Skip to contentSkip to conversation

hwmon: add OneXPlayer mini AMD sensors driver

PATCH Applied Joaquín Ignacio Aramendía 3 participants 5 messages Nov 4, 2022 – Nov 22, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v6 1/1 hwmon: add OneXPlayer mini AMD sensors driver

Sensors driver for OXP Handhelds from One-Netbook that expose fan reading and control via hwmon sysfs.

As far as I could gather all OXP boards have the same DMI strings and they can be told appart only by the boot cpu vendor (Intel/AMD). Currently only AMD boards are supported since Intel have different EC registers and values to read/write.

Fan control is provided via pwm interface in the range [0-255]. AMD boards have [0-100] as range in the EC, the written value is scaled to accommodate for that.

---
Improved documentation.
Fixed some coding issues according to feedback.
Added comment on module_platform_driver() usage.

---
 Documentation/hwmon/index.rst       |   1 +
 Documentation/hwmon/oxp-sensors.rst |  34 ++++
 MAINTAINERS                         |   6 +
 drivers/hwmon/Kconfig               |  11 ++
 drivers/hwmon/Makefile              |   1 +
 drivers/hwmon/oxp-sensors.c         | 262 ++++++++++++++++++++++++++++
 6 files changed, 315 insertions(+)
 create mode 100644 Documentation/hwmon/oxp-sensors.rst
 create mode 100644 drivers/hwmon/oxp-sensors.c
Documentation/hwmon/index.rst +1 -0
index c1d11cf13eef..098986bfbfdd 100644
@@ -160,6 +160,7 @@ Hardware Monitoring Kernel Drivers
    nzxt-kraken2
    nzxt-smart2
    occ
+   oxp-sensors
    pc87360
    pc87427
    pcf8591
Documentation/hwmon/oxp-sensors.rst new file +34 -0
new file mode 100644
index 000000000000..f612dddc964a
@@ -0,0 +1,34 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver oxp-sensors
+=========================
+
+Author:
+    - Joaquín Ignacio Aramendía <[email protected]>
+
+Description:
+------------
+
+One X Player devices from One Netbook provide fan readings and fan control
+through its Embedded Controller.
+
+Currently only supports AMD boards from the One X Player lineup. Intel boards
+could be supported if we could figure out the EC registers and values to write
+to since the EC layout and model is different.
+
+Sysfs entries
+-------------
+
+The following attributes are supported:
+
+fan1_input
+  Read Only. Reads current fan RMP.
+
+pwm1_enable
+  Read Write. Enable manual fan control. Write "1" to set to manual, write "0"
+  to let the EC control de fan speed. Read this attribute to see current status.
+
+pwm1
+  Read Write. Read this attribute to see current duty cycle in the range [0-255].
+  When pwm1_enable is set to "1" (manual) write any value in the range [0-255]
+  to set fan speed.
MAINTAINERS +6 -0
index e1bc31a6624b..bde592896d33 100644
@@ -15343,6 +15343,12 @@ S:	Maintained
 F:	drivers/mtd/nand/onenand/
 F:	include/linux/mtd/onenand*.h
 
+ONEXPLAYER FAN DRIVER
+M:	Joaquín Ignacio Aramendía <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/hwmon/oxp-sensors.c
+
 ONION OMEGA2+ BOARD
 M:	Harvey Hunt <[email protected]>
 L:	[email protected]
drivers/hwmon/Kconfig +11 -0
index 7ac3daaf59ce..993ffa26e44f 100644
@@ -1607,6 +1607,17 @@ config SENSORS_NZXT_SMART2
 
 source "drivers/hwmon/occ/Kconfig"
 
+config SENSORS_OXP
+	tristate "OneXPlayer EC fan control"
+	depends on ACPI
+	depends on X86
+	help
+		If you say yes here you get support for fan readings and control over
+		OneXPlayer handheld devices. Only OneXPlayer mini AMD handheld variant
+		boards are supported.
+
+		Can also be built as a module. In that case it will be called oxp-sensors.
+
 config SENSORS_PCF8591
 	tristate "Philips PCF8591 ADC/DAC"
 	depends on I2C
drivers/hwmon/Makefile +1 -0
index 11d076cad8a2..35824f8be455 100644
@@ -167,6 +167,7 @@ obj-$(CONFIG_SENSORS_NSA320)	+= nsa320-hwmon.o
 obj-$(CONFIG_SENSORS_NTC_THERMISTOR)	+= ntc_thermistor.o
 obj-$(CONFIG_SENSORS_NZXT_KRAKEN2) += nzxt-kraken2.o
 obj-$(CONFIG_SENSORS_NZXT_SMART2) += nzxt-smart2.o
+obj-$(CONFIG_SENSORS_OXP) += oxp-sensors.o
 obj-$(CONFIG_SENSORS_PC87360)	+= pc87360.o
 obj-$(CONFIG_SENSORS_PC87427)	+= pc87427.o
 obj-$(CONFIG_SENSORS_PCF8591)	+= pcf8591.o
drivers/hwmon/oxp-sensors.c new file +262 -0

262 lines not on this page · raw message

--
2.38.1

maintainer Applied
#1 lore raw
Quoted 8 lines · Joaquín Ignacio Aramendía

Sensors driver for OXP Handhelds from One-Netbook that expose fan reading and control via hwmon sysfs.

As far as I could gather all OXP boards have the same DMI strings and they can be told appart only by the boot cpu vendor (Intel/AMD). Currently only AMD boards are supported since Intel have different EC registers and values to read/write.

Quoted 5 lines

Fan control is provided via pwm interface in the range [0-255]. AMD boards have [0-100] as range in the EC, the written value is scaled to accommodate for that.

Applied to hwmon-next.

Thanks,
Guenter

#2 lore raw
Quoted 4 lines

Applied to hwmon-next.

Thanks,
Guenter

Thank you :)

Signature · 1 line
Joaquín I. Aramendía
#3 lore raw
In reply to Joaquín Ignacio Aramendía

Am 04.11.22 um 15:07 schrieb Joaquín Ignacio Aramendía:

Quoted 13 lines

Sensors driver for OXP Handhelds from One-Netbook that expose fan reading and control via hwmon sysfs.

As far as I could gather all OXP boards have the same DMI strings and they can be told appart only by the boot cpu vendor (Intel/AMD). Currently only AMD boards are supported since Intel have different EC registers and values to read/write.

Fan control is provided via pwm interface in the range [0-255]. AMD boards have [0-100] as range in the EC, the written value is scaled to accommodate for that.

...

drivers/hwmon/oxp-sensors.c line 259

Quoted 9 lines
drivers/hwmon/oxp-sensors.c new file +9 -0
+/*
+ * module_platform_driver() may be used here but somehow it breaks the module
+ * either by preventing it from loading or not exposing hwmon attributes.
+ * Either way I'm not smart enough to figure it out so I'll leave init/exit
+ * macros for now.
+ */
+module_init(oxp_platform_init);
+module_exit(oxp_platform_exit);
+

Hello,

i know i am a bit late to point that out, but AFAIK module_platform_driver() only registers a platform driver, not the corresponding platform device. With the platform device missing, the platform driver will never load. This is the reason why platform_create_bundle() exists, it basically registers a platform driver and a platform device together.

Should i send a separate patch to remove the comment?.

Armin Wolf

Quoted 6 lines
drivers/hwmon/oxp-sensors.c new file +3 -1
+MODULE_AUTHOR("Joaquín Ignacio Aramendía <[email protected]>");
+MODULE_DESCRIPTION("Platform driver that handles EC sensors of OneXPlayer devices");
+MODULE_LICENSE("GPL");
--

2.38.1

maintainer
#4 lore raw
Quoted 30 lines · Armin Wolf

Am 04.11.22 um 15:07 schrieb Joaquín Ignacio Aramendía:

Quoted 13 lines

Sensors driver for OXP Handhelds from One-Netbook that expose fan reading and control via hwmon sysfs.

As far as I could gather all OXP boards have the same DMI strings and they can be told appart only by the boot cpu vendor (Intel/AMD). Currently only AMD boards are supported since Intel have different EC registers and values to read/write.

Fan control is provided via pwm interface in the range [0-255]. AMD boards have [0-100] as range in the EC, the written value is scaled to accommodate for that.

...

drivers/hwmon/oxp-sensors.c line 259

Quoted 9 lines
drivers/hwmon/oxp-sensors.c new file +9 -0
+/*
+ * module_platform_driver() may be used here but somehow it breaks the module
+ * either by preventing it from loading or not exposing hwmon attributes.
+ * Either way I'm not smart enough to figure it out so I'll leave init/exit
+ * macros for now.
+ */
+module_init(oxp_platform_init);
+module_exit(oxp_platform_exit);
+

Hello,

Quoted 7 lines

i know i am a bit late to point that out, but AFAIK module_platform_driver() only registers a platform driver, not the corresponding platform device. With the platform device missing, the platform driver will never load. This is the reason why platform_create_bundle() exists, it basically registers a platform driver and a platform device together.

Should i send a separate patch to remove the comment?.

Thanks for the note. I dropped the comment; no further action needed.

Guenter

Quoted 8 lines

Armin Wolf

Quoted 6 lines
drivers/hwmon/oxp-sensors.c new file +3 -0
+MODULE_AUTHOR("Joaquín Ignacio Aramendía <[email protected]>");
+MODULE_DESCRIPTION("Platform driver that handles EC sensors of OneXPlayer devices");
+MODULE_LICENSE("GPL");
Signature · 1 line
2.38.1