OpenE2K
/
linux
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ACPI: thermal: syntax, spelling, kernel-doc 

Reviewed-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Len Brown <len.brown@intel.com>
This commit is contained in:
Len Brown 2008-02-07 16:55:08 -05:00
parent 9f2eef25e0
commit 543a956140
3 changed files with 41 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Documentation/thermal/sysfs-api.txt
View File

@ -14,7 +14,7 @@ The generic thermal sysfs provides a set of interfaces for thermal zone devices
and thermal cooling devices (fan, processor...) to register with the thermal management and thermal cooling devices (fan, processor...) to register with the thermal management
solution and to be a part of it. solution and to be a part of it.
This how-to focusses on enabling new thermal zone and cooling devices to participate This how-to focuses on enabling new thermal zone and cooling devices to participate
in thermal management. in thermal management.
This solution is platform independent and any type of thermal zone devices and This solution is platform independent and any type of thermal zone devices and
cooling devices should be able to make use of the infrastructure. cooling devices should be able to make use of the infrastructure.
@ -41,9 +41,9 @@ and throttle appropriate devices.
name: the thermal zone name. name: the thermal zone name.
trips: the total number of trip points this thermal zone supports. trips: the total number of trip points this thermal zone supports.
devdata: device private data devdata: device private data
ops: thermal zone device callbacks. ops: thermal zone device call-backs.
.bind: bind the thermal zone device with a thermal cooling device. .bind: bind the thermal zone device with a thermal cooling device.
.unbind: unbing the thermal zone device with a thermal cooling device. .unbind: unbind the thermal zone device with a thermal cooling device.
.get_temp: get the current temperature of the thermal zone. .get_temp: get the current temperature of the thermal zone.
.get_mode: get the current mode (user/kernel) of the thermal zone. .get_mode: get the current mode (user/kernel) of the thermal zone.
"kernel" means thermal management is done in kernel. "kernel" means thermal management is done in kernel.
@ -69,7 +69,7 @@ and throttle appropriate devices.
It tries to bind itself to all the thermal zone devices register at the same time. It tries to bind itself to all the thermal zone devices register at the same time.
name: the cooling device name. name: the cooling device name.
devdata: device private data. devdata: device private data.
ops: thermal cooling devices callbacks. ops: thermal cooling devices call-backs.
.get_max_state: get the Maximum throttle state of the cooling device. .get_max_state: get the Maximum throttle state of the cooling device.
.get_cur_state: get the Current throttle state of the cooling device. .get_cur_state: get the Current throttle state of the cooling device.
.set_cur_state: set the Current throttle state of the cooling device. .set_cur_state: set the Current throttle state of the cooling device.
@ -109,7 +109,6 @@ RO read only value
RW read/write value RW read/write value
All thermal sysfs attributes will be represented under /sys/class/thermal All thermal sysfs attributes will be represented under /sys/class/thermal
/sys/class/thermal/
Thermal zone device sys I/F, created once it's registered: Thermal zone device sys I/F, created once it's registered:
|thermal_zone[0-*]: |thermal_zone[0-*]:
@ -129,7 +128,7 @@ Thermal cooling device sys I/F, created once it's registered:
These two dynamic attributes are created/removed in pairs. These two dynamic attributes are created/removed in pairs.
They represent the relationship between a thermal zone and its associated cooling device. They represent the relationship between a thermal zone and its associated cooling device.
They are created/removed for each They are created/removed for each
thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device successful exection. thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device successful execution.
|thermal_zone[0-*] |thermal_zone[0-*]
|-----cdev[0-*]: The [0-*]th cooling device in the current thermal zone |-----cdev[0-*]: The [0-*]th cooling device in the current thermal zone
@ -147,11 +146,11 @@ type Strings which represent the thermal zone type.
Optional Optional
temp Current temperature as reported by thermal zone (sensor) temp Current temperature as reported by thermal zone (sensor)
Unit: degree celsius Unit: degree Celsius
RO RO
Required Required
mode One of the predifned values in [kernel, user] mode One of the predefined values in [kernel, user]
This file gives information about the algorithm This file gives information about the algorithm
that is currently managing the thermal zone. that is currently managing the thermal zone.
It can be either default kernel based algorithm It can be either default kernel based algorithm
@ -164,12 +163,12 @@ mode One of the predifned values in [kernel, user]
charge of the thermal management. charge of the thermal management.
trip_point_[0-*]_temp The temperature above which trip point will be fired trip_point_[0-*]_temp The temperature above which trip point will be fired
Unit: degree celsius Unit: degree Celsius
RO RO
Optional Optional
trip_point_[0-*]_type Strings which indicate the type of the trip point trip_point_[0-*]_type Strings which indicate the type of the trip point
Eg. it can be one of critical, hot, passive, E.g. it can be one of critical, hot, passive,
active[0-*] for ACPI thermal zone. active[0-*] for ACPI thermal zone.
RO RO
Optional Optional
@ -179,7 +178,7 @@ cdev[0-*] Sysfs link to the thermal cooling device node where the sys I/F
RO RO
Optional Optional
cdev[0-*]_trip_point The trip point with which cdev[0-*] is assocated in this thermal zone cdev[0-*]_trip_point The trip point with which cdev[0-*] is associated in this thermal zone
-1 means the cooling device is not associated with any trip point. -1 means the cooling device is not associated with any trip point.
RO RO
Optional Optional
@ -211,7 +210,7 @@ cur_state The current cooling state of this cooling device.
ACPI thermal zone may support multiple trip points like critical/hot/passive/active. ACPI thermal zone may support multiple trip points like critical/hot/passive/active.
If an ACPI thermal zone supports critical, passive, active[0] and active[1] at the same time, If an ACPI thermal zone supports critical, passive, active[0] and active[1] at the same time,
it may register itself as a thermale_zone_device (thermal_zone1) with 4 trip points in all. it may register itself as a thermal_zone_device (thermal_zone1) with 4 trip points in all.
It has one processor and one fan, which are both registered as thermal_cooling_device. It has one processor and one fan, which are both registered as thermal_cooling_device.
If the processor is listed in _PSL method, and the fan is listed in _AL0 method, If the processor is listed in _PSL method, and the fan is listed in _AL0 method,
the sys I/F structure will be built like this: the sys I/F structure will be built like this:

4
drivers/thermal/Kconfig
View File

@ -9,7 +9,7 @@ menuconfig THERMAL
Generic Thermal Sysfs driver offers a generic mechanism for Generic Thermal Sysfs driver offers a generic mechanism for
thermal management. Usually it's made up of one or more thermal thermal management. Usually it's made up of one or more thermal
zone and cooling device. zone and cooling device.
each thermal zone contains its own temperature, trip points, Each thermal zone contains its own temperature, trip points,
cooling devices. cooling devices.
All platforms with ACPI thermal support can use this driver. All platforms with ACPI thermal support can use this driver.
If you want this support, you should say Y here If you want this support, you should say Y here.

39
drivers/thermal/thermal.c
View File

@ -267,7 +267,7 @@ thermal_cooling_device_cur_state_store(struct device *dev,
} }
static struct device_attribute dev_attr_cdev_type = static struct device_attribute dev_attr_cdev_type =
__ATTR(type, 0444, thermal_cooling_device_type_show, NULL); __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
static DEVICE_ATTR(max_state, 0444, static DEVICE_ATTR(max_state, 0444,
thermal_cooling_device_max_state_show, NULL); thermal_cooling_device_max_state_show, NULL);
static DEVICE_ATTR(cur_state, 0644, static DEVICE_ATTR(cur_state, 0644,
@ -293,11 +293,12 @@ thermal_cooling_device_trip_point_show(struct device *dev,
/** /**
* thermal_zone_bind_cooling_device - bind a cooling device to a thermal zone * thermal_zone_bind_cooling_device - bind a cooling device to a thermal zone
* this function is usually called in the thermal zone device .bind callback.
* @tz: thermal zone device * @tz: thermal zone device
* @trip: indicates which trip point the cooling devices is * @trip: indicates which trip point the cooling devices is
* associated with in this thermal zone. * associated with in this thermal zone.
* @cdev: thermal cooling device * @cdev: thermal cooling device
*
* This function is usually called in the thermal zone device .bind callback.
*/ */
int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz, int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
int trip, int trip,
@ -307,8 +308,7 @@ int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
struct thermal_cooling_device_instance *pos; struct thermal_cooling_device_instance *pos;
int result; int result;
if (trip >= tz->trips || if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
(trip < 0 && trip != THERMAL_TRIPS_NONE))
return -EINVAL; return -EINVAL;
if (!tz || !cdev) if (!tz || !cdev)
@ -361,15 +361,17 @@ int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
kfree(dev); kfree(dev);
return result; return result;
} }
EXPORT_SYMBOL(thermal_zone_bind_cooling_device); EXPORT_SYMBOL(thermal_zone_bind_cooling_device);
/** /**
* thermal_zone_unbind_cooling_device - unbind a cooling device from a thermal zone * thermal_zone_unbind_cooling_device - unbind a cooling device from a thermal zone
* this function is usually called in the thermal zone device .unbind callback.
* @tz: thermal zone device * @tz: thermal zone device
* @trip: indicates which trip point the cooling devices is * @trip: indicates which trip point the cooling devices is
* associated with in this thermal zone. * associated with in this thermal zone.
* @cdev: thermal cooling device * @cdev: thermal cooling device
*
* This function is usually called in the thermal zone device .unbind callback.
*/ */
int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz, int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
int trip, int trip,
@ -379,8 +381,7 @@ int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
mutex_lock(&tz->lock); mutex_lock(&tz->lock);
list_for_each_entry_safe(pos, next, &tz->cooling_devices, node) { list_for_each_entry_safe(pos, next, &tz->cooling_devices, node) {
if (pos->tz == tz && pos->trip == trip if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
&& pos->cdev == cdev) {
list_del(&pos->node); list_del(&pos->node);
mutex_unlock(&tz->lock); mutex_unlock(&tz->lock);
goto unbind; goto unbind;
@ -397,6 +398,7 @@ int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
kfree(pos); kfree(pos);
return 0; return 0;
} }
EXPORT_SYMBOL(thermal_zone_unbind_cooling_device); EXPORT_SYMBOL(thermal_zone_unbind_cooling_device);
static void thermal_release(struct device *dev) static void thermal_release(struct device *dev)
@ -425,7 +427,10 @@ static struct class thermal_class = {
* @ops: standard thermal cooling devices callbacks. * @ops: standard thermal cooling devices callbacks.
*/ */
struct thermal_cooling_device *thermal_cooling_device_register(char *type, struct thermal_cooling_device *thermal_cooling_device_register(char *type,
void *devdata, struct thermal_cooling_device_ops *ops) void *devdata,
struct
thermal_cooling_device_ops
*ops)
{ {
struct thermal_cooling_device *cdev; struct thermal_cooling_device *cdev;
struct thermal_zone_device *pos; struct thermal_zone_device *pos;
@ -462,8 +467,7 @@ struct thermal_cooling_device *thermal_cooling_device_register(char *type,
/* sys I/F */ /* sys I/F */
if (type) { if (type) {
result = device_create_file(&cdev->device, result = device_create_file(&cdev->device, &dev_attr_cdev_type);
&dev_attr_cdev_type);
if (result) if (result)
goto unregister; goto unregister;
} }
@ -496,11 +500,11 @@ struct thermal_cooling_device *thermal_cooling_device_register(char *type,
device_unregister(&cdev->device); device_unregister(&cdev->device);
return NULL; return NULL;
} }
EXPORT_SYMBOL(thermal_cooling_device_register); EXPORT_SYMBOL(thermal_cooling_device_register);
/** /**
* thermal_cooling_device_unregister - removes the registered thermal cooling device * thermal_cooling_device_unregister - removes the registered thermal cooling device
*
* @cdev: the thermal cooling device to remove. * @cdev: the thermal cooling device to remove.
* *
* thermal_cooling_device_unregister() must be called when the device is no * thermal_cooling_device_unregister() must be called when the device is no
@ -533,8 +537,7 @@ void thermal_cooling_device_unregister(struct
} }
mutex_unlock(&thermal_list_lock); mutex_unlock(&thermal_list_lock);
if (cdev->type[0]) if (cdev->type[0])
device_remove_file(&cdev->device, device_remove_file(&cdev->device, &dev_attr_cdev_type);
&dev_attr_cdev_type);
device_remove_file(&cdev->device, &dev_attr_max_state); device_remove_file(&cdev->device, &dev_attr_max_state);
device_remove_file(&cdev->device, &dev_attr_cur_state); device_remove_file(&cdev->device, &dev_attr_cur_state);
@ -542,6 +545,7 @@ void thermal_cooling_device_unregister(struct
device_unregister(&cdev->device); device_unregister(&cdev->device);
return; return;
} }
EXPORT_SYMBOL(thermal_cooling_device_unregister); EXPORT_SYMBOL(thermal_cooling_device_unregister);
/** /**
@ -555,8 +559,10 @@ EXPORT_SYMBOL(thermal_cooling_device_unregister);
* longer needed. * longer needed.
*/ */
struct thermal_zone_device *thermal_zone_device_register(char *type, struct thermal_zone_device *thermal_zone_device_register(char *type,
int trips, void *devdata, int trips,
struct thermal_zone_device_ops *ops) void *devdata, struct
thermal_zone_device_ops
*ops)
{ {
struct thermal_zone_device *tz; struct thermal_zone_device *tz;
struct thermal_cooling_device *pos; struct thermal_cooling_device *pos;
@ -639,11 +645,11 @@ struct thermal_zone_device *thermal_zone_device_register(char *type,
device_unregister(&tz->device); device_unregister(&tz->device);
return NULL; return NULL;
} }
EXPORT_SYMBOL(thermal_zone_device_register); EXPORT_SYMBOL(thermal_zone_device_register);
/** /**
* thermal_device_unregister - removes the registered thermal zone device * thermal_device_unregister - removes the registered thermal zone device
*
* @tz: the thermal zone device to remove * @tz: the thermal zone device to remove
*/ */
void thermal_zone_device_unregister(struct thermal_zone_device *tz) void thermal_zone_device_unregister(struct thermal_zone_device *tz)
@ -685,6 +691,7 @@ void thermal_zone_device_unregister(struct thermal_zone_device *tz)
device_unregister(&tz->device); device_unregister(&tz->device);
return; return;
} }
EXPORT_SYMBOL(thermal_zone_device_unregister); EXPORT_SYMBOL(thermal_zone_device_unregister);
static int __init thermal_init(void) static int __init thermal_init(void)