ACPI fan _DSM support
cover ACPI fan _DSM support
Microsoft has designed a _DSM interface for the ACPI fan device [1] that allows the OS to set fan speed trip points. The ACPI firmware will notify the ACPI fan device when said trip points are triggered.
Unfortunately some device manufacturers (like HP) blindly assume that the OS will use this _DSM interface and thus only update the fan speed value returned by the _FST control method when sending a notification to the ACPI fan device. This results in stale fan speed values being reported by the ACPI fan driver [2].
The first patch performs a simple cleanup in order to reduce the usage of the acpi_device struct. The second patch fixes an issue with some 64-bit ACPI implementations where an invalid value was reported instead of the standard ACPI placeholder value (0xFFFFFFFF). The third patch fixes an unrelated issue inside the hwmon support code while the next two patches add support for the ACPI fan notifications as specified in ACPI 11.2.3. The last patch finally adds support for the Microsoft _DSM interface.
All patches where tested with a custom SSDT [3] and the acpi_call [4] kernel module and appear to work just fine.
[1] https://learn.microsoft.com/en-us/windows-hardware/design/device-experiences/design-guide
[2] https://github.com/lm-sensors/lm-sensors/issues/506
[3] https://github.com/Wer-Wolf/acpi-fan-ssdt/blob/master/ssdt-dsm.asl
[4] https://github.com/nix-community/acpi_call
Armin Wolf (6):
ACPI: fan: Use ACPI handle when retrieving _FST
ACPI: fan: Workaround for 64-bit firmware bug
ACPI: fan: Use platform device for devres-related actions
ACPI: fan: Add basic notification support
ACPI: fan: Add hwmon notification support
ACPI: fan: Add support for Microsoft fan extensions
drivers/acpi/fan.h | 47 ++++++- drivers/acpi/fan_attr.c | 2 +- drivers/acpi/fan_core.c | 260 ++++++++++++++++++++++++++++++++++++--- drivers/acpi/fan_hwmon.c | 32 ++--- 4 files changed, 308 insertions(+), 33 deletions(-)
Signature · 1 line
2.39.5
PATCH 1/6 ACPI: fan: Use ACPI handle when retrieving _FST
Usage of the ACPI device should be phased out in the future, as the driver itself is now using the platform bus. Replace any usage of struct acpi_device in acpi_fan_get_fst() to allow users to drop usage of struct acpi_device.
Also extend the integer check to all three package elements.
--- drivers/acpi/fan.h | 3 ++- drivers/acpi/fan_attr.c | 2 +- drivers/acpi/fan_core.c | 34 ++++++++++++++++++++++------------ drivers/acpi/fan_hwmon.c | 3 +-- 4 files changed, 26 insertions(+), 16 deletions(-)
drivers/acpi/fan.h +2 -1
@@ -49,6 +49,7 @@ struct acpi_fan_fst { };struct acpi_fan { +acpi_handle handle;bool acpi4;bool has_fst;struct acpi_fan_fif fif;
@@ -59,7 +60,7 @@ struct acpi_fan {struct device_attribute fine_grain_control; }; -int acpi_fan_get_fst (struct acpi_device *device,struct acpi_fan_fst *fst); +int acpi_fan_get_fst (acpi_handle handle,struct acpi_fan_fst *fst);int acpi_fan_create_attributes (struct acpi_device *device);void acpi_fan_delete_attributes (struct acpi_device *device);
drivers/acpi/fan_attr.c +1 -1
@@ -55,7 +55,7 @@ static ssize_t show_fan_speed(struct device *dev, struct device_attribute *attr,struct acpi_fan_fst fst;int status; - status =acpi_fan_get_fst (acpi_dev, &fst); + status =acpi_fan_get_fst (acpi_dev->handle, &fst);if (status)return status;
drivers/acpi/fan_core.c +22 -12
@@ -44,25 +44,30 @@ static int fan_get_max_state(struct thermal_cooling_device *cdev, unsigned longreturn 0 ; } -int acpi_fan_get_fst (struct acpi_device *device,struct acpi_fan_fst *fst) +int acpi_fan_get_fst (acpi_handle handle,struct acpi_fan_fst *fst) {struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER ,NULL };union acpi_object *obj;acpi_status status;int ret =0 ; - status =acpi_evaluate_object (device->handle,"_FST" ,NULL , &buffer); -if (ACPI_FAILURE (status)) { -dev_err (&device->dev,"Get fan state failed\n" ); -return -ENODEV ; - } + status =acpi_evaluate_object (handle,"_FST" ,NULL , &buffer); +if (ACPI_FAILURE (status)) +return -EIO ; obj = buffer.pointer; -if (!obj || obj->type !=ACPI_TYPE_PACKAGE || - obj->package.count !=3 || - obj->package.elements[1 ].type !=ACPI_TYPE_INTEGER ) { -dev_err (&device->dev,"Invalid _FST data\n" ); - ret = -EINVAL ; +if (!obj) +return -ENODATA ; + +if (obj->type !=ACPI_TYPE_PACKAGE || obj->package.count !=3 ) { + ret = -EPROTO ; + goto err; + } + +if (obj->package.elements[0 ].type !=ACPI_TYPE_INTEGER || + obj->package.elements[1 ].type !=ACPI_TYPE_INTEGER || + obj->package.elements[2 ].type !=ACPI_TYPE_INTEGER ) { + ret = -EPROTO ; goto err; }
@@ -81,7 +86,7 @@ static int fan_get_state_acpi4(struct acpi_device *device, unsigned long *state)struct acpi_fan_fst fst;int status, i; - status =acpi_fan_get_fst (device, &fst); + status =acpi_fan_get_fst (device->handle, &fst);if (status)return status;
@@ -311,11 +316,16 @@ static int acpi_fan_probe(struct platform_device *pdev)struct acpi_device *device =ACPI_COMPANION (&pdev->dev);char *name; +if (!device) +return -ENODEV ; + fan =devm_kzalloc (&pdev->dev,sizeof (*fan),GFP_KERNEL );if (!fan) {dev_err (&device->dev,"No memory for fan\n" );return -ENOMEM ; } + + fan->handle = device->handle; device->driver_data = fan;platform_set_drvdata (pdev, fan);
drivers/acpi/fan_hwmon.c +1 -2
@@ -93,13 +93,12 @@ static umode_t acpi_fan_hwmon_is_visible(const void *drvdata, enum hwmon_sensor_static int acpi_fan_hwmon_read (struct device *dev,enum hwmon_sensor_types type,u32 attr,int channel,long *val) { -struct acpi_device *adev =to_acpi_device (dev->parent);struct acpi_fan *fan =dev_get_drvdata (dev);struct acpi_fan_fps *fps;struct acpi_fan_fst fst;int ret; - ret =acpi_fan_get_fst (adev, &fst); + ret =acpi_fan_get_fst (fan->handle, &fst);if (ret <0 )return ret;
Signature · 1 line
2.39.5
PATCH 2/6 ACPI: fan: Workaround for 64-bit firmware bug
In reply to Armin WolfSome firmware implementations use the "Ones" ASL opcode to produce an integer with all bits set in order to indicate missing speed or power readings. This however only works when using 32-bit intgers, as the ACPI spec requires a 32-bit integer (0xFFFFFFFF) to be returned for missing speed/power readings. With 64-bit integers the "Ones" opcode produces a 64-bit integer with all bits set, violating the ACPI spec regarding the placeholder value for missing readings.
Work around such buggy firmware implementation by also checking for 64-bit integers with all bits set when reading _FST.
--- drivers/acpi/fan.h | 33 +++++++++++++++++++++++++++++++++ drivers/acpi/fan_hwmon.c | 10 +++------- 2 files changed, 36 insertions(+), 7 deletions(-)
drivers/acpi/fan.h +33 -0
@@ -11,6 +11,7 @@#define _ACPI_FAN_H_#include <linux/kconfig.h> +#include <linux/limits.h> #define ACPI_FAN_DEVICE_IDS \ {"INT3404", },/* Fan */ \
@@ -60,6 +61,38 @@ struct acpi_fan {struct device_attribute fine_grain_control; }; +/** +* acpi_fan_speed_valid - Check if fan speed value is valid +* @speeed: Speed value returned by the ACPI firmware +* +* Check if the fan speed value returned by the ACPI firmware is valid. This function is +* necessary as ACPI firmware implementations can return 0xFFFFFFFF to signal that the +* ACPI fan does not support speed reporting. Additionally, some buggy ACPI firmware +* implementations return a value larger than the 32-bit integer value defined by +* the ACPI specification when using placeholder values. Such invalid values are also +* detected by this function. +* +* Returns: True if the fan speed value is valid, false otherwise. +*/ +static inline bool acpi_fan_speed_valid (u64 speed) +{ +return speed <U32_MAX ; +} + +/** +* acpi_fan_power_valid - Check if fan power value is valid +* @power: Power value returned by the ACPI firmware +* +* Check if the fan power value returned by the ACPI firmware is valid. +* See acpi_fan_speed_valid() for details. +* +* Returns: True if the fan power value is valid, false otherwise. +*/ +static inline bool acpi_fan_power_valid (u64 power) +{ +return power <U32_MAX ; +} +int acpi_fan_get_fst (acpi_handle handle,struct acpi_fan_fst *fst);int acpi_fan_create_attributes (struct acpi_device *device);void acpi_fan_delete_attributes (struct acpi_device *device);
drivers/acpi/fan_hwmon.c +3 -7
@@ -15,10 +15,6 @@#include "fan.h" -/* Returned when the ACPI fan does not support speed reporting */ -#define FAN_SPEED_UNAVAILABLE U32_MAX -#define FAN_POWER_UNAVAILABLE U32_MAX -static struct acpi_fan_fps *acpi_fan_get_current_fps (struct acpi_fan *fan,u64 control) {unsigned int i;
@@ -77,7 +73,7 @@ static umode_t acpi_fan_hwmon_is_visible(const void *drvdata, enum hwmon_sensor_* when the associated attribute should not be created. */ for (i =0 ; i < fan->fps_count; i++) { -if (fan->fps[i].power !=FAN_POWER_UNAVAILABLE ) +if (acpi_fan_power_valid (fan->fps[i].power))return 0444 ; }
@@ -106,7 +102,7 @@ static int acpi_fan_hwmon_read(struct device *dev, enum hwmon_sensor_types type,case hwmon_fan:switch (attr) {case hwmon_fan_input: -if (fst.speed ==FAN_SPEED_UNAVAILABLE ) +if (!acpi_fan_speed_valid (fst.speed))return -ENODEV ;if (fst.speed >LONG_MAX )
@@ -134,7 +130,7 @@ static int acpi_fan_hwmon_read(struct device *dev, enum hwmon_sensor_types type,if (!fps)return -EIO ; -if (fps->power ==FAN_POWER_UNAVAILABLE ) +if (!acpi_fan_power_valid (fps->power))return -ENODEV ;if (fps->power >LONG_MAX /MICROWATT_PER_MILLIWATT )
Signature · 1 line
2.39.5
PATCH 3/6 ACPI: fan: Use platform device for devres-related actions
In reply to Armin WolfDevice-managed resources are cleaned up when the driver unbinds from the underlying device. In our case this is the platform device as this driver is a platform driver. Registering device-managed resources on the associated ACPI device will thus result in a resource leak when this driver unbinds.
Ensure that any device-managed resources are only registered on the platform device to ensure that they are cleaned up during removal.
--- drivers/acpi/fan.h | 4 ++-- drivers/acpi/fan_core.c | 2 +- drivers/acpi/fan_hwmon.c | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-)
drivers/acpi/fan.h +2 -2
@@ -98,9 +98,9 @@ int acpi_fan_create_attributes(struct acpi_device *device);void acpi_fan_delete_attributes (struct acpi_device *device);#if IS_REACHABLE (CONFIG_HWMON ) -int devm_acpi_fan_create_hwmon (struct acpi_device *device); +int devm_acpi_fan_create_hwmon (struct device *dev);#else -static inline int devm_acpi_fan_create_hwmon (struct acpi_device *device) {return 0 ; }; +static inline int devm_acpi_fan_create_hwmon (struct device *dev) {return 0 ; };#endif #endif
drivers/acpi/fan_core.c +1 -1
@@ -347,7 +347,7 @@ static int acpi_fan_probe(struct platform_device *pdev) }if (fan->has_fst) { - result =devm_acpi_fan_create_hwmon (device); + result =devm_acpi_fan_create_hwmon (&pdev->dev);if (result)return result;
drivers/acpi/fan_hwmon.c +4 -4
@@ -162,12 +162,12 @@ static const struct hwmon_chip_info acpi_fan_hwmon_chip_info = { .info = acpi_fan_hwmon_info, }; -int devm_acpi_fan_create_hwmon (struct acpi_device *device) +int devm_acpi_fan_create_hwmon (struct device *dev) { -struct acpi_fan *fan =acpi_driver_data (device); +struct acpi_fan *fan =dev_get_drvdata (dev);struct device *hdev; - hdev =devm_hwmon_device_register_with_info (&device->dev,"acpi_fan" , fan, - &acpi_fan_hwmon_chip_info,NULL ); + hdev =devm_hwmon_device_register_with_info (dev,"acpi_fan" , fan, &acpi_fan_hwmon_chip_info, +NULL );return PTR_ERR_OR_ZERO (hdev); }
Signature · 1 line
2.39.5
PATCH 4/6 ACPI: fan: Add basic notification support
In reply to Armin WolfThe ACPI specification states that the platform firmware can notify the ACPI fan device that the fan speed has changed an that the _FST control method should be reevaluated. Add support for this mechanism to prepare for future changes.
--- drivers/acpi/fan_core.c | 49 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+)
drivers/acpi/fan_core.c +49 -0
@@ -19,6 +19,8 @@#include "fan.h" +#define ACPI_FAN_NOTIFY_STATE_CHANGED 0x80 +static const struct acpi_device_id fan_device_ids[] = {ACPI_FAN_DEVICE_IDS , {"" ,0 },
@@ -308,6 +310,49 @@ static int acpi_fan_get_fps(struct acpi_device *device)return status; } +static void acpi_fan_notify_handler (acpi_handle handle,u32 event,void *context) +{ +struct device *dev = context; +struct acpi_fan_fst fst; +int ret; + +switch (event) { +case ACPI_FAN_NOTIFY_STATE_CHANGED : +/* +* The ACPI specification says that we must evaluate _FST when we +* receive an ACPI event indicating that the fan state has changed. +*/ + ret =acpi_fan_get_fst (handle, &fst); +if (ret <0 ) +dev_err (dev,"Error retrieving current fan status: %d\n" , ret); + +break ; +default : +dev_dbg (dev,"Unsupported ACPI notification 0x%x\n" , event); +break ; + } +} + +static void acpi_fan_notify_remove (void *data) +{ +struct acpi_fan *fan = data; + +acpi_remove_notify_handler (fan->handle,ACPI_DEVICE_NOTIFY , acpi_fan_notify_handler); +} + +static int devm_acpi_fan_notify_init (struct device *dev) +{ +struct acpi_fan *fan =dev_get_drvdata (dev); +acpi_status status; + + status =acpi_install_notify_handler (fan->handle,ACPI_DEVICE_NOTIFY , + acpi_fan_notify_handler, dev); +if (ACPI_FAILURE (status)) +return -EIO ; + +return devm_add_action_or_reset (dev, acpi_fan_notify_remove, fan); +} +static int acpi_fan_probe (struct platform_device *pdev) {int result =0 ;
@@ -351,6 +396,10 @@ static int acpi_fan_probe(struct platform_device *pdev)if (result)return result; + result =devm_acpi_fan_notify_init (&pdev->dev); +if (result) +return result; + result =acpi_fan_create_attributes (device);if (result)return result;
Signature · 1 line
2.39.5
PATCH 5/6 ACPI: fan: Add hwmon notification support
In reply to Armin WolfThe platform firmware can notify the ACPI fan device that the fan speed has changed. Relay this notification to the hwmon device if present so that userspace applications can react to it.
--- drivers/acpi/fan.h | 5 +++++ drivers/acpi/fan_core.c | 1 + drivers/acpi/fan_hwmon.c | 15 +++++++++++---- 3 files changed, 17 insertions(+), 4 deletions(-)
drivers/acpi/fan.h +5 -0
@@ -56,6 +56,9 @@ struct acpi_fan {struct acpi_fan_fif fif;struct acpi_fan_fps *fps;int fps_count; +#if IS_REACHABLE (CONFIG_HWMON ) +struct device *hdev; +#endif struct thermal_cooling_device *cdev;struct device_attribute fst_speed;struct device_attribute fine_grain_control;
@@ -99,8 +102,10 @@ void acpi_fan_delete_attributes(struct acpi_device *device);#if IS_REACHABLE (CONFIG_HWMON )int devm_acpi_fan_create_hwmon (struct device *dev); +void acpi_fan_notify_hwmon (struct device *dev);#else static inline int devm_acpi_fan_create_hwmon (struct device *dev) {return 0 ; }; +static inline void acpi_fan_notify_hwmon (struct device *dev) { };#endif #endif
drivers/acpi/fan_core.c +1 -0
@@ -326,6 +326,7 @@ static void acpi_fan_notify_handler(acpi_handle handle, u32 event, void *contextif (ret <0 )dev_err (dev,"Error retrieving current fan status: %d\n" , ret); +acpi_fan_notify_hwmon (dev);break ;default :dev_dbg (dev,"Unsupported ACPI notification 0x%x\n" , event);
drivers/acpi/fan_hwmon.c +11 -4
@@ -162,12 +162,19 @@ static const struct hwmon_chip_info acpi_fan_hwmon_chip_info = { .info = acpi_fan_hwmon_info, }; +void acpi_fan_notify_hwmon (struct device *dev) +{ +struct acpi_fan *fan =dev_get_drvdata (dev); + +hwmon_notify_event (fan->hdev, hwmon_fan, hwmon_fan_input,0 ); +} +int devm_acpi_fan_create_hwmon (struct device *dev) {struct acpi_fan *fan =dev_get_drvdata (dev); -struct device *hdev; - hdev =devm_hwmon_device_register_with_info (dev,"acpi_fan" , fan, &acpi_fan_hwmon_chip_info, -NULL ); -return PTR_ERR_OR_ZERO (hdev); + fan->hdev =devm_hwmon_device_register_with_info (dev,"acpi_fan" , fan, + &acpi_fan_hwmon_chip_info,NULL ); + +return PTR_ERR_OR_ZERO (fan->hdev); }
Signature · 1 line
2.39.5
PATCH 6/6 ACPI: fan: Add support for Microsoft fan extensions
In reply to Armin WolfMicrosoft has designed a set of extensions for the ACPI fan device allowing the OS to specify a set of fan speed trip points. The platform firmware will then notify the ACPI fan device when one of the trip points is triggered.
Unfortunatly, some device manufacturers (like HP) blindly assume that the OS will use said extensions and thus only update the values returned by the _FST control method when receiving such a notification. As a result the ACPI fan driver is currently unusable on such machines, always reporting a constant value.
Fix this by adding support for the Microsoft extensions. During probe and when resuming from suspend the driver will attempt to trigger an initial notification that will update the values returned by _FST. Said trip points will be updated each time a notification is received from the platform firmware to ensure that the values returned by the _FST control method are updated.
--- drivers/acpi/fan.h | 2 + drivers/acpi/fan_core.c | 176 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 176 insertions(+), 2 deletions(-)
drivers/acpi/fan.h +2 -0
@@ -56,6 +56,8 @@ struct acpi_fan {struct acpi_fan_fif fif;struct acpi_fan_fps *fps;int fps_count; +/* A value of 0 means that trippoint-related functions are not supported */ +u32 fan_trip_granularity;#if IS_REACHABLE (CONFIG_HWMON )struct device *hdev;#endif
drivers/acpi/fan_core.c +174 -2
225 lines not on this page · raw message
Signature · 1 line
2.39.5