Blame view
Documentation/thermal/sysfs-api.txt
11.1 KB
203d3d4aa the generic therm... |
1 |
Generic Thermal Sysfs driver How To |
38bb0849a thermal: sysfs-ap... |
2 |
=================================== |
203d3d4aa the generic therm... |
3 4 5 6 7 8 9 10 11 |
Written by Sujith Thomas <sujith.thomas@intel.com>, Zhang Rui <rui.zhang@intel.com> Updated: 2 January 2008 Copyright (c) 2008 Intel Corporation 0. Introduction |
38bb0849a thermal: sysfs-ap... |
12 13 14 |
The generic thermal sysfs provides a set of interfaces for thermal zone devices (sensors) and thermal cooling devices (fan, processor...) to register with the thermal management solution and to be a part of it. |
203d3d4aa the generic therm... |
15 |
|
38bb0849a thermal: sysfs-ap... |
16 17 18 19 |
This how-to focuses on enabling new thermal zone and cooling devices to participate in thermal management. This solution is platform independent and any type of thermal zone devices and cooling devices should be able to make use of the infrastructure. |
203d3d4aa the generic therm... |
20 |
|
38bb0849a thermal: sysfs-ap... |
21 22 23 24 25 |
The main task of the thermal sysfs driver is to expose thermal zone attributes as well as cooling device attributes to the user space. An intelligent thermal management application can make decisions based on inputs from thermal zone attributes (the current temperature and trip point temperature) and throttle appropriate devices. |
203d3d4aa the generic therm... |
26 27 28 29 30 31 32 |
[0-*] denotes any positive number starting from 0 [1-*] denotes any positive number starting from 1 1. thermal sysfs driver interface functions 1.1 thermal zone device interface |
38bb0849a thermal: sysfs-ap... |
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
1.1.1 struct thermal_zone_device *thermal_zone_device_register(char *name, int trips, void *devdata, struct thermal_zone_device_ops *ops) This interface function adds a new thermal zone device (sensor) to /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the thermal cooling devices registered at the same time. name: the thermal zone name. trips: the total number of trip points this thermal zone supports. devdata: device private data ops: thermal zone device call-backs. .bind: bind 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_mode: get the current mode (user/kernel) of the thermal zone. - "kernel" means thermal management is done in kernel. - "user" will prevent kernel thermal driver actions upon trip points so that user applications can take charge of thermal management. .set_mode: set the mode (user/kernel) of the thermal zone. .get_trip_type: get the type of certain trip point. .get_trip_temp: get the temperature above which the certain trip point will be fired. |
203d3d4aa the generic therm... |
55 56 |
1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz) |
38bb0849a thermal: sysfs-ap... |
57 58 59 |
This interface function removes the thermal zone device. It deletes the corresponding entry form /sys/class/thermal folder and unbind all the thermal cooling devices it uses. |
203d3d4aa the generic therm... |
60 61 62 |
1.2 thermal cooling device interface 1.2.1 struct thermal_cooling_device *thermal_cooling_device_register(char *name, |
38bb0849a thermal: sysfs-ap... |
63 64 65 66 67 68 69 70 71 72 73 |
void *devdata, struct thermal_cooling_device_ops *) This interface function adds a new thermal cooling device (fan/processor/...) to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself to all the thermal zone devices register at the same time. name: the cooling device name. devdata: device private data. ops: thermal cooling devices call-backs. .get_max_state: get the Maximum 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. |
203d3d4aa the generic therm... |
74 75 |
1.2.2 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev) |
38bb0849a thermal: sysfs-ap... |
76 77 78 |
This interface function remove the thermal cooling device. It deletes the corresponding entry form /sys/class/thermal folder and unbind itself from all the thermal zone devices using it. |
203d3d4aa the generic therm... |
79 80 81 |
1.3 interface for binding a thermal zone device with a thermal cooling device 1.3.1 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz, |
38bb0849a thermal: sysfs-ap... |
82 |
int trip, struct thermal_cooling_device *cdev); |
203d3d4aa the generic therm... |
83 |
|
38bb0849a thermal: sysfs-ap... |
84 85 86 87 88 89 90 |
This interface function bind a thermal cooling device to the certain trip point of a thermal zone device. This function is usually called in the thermal zone device .bind callback. tz: the thermal zone device cdev: thermal cooling device trip: indicates which trip point the cooling devices is associated with in this thermal zone. |
203d3d4aa the generic therm... |
91 92 |
1.3.2 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz, |
38bb0849a thermal: sysfs-ap... |
93 |
int trip, struct thermal_cooling_device *cdev); |
203d3d4aa the generic therm... |
94 |
|
38bb0849a thermal: sysfs-ap... |
95 96 97 98 99 100 101 |
This interface function unbind a thermal cooling device from the certain trip point of a thermal zone device. This function is usually called in the thermal zone device .unbind callback. tz: the thermal zone device cdev: thermal cooling device trip: indicates which trip point the cooling devices is associated with in this thermal zone. |
203d3d4aa the generic therm... |
102 103 104 105 106 |
2. sysfs attributes structure RO read only value RW read/write value |
e9ae71078 thermal: update t... |
107 108 109 |
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. |
203d3d4aa the generic therm... |
110 111 |
Thermal zone device sys I/F, created once it's registered: |
e9ae71078 thermal: update t... |
112 |
/sys/class/thermal/thermal_zone[0-*]: |
38bb0849a thermal: sysfs-ap... |
113 114 115 116 117 |
|---type: Type of the thermal zone |---temp: Current temperature |---mode: Working mode of the thermal zone |---trip_point_[0-*]_temp: Trip point temperature |---trip_point_[0-*]_type: Trip point type |
203d3d4aa the generic therm... |
118 119 |
Thermal cooling device sys I/F, created once it's registered: |
e9ae71078 thermal: update t... |
120 |
/sys/class/thermal/cooling_device[0-*]: |
38bb0849a thermal: sysfs-ap... |
121 122 123 |
|---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 |
203d3d4aa the generic therm... |
124 |
|
38bb0849a thermal: sysfs-ap... |
125 126 127 128 |
Then next two dynamic attributes are created/removed in pairs. They represent the relationship between a thermal zone and its associated cooling device. They are created/removed for each successful execution of thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device. |
203d3d4aa the generic therm... |
129 |
|
38bb0849a thermal: sysfs-ap... |
130 131 132 |
/sys/class/thermal/thermal_zone[0-*]: |---cdev[0-*]: [0-*]th cooling device in current thermal zone |---cdev[0-*]_trip_point: Trip point that cdev[0-*] is associated with |
203d3d4aa the generic therm... |
133 |
|
e9ae71078 thermal: update t... |
134 |
Besides the thermal zone device sysfs I/F and cooling device sysfs I/F, |
38bb0849a thermal: sysfs-ap... |
135 136 137 138 |
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. |
e9ae71078 thermal: update t... |
139 |
/sys/class/hwmon/hwmon[0-*]: |
38bb0849a thermal: sysfs-ap... |
140 141 142 |
|---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-*] |
e9ae71078 thermal: update t... |
143 |
Please read Documentation/hwmon/sysfs-interface for additional information. |
203d3d4aa the generic therm... |
144 145 146 147 |
*************************** * Thermal zone attributes * *************************** |
38bb0849a thermal: sysfs-ap... |
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
type Strings which represent the thermal zone type. This is given by thermal zone driver as part of registration. E.g: "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 temp Current temperature as reported by thermal zone (sensor). Unit: millidegree Celsius RO, Required mode One of the predefined values in [kernel, user]. This file gives information about the algorithm that is currently managing the thermal zone. It can be either default kernel based algorithm or user space application. kernel = Thermal management in kernel thermal zone driver. user = Preventing kernel thermal zone driver actions upon trip points so that user application can take full charge of the thermal management. RW, Optional trip_point_[0-*]_temp The temperature above which trip point will be fired. Unit: millidegree Celsius RO, Optional trip_point_[0-*]_type Strings which indicate the type of the trip point. E.g. it can be one of critical, hot, passive, active[0-*] for ACPI thermal zone. RO, Optional cdev[0-*] Sysfs link to the thermal cooling device node where the sys I/F for cooling device throttling control represents. RO, Optional 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. RO, Optional |
29226ed3c thermal: sysfs-ap... |
193 194 195 196 197 198 199 200 |
passive Attribute is only present for zones in which the passive cooling policy is not supported by native thermal driver. Default is zero and can be set to a temperature (in millidegrees) to enable a passive trip point for the zone. Activation is done by polling with an interval of 1 second. Unit: millidegrees Celsius |
3d8e3ad87 thermal: add sani... |
201 |
Valid values: 0 (disabled) or greater than 1000 |
29226ed3c thermal: sysfs-ap... |
202 |
RW, Optional |
38bb0849a thermal: sysfs-ap... |
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
***************************** * Cooling device attributes * ***************************** type String which represents the type of device, e.g: - for generic ACPI: should be "Fan", "Processor" or "LCD" - for memory controller device on intel_menlow platform: should be "Memory controller". RO, Required max_state The maximum permissible cooling state of this cooling device. RO, Required cur_state The current cooling state of this cooling device. The value can any integer numbers between 0 and max_state: - cur_state == 0 means no cooling - cur_state == max_state means the maximum cooling. RW, Required |
203d3d4aa the generic therm... |
225 226 |
3. A simple implementation |
38bb0849a thermal: sysfs-ap... |
227 228 229 230 231 232 233 234 235 |
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, 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. 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: |
203d3d4aa the generic therm... |
236 237 238 239 |
/sys/class/thermal: |thermal_zone1: |
38bb0849a thermal: sysfs-ap... |
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
|---type: acpitz |---temp: 37000 |---mode: kernel |---trip_point_0_temp: 100000 |---trip_point_0_type: critical |---trip_point_1_temp: 80000 |---trip_point_1_type: passive |---trip_point_2_temp: 70000 |---trip_point_2_type: active0 |---trip_point_3_temp: 60000 |---trip_point_3_type: active1 |---cdev0: --->/sys/class/thermal/cooling_device0 |---cdev0_trip_point: 1 /* cdev0 can be used for passive */ |---cdev1: --->/sys/class/thermal/cooling_device3 |---cdev1_trip_point: 2 /* cdev1 can be used for active[0]*/ |
203d3d4aa the generic therm... |
255 256 |
|cooling_device0: |
38bb0849a thermal: sysfs-ap... |
257 258 259 |
|---type: Processor |---max_state: 8 |---cur_state: 0 |
203d3d4aa the generic therm... |
260 261 |
|cooling_device3: |
38bb0849a thermal: sysfs-ap... |
262 263 264 |
|---type: Fan |---max_state: 2 |---cur_state: 0 |
e9ae71078 thermal: update t... |
265 266 267 268 |
/sys/class/hwmon: |hwmon0: |
38bb0849a thermal: sysfs-ap... |
269 270 271 |
|---name: acpitz |---temp1_input: 37000 |---temp1_crit: 100000 |
4cb187287 thermal: Add even... |
272 273 274 275 276 277 278 279 280 281 282 283 |
4. Event Notification The framework includes a simple notification mechanism, in the form of a netlink event. Netlink socket initialization is done during the _init_ of the framework. Drivers which intend to use the notification mechanism just need to call generate_netlink_event() with two arguments viz (originator, event). Typically the originator will be an integer assigned to a thermal_zone_device when it registers itself with the framework. The event will be one of:{THERMAL_AUX0, THERMAL_AUX1, THERMAL_CRITICAL, THERMAL_DEV_FAULT}. Notification can be sent when the current temperature crosses any of the configured thresholds. |