1 What: /sys/class/thermal/thermal_zon 1 What: /sys/class/thermal/thermal_zoneX/type
2 Description: 2 Description:
3 Strings which represent the th 3 Strings which represent the thermal zone type.
4 This is given by thermal zone 4 This is given by thermal zone driver as part of registration.
5 E.g: "acpitz" indicates it's a 5 E.g: "acpitz" indicates it's an ACPI thermal device.
6 In order to keep it consistent 6 In order to keep it consistent with hwmon sys attribute; this
7 should be a short, lowercase s !! 7 shouldbe a short, lowercase string, not containing spaces nor
8 dashes. 8 dashes.
9 9
10 RO, Required 10 RO, Required
11 11
12 What: /sys/class/thermal/thermal_zon 12 What: /sys/class/thermal/thermal_zoneX/temp
13 Description: 13 Description:
14 Current temperature as reporte 14 Current temperature as reported by thermal zone (sensor).
15 15
16 Unit: millidegree Celsius 16 Unit: millidegree Celsius
17 17
18 RO, Required 18 RO, Required
19 19
20 What: /sys/class/thermal/thermal_zon 20 What: /sys/class/thermal/thermal_zoneX/mode
21 Description: 21 Description:
22 One of the predefined values i 22 One of the predefined values in [enabled, disabled].
23 This file gives information ab 23 This file gives information about the algorithm that is
24 currently managing the thermal 24 currently managing the thermal zone. It can be either default
25 kernel based algorithm or user 25 kernel based algorithm or user space application.
26 26
27 enabled 27 enabled
28 enable Kernel 28 enable Kernel Thermal management.
29 disabled 29 disabled
30 Preventing ker 30 Preventing kernel thermal zone driver actions upon
31 trip points so 31 trip points so that user application can take full
32 charge of the 32 charge of the thermal management.
33 33
34 RW, Optional 34 RW, Optional
35 35
36 What: /sys/class/thermal/thermal_zon 36 What: /sys/class/thermal/thermal_zoneX/policy
37 Description: 37 Description:
38 One of the various thermal gov 38 One of the various thermal governors used for a particular zone.
39 39
40 RW, Required 40 RW, Required
41 41
42 What: /sys/class/thermal/thermal_zon 42 What: /sys/class/thermal/thermal_zoneX/available_policies
43 Description: 43 Description:
44 Available thermal governors wh 44 Available thermal governors which can be used for a
45 particular zone. 45 particular zone.
46 46
47 RO, Required 47 RO, Required
48 48
49 What: /sys/class/thermal/thermal_zon 49 What: /sys/class/thermal/thermal_zoneX/trip_point_Y_temp
50 Description: 50 Description:
51 The temperature above which tr 51 The temperature above which trip point will be fired.
52 52
53 Unit: millidegree Celsius 53 Unit: millidegree Celsius
54 54
55 RO, Optional 55 RO, Optional
56 56
57 What: /sys/class/thermal/thermal_zon 57 What: /sys/class/thermal/thermal_zoneX/trip_point_Y_type
58 Description: 58 Description:
59 Strings which indicate the typ 59 Strings which indicate the type of the trip point.
60 60
61 E.g. it can be one of critical 61 E.g. it can be one of critical, hot, passive, `active[0-*]`
62 for ACPI thermal zone. 62 for ACPI thermal zone.
63 63
64 RO, Optional 64 RO, Optional
65 65
66 What: /sys/class/thermal/thermal_zon 66 What: /sys/class/thermal/thermal_zoneX/trip_point_Y_hyst
67 Description: 67 Description:
68 The hysteresis value for a tri 68 The hysteresis value for a trip point, represented as an
69 integer. 69 integer.
70 70
71 Unit: Celsius 71 Unit: Celsius
72 72
73 RW, Optional 73 RW, Optional
74 74
75 What: /sys/class/thermal/thermal_zon 75 What: /sys/class/thermal/thermal_zoneX/cdevY
76 Description: 76 Description:
77 Sysfs link to the thermal cooling devi 77 Sysfs link to the thermal cooling device node where the sys I/F
78 for cooling device throttling control 78 for cooling device throttling control represents.
79 79
80 RO, Optional 80 RO, Optional
81 81
82 What: /sys/class/thermal/thermal_zon 82 What: /sys/class/thermal/thermal_zoneX/cdevY_trip_point
83 Description: 83 Description:
84 The trip point in this thermal 84 The trip point in this thermal zone which `cdev[0-*]` is
85 associated with; -1 means the 85 associated with; -1 means the cooling device is not
86 associated with any trip point 86 associated with any trip point.
87 87
88 RO, Optional 88 RO, Optional
89 89
90 What: /sys/class/thermal/thermal_zon 90 What: /sys/class/thermal/thermal_zoneX/cdevY_weight
91 Description: 91 Description:
92 The influence of `cdev[0-*]` i 92 The influence of `cdev[0-*]` in this thermal zone. This value
93 is relative to the rest of coo 93 is relative to the rest of cooling devices in the thermal
94 zone. For example, if a coolin 94 zone. For example, if a cooling device has a weight double
95 than that of other, it's twice 95 than that of other, it's twice as effective in cooling the
96 thermal zone. 96 thermal zone.
97 97
98 RW, Optional 98 RW, Optional
99 99
100 What: /sys/class/thermal/thermal_zon 100 What: /sys/class/thermal/thermal_zoneX/emul_temp
101 Description: 101 Description:
102 Interface to set the emulated 102 Interface to set the emulated temperature method in thermal zone
103 (sensor). After setting this t 103 (sensor). After setting this temperature, the thermal zone may
104 pass this temperature to platf 104 pass this temperature to platform emulation function if
105 registered or cache it locally 105 registered or cache it locally. This is useful in debugging
106 different temperature threshol 106 different temperature threshold and its associated cooling
107 action. This is write only nod 107 action. This is write only node and writing 0 on this node
108 should disable emulation. 108 should disable emulation.
109 109
110 Unit: millidegree Celsius 110 Unit: millidegree Celsius
111 111
112 WO, Optional 112 WO, Optional
113 113
114 WARNING: 114 WARNING:
115 Be careful while enabling 115 Be careful while enabling this option on production systems,
116 because userland can easil 116 because userland can easily disable the thermal policy by simply
117 flooding this sysfs node w 117 flooding this sysfs node with low temperature values.
118 118
119 119
120 What: /sys/class/thermal/thermal_zon 120 What: /sys/class/thermal/thermal_zoneX/k_d
121 Description: 121 Description:
122 The derivative term of the pow 122 The derivative term of the power allocator governor's PID
123 controller. For more informati 123 controller. For more information see
124 Documentation/driver-api/therm 124 Documentation/driver-api/thermal/power_allocator.rst
125 125
126 RW, Optional 126 RW, Optional
127 127
128 What: /sys/class/thermal/thermal_zon 128 What: /sys/class/thermal/thermal_zoneX/k_i
129 Description: 129 Description:
130 The integral term of the power 130 The integral term of the power allocator governor's PID
131 controller. This term allows t 131 controller. This term allows the PID controller to compensate
132 for long term drift. For more 132 for long term drift. For more information see
133 Documentation/driver-api/therm 133 Documentation/driver-api/thermal/power_allocator.rst
134 134
135 RW, Optional 135 RW, Optional
136 136
137 What: /sys/class/thermal/thermal_zon 137 What: /sys/class/thermal/thermal_zoneX/k_po
138 Description: 138 Description:
139 The proportional term of the p 139 The proportional term of the power allocator governor's PID
140 controller during temperature 140 controller during temperature overshoot. Temperature overshoot
141 is when the current temperatur 141 is when the current temperature is above the "desired
142 temperature" trip point. For m 142 temperature" trip point. For more information see
143 Documentation/driver-api/therm 143 Documentation/driver-api/thermal/power_allocator.rst
144 144
145 RW, Optional 145 RW, Optional
146 146
147 What: /sys/class/thermal/thermal_zon 147 What: /sys/class/thermal/thermal_zoneX/k_pu
148 Description: 148 Description:
149 The proportional term of the p 149 The proportional term of the power allocator governor's PID
150 controller during temperature 150 controller during temperature undershoot. Temperature undershoot
151 is when the current temperatur 151 is when the current temperature is below the "desired
152 temperature" trip point. For m 152 temperature" trip point. For more information see
153 Documentation/driver-api/therm 153 Documentation/driver-api/thermal/power_allocator.rst
154 154
155 RW, Optional 155 RW, Optional
156 156
157 What: /sys/class/thermal/thermal_zon 157 What: /sys/class/thermal/thermal_zoneX/integral_cutoff
158 Description: 158 Description:
159 Temperature offset from the de 159 Temperature offset from the desired temperature trip point
160 above which the integral term 160 above which the integral term of the power allocator
161 governor's PID controller star 161 governor's PID controller starts accumulating errors. For
162 example, if integral_cutoff is 162 example, if integral_cutoff is 0, then the integral term only
163 accumulates error when tempera 163 accumulates error when temperature is above the desired
164 temperature trip point. For mo 164 temperature trip point. For more information see
165 Documentation/driver-api/therm 165 Documentation/driver-api/thermal/power_allocator.rst
166 166
167 Unit: millidegree Celsius 167 Unit: millidegree Celsius
168 168
169 RW, Optional 169 RW, Optional
170 170
171 What: /sys/class/thermal/thermal_zon 171 What: /sys/class/thermal/thermal_zoneX/slope
172 Description: 172 Description:
173 The slope constant used in a l 173 The slope constant used in a linear extrapolation model
174 to determine a hotspot tempera 174 to determine a hotspot temperature based off the sensor's
175 raw readings. It is up to the 175 raw readings. It is up to the device driver to determine
176 the usage of these values. 176 the usage of these values.
177 177
178 RW, Optional 178 RW, Optional
179 179
180 What: /sys/class/thermal/thermal_zon 180 What: /sys/class/thermal/thermal_zoneX/offset
181 Description: 181 Description:
182 The offset constant used in a 182 The offset constant used in a linear extrapolation model
183 to determine a hotspot tempera 183 to determine a hotspot temperature based off the sensor's
184 raw readings. It is up to the 184 raw readings. It is up to the device driver to determine
185 the usage of these values. 185 the usage of these values.
186 186
187 RW, Optional 187 RW, Optional
188 188
189 What: /sys/class/thermal/thermal_zon 189 What: /sys/class/thermal/thermal_zoneX/sustainable_power
190 Description: 190 Description:
191 An estimate of the sustained p 191 An estimate of the sustained power that can be dissipated by
192 the thermal zone. Used by the 192 the thermal zone. Used by the power allocator governor. For
193 more information see 193 more information see
194 Documentation/driver-api/therm 194 Documentation/driver-api/thermal/power_allocator.rst
195 195
196 Unit: milliwatts 196 Unit: milliwatts
197 197
198 RW, Optional 198 RW, Optional
199 199
200 What: /sys/class/thermal/cooling_dev 200 What: /sys/class/thermal/cooling_deviceX/type
201 Description: 201 Description:
202 String which represents the ty 202 String which represents the type of device, e.g:
203 203
204 - for generic ACPI: should be 204 - for generic ACPI: should be "Fan", "Processor" or "LCD"
205 - for memory controller device 205 - for memory controller device on intel_menlow platform:
206 should be "Memory controller 206 should be "Memory controller".
207 207
208 RO, Required 208 RO, Required
209 209
210 What: /sys/class/thermal/cooling_dev 210 What: /sys/class/thermal/cooling_deviceX/max_state
211 Description: 211 Description:
212 The maximum permissible coolin 212 The maximum permissible cooling state of this cooling device.
213 213
214 RO, Required 214 RO, Required
215 215
216 What: /sys/class/thermal/cooling_dev 216 What: /sys/class/thermal/cooling_deviceX/cur_state
217 Description: 217 Description:
218 The current cooling state of t 218 The current cooling state of this cooling device.
219 The value can any integer numb 219 The value can any integer numbers between 0 and max_state:
220 220
221 - cur_state == 0 means no cool 221 - cur_state == 0 means no cooling
222 - cur_state == max_state means 222 - cur_state == max_state means the maximum cooling.
223 223
224 RW, Required 224 RW, Required
225 225
226 What: /sys/class/thermal/cooling_dev 226 What: /sys/class/thermal/cooling_deviceX/stats/reset
227 Description: 227 Description:
228 Writing any value resets the c 228 Writing any value resets the cooling device's statistics.
229 229
230 WO, Required 230 WO, Required
231 231
232 What: /sys/class/thermal/cooling_dev 232 What: /sys/class/thermal/cooling_deviceX/stats/time_in_state_ms:
233 Description: 233 Description:
234 The amount of time spent by th 234 The amount of time spent by the cooling device in various
235 cooling states. The output wil 235 cooling states. The output will have "<state> <time>" pair
236 in each line, which will mean 236 in each line, which will mean this cooling device spent <time>
237 msec of time at <state>. 237 msec of time at <state>.
238 238
239 Output will have one line for 239 Output will have one line for each of the supported states.
240 240
241 RO, Required 241 RO, Required
242 242
243 What: /sys/class/thermal/cooling_dev 243 What: /sys/class/thermal/cooling_deviceX/stats/total_trans
244 Description: 244 Description:
245 A single positive value showin 245 A single positive value showing the total number of times
246 the state of a cooling device 246 the state of a cooling device is changed.
247 247
248 RO, Required 248 RO, Required
249 249
250 What: /sys/class/thermal/cooling_dev 250 What: /sys/class/thermal/cooling_deviceX/stats/trans_table
251 Description: 251 Description:
252 This gives fine grained inform 252 This gives fine grained information about all the cooling state
253 transitions. The cat output he 253 transitions. The cat output here is a two dimensional matrix,
254 where an entry <i,j> (row i, c 254 where an entry <i,j> (row i, column j) represents the number
255 of transitions from State_i to 255 of transitions from State_i to State_j. If the transition
256 table is bigger than PAGE_SIZE 256 table is bigger than PAGE_SIZE, reading this will return
257 an -EFBIG error. 257 an -EFBIG error.
258 258
259 RO, Required 259 RO, Required
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.