Thermal zone device structure encapsulation
Subsystems (3)
v4 cover Thermal zone device structure encapsulation
The thermal zone device structure is defined in the exported thermal header include/linux/thermal.h
Given the definition being public, the structure is exposed to the external components other than the thermal framework core code. It results the drivers are tampering the structure internals like taking the lock or changing the field values.
Obviously that is bad for several reasons as the drivers can hook the thermal framework behavior and makes very difficult the changes in the core code as external components depend on it directly.
Moreover, the thermal trip points being reworked, we don't want the drivers to access the trips array directly in the thermal zone structure and doing assumptions on how they are organized.
This series provides a second set of changes moving to the thermal zone device structure self-encapsulation.
The ACPI and the Menlon drivers are using the thermal zone's device fields to create symlinks and new attributes in the sysfs thermal zone directory. These changes provide a hopefully temporary wrapper to access it in order to allow moving forward in the thermal zone device self-encapsulation and a Kconfig option to disable by default such a extra sysfs information.
Changelog:
v4:
- Encapsulate extra sysfs information inside a function for ACPI but remove the Kconfig option
- Encapsulate extra sysfs information inside a function, create the stubs and put that conditionnal to a Kconfig option for Menlow
v3:
- Split the Kconfig option to be driver related when disabling the specific attributes
- Use the thermal zone's device wrapper to write a trace in the pch intel driver
v2:
- Add the Kconfig option to remove specific attributes
- Add a thermal_zone_device() wrapper to access tz->device
Daniel Lezcano (6):
thermal/core: Encapsulate tz->device field thermal/drivers/intel_pch_thermal: Use thermal driver device to write
a trace
thermal/drivers/acpi: Use thermal_zone_device() thermal/drivers/menlow: Use thermal_zone_device() thermal/drivers/acpi: Move to dedicated function sysfs extra attr
creation
thermal/drivers/intel_menlow: Make additionnal sysfs information
optional
drivers/acpi/thermal.c | 47 +++++++++++++++-------- drivers/thermal/intel/Kconfig | 11 ++++++ drivers/thermal/intel/intel_menlow.c | 18 +++++++-- drivers/thermal/intel/intel_pch_thermal.c | 3 +- drivers/thermal/thermal_core.c | 6 +++ include/linux/thermal.h | 1 + 6 files changed, 67 insertions(+), 19 deletions(-)
Signature · 1 line
2.34.1
PATCH v4 1/6 thermal/core: Encapsulate tz->device field
There are still some drivers needing to play with the thermal zone device internals. That is not the best but until we can figure out if the information is really needed, let's encapsulate the field used in the thermal zone device structure, so we can move forward relocating the thermal zone device structure definition in the thermal framework private headers.
Some drivers are accessing tz->device, that implies they need to have the knowledge of the thermal_zone_device structure but we want to self-encapsulate this structure and reduce the scope of the structure to the thermal core only.
By adding this wrapper, these drivers won't need the thermal zone device structure definition and are no longer an obstacle to its relocation to the private thermal core headers.
--- drivers/thermal/thermal_core.c | 6 ++++++ include/linux/thermal.h | 1 + 2 files changed, 7 insertions(+)
drivers/thermal/thermal_core.c +6 -0
@@ -1398,6 +1398,12 @@ int thermal_zone_device_id(struct thermal_zone_device *tzd) }EXPORT_SYMBOL_GPL (thermal_zone_device_id); +struct device *thermal_zone_device (struct thermal_zone_device *tzd) +{ +return &tzd->device; +} +EXPORT_SYMBOL_GPL (thermal_zone_device); +/** * thermal_zone_device_unregister - removes the registered thermal zone device * @tz: the thermal zone device to remove
include/linux/thermal.h +1 -0
@@ -313,6 +313,7 @@ thermal_zone_device_register_with_trips(const char *, struct thermal_trip *, intvoid *thermal_zone_device_priv (struct thermal_zone_device *tzd);const char *thermal_zone_device_type (struct thermal_zone_device *tzd);int thermal_zone_device_id (struct thermal_zone_device *tzd); +struct device *thermal_zone_device (struct thermal_zone_device *tzd); int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int, struct thermal_cooling_device *,
Signature · 1 line
2.34.1
PATCH v4 2/6 thermal/drivers/intel_pch_thermal: Use thermal driver device to write a trace
In reply to Daniel LezcanoThe pch_critical() callback accesses the thermal zone device structure internals, it dereferences the thermal zone struct device and the 'type'.
Use the available accessors instead of accessing the structure directly.
--- drivers/thermal/intel/intel_pch_thermal.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/thermal/intel/intel_pch_thermal.c +2 -1
@@ -127,7 +127,8 @@ static int pch_thermal_get_temp(struct thermal_zone_device *tzd, int *temp)static void pch_critical (struct thermal_zone_device *tzd) { -dev_dbg (&tzd->device,"%s: critical temperature reached\n" , tzd->type); +dev_dbg (thermal_zone_device (tzd),"%s: critical temperature reached\n" , +thermal_zone_device_type (tzd)); }static struct thermal_zone_device_ops tzd_ops = {
Signature · 1 line
2.34.1
PATCH v4 3/6 thermal/drivers/acpi: Use thermal_zone_device()
In reply to Daniel LezcanoIn order to get the device associated with the thermal zone, let's use the wrapper thermal_zone_device() instead of accessing directly the content of the thermal zone device structure.
--- drivers/acpi/thermal.c | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-)
drivers/acpi/thermal.c +9 -4
@@ -789,6 +789,7 @@ static struct thermal_zone_device_ops acpi_thermal_zone_ops = {static int acpi_thermal_register_thermal_zone (struct acpi_thermal *tz) { +struct device *tzdev;int trips =0 ;int result;acpi_status status;
@@ -820,12 +821,14 @@ static int acpi_thermal_register_thermal_zone(struct acpi_thermal *tz)if (IS_ERR (tz->thermal_zone))return -ENODEV ; + tzdev =thermal_zone_device (tz->thermal_zone); + result =sysfs_create_link (&tz->device->dev.kobj, - &tz->thermal_zone->device.kobj,"thermal_zone" ); + &tzdev->kobj,"thermal_zone" );if (result) goto unregister_tzd; - result =sysfs_create_link (&tz->thermal_zone->device.kobj, + result =sysfs_create_link (&tzdev->kobj, &tz->device->dev.kobj,"device" );if (result) goto remove_tz_link;
@@ -849,7 +852,7 @@ static int acpi_thermal_register_thermal_zone(struct acpi_thermal *tz) acpi_bus_detach:acpi_bus_detach_private_data (tz->device->handle); remove_dev_link: -sysfs_remove_link (&tz->thermal_zone->device.kobj,"device" ); +sysfs_remove_link (&tzdev->kobj,"device" ); remove_tz_link:sysfs_remove_link (&tz->device->dev.kobj,"thermal_zone" ); unregister_tzd:
@@ -860,8 +863,10 @@ static int acpi_thermal_register_thermal_zone(struct acpi_thermal *tz)static void acpi_thermal_unregister_thermal_zone (struct acpi_thermal *tz) { +struct device *tzdev =thermal_zone_device (tz->thermal_zone); +sysfs_remove_link (&tz->device->dev.kobj,"thermal_zone" ); -sysfs_remove_link (&tz->thermal_zone->device.kobj,"device" ); +sysfs_remove_link (&tzdev->kobj,"device" );thermal_zone_device_unregister (tz->thermal_zone); tz->thermal_zone =NULL ;acpi_bus_detach_private_data (tz->device->handle);
Signature · 1 line
2.34.1
PATCH v4 4/6 thermal/drivers/menlow: Use thermal_zone_device()
In reply to Daniel LezcanoIn order to get the device associated with the thermal zone, let's use the wrapper thermal_zone_device() instead of accessing directly the content of the thermal zone device structure.
--- drivers/thermal/intel/intel_menlow.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
drivers/thermal/intel/intel_menlow.c +6 -3
@@ -422,7 +422,8 @@ static acpi_status intel_menlow_register_sensor(acpi_handle handle, u32 lvl, result =intel_menlow_add_one_attribute ("aux0" ,0644 , aux0_show, aux0_store, - &thermal->device, handle); +thermal_zone_device (thermal), + handle);if (result)return AE_ERROR ;
@@ -436,7 +437,8 @@ static acpi_status intel_menlow_register_sensor(acpi_handle handle, u32 lvl, result =intel_menlow_add_one_attribute ("aux1" ,0644 , aux1_show, aux1_store, - &thermal->device, handle); +thermal_zone_device (thermal), + handle);if (result) {intel_menlow_unregister_sensor ();return AE_ERROR ;
@@ -449,7 +451,8 @@ static acpi_status intel_menlow_register_sensor(acpi_handle handle, u32 lvl, result =intel_menlow_add_one_attribute ("bios_enabled" ,0444 , bios_enabled_show,NULL , - &thermal->device, handle); +thermal_zone_device (thermal), + handle);if (result) {intel_menlow_unregister_sensor ();return AE_ERROR ;
Signature · 1 line
2.34.1
PATCH v4 5/6 thermal/drivers/acpi: Move to dedicated function sysfs extra attr creation
In reply to Daniel LezcanoThe ACPI thermal driver creates extra sysfs attributes in its own directory pointing to the thermal zone it is related to and add a pointer to the sysfs ACPI thermal device from the thermal zone sysfs entry.
This is very specific to this ACPI thermal driver, let's encapsulate the related creation/deletion code to group it inside a function we can identify later for removal if needed.
--- drivers/acpi/thermal.c | 52 ++++++++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 20 deletions(-)
drivers/acpi/thermal.c +32 -20
@@ -787,9 +787,34 @@ static struct thermal_zone_device_ops acpi_thermal_zone_ops = { .critical = acpi_thermal_zone_device_critical, }; +static int acpi_thermal_zone_sysfs_add (struct acpi_thermal *tz) +{ +struct device *tzdev =thermal_zone_device (tz->thermal_zone); +int ret; + + ret =sysfs_create_link (&tz->device->dev.kobj, + &tzdev->kobj,"thermal_zone" ); +if (ret) +return ret; + + ret =sysfs_create_link (&tzdev->kobj, + &tz->device->dev.kobj,"device" ); +if (ret) +sysfs_remove_link (&tz->device->dev.kobj,"thermal_zone" ); + +return ret; +} + +static void acpi_thermal_zone_sysfs_remove (struct acpi_thermal *tz) +{ +struct device *tzdev =thermal_zone_device (tz->thermal_zone); + +sysfs_remove_link (&tz->device->dev.kobj,"thermal_zone" ); +sysfs_remove_link (&tzdev->kobj,"device" ); +} +static int acpi_thermal_register_thermal_zone (struct acpi_thermal *tz) { -struct device *tzdev;int trips =0 ;int result;acpi_status status;
@@ -821,23 +846,15 @@ static int acpi_thermal_register_thermal_zone(struct acpi_thermal *tz)if (IS_ERR (tz->thermal_zone))return -ENODEV ; - tzdev =thermal_zone_device (tz->thermal_zone); - - result =sysfs_create_link (&tz->device->dev.kobj, - &tzdev->kobj,"thermal_zone" ); + result =acpi_thermal_zone_sysfs_add (tz);if (result) goto unregister_tzd; - - result =sysfs_create_link (&tzdev->kobj, - &tz->device->dev.kobj,"device" ); -if (result) - goto remove_tz_link; - + status =acpi_bus_attach_private_data (tz->device->handle, tz->thermal_zone);if (ACPI_FAILURE (status)) { result = -ENODEV ; - goto remove_dev_link; + goto remove_links; } result =thermal_zone_device_enable (tz->thermal_zone);
@@ -851,10 +868,8 @@ static int acpi_thermal_register_thermal_zone(struct acpi_thermal *tz) acpi_bus_detach:acpi_bus_detach_private_data (tz->device->handle); -remove_dev_link: -sysfs_remove_link (&tzdev->kobj,"device" ); -remove_tz_link: -sysfs_remove_link (&tz->device->dev.kobj,"thermal_zone" ); +remove_links: +acpi_thermal_zone_sysfs_remove (tz); unregister_tzd:thermal_zone_device_unregister (tz->thermal_zone);
@@ -863,10 +878,7 @@ static int acpi_thermal_register_thermal_zone(struct acpi_thermal *tz)static void acpi_thermal_unregister_thermal_zone (struct acpi_thermal *tz) { -struct device *tzdev =thermal_zone_device (tz->thermal_zone); - -sysfs_remove_link (&tz->device->dev.kobj,"thermal_zone" ); -sysfs_remove_link (&tzdev->kobj,"device" ); +acpi_thermal_zone_sysfs_remove (tz);thermal_zone_device_unregister (tz->thermal_zone); tz->thermal_zone =NULL ;acpi_bus_detach_private_data (tz->device->handle);
Signature · 1 line
2.34.1
PATCH v4 6/6 thermal/drivers/intel_menlow: Make additionnal sysfs information optional
In reply to Daniel LezcanoThe Menlon thermal driver creates auxiliary trip points in the thermal zone sysfs directory. It is specific to Menlon. Actually these trip points could be generalized with the generic trip points in the future.
Let's make the code optional and disable it by default so we have a consistency with the attributes in the thermal zone sysfs directories. If that hurts we will enable by default this option instead of disabling it.
--- drivers/thermal/intel/Kconfig | 11 +++++++++++ drivers/thermal/intel/intel_menlow.c | 9 +++++++++ 2 files changed, 20 insertions(+)
drivers/thermal/intel/Kconfig +11 -0
@@ -112,6 +112,17 @@ config INTEL_MENLOW If unsure, say N. +config INTEL_MENLOW_SYSFS_ADDON + bool "Enable extra sysfs attributes in the thermal zone" + depends on INTEL_MENLOW + def_bool n + help + Create auxiliary trip points in the thermal zone sysfs + directory. This is specific to this driver. By default those + are disabled and are candidate for removal, if you need these + information anyway, enable the option or upgrade the + userspace program using them. + config INTEL_HFI_THERMAL bool "Intel Hardware Feedback Interface" depends on NET
drivers/thermal/intel/intel_menlow.c +9 -0
@@ -367,6 +367,7 @@ static ssize_t bios_enabled_show(struct device *dev,return sprintf (buf,"%s\n" , bios_enabled ?"enabled" :"disabled" ); } +#ifdef CONFIG_INTEL_MENLOW_SYSFS_ADDON static int intel_menlow_add_one_attribute (char *name,umode_t mode,void *show,void *store,struct device *dev,acpi_handle handle)
@@ -398,6 +399,14 @@ static int intel_menlow_add_one_attribute(char *name, umode_t mode, void *show, return 0; } +#else +static int intel_menlow_add_one_attribute (char *name,umode_t mode,void *show, +void *store,struct device *dev, +acpi_handle handle) +{ +return 0 ; +} +#endif static acpi_status intel_menlow_register_sensor (acpi_handle handle,u32 lvl,void *context,void **rv)
Signature · 1 line
2.34.1
Rafael J. Wysocki
maintainerRe: [PATCH v4 6/6] thermal/drivers/intel_menlow: Make additionnal sysfs information optional
Quoted 51 lines · Daniel Lezcano
The Menlon thermal driver creates auxiliary trip points in the thermal zone sysfs directory. It is specific to Menlon. Actually these trip points could be generalized with the generic trip points in the future.
Let's make the code optional and disable it by default so we have a consistency with the attributes in the thermal zone sysfs directories. If that hurts we will enable by default this option instead of disabling it.
Signed-off-by Daniel Lezcano <[email protected]>--- drivers/thermal/intel/Kconfig | 11 +++++++++++ drivers/thermal/intel/intel_menlow.c | 9 +++++++++ 2 files changed, 20 insertions(+)drivers/thermal/intel/Kconfig +11
-0@@ -112,6 +112,17 @@ config INTEL_MENLOW If unsure, say N. +config INTEL_MENLOW_SYSFS_ADDON + bool "Enable extra sysfs attributes in the thermal zone" + depends on INTEL_MENLOW + def_bool n + help + Create auxiliary trip points in the thermal zone sysfs + directory. This is specific to this driver. By default those + are disabled and are candidate for removal, if you need these + information anyway, enable the option or upgrade the + userspace program using them. + config INTEL_HFI_THERMAL bool "Intel Hardware Feedback Interface" depends on NETdrivers/thermal/intel/intel_menlow.c +1
-0@@ -367,6 +367,7 @@ static ssize_t bios_enabled_show(struct device *dev,return sprintf (buf,"%s\n" , bios_enabled ?"enabled" :"disabled" ); } +#ifdef CONFIG_INTEL_MENLOW_SYSFS_ADDON static int intel_menlow_add_one_attribute (char *name,umode_t mode,void *show,void *store,struct device *dev,acpi_handle handle)
drivers/thermal/intel/intel_menlow.c static int intel_menlow_add_one_attribute(char *name, umode_t mode, void *show, · line 408
Quoted 10 lines
drivers/thermal/intel/intel_menlow.c +7
-0@@ -398,6 +399,14 @@ static int intel_menlow_add_one_attribute(char *name, umode_t mode, void *show, return 0; } +#else +static int intel_menlow_add_one_attribute (char *name,umode_t mode,void *show, +void *store,struct device *dev, +acpi_handle handle) +{ +return 0 ; +}
After looking at it once more, I think that this driver isn't really functional without the additional sysfs attributes, so if CONFIG_INTEL_MENLOW_SYSFS_ADDON is set, the driver effectively becomes dead code.
That's rather unfortunate and I'm not sure how to deal with it ATM.
I can queue up the rest of the series for 6.4-rc1 (in which case it will be pushed in the second half of the merge window), but this particular patch requires more thought IMV.
Quoted 5 lines
drivers/thermal/intel/intel_menlow.c +1
-1+#endif static acpi_status intel_menlow_register_sensor (acpi_handle handle,u32 lvl,void *context,void **rv) --
Re: [PATCH v4 6/6] thermal/drivers/intel_menlow: Make additionnal sysfs information optional
On 20/04/2023 19:24, Rafael J. Wysocki wrote:
[ ... ]
Quoted 10 lines
After looking at it once more, I think that this driver isn't really functional without the additional sysfs attributes, so if
CONFIG_INTEL_MENLOW_SYSFS_ADDONis set, the driver effectively becomes dead code.That's rather unfortunate and I'm not sure how to deal with it ATM.
I can queue up the rest of the series for 6.4-rc1 (in which case it will be pushed in the second half of the merge window), but this particular patch requires more thought IMV.
I'm fine if you drop this one from the series.
Thanks for looking at it more deeply
Signature · 5 lines
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs Follow Linaro: <http://www.facebook.com/pages/Linaro> Facebook | <http://twitter.com/#!/linaroorg> Twitter | <http://www.linaro.org/linaro-blog/> Blog
Rafael J. Wysocki
maintainerRe: [PATCH v4 6/6] thermal/drivers/intel_menlow: Make additionnal sysfs information optional
Quoted 12 lines · Daniel Lezcano
On 20/04/2023 19:24, Rafael J. Wysocki wrote:
[ ... ]
Quoted 7 lines
After looking at it once more, I think that this driver isn't really functional without the additional sysfs attributes, so if
CONFIG_INTEL_MENLOW_SYSFS_ADDONis set, the driver effectively becomes dead code.That's rather unfortunate and I'm not sure how to deal with it ATM.
Quoted 7 lines
Quoted 3 lines
I can queue up the rest of the series for 6.4-rc1 (in which case it will be pushed in the second half of the merge window), but this particular patch requires more thought IMV.
I'm fine if you drop this one from the series.
Thanks for looking at it more deeply
No problem.
After some private conversation with Srinivas regarding this driver, I've just posted a patch to get rid of it entirely and so I'm going to skip all of the patches touching the Menlow driver in this series.
Rafael J. Wysocki
maintainerQuoted 62 lines · Daniel Lezcano
The thermal zone device structure is defined in the exported thermal header
include/linux/thermal.hGiven the definition being public, the structure is exposed to the external components other than the thermal framework core code. It results the drivers are tampering the structure internals like taking the lock or changing the field values.
Obviously that is bad for several reasons as the drivers can hook the thermal framework behavior and makes very difficult the changes in the core code as external components depend on it directly.
Moreover, the thermal trip points being reworked, we don't want the drivers to access the trips array directly in the thermal zone structure and doing assumptions on how they are organized.
This series provides a second set of changes moving to the thermal zone device structure self-encapsulation.
The ACPI and the Menlon drivers are using the thermal zone's device fields to create symlinks and new attributes in the sysfs thermal zone directory. These changes provide a hopefully temporary wrapper to access it in order to allow moving forward in the thermal zone device self-encapsulation and a
Kconfigoption to disable by default such a extra sysfs information.Changelog:
v4:
- Encapsulate extra sysfs information inside a function for ACPI but remove theKconfigoption
- Encapsulate extra sysfs information inside a function, create the stubs and put that conditionnal to aKconfigoption for Menlow
v3:
- Split theKconfigoption to be driver related when disabling the specific attributes
- Use the thermal zone's device wrapper to write a trace in the pch intel driver
v2:
- Add theKconfigoption to remove specific attributes
- Add athermal_zone_device()wrapper to accesstz->deviceDaniel Lezcano (6):
thermal/core: Encapsulatetz->devicefield thermal/drivers/intel_pch_thermal: Use thermal driver device to write
a trace
thermal/drivers/acpi: Usethermal_zone_device()thermal/drivers/menlow: Usethermal_zone_device()thermal/drivers/acpi: Move to dedicated function sysfs extra attr
creation
thermal/drivers/intel_menlow: Make additionnal sysfs information
optionaldrivers/acpi/thermal.c | 47 +++++++++++++++-------- drivers/thermal/intel/Kconfig | 11 ++++++ drivers/thermal/intel/intel_menlow.c | 18 +++++++-- drivers/thermal/intel/intel_pch_thermal.c | 3 +- drivers/thermal/thermal_core.c | 6 +++ include/linux/thermal.h | 1 + 6 files changed, 67 insertions(+), 19 deletions(-)
Quoted 1 line
--
Patches [4/6] and [6/6] were superseded by the Menlow driver removal.
I've applied the rest as 6.4-rc material, with some subject adjustments and after removing some trailing white space in a few places.
Thanks!
Quoted 29 lines · Rafael J. Wysocki
Quoted 27 lines · Daniel Lezcano
The thermal zone device structure is defined in the exported thermal header
include/linux/thermal.hGiven the definition being public, the structure is exposed to the external components other than the thermal framework core code. It results the drivers are tampering the structure internals like taking the lock or changing the field values.
Obviously that is bad for several reasons as the drivers can hook the thermal framework behavior and makes very difficult the changes in the core code as external components depend on it directly.
Moreover, the thermal trip points being reworked, we don't want the drivers to access the trips array directly in the thermal zone structure and doing assumptions on how they are organized.
This series provides a second set of changes moving to the thermal zone device structure self-encapsulation.
The ACPI and the Menlon drivers are using the thermal zone's device fields to create symlinks and new attributes in the sysfs thermal zone directory. These changes provide a hopefully temporary wrapper to access it in order to allow moving forward in the thermal zone device self-encapsulation and a
Kconfigoption to disable by default such a extra sysfs information.
[ ... ]
Quoted 5 lines
Patches [4/6] and [6/6] were superseded by the Menlow driver removal.
I've applied the rest as 6.4-rc material, with some subject adjustments and after removing some trailing white space in a few places.
Thanks!
Signature · 5 lines
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs Follow Linaro: <http://www.facebook.com/pages/Linaro> Facebook | <http://twitter.com/#!/linaroorg> Twitter | <http://www.linaro.org/linaro-blog/> Blog