Skip to contentSkip to conversation

Surface fan monitoring driver

PATCH Applied Ivor Wanders 4 participants 9 messages Jan 31, 2024 – Feb 6, 2024

Subsystems (6)
lore
Share & tools
lore

Ivor Wanders

author maintainer
#0 lore raw

v5 cover Surface fan monitoring driver

Fifth version of a hwmon driver to monitor the fan's rpm on Microsoft Surface devices, originally submitted in [1], [2], [3], v4 at [4]. Only change since v4 is rebasing on mainline kernel tree's master.

Changes in v5:
- Rebased on mainline kernel tree's master branch.
Changes in v4:
- Return 0 from surface_fan_hwmon_read instead of ret.
- Use PTR_ERR_OR_ZERO in probe instead of if statement.
Changes in v3:
- Removed type and attr checks in read and is_visible.
- Removed assigning sdev to ssam_device drvdata.
- Propagate return from __ssam_fan_rpm_get.
- Renamed hwmon chip name from 'fan' to 'surface_fan'.
- Removed unnecessary platform_device header.
Changes in v2:
- Removed all unsupported sysfs attributes from the hwmon driver, leaving the fan input as the only supported attribute.

[1] https://lore.kernel.org/linux-hwmon/[email protected]/T/
[2] https://lore.kernel.org/linux-hwmon/[email protected]/T/
[3] https://lore.kernel.org/linux-hwmon/[email protected]/T/
[4] https://lore.kernel.org/linux-hwmon/[email protected]/T/

Ivor Wanders (2):
hwmon: add fan speed monitoring driver for Surface devices platform/surface: aggregator_registry: add entry for fan speed

 Documentation/hwmon/index.rst                 |  1 +
 Documentation/hwmon/surface_fan.rst           | 25 +++++
 MAINTAINERS                                   |  8 ++
 drivers/hwmon/Kconfig                         | 13 +++
 drivers/hwmon/Makefile                        |  1 +
 drivers/hwmon/surface_fan.c                   | 91 +++++++++++++++++++
 .../surface/surface_aggregator_registry.c     |  7 ++
 7 files changed, 146 insertions(+)
 create mode 100644 Documentation/hwmon/surface_fan.rst
 create mode 100644 drivers/hwmon/surface_fan.c
Signature · 1 line
2.17.1
author maintainer
#1 lore raw

PATCH v5 1/2 hwmon: add fan speed monitoring driver for Surface devices

Adds a driver that provides read only access to the fan speed for Microsoft Surface Pro devices. The fan speed is always regulated by the EC and cannot be influenced directly.

---
Changes in v5:
- No changes in this patch.
Changes in v4:
- Return 0 from surface_fan_hwmon_read instead of ret.
- Use PTR_ERR_OR_ZERO in probe instead of if statement.
Changes in v3:
- Removed type and attr checks in read and is_visible.
- Removed assigning sdev to ssam_device drvdata.
- Propagate return from __ssam_fan_rpm_get.
- Renamed hwmon chip name from 'fan' to 'surface_fan'.
- Removed unnecessary platform_device header.
Changes in v2:
- Removed all sysfs attributes except fan1_input. Simplified code and updated documentation accordingly.

---
 Documentation/hwmon/index.rst       |  1 +
 Documentation/hwmon/surface_fan.rst | 25 ++++++++
 MAINTAINERS                         |  8 +++
 drivers/hwmon/Kconfig               | 13 +++++
 drivers/hwmon/Makefile              |  1 +
 drivers/hwmon/surface_fan.c         | 91 +++++++++++++++++++++++++++++
 6 files changed, 139 insertions(+)
 create mode 100644 Documentation/hwmon/surface_fan.rst
 create mode 100644 drivers/hwmon/surface_fan.c
Documentation/hwmon/index.rst +1 -0
index c7ed1f73a..58be92e94 100644
@@ -208,6 +208,7 @@ Hardware Monitoring Kernel Drivers
    smsc47m1
    sparx5-temp
    stpddc60
+   surface_fan
    sy7636a-hwmon
    tc654
    tc74
Documentation/hwmon/surface_fan.rst new file +25 -0
new file mode 100644
index 000000000..07942574c
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver surface_fan
+=========================
+
+Supported Devices:
+
+  * Microsoft Surface Pro 9
+
+Author: Ivor Wanders <[email protected]>
+
+Description
+-----------
+
+This provides monitoring of the fan found in some Microsoft Surface Pro devices,
+like the Surface Pro 9. The fan is always controlled by the onboard controller.
+
+Sysfs interface
+---------------
+
+======================= ======= =========================================
+Name                    Perm    Description
+======================= ======= =========================================
+``fan1_input``          RO      Current fan speed in RPM.
+======================= ======= =========================================
MAINTAINERS +8 -0
index c4828ab15..2c5c4d7e5 100644
@@ -14560,6 +14560,14 @@ F:	Documentation/driver-api/surface_aggregator/clients/dtx.rst
 F:	drivers/platform/surface/surface_dtx.c
 F:	include/uapi/linux/surface_aggregator/dtx.h
 
+MICROSOFT SURFACE SENSOR FAN DRIVER
+M:	Maximilian Luz <[email protected]>
+M:	Ivor Wanders <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	Documentation/hwmon/surface_fan.rst
+F:	drivers/hwmon/surface_fan.c
+
 MICROSOFT SURFACE GPE LID SUPPORT DRIVER
 M:	Maximilian Luz <[email protected]>
 L:	[email protected]
drivers/hwmon/Kconfig +13 -0
index a608264da..e762f6138 100644
@@ -1994,6 +1994,19 @@ config SENSORS_SFCTEMP
 	  This driver can also be built as a module.  If so, the module
 	  will be called sfctemp.
 
+config SENSORS_SURFACE_FAN
+	tristate "Surface Fan Driver"
+	depends on SURFACE_AGGREGATOR
+	help
+	  Driver that provides monitoring of the fan on Surface Pro devices that
+	  have a fan, like the Surface Pro 9.
+
+	  This makes the fan's current speed accessible through the hwmon
+	  system. It does not provide control over the fan, the firmware is
+	  responsible for that, this driver merely provides monitoring.
+
+	  Select M or Y here, if you want to be able to read the fan's speed.
+
 config SENSORS_ADC128D818
 	tristate "Texas Instruments ADC128D818"
 	depends on I2C
drivers/hwmon/Makefile +1 -0
index 47be39af5..30cc90f40 100644
@@ -201,6 +201,7 @@ obj-$(CONFIG_SENSORS_SMSC47M1)	+= smsc47m1.o
 obj-$(CONFIG_SENSORS_SMSC47M192)+= smsc47m192.o
 obj-$(CONFIG_SENSORS_SPARX5)	+= sparx5-temp.o
 obj-$(CONFIG_SENSORS_STTS751)	+= stts751.o
+obj-$(CONFIG_SENSORS_SURFACE_FAN)+= surface_fan.o
 obj-$(CONFIG_SENSORS_SY7636A)	+= sy7636a-hwmon.o
 obj-$(CONFIG_SENSORS_AMC6821)	+= amc6821.o
 obj-$(CONFIG_SENSORS_TC74)	+= tc74.o
drivers/hwmon/surface_fan.c new file +91 -0

91 lines not on this page · raw message

Signature · 1 line
2.17.1
maintainer Applied
#2 lore raw

Re: [PATCH v5 1/2] hwmon: add fan speed monitoring driver for Surface devices

Quoted 8 lines · Ivor Wanders

Adds a driver that provides read only access to the fan speed for Microsoft Surface Pro devices. The fan speed is always regulated by the EC and cannot be influenced directly.

Applied.

Thanks,
Guenter

Quoted 221 lines

---
Changes in v5:
- No changes in this patch.
Changes in v4:
- Return 0 from surface_fan_hwmon_read instead of ret.
- Use PTR_ERR_OR_ZERO in probe instead of if statement.
Changes in v3:
- Removed type and attr checks in read and is_visible.
- Removed assigning sdev to ssam_device drvdata.
- Propagate return from __ssam_fan_rpm_get.
- Renamed hwmon chip name from 'fan' to 'surface_fan'.
- Removed unnecessary platform_device header.
Changes in v2:
- Removed all sysfs attributes except fan1_input. Simplified code and updated documentation accordingly.

---
 Documentation/hwmon/index.rst       |  1 +
 Documentation/hwmon/surface_fan.rst | 25 ++++++++
 MAINTAINERS                         |  8 +++
 drivers/hwmon/Kconfig               | 13 +++++
 drivers/hwmon/Makefile              |  1 +
 drivers/hwmon/surface_fan.c         | 91 +++++++++++++++++++++++++++++
 6 files changed, 139 insertions(+)
 create mode 100644 Documentation/hwmon/surface_fan.rst
 create mode 100644 drivers/hwmon/surface_fan.c
Documentation/hwmon/index.rst +1 -0
index c7ed1f73a..58be92e94 100644
@@ -208,6 +208,7 @@ Hardware Monitoring Kernel Drivers
    smsc47m1
    sparx5-temp
    stpddc60
+   surface_fan
    sy7636a-hwmon
    tc654
    tc74
Documentation/hwmon/surface_fan.rst new file +25 -0
new file mode 100644
index 000000000..07942574c
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver surface_fan
+=========================
+
+Supported Devices:
+
+  * Microsoft Surface Pro 9
+
+Author: Ivor Wanders <[email protected]>
+
+Description
+-----------
+
+This provides monitoring of the fan found in some Microsoft Surface Pro devices,
+like the Surface Pro 9. The fan is always controlled by the onboard controller.
+
+Sysfs interface
+---------------
+
+======================= ======= =========================================
+Name                    Perm    Description
+======================= ======= =========================================
+``fan1_input``          RO      Current fan speed in RPM.
+======================= ======= =========================================
MAINTAINERS +8 -0
index c4828ab15..2c5c4d7e5 100644
@@ -14560,6 +14560,14 @@ F:	Documentation/driver-api/surface_aggregator/clients/dtx.rst
 F:	drivers/platform/surface/surface_dtx.c
 F:	include/uapi/linux/surface_aggregator/dtx.h
 
+MICROSOFT SURFACE SENSOR FAN DRIVER
+M:	Maximilian Luz <[email protected]>
+M:	Ivor Wanders <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	Documentation/hwmon/surface_fan.rst
+F:	drivers/hwmon/surface_fan.c
+
 MICROSOFT SURFACE GPE LID SUPPORT DRIVER
 M:	Maximilian Luz <[email protected]>
 L:	[email protected]
drivers/hwmon/Kconfig +13 -0
index a608264da..e762f6138 100644
@@ -1994,6 +1994,19 @@ config SENSORS_SFCTEMP
 	  This driver can also be built as a module.  If so, the module
 	  will be called sfctemp.
 
+config SENSORS_SURFACE_FAN
+	tristate "Surface Fan Driver"
+	depends on SURFACE_AGGREGATOR
+	help
+	  Driver that provides monitoring of the fan on Surface Pro devices that
+	  have a fan, like the Surface Pro 9.
+
+	  This makes the fan's current speed accessible through the hwmon
+	  system. It does not provide control over the fan, the firmware is
+	  responsible for that, this driver merely provides monitoring.
+
+	  Select M or Y here, if you want to be able to read the fan's speed.
+
 config SENSORS_ADC128D818
 	tristate "Texas Instruments ADC128D818"
 	depends on I2C
drivers/hwmon/Makefile +1 -0
index 47be39af5..30cc90f40 100644
@@ -201,6 +201,7 @@ obj-$(CONFIG_SENSORS_SMSC47M1)	+= smsc47m1.o
 obj-$(CONFIG_SENSORS_SMSC47M192)+= smsc47m192.o
 obj-$(CONFIG_SENSORS_SPARX5)	+= sparx5-temp.o
 obj-$(CONFIG_SENSORS_STTS751)	+= stts751.o
+obj-$(CONFIG_SENSORS_SURFACE_FAN)+= surface_fan.o
 obj-$(CONFIG_SENSORS_SY7636A)	+= sy7636a-hwmon.o
 obj-$(CONFIG_SENSORS_AMC6821)	+= amc6821.o
 obj-$(CONFIG_SENSORS_TC74)	+= tc74.o
drivers/hwmon/surface_fan.c new file +91 -0
new file mode 100644
index 000000000..31cd5da9e
@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Surface Fan driver for Surface System Aggregator Module. It provides access
+ * to the fan's rpm through the hwmon system.
+ *
+ * Copyright (C) 2023 Ivor Wanders <[email protected]>
+ */
+
+#include <linux/hwmon.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/surface_aggregator/device.h>
+#include <linux/types.h>
+
+// SSAM
+SSAM_DEFINE_SYNC_REQUEST_CL_R(__ssam_fan_rpm_get, __le16, {
+	.target_category = SSAM_SSH_TC_FAN,
+	.command_id      = 0x01,
+});
+
+// hwmon
+umode_t surface_fan_hwmon_is_visible(const void *drvdata,
+				     enum hwmon_sensor_types type, u32 attr,
+				     int channel)
+{
+	return 0444;
+}
+
+static int surface_fan_hwmon_read(struct device *dev,
+				  enum hwmon_sensor_types type, u32 attr,
+				  int channel, long *val)
+{
+	struct ssam_device *sdev = dev_get_drvdata(dev);
+	int ret;
+	__le16 value;
+
+	ret = __ssam_fan_rpm_get(sdev, &value);
+	if (ret)
+		return ret;
+
+	*val = le16_to_cpu(value);
+
+	return 0;
+}
+
+static const struct hwmon_channel_info *const surface_fan_info[] = {
+	HWMON_CHANNEL_INFO(fan, HWMON_F_INPUT),
+	NULL
+};
+
+static const struct hwmon_ops surface_fan_hwmon_ops = {
+	.is_visible = surface_fan_hwmon_is_visible,
+	.read = surface_fan_hwmon_read,
+};
+
+static const struct hwmon_chip_info surface_fan_chip_info = {
+	.ops = &surface_fan_hwmon_ops,
+	.info = surface_fan_info,
+};
+
+static int surface_fan_probe(struct ssam_device *sdev)
+{
+	struct device *hdev;
+
+	hdev = devm_hwmon_device_register_with_info(&sdev->dev,
+						    "surface_fan", sdev,
+						    &surface_fan_chip_info,
+						    NULL);
+
+	return PTR_ERR_OR_ZERO(hdev);
+}
+
+static const struct ssam_device_id ssam_fan_match[] = {
+	{ SSAM_SDEV(FAN, SAM, 0x01, 0x01) },
+	{},
+};
+MODULE_DEVICE_TABLE(ssam, ssam_fan_match);
+
+static struct ssam_device_driver surface_fan = {
+	.probe = surface_fan_probe,
+	.match_table = ssam_fan_match,
+	.driver = {
+		.name = "surface_fan",
+		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
+	},
+};
+module_ssam_device_driver(surface_fan);
+
+MODULE_AUTHOR("Ivor Wanders <[email protected]>");
+MODULE_DESCRIPTION("Fan Driver for Surface System Aggregator Module");
+MODULE_LICENSE("GPL");
author maintainer
#3 lore raw

PATCH v5 2/2 platform/surface: aggregator_registry: add entry for fan speed

In reply to Ivor Wanders

Add an entry for the fan speed function.
Add this new entry to the Surface Pro 9 group.

---
Changes in v5:
- No changes in this patch.
Changes in v4:
- No changes in this patch.
Changes in v3:
- No changes in this patch.
Changes in v2:
- No changes in this patch.

---
 drivers/platform/surface/surface_aggregator_registry.c | 7 +++++++
 1 file changed, 7 insertions(+)
drivers/platform/surface/surface_aggregator_registry.c +7 -0
index aeb3feae4..035d6b410 100644
@@ -74,6 +74,12 @@ static const struct software_node ssam_node_tmp_pprof = {
 	.parent = &ssam_node_root,
 };
 
+/* Fan speed function. */
+static const struct software_node ssam_node_fan_speed = {
+	.name = "ssam:01:05:01:01:01",
+	.parent = &ssam_node_root,
+};
+
 /* Tablet-mode switch via KIP subsystem. */
 static const struct software_node ssam_node_kip_tablet_switch = {
 	.name = "ssam:01:0e:01:00:01",
@@ -305,6 +311,7 @@ static const struct software_node *ssam_node_group_sp9[] = {
 	&ssam_node_bat_ac,
 	&ssam_node_bat_main,
 	&ssam_node_tmp_pprof,
+	&ssam_node_fan_speed,
 	&ssam_node_pos_tablet_switch,
 	&ssam_node_hid_kip_keyboard,
 	&ssam_node_hid_kip_penstash,
Signature · 1 line
2.17.1
maintainer
#4 lore raw

Re: [PATCH v5 2/2] platform/surface: aggregator_registry: add entry for fan speed

Quoted 6 lines · Ivor Wanders

Add an entry for the fan speed function.
Add this new entry to the Surface Pro 9 group.

I wasn't sure if the Reviewed-by: tag means that I should apply the patch through the hwmon subsystem. If so, please let me know. For now I'll assume that it will be applied through a platform tree.

Thanks,
Guenter

maintainer
#5 lore raw

Re: [PATCH v5 2/2] platform/surface: aggregator_registry: add entry for fan speed

Am 1/31/2024 um 2:24 PM schrieb Guenter Roeck:

Quoted 11 lines · Ivor Wanders
Quoted 6 lines

Add an entry for the fan speed function.
Add this new entry to the Surface Pro 9 group.

I wasn't sure if the Reviewed-by: tag means that I should apply the patch through the hwmon subsystem. If so, please let me know. For now I'll assume that it will be applied through a platform tree.

I think it would make more sense for it to go through pdx86 (as usual for platform/surface). That would avoid any potential merge conflicts if we get more changes to the surface_aggregator_registry later on.

Hans, Ilpo, could you please take this?

Also I just noticed that Ilpo wasn't CCd, I assume because of an older MAINTAINERS list. Ivor, please add him for any next submissions to platform/surface.

Best regards,
Max

author maintainer
#6 lore raw

Re: [PATCH v5 2/2] platform/surface: aggregator_registry: add entry for fan speed

Quoted 2 lines

I assume because of an older MAINTAINERS list. Ivor, please add him for any next submissions to platform/surface.

Yes, mea culpa. Guenter also ran into trouble applying the v4 version of the patch yesterday. I'm sorry I didn't base this off the correct branch everyone, will be sure to do so in the future!

~Ivor

maintainer
#7 lore raw

Re: [PATCH v5 2/2] platform/surface: aggregator_registry: add entry for fan speed

In reply to Maximilian Luz
Quoted 17 lines · Maximilian Luz

Am 1/31/2024 um 2:24 PM schrieb Guenter Roeck:

Quoted 11 lines · Ivor Wanders
Quoted 6 lines

Add an entry for the fan speed function.
Add this new entry to the Surface Pro 9 group.

I wasn't sure if the Reviewed-by: tag means that I should apply the patch through the hwmon subsystem. If so, please let me know. For now I'll assume that it will be applied through a platform tree.

I think it would make more sense for it to go through pdx86 (as usual for platform/surface). That would avoid any potential merge conflicts if we get more changes to the surface_aggregator_registry later on.

Quoted 5 lines

Hans, Ilpo, could you please take this?

Also I just noticed that Ilpo wasn't CCd, I assume because of an older MAINTAINERS list. Ivor, please add him for any next submissions to platform/surface.

Okay, thanks for letting me know (I assumed the opposite). I'll take it through pdx86.

Signature · 1 line
 i.
maintainer
#8 lore raw

Re: [PATCH v5 2/2] platform/surface: aggregator_registry: add entry for fan speed

Quoted 19 lines · Ilpo Järvinen
Quoted 17 lines · Maximilian Luz

Am 1/31/2024 um 2:24 PM schrieb Guenter Roeck:

Quoted 11 lines · Ivor Wanders
Quoted 6 lines

Add an entry for the fan speed function.
Add this new entry to the Surface Pro 9 group.

I wasn't sure if the Reviewed-by: tag means that I should apply the patch through the hwmon subsystem. If so, please let me know. For now I'll assume that it will be applied through a platform tree.

I think it would make more sense for it to go through pdx86 (as usual for platform/surface). That would avoid any potential merge conflicts if we get more changes to the surface_aggregator_registry later on.

Quoted 8 lines
Quoted 5 lines

Hans, Ilpo, could you please take this?

Also I just noticed that Ilpo wasn't CCd, I assume because of an older MAINTAINERS list. Ivor, please add him for any next submissions to platform/surface.

Okay, thanks for letting me know (I assumed the opposite). I'll take it through pdx86.

Patch 2/2 applied to review-ilpo.

Signature · 1 line
 i.