[lm-sensors] [PATCH 4/6] thermal: update the documentation
Zhang Rui
rui.zhang at intel.com
Mon Apr 21 10:07:10 CEST 2008
On Thu, 2008-04-17 at 04:35 +0800, Jean Delvare wrote:
> On Thu, 10 Apr 2008 16:17:01 +0800, Zhang, Rui wrote:
> >
> > Update the documentation for the thermal driver hwmon sys I/F.
> >
> > Change the ACPI thermal zone type to be consistent with hwmon.
> >
> > Signed-off-by: Zhang Rui <rui.zhang at intel.com>
> > ---
> > Documentation/thermal/sysfs-api.txt | 33
> +++++++++++++++++++++++++++------
> > drivers/acpi/thermal.c | 2 +-
> > 2 files changed, 28 insertions(+), 7 deletions(-)
> >
> > Index: linux-2.6/Documentation/thermal/sysfs-api.txt
> > ===================================================================
> > --- linux-2.6.orig/Documentation/thermal/sysfs-api.txt
> > +++ linux-2.6/Documentation/thermal/sysfs-api.txt
> > @@ -108,10 +108,12 @@ and throttle appropriate devices.
> > RO read only value
> > RW read/write value
> >
> > -All thermal sysfs attributes will be represented
> under /sys/class/thermal
> > +Thermal sysfs attributes will be represented
> under /sys/class/thermal.
> > +Hwmon sysfs I/F extension is also available under /sys/class/hwmon
> > +if hwmon is compiled in or built as a module.
> >
> > Thermal zone device sys I/F, created once it's registered:
> > -|thermal_zone[0-*]:
> > +/sys/class/thermal/thermal_zone[0-*]:
> > |-----type: Type of the thermal zone
> > |-----temp: Current temperature
> > |-----mode: Working mode of the thermal
> zone
> > @@ -119,7 +121,7 @@ Thermal zone device sys I/F, created onc
> > |-----trip_point_[0-*]_type: Trip point type
> >
> > Thermal cooling device sys I/F, created once it's registered:
> > -|cooling_device[0-*]:
> > +/sys/class/thermal/cooling_device[0-*]:
> > |-----type : Type of the cooling
> device(processor/fan/...)
> > |-----max_state: Maximum cooling state of the
> cooling device
> > |-----cur_state: Current cooling state of the
> cooling device
> > @@ -130,10 +132,19 @@ They represent the relationship between
> > They are created/removed for each
> > thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device
> successful execution.
> >
> > -|thermal_zone[0-*]
> > +/sys/class/thermal/thermal_zone[0-*]
> > |-----cdev[0-*]: The [0-*]th cooling device in
> the current thermal zone
> > |-----cdev[0-*]_trip_point: Trip point that cdev[0-*] is
> associated with
> >
> > +Besides the thermal zone device sysfs I/F and cooling device sysfs
> I/F,
> > +the generic thermal driver also creates a hwmon sysfs I/F for each
> _type_ of
> > +thermal zone device. E.g. the generic thermal driver reigsters one
> hwmon class device
>
> Typo: registers.
>
> > +and build the associated hwmon sys I/F for all the registered ACPI
> thermal zones.
>
> sysfs I/F.
>
> > +/sys/class/hwmon/hwmon[0-*]:
> > + |-----name: The type of the thermal zone
> devices.
> > + |-----temp[1-*]_input: The current temperature of
> thermal zone [1-*].
> > + |-----temp[1-*]_critical: The critical trip point of
> thermal zone [1-*].
> > +Please read Documentation/hwmon/sysfs-interface for additional
> information.
> >
> > ***************************
> > * Thermal zone attributes *
> > @@ -141,7 +152,10 @@ thermal_zone_bind_cooling_device/thermal
> >
> > type Strings which represent the thermal
> zone type.
> > This is given by thermal zone driver
> as part of registration.
> > - Eg: "ACPI thermal zone" indicates it's
> a ACPI thermal device
> > + Eg: "acpitz" indicates it's an ACPI
> thermal device.
> > + In order to keep it consistent with
> hwmon sys attribute,
> > + this should be a short, lowercase
> string,
> > + not containing spaces nor dashes.
> > RO
> > Required
> >
> > @@ -218,7 +232,7 @@ the sys I/F structure will be built like
> > /sys/class/thermal:
> >
> > |thermal_zone1:
> > - |-----type: ACPI thermal zone
> > + |-----type: acpitz
> > |-----temp: 37000
> > |-----mode: kernel
> > |-----trip_point_0_temp: 100000
> > @@ -243,3 +257,10 @@ the sys I/F structure will be built like
> > |-----type: Fan
> > |-----max_state: 2
> > |-----cur_state: 0
> > +
> > +/sys/class/hwmon:
> > +
> > +|hwmon0:
> > + |-----name: acpitz
> > + |-----temp1_input: 37000
> > + |-----temp1_crit: 100000
> > Index: linux-2.6/drivers/acpi/thermal.c
> > ===================================================================
> > --- linux-2.6.orig/drivers/acpi/thermal.c
> > +++ linux-2.6/drivers/acpi/thermal.c
> > @@ -1136,7 +1136,7 @@ static int acpi_thermal_register_thermal
> >
> > for (i = 0; i < ACPI_THERMAL_MAX_ACTIVE &&
> > tz->trips.active[i].flags.valid; i++, trips
> ++);
> > - tz->thermal_zone = thermal_zone_device_register("ACPI thermal
> zone",
> > + tz->thermal_zone = thermal_zone_device_register("acpitz",
> > trips, tz,
> &acpi_thermal_zone_ops);
> > if (!tz->thermal_zone)
> > return -ENODEV;
> >
> >
>
> Other than these details, the patch looks OK to me.
>
Update the documentation for the thermal driver hwmon sys I/F.
Change the ACPI thermal zone type to be consistent with hwmon.
Signed-off-by: Zhang Rui <rui.zhang at intel.com>
---
Documentation/thermal/sysfs-api.txt | 33
+++++++++++++++++++++++++++------
drivers/acpi/thermal.c | 2 +-
2 files changed, 28 insertions(+), 7 deletions(-)
Index: old-git/Documentation/thermal/sysfs-api.txt
===================================================================
--- old-git.orig/Documentation/thermal/sysfs-api.txt 2008-04-21
15:16:05.000000000 +0800
+++ old-git/Documentation/thermal/sysfs-api.txt 2008-04-21
15:20:59.000000000 +0800
@@ -108,10 +108,12 @@
RO read only value
RW read/write value
-All thermal sysfs attributes will be represented
under /sys/class/thermal
+Thermal sysfs attributes will be represented under /sys/class/thermal.
+Hwmon sysfs I/F extension is also available under /sys/class/hwmon
+if hwmon is compiled in or built as a module.
Thermal zone device sys I/F, created once it's registered:
-|thermal_zone[0-*]:
+/sys/class/thermal/thermal_zone[0-*]:
|-----type: Type of the thermal zone
|-----temp: Current temperature
|-----mode: Working mode of the thermal zone
@@ -119,7 +121,7 @@
|-----trip_point_[0-*]_type: Trip point type
Thermal cooling device sys I/F, created once it's registered:
-|cooling_device[0-*]:
+/sys/class/thermal/cooling_device[0-*]:
|-----type : Type of the cooling device(processor/fan/...)
|-----max_state: Maximum cooling state of the cooling device
|-----cur_state: Current cooling state of the cooling device
@@ -130,10 +132,19 @@
They are created/removed for each
thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device
successful execution.
-|thermal_zone[0-*]
+/sys/class/thermal/thermal_zone[0-*]
|-----cdev[0-*]: The [0-*]th cooling device in the current thermal
zone
|-----cdev[0-*]_trip_point: Trip point that cdev[0-*] is associated
with
+Besides the thermal zone device sysfs I/F and cooling device sysfs I/F,
+the generic thermal driver also creates a hwmon sysfs I/F for each
_type_ of
+thermal zone device. E.g. the generic thermal driver registers one
hwmon class device
+and build the associated hwmon sysfs I/F for all the registered ACPI
thermal zones.
+/sys/class/hwmon/hwmon[0-*]:
+ |-----name: The type of the thermal zone devices.
+ |-----temp[1-*]_input: The current temperature of thermal zone [1-*].
+ |-----temp[1-*]_critical: The critical trip point of thermal zone
[1-*].
+Please read Documentation/hwmon/sysfs-interface for additional
information.
***************************
* Thermal zone attributes *
@@ -141,7 +152,10 @@
type Strings which represent the thermal zone type.
This is given by thermal zone driver as part of registration.
- Eg: "ACPI thermal zone" indicates it's a ACPI thermal device
+ Eg: "acpitz" indicates it's an ACPI thermal device.
+ In order to keep it consistent with hwmon sys attribute,
+ this should be a short, lowercase string,
+ not containing spaces nor dashes.
RO
Required
@@ -218,7 +232,7 @@
/sys/class/thermal:
|thermal_zone1:
- |-----type: ACPI thermal zone
+ |-----type: acpitz
|-----temp: 37000
|-----mode: kernel
|-----trip_point_0_temp: 100000
@@ -243,3 +257,10 @@
|-----type: Fan
|-----max_state: 2
|-----cur_state: 0
+
+/sys/class/hwmon:
+
+|hwmon0:
+ |-----name: acpitz
+ |-----temp1_input: 37000
+ |-----temp1_crit: 100000
Index: old-git/drivers/acpi/thermal.c
===================================================================
--- old-git.orig/drivers/acpi/thermal.c 2008-04-21 15:16:05.000000000
+0800
+++ old-git/drivers/acpi/thermal.c 2008-04-21 15:20:14.000000000 +0800
@@ -1136,7 +1136,7 @@
for (i = 0; i < ACPI_THERMAL_MAX_ACTIVE &&
tz->trips.active[i].flags.valid; i++, trips++);
- tz->thermal_zone = thermal_zone_device_register("ACPI thermal zone",
+ tz->thermal_zone = thermal_zone_device_register("acpitz",
trips, tz, &acpi_thermal_zone_ops);
if (!tz->thermal_zone)
return -ENODEV;
More information about the lm-sensors
mailing list