Commit | Line | Data |
---|---|---|
b02f1651 MCC |
1 | =========================== |
2 | ThinkPad ACPI Extras Driver | |
3 | =========================== | |
1da177e4 | 4 | |
b02f1651 | 5 | Version 0.25 |
1da177e4 | 6 | |
b02f1651 | 7 | October 16th, 2013 |
1da177e4 | 8 | |
b02f1651 MCC |
9 | - Borislav Deianov <borislav@users.sf.net> |
10 | - Henrique de Moraes Holschuh <hmh@hmh.eng.br> | |
11 | ||
12 | http://ibm-acpi.sf.net/ | |
1da177e4 | 13 | |
643f12db HMH |
14 | This is a Linux driver for the IBM and Lenovo ThinkPad laptops. It |
15 | supports various features of these laptops which are accessible | |
16 | through the ACPI and ACPI EC framework, but not otherwise fully | |
17 | supported by the generic Linux ACPI drivers. | |
18 | ||
19 | This driver used to be named ibm-acpi until kernel 2.6.21 and release | |
20 | 0.13-20070314. It used to be in the drivers/acpi tree, but it was | |
21 | moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel | |
9abf0eea | 22 | 2.6.22, and release 0.14. It was moved to drivers/platform/x86 for |
aa2fbcec | 23 | kernel 2.6.29 and release 0.22. |
1da177e4 | 24 | |
95e57ab2 | 25 | The driver is named "thinkpad-acpi". In some places, like module |
078ac19e HMH |
26 | names and log messages, "thinkpad_acpi" is used because of userspace |
27 | issues. | |
95e57ab2 HMH |
28 | |
29 | "tpacpi" is used as a shorthand where "thinkpad-acpi" would be too | |
30 | long due to length limitations on some Linux kernel versions. | |
1da177e4 LT |
31 | |
32 | Status | |
33 | ------ | |
34 | ||
35 | The features currently supported are the following (see below for | |
36 | detailed description): | |
37 | ||
38 | - Fn key combinations | |
39 | - Bluetooth enable and disable | |
837ca6dd | 40 | - video output switching, expansion control |
1da177e4 | 41 | - ThinkLight on and off |
078ac19e | 42 | - CMOS/UCMS control |
78f81cc4 BD |
43 | - LED control |
44 | - ACPI sounds | |
45 | - temperature sensors | |
46 | - Experimental: embedded controller register dump | |
24f7ff0a SS |
47 | - LCD brightness control |
48 | - Volume control | |
ecf2a80a | 49 | - Fan control and monitoring: fan speed, fan enable/disable |
9662e080 | 50 | - WAN enable and disable |
078ac19e | 51 | - UWB enable and disable |
110ea1d8 | 52 | - LCD Shadow (PrivacyGuard) enable and disable |
acf7f4a5 | 53 | - Lap mode sensor |
1da177e4 LT |
54 | |
55 | A compatibility table by model and feature is maintained on the web | |
56 | site, http://ibm-acpi.sf.net/. I appreciate any success or failure | |
57 | reports, especially if they add to or correct the compatibility table. | |
58 | Please include the following information in your report: | |
59 | ||
60 | - ThinkPad model name | |
078ac19e | 61 | - a copy of your ACPI tables, using the "acpidump" utility |
643f12db HMH |
62 | - a copy of the output of dmidecode, with serial numbers |
63 | and UUIDs masked off | |
1da177e4 LT |
64 | - which driver features work and which don't |
65 | - the observed behavior of non-working features | |
66 | ||
67 | Any other comments or patches are also more than welcome. | |
68 | ||
69 | ||
70 | Installation | |
71 | ------------ | |
72 | ||
73 | If you are compiling this driver as included in the Linux kernel | |
078ac19e HMH |
74 | sources, look for the CONFIG_THINKPAD_ACPI Kconfig option. |
75 | It is located on the menu path: "Device Drivers" -> "X86 Platform | |
76 | Specific Device Drivers" -> "ThinkPad ACPI Laptop Extras". | |
77 | ||
1da177e4 LT |
78 | |
79 | Features | |
80 | -------- | |
81 | ||
54ae1501 HMH |
82 | The driver exports two different interfaces to userspace, which can be |
83 | used to access the features it provides. One is a legacy procfs-based | |
078ac19e HMH |
84 | interface, which will be removed at some time in the future. The other |
85 | is a new sysfs-based interface which is not complete yet. | |
54ae1501 HMH |
86 | |
87 | The procfs interface creates the /proc/acpi/ibm directory. There is a | |
88 | file under that directory for each feature it supports. The procfs | |
89 | interface is mostly frozen, and will change very little if at all: it | |
90 | will not be extended to add any new functionality in the driver, instead | |
91 | all new functionality will be implemented on the sysfs interface. | |
92 | ||
93 | The sysfs interface tries to blend in the generic Linux sysfs subsystems | |
94 | and classes as much as possible. Since some of these subsystems are not | |
95 | yet ready or stabilized, it is expected that this interface will change, | |
96 | and any and all userspace programs must deal with it. | |
97 | ||
98 | ||
b02f1651 MCC |
99 | Notes about the sysfs interface |
100 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
54ae1501 HMH |
101 | |
102 | Unlike what was done with the procfs interface, correctness when talking | |
103 | to the sysfs interfaces will be enforced, as will correctness in the | |
104 | thinkpad-acpi's implementation of sysfs interfaces. | |
105 | ||
106 | Also, any bugs in the thinkpad-acpi sysfs driver code or in the | |
107 | thinkpad-acpi's implementation of the sysfs interfaces will be fixed for | |
108 | maximum correctness, even if that means changing an interface in | |
109 | non-compatible ways. As these interfaces mature both in the kernel and | |
110 | in thinkpad-acpi, such changes should become quite rare. | |
111 | ||
112 | Applications interfacing to the thinkpad-acpi sysfs interfaces must | |
113 | follow all sysfs guidelines and correctly process all errors (the sysfs | |
114 | interface makes extensive use of errors). File descriptors and open / | |
115 | close operations to the sysfs inodes must also be properly implemented. | |
1da177e4 | 116 | |
176750d6 HMH |
117 | The version of thinkpad-acpi's sysfs interface is exported by the driver |
118 | as a driver attribute (see below). | |
119 | ||
120 | Sysfs driver attributes are on the driver's sysfs attribute space, | |
078ac19e | 121 | for 2.6.23+ this is /sys/bus/platform/drivers/thinkpad_acpi/ and |
7fd40029 | 122 | /sys/bus/platform/drivers/thinkpad_hwmon/ |
176750d6 | 123 | |
7fd40029 | 124 | Sysfs device attributes are on the thinkpad_acpi device sysfs attribute |
078ac19e | 125 | space, for 2.6.23+ this is /sys/devices/platform/thinkpad_acpi/. |
7fd40029 HMH |
126 | |
127 | Sysfs device attributes for the sensors and fan are on the | |
128 | thinkpad_hwmon device's sysfs attribute space, but you should locate it | |
078ac19e | 129 | looking for a hwmon device with the name attribute of "thinkpad", or |
6b99e356 SF |
130 | better yet, through libsensors. For 4.14+ sysfs attributes were moved to the |
131 | hwmon device (/sys/bus/platform/devices/thinkpad_hwmon/hwmon/hwmon? or | |
132 | /sys/class/hwmon/hwmon?). | |
176750d6 HMH |
133 | |
134 | Driver version | |
135 | -------------- | |
136 | ||
137 | procfs: /proc/acpi/ibm/driver | |
b02f1651 | 138 | |
176750d6 | 139 | sysfs driver attribute: version |
1da177e4 LT |
140 | |
141 | The driver name and version. No commands can be written to this file. | |
142 | ||
078ac19e | 143 | |
176750d6 HMH |
144 | Sysfs interface version |
145 | ----------------------- | |
146 | ||
147 | sysfs driver attribute: interface_version | |
148 | ||
149 | Version of the thinkpad-acpi sysfs interface, as an unsigned long | |
150 | (output in hex format: 0xAAAABBCC), where: | |
b02f1651 MCC |
151 | |
152 | AAAA | |
153 | - major revision | |
154 | BB | |
155 | - minor revision | |
156 | CC | |
157 | - bugfix revision | |
176750d6 HMH |
158 | |
159 | The sysfs interface version changelog for the driver can be found at the | |
160 | end of this document. Changes to the sysfs interface done by the kernel | |
161 | subsystems are not documented here, nor are they tracked by this | |
162 | attribute. | |
163 | ||
94b08713 HMH |
164 | Changes to the thinkpad-acpi sysfs interface are only considered |
165 | non-experimental when they are submitted to Linux mainline, at which | |
166 | point the changes in this interface are documented and interface_version | |
167 | may be updated. If you are using any thinkpad-acpi features not yet | |
168 | sent to mainline for merging, you do so on your own risk: these features | |
169 | may disappear, or be implemented in a different and incompatible way by | |
170 | the time they are merged in Linux mainline. | |
171 | ||
172 | Changes that are backwards-compatible by nature (e.g. the addition of | |
173 | attributes that do not change the way the other attributes work) do not | |
174 | always warrant an update of interface_version. Therefore, one must | |
175 | expect that an attribute might not be there, and deal with it properly | |
176 | (an attribute not being there *is* a valid way to make it clear that a | |
177 | feature is not available in sysfs). | |
178 | ||
078ac19e | 179 | |
a0416420 HMH |
180 | Hot keys |
181 | -------- | |
182 | ||
183 | procfs: /proc/acpi/ibm/hotkey | |
b02f1651 | 184 | |
cc4c24e1 | 185 | sysfs device attribute: hotkey_* |
1da177e4 | 186 | |
d0788cfb | 187 | In a ThinkPad, the ACPI HKEY handler is responsible for communicating |
1a343760 HMH |
188 | some important events and also keyboard hot key presses to the operating |
189 | system. Enabling the hotkey functionality of thinkpad-acpi signals the | |
190 | firmware that such a driver is present, and modifies how the ThinkPad | |
191 | firmware will behave in many situations. | |
192 | ||
2586d566 HMH |
193 | The driver enables the HKEY ("hot key") event reporting automatically |
194 | when loaded, and disables it when it is removed. | |
ff80f137 | 195 | |
b02f1651 | 196 | The driver will report HKEY events in the following format:: |
1da177e4 LT |
197 | |
198 | ibm/hotkey HKEY 00000080 0000xxxx | |
199 | ||
2586d566 | 200 | Some of these events refer to hot key presses, but not all of them. |
6a38abbf | 201 | |
ff80f137 HMH |
202 | The driver will generate events over the input layer for hot keys and |
203 | radio switches, and over the ACPI netlink layer for other events. The | |
204 | input layer support accepts the standard IOCTLs to remap the keycodes | |
205 | assigned to each hot key. | |
1a343760 HMH |
206 | |
207 | The hot key bit mask allows some control over which hot keys generate | |
208 | events. If a key is "masked" (bit set to 0 in the mask), the firmware | |
209 | will handle it. If it is "unmasked", it signals the firmware that | |
210 | thinkpad-acpi would prefer to handle it, if the firmware would be so | |
211 | kind to allow it (and it often doesn't!). | |
212 | ||
213 | Not all bits in the mask can be modified. Not all bits that can be | |
214 | modified do anything. Not all hot keys can be individually controlled | |
0d922e3b HMH |
215 | by the mask. Some models do not support the mask at all. The behaviour |
216 | of the mask is, therefore, highly dependent on the ThinkPad model. | |
217 | ||
218 | The driver will filter out any unmasked hotkeys, so even if the firmware | |
219 | doesn't allow disabling an specific hotkey, the driver will not report | |
220 | events for unmasked hotkeys. | |
1a343760 HMH |
221 | |
222 | Note that unmasking some keys prevents their default behavior. For | |
223 | example, if Fn+F5 is unmasked, that key will no longer enable/disable | |
0d922e3b | 224 | Bluetooth by itself in firmware. |
1a343760 | 225 | |
0d922e3b HMH |
226 | Note also that not all Fn key combinations are supported through ACPI |
227 | depending on the ThinkPad model and firmware version. On those | |
228 | ThinkPads, it is still possible to support some extra hotkeys by | |
229 | polling the "CMOS NVRAM" at least 10 times per second. The driver | |
230 | attempts to enables this functionality automatically when required. | |
1da177e4 | 231 | |
b02f1651 MCC |
232 | procfs notes |
233 | ^^^^^^^^^^^^ | |
a0416420 | 234 | |
b02f1651 | 235 | The following commands can be written to the /proc/acpi/ibm/hotkey file:: |
a0416420 | 236 | |
ae92bd17 HMH |
237 | echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys |
238 | echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys | |
239 | ... any other 8-hex-digit mask ... | |
20c9aa46 | 240 | echo reset > /proc/acpi/ibm/hotkey -- restore the recommended mask |
a0416420 | 241 | |
2586d566 | 242 | The following commands have been deprecated and will cause the kernel |
b02f1651 | 243 | to log a warning:: |
2586d566 HMH |
244 | |
245 | echo enable > /proc/acpi/ibm/hotkey -- does nothing | |
246 | echo disable > /proc/acpi/ibm/hotkey -- returns an error | |
247 | ||
01e88f25 HMH |
248 | The procfs interface does not support NVRAM polling control. So as to |
249 | maintain maximum bug-to-bug compatibility, it does not report any masks, | |
250 | nor does it allow one to manipulate the hot key mask when the firmware | |
251 | does not support masks at all, even if NVRAM polling is in use. | |
252 | ||
b02f1651 MCC |
253 | sysfs notes |
254 | ^^^^^^^^^^^ | |
a0416420 | 255 | |
cc4c24e1 | 256 | hotkey_bios_enabled: |
2586d566 | 257 | DEPRECATED, WILL BE REMOVED SOON. |
a0416420 | 258 | |
2586d566 | 259 | Returns 0. |
a0416420 | 260 | |
cc4c24e1 | 261 | hotkey_bios_mask: |
06777be6 HMH |
262 | DEPRECATED, DON'T USE, WILL BE REMOVED IN THE FUTURE. |
263 | ||
a0416420 HMH |
264 | Returns the hot keys mask when thinkpad-acpi was loaded. |
265 | Upon module unload, the hot keys mask will be restored | |
06777be6 HMH |
266 | to this value. This is always 0x80c, because those are |
267 | the hotkeys that were supported by ancient firmware | |
268 | without mask support. | |
a0416420 | 269 | |
cc4c24e1 | 270 | hotkey_enable: |
2586d566 | 271 | DEPRECATED, WILL BE REMOVED SOON. |
a0416420 | 272 | |
2586d566 HMH |
273 | 0: returns -EPERM |
274 | 1: does nothing | |
a0416420 | 275 | |
cc4c24e1 | 276 | hotkey_mask: |
0d922e3b | 277 | bit mask to enable reporting (and depending on |
01e88f25 HMH |
278 | the firmware, ACPI event generation) for each hot key |
279 | (see above). Returns the current status of the hot keys | |
280 | mask, and allows one to modify it. | |
281 | ||
9b010de5 HMH |
282 | hotkey_all_mask: |
283 | bit mask that should enable event reporting for all | |
284 | supported hot keys, when echoed to hotkey_mask above. | |
285 | Unless you know which events need to be handled | |
286 | passively (because the firmware *will* handle them | |
287 | anyway), do *not* use hotkey_all_mask. Use | |
288 | hotkey_recommended_mask, instead. You have been warned. | |
289 | ||
290 | hotkey_recommended_mask: | |
291 | bit mask that should enable event reporting for all | |
1a343760 HMH |
292 | supported hot keys, except those which are always |
293 | handled by the firmware anyway. Echo it to | |
0d922e3b HMH |
294 | hotkey_mask above, to use. This is the default mask |
295 | used by the driver. | |
9b010de5 | 296 | |
01e88f25 HMH |
297 | hotkey_source_mask: |
298 | bit mask that selects which hot keys will the driver | |
299 | poll the NVRAM for. This is auto-detected by the driver | |
300 | based on the capabilities reported by the ACPI firmware, | |
301 | but it can be overridden at runtime. | |
302 | ||
0d922e3b HMH |
303 | Hot keys whose bits are set in hotkey_source_mask are |
304 | polled for in NVRAM, and reported as hotkey events if | |
305 | enabled in hotkey_mask. Only a few hot keys are | |
306 | available through CMOS NVRAM polling. | |
01e88f25 HMH |
307 | |
308 | Warning: when in NVRAM mode, the volume up/down/mute | |
309 | keys are synthesized according to changes in the mixer, | |
69df49eb HMH |
310 | which uses a single volume up or volume down hotkey |
311 | press to unmute, as per the ThinkPad volume mixer user | |
312 | interface. When in ACPI event mode, volume up/down/mute | |
313 | events are reported by the firmware and can behave | |
314 | differently (and that behaviour changes with firmware | |
315 | version -- not just with firmware models -- as well as | |
316 | OSI(Linux) state). | |
01e88f25 HMH |
317 | |
318 | hotkey_poll_freq: | |
319 | frequency in Hz for hot key polling. It must be between | |
320 | 0 and 25 Hz. Polling is only carried out when strictly | |
321 | needed. | |
322 | ||
323 | Setting hotkey_poll_freq to zero disables polling, and | |
324 | will cause hot key presses that require NVRAM polling | |
325 | to never be reported. | |
326 | ||
69df49eb | 327 | Setting hotkey_poll_freq too low may cause repeated |
01e88f25 HMH |
328 | pressings of the same hot key to be misreported as a |
329 | single key press, or to not even be detected at all. | |
330 | The recommended polling frequency is 10Hz. | |
331 | ||
74941a69 | 332 | hotkey_radio_sw: |
d147da73 | 333 | If the ThinkPad has a hardware radio switch, this |
74941a69 | 334 | attribute will read 0 if the switch is in the "radios |
d0788cfb | 335 | disabled" position, and 1 if the switch is in the |
74941a69 HMH |
336 | "radios enabled" position. |
337 | ||
50ebec09 HMH |
338 | This attribute has poll()/select() support. |
339 | ||
6c231bd5 HMH |
340 | hotkey_tablet_mode: |
341 | If the ThinkPad has tablet capabilities, this attribute | |
342 | will read 0 if the ThinkPad is in normal mode, and | |
343 | 1 if the ThinkPad is in tablet mode. | |
344 | ||
345 | This attribute has poll()/select() support. | |
346 | ||
a713b4d7 HMH |
347 | wakeup_reason: |
348 | Set to 1 if the system is waking up because the user | |
349 | requested a bay ejection. Set to 2 if the system is | |
350 | waking up because the user requested the system to | |
351 | undock. Set to zero for normal wake-ups or wake-ups | |
352 | due to unknown reasons. | |
353 | ||
50ebec09 HMH |
354 | This attribute has poll()/select() support. |
355 | ||
a713b4d7 HMH |
356 | wakeup_hotunplug_complete: |
357 | Set to 1 if the system was waken up because of an | |
358 | undock or bay ejection request, and that request | |
d0788cfb | 359 | was successfully completed. At this point, it might |
a713b4d7 HMH |
360 | be useful to send the system back to sleep, at the |
361 | user's choice. Refer to HKEY events 0x4003 and | |
362 | 0x3003, below. | |
363 | ||
50ebec09 HMH |
364 | This attribute has poll()/select() support. |
365 | ||
b02f1651 MCC |
366 | input layer notes |
367 | ^^^^^^^^^^^^^^^^^ | |
6a38abbf HMH |
368 | |
369 | A Hot key is mapped to a single input layer EV_KEY event, possibly | |
370 | followed by an EV_MSC MSC_SCAN event that shall contain that key's scan | |
371 | code. An EV_SYN event will always be generated to mark the end of the | |
372 | event block. | |
373 | ||
374 | Do not use the EV_MSC MSC_SCAN events to process keys. They are to be | |
375 | used as a helper to remap keys, only. They are particularly useful when | |
376 | remapping KEY_UNKNOWN keys. | |
377 | ||
378 | The events are available in an input device, with the following id: | |
379 | ||
b02f1651 MCC |
380 | ============== ============================== |
381 | Bus BUS_HOST | |
382 | vendor 0x1014 (PCI_VENDOR_ID_IBM) or | |
edf0e0e5 | 383 | 0x17aa (PCI_VENDOR_ID_LENOVO) |
b02f1651 MCC |
384 | product 0x5054 ("TP") |
385 | version 0x4101 | |
386 | ============== ============================== | |
6a38abbf HMH |
387 | |
388 | The version will have its LSB incremented if the keymap changes in a | |
389 | backwards-compatible way. The MSB shall always be 0x41 for this input | |
390 | device. If the MSB is not 0x41, do not use the device as described in | |
391 | this section, as it is either something else (e.g. another input device | |
392 | exported by a thinkpad driver, such as HDAPS) or its functionality has | |
393 | been changed in a non-backwards compatible way. | |
394 | ||
395 | Adding other event types for other functionalities shall be considered a | |
396 | backwards-compatible change for this input device. | |
397 | ||
398 | Thinkpad-acpi Hot Key event map (version 0x4101): | |
399 | ||
b02f1651 | 400 | ======= ======= ============== ============================================== |
6a38abbf HMH |
401 | ACPI Scan |
402 | event code Key Notes | |
b02f1651 | 403 | ======= ======= ============== ============================================== |
6a38abbf | 404 | 0x1001 0x00 FN+F1 - |
69df49eb | 405 | |
edf0e0e5 HMH |
406 | 0x1002 0x01 FN+F2 IBM: battery (rare) |
407 | Lenovo: Screen lock | |
6a38abbf | 408 | |
edf0e0e5 HMH |
409 | 0x1003 0x02 FN+F3 Many IBM models always report |
410 | this hot key, even with hot keys | |
6a38abbf HMH |
411 | disabled or with Fn+F3 masked |
412 | off | |
69df49eb HMH |
413 | IBM: screen lock, often turns |
414 | off the ThinkLight as side-effect | |
edf0e0e5 | 415 | Lenovo: battery |
6a38abbf HMH |
416 | |
417 | 0x1004 0x03 FN+F4 Sleep button (ACPI sleep button | |
d0788cfb | 418 | semantics, i.e. sleep-to-RAM). |
123aeec2 | 419 | It always generates some kind |
6a38abbf | 420 | of event, either the hot key |
123aeec2 | 421 | event or an ACPI sleep button |
6a38abbf HMH |
422 | event. The firmware may |
423 | refuse to generate further FN+F4 | |
424 | key presses until a S3 or S4 ACPI | |
425 | sleep cycle is performed or some | |
426 | time passes. | |
427 | ||
428 | 0x1005 0x04 FN+F5 Radio. Enables/disables | |
d0788cfb | 429 | the internal Bluetooth hardware |
6a38abbf HMH |
430 | and W-WAN card if left in control |
431 | of the firmware. Does not affect | |
432 | the WLAN card. | |
edf0e0e5 | 433 | Should be used to turn on/off all |
d0788cfb | 434 | radios (Bluetooth+W-WAN+WLAN), |
edf0e0e5 | 435 | really. |
6a38abbf HMH |
436 | |
437 | 0x1006 0x05 FN+F6 - | |
438 | ||
439 | 0x1007 0x06 FN+F7 Video output cycle. | |
440 | Do you feel lucky today? | |
441 | ||
edf0e0e5 | 442 | 0x1008 0x07 FN+F8 IBM: toggle screen expand |
69df49eb HMH |
443 | Lenovo: configure UltraNav, |
444 | or toggle screen expand | |
edf0e0e5 HMH |
445 | |
446 | 0x1009 0x08 FN+F9 - | |
b02f1651 MCC |
447 | |
448 | ... ... ... ... | |
449 | ||
6a38abbf HMH |
450 | 0x100B 0x0A FN+F11 - |
451 | ||
452 | 0x100C 0x0B FN+F12 Sleep to disk. You are always | |
453 | supposed to handle it yourself, | |
454 | either through the ACPI event, | |
455 | or through a hotkey event. | |
456 | The firmware may refuse to | |
69df49eb | 457 | generate further FN+F12 key |
6a38abbf HMH |
458 | press events until a S3 or S4 |
459 | ACPI sleep cycle is performed, | |
460 | or some time passes. | |
461 | ||
462 | 0x100D 0x0C FN+BACKSPACE - | |
463 | 0x100E 0x0D FN+INSERT - | |
464 | 0x100F 0x0E FN+DELETE - | |
465 | ||
466 | 0x1010 0x0F FN+HOME Brightness up. This key is | |
edf0e0e5 HMH |
467 | always handled by the firmware |
468 | in IBM ThinkPads, even when | |
469 | unmasked. Just leave it alone. | |
470 | For Lenovo ThinkPads with a new | |
471 | BIOS, it has to be handled either | |
472 | by the ACPI OSI, or by userspace. | |
347a2686 HMH |
473 | The driver does the right thing, |
474 | never mess with this. | |
edf0e0e5 HMH |
475 | 0x1011 0x10 FN+END Brightness down. See brightness |
476 | up for details. | |
477 | ||
d0788cfb | 478 | 0x1012 0x11 FN+PGUP ThinkLight toggle. This key is |
6a38abbf HMH |
479 | always handled by the firmware, |
480 | even when unmasked. | |
481 | ||
482 | 0x1013 0x12 FN+PGDOWN - | |
483 | ||
484 | 0x1014 0x13 FN+SPACE Zoom key | |
485 | ||
486 | 0x1015 0x14 VOLUME UP Internal mixer volume up. This | |
487 | key is always handled by the | |
488 | firmware, even when unmasked. | |
edf0e0e5 HMH |
489 | NOTE: Lenovo seems to be changing |
490 | this. | |
6a38abbf HMH |
491 | 0x1016 0x15 VOLUME DOWN Internal mixer volume up. This |
492 | key is always handled by the | |
493 | firmware, even when unmasked. | |
edf0e0e5 HMH |
494 | NOTE: Lenovo seems to be changing |
495 | this. | |
6a38abbf HMH |
496 | 0x1017 0x16 MUTE Mute internal mixer. This |
497 | key is always handled by the | |
498 | firmware, even when unmasked. | |
499 | ||
d0788cfb | 500 | 0x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key |
6a38abbf HMH |
501 | |
502 | 0x1019 0x18 unknown | |
b02f1651 MCC |
503 | |
504 | ... ... ... | |
505 | ||
6a38abbf | 506 | 0x1020 0x1F unknown |
b02f1651 | 507 | ======= ======= ============== ============================================== |
6a38abbf HMH |
508 | |
509 | The ThinkPad firmware does not allow one to differentiate when most hot | |
510 | keys are pressed or released (either that, or we don't know how to, yet). | |
511 | For these keys, the driver generates a set of events for a key press and | |
512 | immediately issues the same set of events for a key release. It is | |
513 | unknown by the driver if the ThinkPad firmware triggered these events on | |
514 | hot key press or release, but the firmware will do it for either one, not | |
515 | both. | |
516 | ||
ff80f137 | 517 | If a key is mapped to KEY_RESERVED, it generates no input events at all. |
6a38abbf | 518 | If a key is mapped to KEY_UNKNOWN, it generates an input event that |
ff80f137 HMH |
519 | includes an scan code. If a key is mapped to anything else, it will |
520 | generate input device EV_KEY events. | |
6a38abbf | 521 | |
d0788cfb HMH |
522 | In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW |
523 | events for switches: | |
524 | ||
b02f1651 | 525 | ============== ============================================== |
19f59460 | 526 | SW_RFKILL_ALL T60 and later hardware rfkill rocker switch |
d0788cfb | 527 | SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A |
b02f1651 | 528 | ============== ============================================== |
d0788cfb | 529 | |
b02f1651 MCC |
530 | Non hotkey ACPI HKEY event map |
531 | ------------------------------ | |
69df49eb | 532 | |
69df49eb | 533 | Events that are never propagated by the driver: |
ff80f137 | 534 | |
b02f1651 | 535 | ====== ================================================== |
a713b4d7 HMH |
536 | 0x2304 System is waking up from suspend to undock |
537 | 0x2305 System is waking up from suspend to eject bay | |
538 | 0x2404 System is waking up from hibernation to undock | |
539 | 0x2405 System is waking up from hibernation to eject bay | |
8b5301c5 TR |
540 | 0x5001 Lid closed |
541 | 0x5002 Lid opened | |
542 | 0x5009 Tablet swivel: switched to tablet mode | |
543 | 0x500A Tablet swivel: switched to normal mode | |
176dd985 | 544 | 0x5010 Brightness level changed/control event |
2d43f671 HMH |
545 | 0x6000 KEYBOARD: Numlock key pressed |
546 | 0x6005 KEYBOARD: Fn key pressed (TO BE VERIFIED) | |
8b5301c5 | 547 | 0x7000 Radio Switch may have changed state |
b02f1651 | 548 | ====== ================================================== |
8b5301c5 | 549 | |
a713b4d7 | 550 | |
69df49eb | 551 | Events that are propagated by the driver to userspace: |
a713b4d7 | 552 | |
b02f1651 | 553 | ====== ===================================================== |
69df49eb HMH |
554 | 0x2313 ALARM: System is waking up from suspend because |
555 | the battery is nearly empty | |
556 | 0x2413 ALARM: System is waking up from hibernation because | |
557 | the battery is nearly empty | |
a713b4d7 | 558 | 0x3003 Bay ejection (see 0x2x05) complete, can sleep again |
69df49eb HMH |
559 | 0x3006 Bay hotplug request (hint to power up SATA link when |
560 | the optical drive tray is ejected) | |
a713b4d7 | 561 | 0x4003 Undocked (see 0x2x04), can sleep again |
a50245af HMH |
562 | 0x4010 Docked into hotplug port replicator (non-ACPI dock) |
563 | 0x4011 Undocked from hotplug port replicator (non-ACPI dock) | |
d0788cfb | 564 | 0x500B Tablet pen inserted into its storage bay |
d1edb2b5 | 565 | 0x500C Tablet pen removed from its storage bay |
69df49eb HMH |
566 | 0x6011 ALARM: battery is too hot |
567 | 0x6012 ALARM: battery is extremely hot | |
568 | 0x6021 ALARM: a sensor is too hot | |
569 | 0x6022 ALARM: a sensor is extremely hot | |
570 | 0x6030 System thermal table changed | |
6e6bc5f6 | 571 | 0x6032 Thermal Control command set completion (DYTC, Windows) |
2d43f671 | 572 | 0x6040 Nvidia Optimus/AC adapter related (TO BE VERIFIED) |
b03f4d49 | 573 | 0x60C0 X1 Yoga 2016, Tablet mode status changed |
6e6bc5f6 | 574 | 0x60F0 Thermal Transformation changed (GMTS, Windows) |
b02f1651 | 575 | ====== ===================================================== |
69df49eb HMH |
576 | |
577 | Battery nearly empty alarms are a last resort attempt to get the | |
578 | operating system to hibernate or shutdown cleanly (0x2313), or shutdown | |
579 | cleanly (0x2413) before power is lost. They must be acted upon, as the | |
580 | wake up caused by the firmware will have negated most safety nets... | |
581 | ||
582 | When any of the "too hot" alarms happen, according to Lenovo the user | |
583 | should suspend or hibernate the laptop (and in the case of battery | |
584 | alarms, unplug the AC adapter) to let it cool down. These alarms do | |
585 | signal that something is wrong, they should never happen on normal | |
586 | operating conditions. | |
587 | ||
588 | The "extremely hot" alarms are emergencies. According to Lenovo, the | |
589 | operating system is to force either an immediate suspend or hibernate | |
590 | cycle, or a system shutdown. Obviously, something is very wrong if this | |
591 | happens. | |
3b64b51d | 592 | |
a0416420 | 593 | |
b02f1651 MCC |
594 | Brightness hotkey notes |
595 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
b5972796 | 596 | |
347a2686 HMH |
597 | Don't mess with the brightness hotkeys in a Thinkpad. If you want |
598 | notifications for OSD, use the sysfs backlight class event support. | |
b5972796 | 599 | |
347a2686 HMH |
600 | The driver will issue KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN events |
601 | automatically for the cases were userspace has to do something to | |
602 | implement brightness changes. When you override these events, you will | |
603 | either fail to handle properly the ThinkPads that require explicit | |
604 | action to change backlight brightness, or the ThinkPads that require | |
605 | that no action be taken to work properly. | |
b5972796 | 606 | |
078ac19e | 607 | |
d3a6ade4 HMH |
608 | Bluetooth |
609 | --------- | |
1da177e4 | 610 | |
d3a6ade4 | 611 | procfs: /proc/acpi/ibm/bluetooth |
b02f1651 | 612 | |
0e74dc26 | 613 | sysfs device attribute: bluetooth_enable (deprecated) |
b02f1651 | 614 | |
0e74dc26 | 615 | sysfs rfkill class: switch "tpacpi_bluetooth_sw" |
d3a6ade4 HMH |
616 | |
617 | This feature shows the presence and current state of a ThinkPad | |
618 | Bluetooth device in the internal ThinkPad CDC slot. | |
619 | ||
078ac19e HMH |
620 | If the ThinkPad supports it, the Bluetooth state is stored in NVRAM, |
621 | so it is kept across reboots and power-off. | |
622 | ||
b02f1651 MCC |
623 | Procfs notes |
624 | ^^^^^^^^^^^^ | |
d3a6ade4 | 625 | |
b02f1651 | 626 | If Bluetooth is installed, the following commands can be used:: |
1da177e4 LT |
627 | |
628 | echo enable > /proc/acpi/ibm/bluetooth | |
629 | echo disable > /proc/acpi/ibm/bluetooth | |
630 | ||
b02f1651 MCC |
631 | Sysfs notes |
632 | ^^^^^^^^^^^ | |
d3a6ade4 HMH |
633 | |
634 | If the Bluetooth CDC card is installed, it can be enabled / | |
cc4c24e1 | 635 | disabled through the "bluetooth_enable" thinkpad-acpi device |
d3a6ade4 HMH |
636 | attribute, and its current status can also be queried. |
637 | ||
638 | enable: | |
b02f1651 MCC |
639 | |
640 | - 0: disables Bluetooth / Bluetooth is disabled | |
641 | - 1: enables Bluetooth / Bluetooth is enabled. | |
d3a6ade4 | 642 | |
0e74dc26 HMH |
643 | Note: this interface has been superseded by the generic rfkill |
644 | class. It has been deprecated, and it will be removed in year | |
645 | 2010. | |
646 | ||
647 | rfkill controller switch "tpacpi_bluetooth_sw": refer to | |
baa293e9 | 648 | Documentation/driver-api/rfkill.rst for details. |
d3a6ade4 | 649 | |
078ac19e | 650 | |
1da177e4 LT |
651 | Video output control -- /proc/acpi/ibm/video |
652 | -------------------------------------------- | |
653 | ||
654 | This feature allows control over the devices used for video output - | |
b02f1651 | 655 | LCD, CRT or DVI (if available). The following commands are available:: |
1da177e4 LT |
656 | |
657 | echo lcd_enable > /proc/acpi/ibm/video | |
658 | echo lcd_disable > /proc/acpi/ibm/video | |
659 | echo crt_enable > /proc/acpi/ibm/video | |
660 | echo crt_disable > /proc/acpi/ibm/video | |
661 | echo dvi_enable > /proc/acpi/ibm/video | |
662 | echo dvi_disable > /proc/acpi/ibm/video | |
663 | echo auto_enable > /proc/acpi/ibm/video | |
664 | echo auto_disable > /proc/acpi/ibm/video | |
665 | echo expand_toggle > /proc/acpi/ibm/video | |
666 | echo video_switch > /proc/acpi/ibm/video | |
667 | ||
b02f1651 MCC |
668 | NOTE: |
669 | Access to this feature is restricted to processes owning the | |
670 | CAP_SYS_ADMIN capability for safety reasons, as it can interact badly | |
671 | enough with some versions of X.org to crash it. | |
b525c06c | 672 | |
1da177e4 LT |
673 | Each video output device can be enabled or disabled individually. |
674 | Reading /proc/acpi/ibm/video shows the status of each device. | |
675 | ||
676 | Automatic video switching can be enabled or disabled. When automatic | |
677 | video switching is enabled, certain events (e.g. opening the lid, | |
678 | docking or undocking) cause the video output device to change | |
679 | automatically. While this can be useful, it also causes flickering | |
680 | and, on the X40, video corruption. By disabling automatic switching, | |
681 | the flickering or video corruption can be avoided. | |
682 | ||
683 | The video_switch command cycles through the available video outputs | |
78f81cc4 | 684 | (it simulates the behavior of Fn-F7). |
1da177e4 LT |
685 | |
686 | Video expansion can be toggled through this feature. This controls | |
687 | whether the display is expanded to fill the entire LCD screen when a | |
688 | mode with less than full resolution is used. Note that the current | |
689 | video expansion status cannot be determined through this feature. | |
690 | ||
691 | Note that on many models (particularly those using Radeon graphics | |
692 | chips) the X driver configures the video card in a way which prevents | |
693 | Fn-F7 from working. This also disables the video output switching | |
694 | features of this driver, as it uses the same ACPI methods as | |
695 | Fn-F7. Video switching on the console should still work. | |
696 | ||
078ac19e | 697 | UPDATE: refer to https://bugs.freedesktop.org/show_bug.cgi?id=2000 |
78f81cc4 | 698 | |
78f81cc4 | 699 | |
e306501d HMH |
700 | ThinkLight control |
701 | ------------------ | |
702 | ||
703 | procfs: /proc/acpi/ibm/light | |
b02f1651 | 704 | |
65807cc2 | 705 | sysfs attributes: as per LED class, for the "tpacpi::thinklight" LED |
e306501d | 706 | |
b02f1651 MCC |
707 | procfs notes |
708 | ^^^^^^^^^^^^ | |
1da177e4 | 709 | |
e306501d HMH |
710 | The ThinkLight status can be read and set through the procfs interface. A |
711 | few models which do not make the status available will show the ThinkLight | |
b02f1651 | 712 | status as "unknown". The available commands are:: |
1da177e4 LT |
713 | |
714 | echo on > /proc/acpi/ibm/light | |
715 | echo off > /proc/acpi/ibm/light | |
716 | ||
b02f1651 MCC |
717 | sysfs notes |
718 | ^^^^^^^^^^^ | |
e306501d | 719 | |
65807cc2 | 720 | The ThinkLight sysfs interface is documented by the LED class |
8dab9197 | 721 | documentation, in Documentation/leds/leds-class.rst. The ThinkLight LED name |
e306501d HMH |
722 | is "tpacpi::thinklight". |
723 | ||
078ac19e | 724 | Due to limitations in the sysfs LED class, if the status of the ThinkLight |
e306501d HMH |
725 | cannot be read or if it is unknown, thinkpad-acpi will report it as "off". |
726 | It is impossible to know if the status returned through sysfs is valid. | |
727 | ||
078ac19e | 728 | |
078ac19e HMH |
729 | CMOS/UCMS control |
730 | ----------------- | |
b616004c HMH |
731 | |
732 | procfs: /proc/acpi/ibm/cmos | |
b02f1651 | 733 | |
b616004c | 734 | sysfs device attribute: cmos_command |
1da177e4 | 735 | |
d54b7d7f HMH |
736 | This feature is mostly used internally by the ACPI firmware to keep the legacy |
737 | CMOS NVRAM bits in sync with the current machine state, and to record this | |
738 | state so that the ThinkPad will retain such settings across reboots. | |
739 | ||
740 | Some of these commands actually perform actions in some ThinkPad models, but | |
741 | this is expected to disappear more and more in newer models. As an example, in | |
742 | a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for | |
743 | real, but commands 0 to 2 don't control the mixer anymore (they have been | |
744 | phased out) and just update the NVRAM. | |
1da177e4 | 745 | |
b616004c HMH |
746 | The range of valid cmos command numbers is 0 to 21, but not all have an |
747 | effect and the behavior varies from model to model. Here is the behavior | |
748 | on the X40 (tpb is the ThinkPad Buttons utility): | |
1da177e4 | 749 | |
b02f1651 MCC |
750 | - 0 - Related to "Volume down" key press |
751 | - 1 - Related to "Volume up" key press | |
752 | - 2 - Related to "Mute on" key press | |
753 | - 3 - Related to "Access IBM" key press | |
754 | - 4 - Related to "LCD brightness up" key press | |
755 | - 5 - Related to "LCD brightness down" key press | |
756 | - 11 - Related to "toggle screen expansion" key press/function | |
757 | - 12 - Related to "ThinkLight on" | |
758 | - 13 - Related to "ThinkLight off" | |
759 | - 14 - Related to "ThinkLight" key press (toggle ThinkLight) | |
1da177e4 | 760 | |
b616004c | 761 | The cmos command interface is prone to firmware split-brain problems, as |
d54b7d7f HMH |
762 | in newer ThinkPads it is just a compatibility layer. Do not use it, it is |
763 | exported just as a debug tool. | |
b616004c | 764 | |
078ac19e | 765 | |
af116101 HMH |
766 | LED control |
767 | ----------- | |
1da177e4 | 768 | |
af116101 | 769 | procfs: /proc/acpi/ibm/led |
65807cc2 | 770 | sysfs attributes: as per LED class, see below for names |
af116101 HMH |
771 | |
772 | Some of the LED indicators can be controlled through this feature. On | |
773 | some older ThinkPad models, it is possible to query the status of the | |
774 | LED indicators as well. Newer ThinkPads cannot query the real status | |
775 | of the LED indicators. | |
776 | ||
a4d5effc HMH |
777 | Because misuse of the LEDs could induce an unaware user to perform |
778 | dangerous actions (like undocking or ejecting a bay device while the | |
779 | buses are still active), or mask an important alarm (such as a nearly | |
780 | empty battery, or a broken battery), access to most LEDs is | |
781 | restricted. | |
782 | ||
783 | Unrestricted access to all LEDs requires that thinkpad-acpi be | |
784 | compiled with the CONFIG_THINKPAD_ACPI_UNSAFE_LEDS option enabled. | |
785 | Distributions must never enable this option. Individual users that | |
786 | are aware of the consequences are welcome to enabling it. | |
787 | ||
420f9739 DH |
788 | Audio mute and microphone mute LEDs are supported, but currently not |
789 | visible to userspace. They are used by the snd-hda-intel audio driver. | |
790 | ||
b02f1651 MCC |
791 | procfs notes |
792 | ^^^^^^^^^^^^ | |
af116101 | 793 | |
b02f1651 | 794 | The available commands are:: |
1da177e4 | 795 | |
65807cc2 HMH |
796 | echo '<LED number> on' >/proc/acpi/ibm/led |
797 | echo '<LED number> off' >/proc/acpi/ibm/led | |
798 | echo '<LED number> blink' >/proc/acpi/ibm/led | |
1da177e4 | 799 | |
f21179a4 | 800 | The <LED number> range is 0 to 15. The set of LEDs that can be |
af116101 HMH |
801 | controlled varies from model to model. Here is the common ThinkPad |
802 | mapping: | |
1da177e4 | 803 | |
b02f1651 MCC |
804 | - 0 - power |
805 | - 1 - battery (orange) | |
806 | - 2 - battery (green) | |
807 | - 3 - UltraBase/dock | |
808 | - 4 - UltraBay | |
809 | - 5 - UltraBase battery slot | |
810 | - 6 - (unknown) | |
811 | - 7 - standby | |
812 | - 8 - dock status 1 | |
813 | - 9 - dock status 2 | |
814 | - 10, 11 - (unknown) | |
815 | - 12 - thinkvantage | |
816 | - 13, 14, 15 - (unknown) | |
1da177e4 LT |
817 | |
818 | All of the above can be turned on and off and can be made to blink. | |
819 | ||
b02f1651 MCC |
820 | sysfs notes |
821 | ^^^^^^^^^^^ | |
af116101 | 822 | |
65807cc2 | 823 | The ThinkPad LED sysfs interface is described in detail by the LED class |
8dab9197 | 824 | documentation, in Documentation/leds/leds-class.rst. |
af116101 | 825 | |
f21179a4 | 826 | The LEDs are named (in LED ID order, from 0 to 12): |
af116101 HMH |
827 | "tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt", |
828 | "tpacpi::dock_active", "tpacpi::bay_active", "tpacpi::dock_batt", | |
f21179a4 HMH |
829 | "tpacpi::unknown_led", "tpacpi::standby", "tpacpi::dock_status1", |
830 | "tpacpi::dock_status2", "tpacpi::unknown_led2", "tpacpi::unknown_led3", | |
831 | "tpacpi::thinkvantage". | |
af116101 | 832 | |
65807cc2 | 833 | Due to limitations in the sysfs LED class, if the status of the LED |
af116101 HMH |
834 | indicators cannot be read due to an error, thinkpad-acpi will report it as |
835 | a brightness of zero (same as LED off). | |
836 | ||
837 | If the thinkpad firmware doesn't support reading the current status, | |
838 | trying to read the current LED brightness will just return whatever | |
839 | brightness was last written to that attribute. | |
840 | ||
841 | These LEDs can blink using hardware acceleration. To request that a | |
842 | ThinkPad indicator LED should blink in hardware accelerated mode, use the | |
843 | "timer" trigger, and leave the delay_on and delay_off parameters set to | |
844 | zero (to request hardware acceleration autodetection). | |
845 | ||
f21179a4 HMH |
846 | LEDs that are known not to exist in a given ThinkPad model are not |
847 | made available through the sysfs interface. If you have a dock and you | |
848 | notice there are LEDs listed for your ThinkPad that do not exist (and | |
849 | are not in the dock), or if you notice that there are missing LEDs, | |
850 | a report to ibm-acpi-devel@lists.sourceforge.net is appreciated. | |
851 | ||
078ac19e | 852 | |
78f81cc4 BD |
853 | ACPI sounds -- /proc/acpi/ibm/beep |
854 | ---------------------------------- | |
1da177e4 LT |
855 | |
856 | The BEEP method is used internally by the ACPI firmware to provide | |
78f81cc4 | 857 | audible alerts in various situations. This feature allows the same |
1da177e4 LT |
858 | sounds to be triggered manually. |
859 | ||
b02f1651 | 860 | The commands are non-negative integer numbers:: |
1da177e4 | 861 | |
78f81cc4 | 862 | echo <number> >/proc/acpi/ibm/beep |
1da177e4 | 863 | |
78f81cc4 BD |
864 | The valid <number> range is 0 to 17. Not all numbers trigger sounds |
865 | and the sounds vary from model to model. Here is the behavior on the | |
866 | X40: | |
1da177e4 | 867 | |
b02f1651 MCC |
868 | - 0 - stop a sound in progress (but use 17 to stop 16) |
869 | - 2 - two beeps, pause, third beep ("low battery") | |
870 | - 3 - single beep | |
871 | - 4 - high, followed by low-pitched beep ("unable") | |
872 | - 5 - single beep | |
873 | - 6 - very high, followed by high-pitched beep ("AC/DC") | |
874 | - 7 - high-pitched beep | |
875 | - 9 - three short beeps | |
876 | - 10 - very long beep | |
877 | - 12 - low-pitched beep | |
878 | - 15 - three high-pitched beeps repeating constantly, stop with 0 | |
879 | - 16 - one medium-pitched beep repeating constantly, stop with 17 | |
880 | - 17 - stop 16 | |
78f81cc4 | 881 | |
078ac19e | 882 | |
2c37aa4e HMH |
883 | Temperature sensors |
884 | ------------------- | |
885 | ||
886 | procfs: /proc/acpi/ibm/thermal | |
b02f1651 | 887 | |
7fd40029 | 888 | sysfs device attributes: (hwmon "thinkpad") temp*_input |
78f81cc4 | 889 | |
3d6f99ca HMH |
890 | Most ThinkPads include six or more separate temperature sensors but only |
891 | expose the CPU temperature through the standard ACPI methods. This | |
892 | feature shows readings from up to eight different sensors on older | |
893 | ThinkPads, and up to sixteen different sensors on newer ThinkPads. | |
60eb0b35 HMH |
894 | |
895 | For example, on the X40, a typical output may be: | |
b02f1651 MCC |
896 | |
897 | temperatures: | |
898 | 42 42 45 41 36 -128 33 -128 | |
78f81cc4 | 899 | |
3d6f99ca | 900 | On the T43/p, a typical output may be: |
b02f1651 MCC |
901 | |
902 | temperatures: | |
903 | 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128 | |
60eb0b35 HMH |
904 | |
905 | The mapping of thermal sensors to physical locations varies depending on | |
906 | system-board model (and thus, on ThinkPad model). | |
907 | ||
6b2484e1 | 908 | https://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that |
60eb0b35 HMH |
909 | tries to track down these locations for various models. |
910 | ||
911 | Most (newer?) models seem to follow this pattern: | |
78f81cc4 | 912 | |
b02f1651 MCC |
913 | - 1: CPU |
914 | - 2: (depends on model) | |
915 | - 3: (depends on model) | |
916 | - 4: GPU | |
917 | - 5: Main battery: main sensor | |
918 | - 6: Bay battery: main sensor | |
919 | - 7: Main battery: secondary sensor | |
920 | - 8: Bay battery: secondary sensor | |
921 | - 9-15: (depends on model) | |
60eb0b35 HMH |
922 | |
923 | For the R51 (source: Thomas Gruber): | |
b02f1651 MCC |
924 | |
925 | - 2: Mini-PCI | |
926 | - 3: Internal HDD | |
60eb0b35 HMH |
927 | |
928 | For the T43, T43/p (source: Shmidoax/Thinkwiki.org) | |
6b2484e1 | 929 | https://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p |
b02f1651 MCC |
930 | |
931 | - 2: System board, left side (near PCMCIA slot), reported as HDAPS temp | |
932 | - 3: PCMCIA slot | |
933 | - 9: MCH (northbridge) to DRAM Bus | |
934 | - 10: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI | |
935 | card, under touchpad | |
936 | - 11: Power regulator, underside of system board, below F2 key | |
78f81cc4 | 937 | |
88679a15 | 938 | The A31 has a very atypical layout for the thermal sensors |
6b2484e1 | 939 | (source: Milos Popovic, https://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31) |
88679a15 | 940 | |
b02f1651 MCC |
941 | - 1: CPU |
942 | - 2: Main Battery: main sensor | |
943 | - 3: Power Converter | |
944 | - 4: Bay Battery: main sensor | |
945 | - 5: MCH (northbridge) | |
946 | - 6: PCMCIA/ambient | |
947 | - 7: Main Battery: secondary sensor | |
948 | - 8: Bay Battery: secondary sensor | |
949 | ||
950 | ||
951 | Procfs notes | |
952 | ^^^^^^^^^^^^ | |
78f81cc4 | 953 | |
2c37aa4e HMH |
954 | Readings from sensors that are not available return -128. |
955 | No commands can be written to this file. | |
956 | ||
b02f1651 MCC |
957 | Sysfs notes |
958 | ^^^^^^^^^^^ | |
959 | ||
2c37aa4e HMH |
960 | Sensors that are not available return the ENXIO error. This |
961 | status may change at runtime, as there are hotplug thermal | |
962 | sensors, like those inside the batteries and docks. | |
963 | ||
964 | thinkpad-acpi thermal sensors are reported through the hwmon | |
965 | subsystem, and follow all of the hwmon guidelines at | |
966 | Documentation/hwmon. | |
967 | ||
a420e464 TR |
968 | EXPERIMENTAL: Embedded controller register dump |
969 | ----------------------------------------------- | |
2c37aa4e | 970 | |
a420e464 TR |
971 | This feature is not included in the thinkpad driver anymore. |
972 | Instead the EC can be accessed through /sys/kernel/debug/ec with | |
973 | a userspace tool which can be found here: | |
974 | ftp://ftp.suse.com/pub/people/trenn/sources/ec | |
78f81cc4 | 975 | |
a420e464 TR |
976 | Use it to determine the register holding the fan |
977 | speed on some models. To do that, do the following: | |
b02f1651 | 978 | |
78f81cc4 BD |
979 | - make sure the battery is fully charged |
980 | - make sure the fan is running | |
a420e464 TR |
981 | - use above mentioned tool to read out the EC |
982 | ||
983 | Often fan and temperature values vary between | |
78f81cc4 BD |
984 | readings. Since temperatures don't change vary fast, you can take |
985 | several quick dumps to eliminate them. | |
986 | ||
987 | You can use a similar method to figure out the meaning of other | |
988 | embedded controller registers - e.g. make sure nothing else changes | |
989 | except the charging or discharging battery to determine which | |
990 | registers contain the current battery capacity, etc. If you experiment | |
991 | with this, do send me your results (including some complete dumps with | |
992 | a description of the conditions when they were taken.) | |
993 | ||
078ac19e | 994 | |
7d5a015e HMH |
995 | LCD brightness control |
996 | ---------------------- | |
997 | ||
998 | procfs: /proc/acpi/ibm/brightness | |
b02f1651 | 999 | |
7d5a015e | 1000 | sysfs backlight device "thinkpad_screen" |
78f81cc4 BD |
1001 | |
1002 | This feature allows software control of the LCD brightness on ThinkPad | |
7d5a015e HMH |
1003 | models which don't have a hardware brightness slider. |
1004 | ||
078ac19e HMH |
1005 | It has some limitations: the LCD backlight cannot be actually turned |
1006 | on or off by this interface, it just controls the backlight brightness | |
1007 | level. | |
a3f104c0 HMH |
1008 | |
1009 | On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control | |
1010 | has eight brightness levels, ranging from 0 to 7. Some of the levels | |
1011 | may not be distinct. Later Lenovo models that implement the ACPI | |
1012 | display backlight brightness control methods have 16 levels, ranging | |
1013 | from 0 to 15. | |
1014 | ||
d7880f10 HMH |
1015 | For IBM ThinkPads, there are two interfaces to the firmware for direct |
1016 | brightness control, EC and UCMS (or CMOS). To select which one should be | |
1017 | used, use the brightness_mode module parameter: brightness_mode=1 selects | |
1018 | EC mode, brightness_mode=2 selects UCMS mode, brightness_mode=3 selects EC | |
1019 | mode with NVRAM backing (so that brightness changes are remembered across | |
1020 | shutdown/reboot). | |
0e501834 HMH |
1021 | |
1022 | The driver tries to select which interface to use from a table of | |
1023 | defaults for each ThinkPad model. If it makes a wrong choice, please | |
1024 | report this as a bug, so that we can fix it. | |
a3f104c0 | 1025 | |
d7880f10 HMH |
1026 | Lenovo ThinkPads only support brightness_mode=2 (UCMS). |
1027 | ||
a3f104c0 HMH |
1028 | When display backlight brightness controls are available through the |
1029 | standard ACPI interface, it is best to use it instead of this direct | |
e11e211a HMH |
1030 | ThinkPad-specific interface. The driver will disable its native |
1031 | backlight brightness control interface if it detects that the standard | |
1032 | ACPI interface is available in the ThinkPad. | |
24d3b774 | 1033 | |
217f0963 HMH |
1034 | If you want to use the thinkpad-acpi backlight brightness control |
1035 | instead of the generic ACPI video backlight brightness control for some | |
1036 | reason, you should use the acpi_backlight=vendor kernel parameter. | |
1037 | ||
87cc537a HMH |
1038 | The brightness_enable module parameter can be used to control whether |
1039 | the LCD brightness control feature will be enabled when available. | |
e11e211a HMH |
1040 | brightness_enable=0 forces it to be disabled. brightness_enable=1 |
1041 | forces it to be enabled when available, even if the standard ACPI | |
1042 | interface is also available. | |
87cc537a | 1043 | |
b02f1651 MCC |
1044 | Procfs notes |
1045 | ^^^^^^^^^^^^ | |
7d5a015e | 1046 | |
b02f1651 | 1047 | The available commands are:: |
78f81cc4 BD |
1048 | |
1049 | echo up >/proc/acpi/ibm/brightness | |
1050 | echo down >/proc/acpi/ibm/brightness | |
1051 | echo 'level <level>' >/proc/acpi/ibm/brightness | |
1052 | ||
b02f1651 MCC |
1053 | Sysfs notes |
1054 | ^^^^^^^^^^^ | |
7d5a015e | 1055 | |
a3f104c0 HMH |
1056 | The interface is implemented through the backlight sysfs class, which is |
1057 | poorly documented at this time. | |
7d5a015e | 1058 | |
a3f104c0 HMH |
1059 | Locate the thinkpad_screen device under /sys/class/backlight, and inside |
1060 | it there will be the following attributes: | |
7d5a015e HMH |
1061 | |
1062 | max_brightness: | |
1063 | Reads the maximum brightness the hardware can be set to. | |
1064 | The minimum is always zero. | |
1065 | ||
1066 | actual_brightness: | |
1067 | Reads what brightness the screen is set to at this instant. | |
1068 | ||
1069 | brightness: | |
a3f104c0 HMH |
1070 | Writes request the driver to change brightness to the |
1071 | given value. Reads will tell you what brightness the | |
1072 | driver is trying to set the display to when "power" is set | |
1073 | to zero and the display has not been dimmed by a kernel | |
1074 | power management event. | |
7d5a015e HMH |
1075 | |
1076 | power: | |
a3f104c0 HMH |
1077 | power management mode, where 0 is "display on", and 1 to 3 |
1078 | will dim the display backlight to brightness level 0 | |
1079 | because thinkpad-acpi cannot really turn the backlight | |
1080 | off. Kernel power management events can temporarily | |
1081 | increase the current power management level, i.e. they can | |
1082 | dim the display. | |
7d5a015e | 1083 | |
78f81cc4 | 1084 | |
b5972796 HMH |
1085 | WARNING: |
1086 | ||
1087 | Whatever you do, do NOT ever call thinkpad-acpi backlight-level change | |
1088 | interface and the ACPI-based backlight level change interface | |
1089 | (available on newer BIOSes, and driven by the Linux ACPI video driver) | |
1090 | at the same time. The two will interact in bad ways, do funny things, | |
1091 | and maybe reduce the life of the backlight lamps by needlessly kicking | |
1092 | its level up and down at every change. | |
1093 | ||
078ac19e | 1094 | |
169220f8 HMH |
1095 | Volume control (Console Audio control) |
1096 | -------------------------------------- | |
329e4e18 HMH |
1097 | |
1098 | procfs: /proc/acpi/ibm/volume | |
b02f1651 | 1099 | |
0d204c34 | 1100 | ALSA: "ThinkPad Console Audio Control", default ID: "ThinkPadEC" |
78f81cc4 | 1101 | |
c7ac6291 HMH |
1102 | NOTE: by default, the volume control interface operates in read-only |
1103 | mode, as it is supposed to be used for on-screen-display purposes. | |
1104 | The read/write mode can be enabled through the use of the | |
1105 | "volume_control=1" module parameter. | |
1106 | ||
1107 | NOTE: distros are urged to not enable volume_control by default, this | |
1108 | should be done by the local admin only. The ThinkPad UI is for the | |
1109 | console audio control to be done through the volume keys only, and for | |
1110 | the desktop environment to just provide on-screen-display feedback. | |
1111 | Software volume control should be done only in the main AC97/HDA | |
1112 | mixer. | |
1113 | ||
169220f8 | 1114 | |
b02f1651 MCC |
1115 | About the ThinkPad Console Audio control |
1116 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
169220f8 HMH |
1117 | |
1118 | ThinkPads have a built-in amplifier and muting circuit that drives the | |
1119 | console headphone and speakers. This circuit is after the main AC97 | |
1120 | or HDA mixer in the audio path, and under exclusive control of the | |
1121 | firmware. | |
1122 | ||
1123 | ThinkPads have three special hotkeys to interact with the console | |
1124 | audio control: volume up, volume down and mute. | |
1125 | ||
1126 | It is worth noting that the normal way the mute function works (on | |
1127 | ThinkPads that do not have a "mute LED") is: | |
1128 | ||
1129 | 1. Press mute to mute. It will *always* mute, you can press it as | |
1130 | many times as you want, and the sound will remain mute. | |
1131 | ||
1132 | 2. Press either volume key to unmute the ThinkPad (it will _not_ | |
1133 | change the volume, it will just unmute). | |
1134 | ||
1135 | This is a very superior design when compared to the cheap software-only | |
1136 | mute-toggle solution found on normal consumer laptops: you can be | |
1137 | absolutely sure the ThinkPad will not make noise if you press the mute | |
1138 | button, no matter the previous state. | |
1139 | ||
1140 | The IBM ThinkPads, and the earlier Lenovo ThinkPads have variable-gain | |
1141 | amplifiers driving the speakers and headphone output, and the firmware | |
1142 | also handles volume control for the headphone and speakers on these | |
1143 | ThinkPads without any help from the operating system (this volume | |
1144 | control stage exists after the main AC97 or HDA mixer in the audio | |
1145 | path). | |
1146 | ||
1147 | The newer Lenovo models only have firmware mute control, and depend on | |
1148 | the main HDA mixer to do volume control (which is done by the operating | |
1149 | system). In this case, the volume keys are filtered out for unmute | |
1150 | key press (there are some firmware bugs in this area) and delivered as | |
1151 | normal key presses to the operating system (thinkpad-acpi is not | |
1152 | involved). | |
1153 | ||
1154 | ||
b02f1651 MCC |
1155 | The ThinkPad-ACPI volume control |
1156 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
169220f8 HMH |
1157 | |
1158 | The preferred way to interact with the Console Audio control is the | |
1159 | ALSA interface. | |
1160 | ||
1161 | The legacy procfs interface allows one to read the current state, | |
b02f1651 | 1162 | and if volume control is enabled, accepts the following commands:: |
78f81cc4 BD |
1163 | |
1164 | echo up >/proc/acpi/ibm/volume | |
1165 | echo down >/proc/acpi/ibm/volume | |
1166 | echo mute >/proc/acpi/ibm/volume | |
a112ceee | 1167 | echo unmute >/proc/acpi/ibm/volume |
78f81cc4 BD |
1168 | echo 'level <level>' >/proc/acpi/ibm/volume |
1169 | ||
329e4e18 | 1170 | The <level> number range is 0 to 14 although not all of them may be |
169220f8 | 1171 | distinct. To unmute the volume after the mute command, use either the |
a112ceee HMH |
1172 | up or down command (the level command will not unmute the volume), or |
1173 | the unmute command. | |
1174 | ||
a112ceee HMH |
1175 | You can use the volume_capabilities parameter to tell the driver |
1176 | whether your thinkpad has volume control or mute-only control: | |
1177 | volume_capabilities=1 for mixers with mute and volume control, | |
1178 | volume_capabilities=2 for mixers with only mute control. | |
1179 | ||
1180 | If the driver misdetects the capabilities for your ThinkPad model, | |
1181 | please report this to ibm-acpi-devel@lists.sourceforge.net, so that we | |
1182 | can update the driver. | |
1183 | ||
329e4e18 HMH |
1184 | There are two strategies for volume control. To select which one |
1185 | should be used, use the volume_mode module parameter: volume_mode=1 | |
1186 | selects EC mode, and volume_mode=3 selects EC mode with NVRAM backing | |
1187 | (so that volume/mute changes are remembered across shutdown/reboot). | |
1188 | ||
1189 | The driver will operate in volume_mode=3 by default. If that does not | |
1190 | work well on your ThinkPad model, please report this to | |
1191 | ibm-acpi-devel@lists.sourceforge.net. | |
1192 | ||
0d204c34 HMH |
1193 | The driver supports the standard ALSA module parameters. If the ALSA |
1194 | mixer is disabled, the driver will disable all volume functionality. | |
078ac19e HMH |
1195 | |
1196 | ||
ecf2a80a HMH |
1197 | Fan control and monitoring: fan speed, fan enable/disable |
1198 | --------------------------------------------------------- | |
fe98a52c HMH |
1199 | |
1200 | procfs: /proc/acpi/ibm/fan | |
b02f1651 MCC |
1201 | |
1202 | sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1, pwm1_enable, fan2_input | |
1203 | ||
7fd40029 | 1204 | sysfs hwmon driver attributes: fan_watchdog |
78f81cc4 | 1205 | |
b02f1651 MCC |
1206 | NOTE NOTE NOTE: |
1207 | fan control operations are disabled by default for | |
1208 | safety reasons. To enable them, the module parameter "fan_control=1" | |
1209 | must be given to thinkpad-acpi. | |
78f81cc4 | 1210 | |
a12095c2 HMH |
1211 | This feature attempts to show the current fan speed, control mode and |
1212 | other fan data that might be available. The speed is read directly | |
1213 | from the hardware registers of the embedded controller. This is known | |
ecf2a80a | 1214 | to work on later R, T, X and Z series ThinkPads but may show a bogus |
a12095c2 HMH |
1215 | value on other models. |
1216 | ||
d7377247 HMH |
1217 | Some Lenovo ThinkPads support a secondary fan. This fan cannot be |
1218 | controlled separately, it shares the main fan control. | |
1219 | ||
b02f1651 MCC |
1220 | Fan levels |
1221 | ^^^^^^^^^^ | |
a12095c2 | 1222 | |
fe98a52c HMH |
1223 | Most ThinkPad fans work in "levels" at the firmware interface. Level 0 |
1224 | stops the fan. The higher the level, the higher the fan speed, although | |
1225 | adjacent levels often map to the same fan speed. 7 is the highest | |
1226 | level, where the fan reaches the maximum recommended speed. | |
78f81cc4 | 1227 | |
fe98a52c HMH |
1228 | Level "auto" means the EC changes the fan level according to some |
1229 | internal algorithm, usually based on readings from the thermal sensors. | |
78f81cc4 | 1230 | |
fe98a52c HMH |
1231 | There is also a "full-speed" level, also known as "disengaged" level. |
1232 | In this level, the EC disables the speed-locked closed-loop fan control, | |
1233 | and drives the fan as fast as it can go, which might exceed hardware | |
1234 | limits, so use this level with caution. | |
78f81cc4 | 1235 | |
fe98a52c HMH |
1236 | The fan usually ramps up or down slowly from one speed to another, and |
1237 | it is normal for the EC to take several seconds to react to fan | |
1238 | commands. The full-speed level may take up to two minutes to ramp up to | |
1239 | maximum speed, and in some ThinkPads, the tachometer readings go stale | |
1240 | while the EC is transitioning to the full-speed level. | |
a12095c2 | 1241 | |
78f81cc4 | 1242 | WARNING WARNING WARNING: do not leave the fan disabled unless you are |
a12095c2 HMH |
1243 | monitoring all of the temperature sensor readings and you are ready to |
1244 | enable it if necessary to avoid overheating. | |
1245 | ||
1246 | An enabled fan in level "auto" may stop spinning if the EC decides the | |
1247 | ThinkPad is cool enough and doesn't need the extra airflow. This is | |
01dd2fbf | 1248 | normal, and the EC will spin the fan up if the various thermal readings |
a12095c2 HMH |
1249 | rise too much. |
1250 | ||
1251 | On the X40, this seems to depend on the CPU and HDD temperatures. | |
1252 | Specifically, the fan is turned on when either the CPU temperature | |
1253 | climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The | |
1254 | fan is turned off when the CPU temperature drops to 49 degrees and the | |
1255 | HDD temperature drops to 41 degrees. These thresholds cannot | |
1256 | currently be controlled. | |
1257 | ||
fe98a52c HMH |
1258 | The ThinkPad's ACPI DSDT code will reprogram the fan on its own when |
1259 | certain conditions are met. It will override any fan programming done | |
1260 | through thinkpad-acpi. | |
1261 | ||
1262 | The thinkpad-acpi kernel driver can be programmed to revert the fan | |
1263 | level to a safe setting if userspace does not issue one of the procfs | |
1264 | fan commands: "enable", "disable", "level" or "watchdog", or if there | |
1265 | are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is | |
1266 | set to 1, manual mode) within a configurable amount of time of up to | |
1267 | 120 seconds. This functionality is called fan safety watchdog. | |
1268 | ||
1269 | Note that the watchdog timer stops after it enables the fan. It will be | |
1270 | rearmed again automatically (using the same interval) when one of the | |
1271 | above mentioned fan commands is received. The fan watchdog is, | |
1272 | therefore, not suitable to protect against fan mode changes made through | |
1273 | means other than the "enable", "disable", and "level" procfs fan | |
1274 | commands, or the hwmon fan control sysfs interface. | |
1275 | ||
b02f1651 MCC |
1276 | Procfs notes |
1277 | ^^^^^^^^^^^^ | |
fe98a52c | 1278 | |
b02f1651 | 1279 | The fan may be enabled or disabled with the following commands:: |
fe98a52c HMH |
1280 | |
1281 | echo enable >/proc/acpi/ibm/fan | |
1282 | echo disable >/proc/acpi/ibm/fan | |
1283 | ||
1284 | Placing a fan on level 0 is the same as disabling it. Enabling a fan | |
1285 | will try to place it in a safe level if it is too slow or disabled. | |
1286 | ||
b02f1651 | 1287 | The fan level can be controlled with the command:: |
78f81cc4 | 1288 | |
fe98a52c | 1289 | echo 'level <level>' > /proc/acpi/ibm/fan |
a12095c2 | 1290 | |
fe98a52c HMH |
1291 | Where <level> is an integer from 0 to 7, or one of the words "auto" or |
1292 | "full-speed" (without the quotes). Not all ThinkPads support the "auto" | |
1293 | and "full-speed" levels. The driver accepts "disengaged" as an alias for | |
1294 | "full-speed", and reports it as "disengaged" for backwards | |
1295 | compatibility. | |
78f81cc4 BD |
1296 | |
1297 | On the X31 and X40 (and ONLY on those models), the fan speed can be | |
fe98a52c | 1298 | controlled to a certain degree. Once the fan is running, it can be |
b02f1651 | 1299 | forced to run faster or slower with the following command:: |
78f81cc4 | 1300 | |
fe98a52c | 1301 | echo 'speed <speed>' > /proc/acpi/ibm/fan |
78f81cc4 | 1302 | |
fe98a52c HMH |
1303 | The sustainable range of fan speeds on the X40 appears to be from about |
1304 | 3700 to about 7350. Values outside this range either do not have any | |
1305 | effect or the fan speed eventually settles somewhere in that range. The | |
1306 | fan cannot be stopped or started with this command. This functionality | |
1307 | is incomplete, and not available through the sysfs interface. | |
78f81cc4 | 1308 | |
b02f1651 | 1309 | To program the safety watchdog, use the "watchdog" command:: |
fe98a52c HMH |
1310 | |
1311 | echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan | |
1312 | ||
1313 | If you want to disable the watchdog, use 0 as the interval. | |
1314 | ||
b02f1651 MCC |
1315 | Sysfs notes |
1316 | ^^^^^^^^^^^ | |
fe98a52c HMH |
1317 | |
1318 | The sysfs interface follows the hwmon subsystem guidelines for the most | |
1319 | part, and the exception is the fan safety watchdog. | |
1320 | ||
b39fe582 HMH |
1321 | Writes to any of the sysfs attributes may return the EINVAL error if |
1322 | that operation is not supported in a given ThinkPad or if the parameter | |
1323 | is out-of-bounds, and EPERM if it is forbidden. They may also return | |
1324 | EINTR (interrupted system call), and EIO (I/O error while trying to talk | |
1325 | to the firmware). | |
1326 | ||
1327 | Features not yet implemented by the driver return ENOSYS. | |
1328 | ||
fe98a52c | 1329 | hwmon device attribute pwm1_enable: |
b02f1651 MCC |
1330 | - 0: PWM offline (fan is set to full-speed mode) |
1331 | - 1: Manual PWM control (use pwm1 to set fan level) | |
1332 | - 2: Hardware PWM control (EC "auto" mode) | |
1333 | - 3: reserved (Software PWM control, not implemented yet) | |
fe98a52c | 1334 | |
b39fe582 HMH |
1335 | Modes 0 and 2 are not supported by all ThinkPads, and the |
1336 | driver is not always able to detect this. If it does know a | |
1337 | mode is unsupported, it will return -EINVAL. | |
fe98a52c HMH |
1338 | |
1339 | hwmon device attribute pwm1: | |
1340 | Fan level, scaled from the firmware values of 0-7 to the hwmon | |
1341 | scale of 0-255. 0 means fan stopped, 255 means highest normal | |
1342 | speed (level 7). | |
1343 | ||
1344 | This attribute only commands the fan if pmw1_enable is set to 1 | |
1345 | (manual PWM control). | |
1346 | ||
1347 | hwmon device attribute fan1_input: | |
1348 | Fan tachometer reading, in RPM. May go stale on certain | |
1349 | ThinkPads while the EC transitions the PWM to offline mode, | |
1350 | which can take up to two minutes. May return rubbish on older | |
1351 | ThinkPads. | |
1352 | ||
d7377247 HMH |
1353 | hwmon device attribute fan2_input: |
1354 | Fan tachometer reading, in RPM, for the secondary fan. | |
1355 | Available only on some ThinkPads. If the secondary fan is | |
1356 | not installed, will always read 0. | |
1357 | ||
7fd40029 | 1358 | hwmon driver attribute fan_watchdog: |
fe98a52c HMH |
1359 | Fan safety watchdog timer interval, in seconds. Minimum is |
1360 | 1 second, maximum is 120 seconds. 0 disables the watchdog. | |
1361 | ||
1362 | To stop the fan: set pwm1 to zero, and pwm1_enable to 1. | |
1363 | ||
1364 | To start the fan in a safe mode: set pwm1_enable to 2. If that fails | |
b39fe582 HMH |
1365 | with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255 |
1366 | would be the safest choice, though). | |
1da177e4 | 1367 | |
38f996ed | 1368 | |
9662e080 JF |
1369 | WAN |
1370 | --- | |
d3a6ade4 HMH |
1371 | |
1372 | procfs: /proc/acpi/ibm/wan | |
b02f1651 | 1373 | |
0e74dc26 | 1374 | sysfs device attribute: wwan_enable (deprecated) |
b02f1651 | 1375 | |
0e74dc26 | 1376 | sysfs rfkill class: switch "tpacpi_wwan_sw" |
28b779d1 | 1377 | |
078ac19e HMH |
1378 | This feature shows the presence and current state of the built-in |
1379 | Wireless WAN device. | |
1380 | ||
1381 | If the ThinkPad supports it, the WWAN state is stored in NVRAM, | |
1382 | so it is kept across reboots and power-off. | |
d3a6ade4 | 1383 | |
d0788cfb HMH |
1384 | It was tested on a Lenovo ThinkPad X60. It should probably work on other |
1385 | ThinkPad models which come with this module installed. | |
d3a6ade4 | 1386 | |
b02f1651 MCC |
1387 | Procfs notes |
1388 | ^^^^^^^^^^^^ | |
d3a6ade4 | 1389 | |
b02f1651 | 1390 | If the W-WAN card is installed, the following commands can be used:: |
28b779d1 SS |
1391 | |
1392 | echo enable > /proc/acpi/ibm/wan | |
1393 | echo disable > /proc/acpi/ibm/wan | |
1394 | ||
b02f1651 MCC |
1395 | Sysfs notes |
1396 | ^^^^^^^^^^^ | |
d3a6ade4 HMH |
1397 | |
1398 | If the W-WAN card is installed, it can be enabled / | |
cc4c24e1 | 1399 | disabled through the "wwan_enable" thinkpad-acpi device |
d3a6ade4 HMH |
1400 | attribute, and its current status can also be queried. |
1401 | ||
1402 | enable: | |
b02f1651 MCC |
1403 | - 0: disables WWAN card / WWAN card is disabled |
1404 | - 1: enables WWAN card / WWAN card is enabled. | |
d3a6ade4 | 1405 | |
0e74dc26 HMH |
1406 | Note: this interface has been superseded by the generic rfkill |
1407 | class. It has been deprecated, and it will be removed in year | |
1408 | 2010. | |
1409 | ||
1410 | rfkill controller switch "tpacpi_wwan_sw": refer to | |
baa293e9 | 1411 | Documentation/driver-api/rfkill.rst for details. |
1da177e4 | 1412 | |
078ac19e | 1413 | |
110ea1d8 AS |
1414 | LCD Shadow control |
1415 | ------------------ | |
1416 | ||
1417 | procfs: /proc/acpi/ibm/lcdshadow | |
1418 | ||
1419 | Some newer T480s and T490s ThinkPads provide a feature called | |
1420 | PrivacyGuard. By turning this feature on, the usable vertical and | |
1421 | horizontal viewing angles of the LCD can be limited (as if some privacy | |
1422 | screen was applied manually in front of the display). | |
1423 | ||
1424 | procfs notes | |
1425 | ^^^^^^^^^^^^ | |
1426 | ||
1427 | The available commands are:: | |
1428 | ||
1429 | echo '0' >/proc/acpi/ibm/lcdshadow | |
1430 | echo '1' >/proc/acpi/ibm/lcdshadow | |
1431 | ||
1432 | The first command ensures the best viewing angle and the latter one turns | |
1433 | on the feature, restricting the viewing angles. | |
1434 | ||
1435 | ||
acf7f4a5 | 1436 | DYTC Lapmode sensor |
92001bc0 | 1437 | ------------------- |
acf7f4a5 MP |
1438 | |
1439 | sysfs: dytc_lapmode | |
1440 | ||
1441 | Newer thinkpads and mobile workstations have the ability to determine if | |
1442 | the device is in deskmode or lapmode. This feature is used by user space | |
1443 | to decide if WWAN transmission can be increased to maximum power and is | |
1444 | also useful for understanding the different thermal modes available as | |
1445 | they differ between desk and lap mode. | |
1446 | ||
1447 | The property is read-only. If the platform doesn't have support the sysfs | |
1448 | class is not created. | |
1449 | ||
0045c0aa HMH |
1450 | EXPERIMENTAL: UWB |
1451 | ----------------- | |
1452 | ||
aa8820cc | 1453 | This feature is considered EXPERIMENTAL because it has not been extensively |
0045c0aa HMH |
1454 | tested and validated in various ThinkPad models yet. The feature may not |
1455 | work as expected. USE WITH CAUTION! To use this feature, you need to supply | |
1456 | the experimental=1 parameter when loading the module. | |
1457 | ||
1458 | sysfs rfkill class: switch "tpacpi_uwb_sw" | |
1459 | ||
1460 | This feature exports an rfkill controller for the UWB device, if one is | |
1461 | present and enabled in the BIOS. | |
1462 | ||
b02f1651 MCC |
1463 | Sysfs notes |
1464 | ^^^^^^^^^^^ | |
0045c0aa HMH |
1465 | |
1466 | rfkill controller switch "tpacpi_uwb_sw": refer to | |
baa293e9 | 1467 | Documentation/driver-api/rfkill.rst for details. |
0045c0aa | 1468 | |
b790ceeb BN |
1469 | Adaptive keyboard |
1470 | ----------------- | |
1471 | ||
1472 | sysfs device attribute: adaptive_kbd_mode | |
1473 | ||
1474 | This sysfs attribute controls the keyboard "face" that will be shown on the | |
1475 | Lenovo X1 Carbon 2nd gen (2014)'s adaptive keyboard. The value can be read | |
1476 | and set. | |
1477 | ||
b02f1651 MCC |
1478 | - 1 = Home mode |
1479 | - 2 = Web-browser mode | |
1480 | - 3 = Web-conference mode | |
1481 | - 4 = Function mode | |
1482 | - 5 = Layflat mode | |
b790ceeb BN |
1483 | |
1484 | For more details about which buttons will appear depending on the mode, please | |
1485 | review the laptop's user guide: | |
1486 | http://www.lenovo.com/shop/americas/content/user_guides/x1carbon_2_ug_en.pdf | |
078ac19e | 1487 | |
61781298 BP |
1488 | Battery charge control |
1489 | ---------------------- | |
1490 | ||
1491 | sysfs attributes: | |
1492 | /sys/class/power_supply/BAT*/charge_control_{start,end}_threshold | |
1493 | ||
1494 | These two attributes are created for those batteries that are supported by the | |
1495 | driver. They enable the user to control the battery charge thresholds of the | |
1496 | given battery. Both values may be read and set. `charge_control_start_threshold` | |
1497 | accepts an integer between 0 and 99 (inclusive); this value represents a battery | |
1498 | percentage level, below which charging will begin. `charge_control_end_threshold` | |
1499 | accepts an integer between 1 and 100 (inclusive); this value represents a battery | |
1500 | percentage level, above which charging will stop. | |
1501 | ||
1502 | The exact semantics of the attributes may be found in | |
1503 | Documentation/ABI/testing/sysfs-class-power. | |
1504 | ||
78f81cc4 BD |
1505 | Multiple Commands, Module Parameters |
1506 | ------------------------------------ | |
1da177e4 LT |
1507 | |
1508 | Multiple commands can be written to the proc files in one shot by | |
b02f1651 | 1509 | separating them with commas, for example:: |
1da177e4 LT |
1510 | |
1511 | echo enable,0xffff > /proc/acpi/ibm/hotkey | |
1512 | echo lcd_disable,crt_enable > /proc/acpi/ibm/video | |
1513 | ||
643f12db | 1514 | Commands can also be specified when loading the thinkpad-acpi module, |
b02f1651 | 1515 | for example:: |
1da177e4 | 1516 | |
643f12db | 1517 | modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable |
1da177e4 | 1518 | |
078ac19e | 1519 | |
132ce091 HMH |
1520 | Enabling debugging output |
1521 | ------------------------- | |
1522 | ||
0f035b8e | 1523 | The module takes a debug parameter which can be used to selectively |
b02f1651 | 1524 | enable various classes of debugging output, for example:: |
132ce091 | 1525 | |
5f24927f | 1526 | modprobe thinkpad_acpi debug=0xffff |
132ce091 HMH |
1527 | |
1528 | will enable all debugging output classes. It takes a bitmask, so | |
1529 | to enable more than one output class, just add their values. | |
1530 | ||
b02f1651 | 1531 | ============= ====================================== |
fe08bc4b | 1532 | Debug bitmask Description |
b02f1651 | 1533 | ============= ====================================== |
73a94d86 HMH |
1534 | 0x8000 Disclose PID of userspace programs |
1535 | accessing some functions of the driver | |
fe08bc4b HMH |
1536 | 0x0001 Initialization and probing |
1537 | 0x0002 Removal | |
bee4cd9b HMH |
1538 | 0x0004 RF Transmitter control (RFKILL) |
1539 | (bluetooth, WWAN, UWB...) | |
56e2c200 | 1540 | 0x0008 HKEY event interface, hotkeys |
74a60c0f | 1541 | 0x0010 Fan control |
0e501834 | 1542 | 0x0020 Backlight brightness |
329e4e18 | 1543 | 0x0040 Audio mixer/volume control |
b02f1651 | 1544 | ============= ====================================== |
fe08bc4b | 1545 | |
132ce091 HMH |
1546 | There is also a kernel build option to enable more debugging |
1547 | information, which may be necessary to debug driver problems. | |
0dcef77c | 1548 | |
176750d6 HMH |
1549 | The level of debugging information output by the driver can be changed |
1550 | at runtime through sysfs, using the driver attribute debug_level. The | |
1551 | attribute takes the same bitmask as the debug module parameter above. | |
1552 | ||
078ac19e | 1553 | |
0dcef77c HMH |
1554 | Force loading of module |
1555 | ----------------------- | |
1556 | ||
1557 | If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify | |
1558 | the module parameter force_load=1. Regardless of whether this works or | |
1559 | not, please contact ibm-acpi-devel@lists.sourceforge.net with a report. | |
176750d6 HMH |
1560 | |
1561 | ||
b02f1651 MCC |
1562 | Sysfs interface changelog |
1563 | ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
176750d6 | 1564 | |
b02f1651 | 1565 | ========= =============================================================== |
176750d6 HMH |
1566 | 0x000100: Initial sysfs support, as a single platform driver and |
1567 | device. | |
94b08713 HMH |
1568 | 0x000200: Hot key support for 32 hot keys, and radio slider switch |
1569 | support. | |
741553c2 HMH |
1570 | 0x010000: Hot keys are now handled by default over the input |
1571 | layer, the radio switch generates input event EV_RADIO, | |
1572 | and the driver enables hot key handling by default in | |
1573 | the firmware. | |
7fd40029 HMH |
1574 | |
1575 | 0x020000: ABI fix: added a separate hwmon platform device and | |
1576 | driver, which must be located by name (thinkpad) | |
1577 | and the hwmon class for libsensors4 (lm-sensors 3) | |
1578 | compatibility. Moved all hwmon attributes to this | |
1579 | new platform device. | |
01e88f25 HMH |
1580 | |
1581 | 0x020100: Marker for thinkpad-acpi with hot key NVRAM polling | |
1582 | support. If you must, use it to know you should not | |
0211a9c8 | 1583 | start a userspace NVRAM poller (allows to detect when |
01e88f25 HMH |
1584 | NVRAM is compiled out by the user because it is |
1585 | unneeded/undesired in the first place). | |
1586 | 0x020101: Marker for thinkpad-acpi with hot key NVRAM polling | |
d0788cfb | 1587 | and proper hotkey_mask semantics (version 8 of the |
01e88f25 HMH |
1588 | NVRAM polling patch). Some development snapshots of |
1589 | 0.18 had an earlier version that did strange things | |
1590 | to hotkey_mask. | |
50ebec09 HMH |
1591 | |
1592 | 0x020200: Add poll()/select() support to the following attributes: | |
1593 | hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason | |
2586d566 HMH |
1594 | |
1595 | 0x020300: hotkey enable/disable support removed, attributes | |
1596 | hotkey_bios_enabled and hotkey_enable deprecated and | |
1597 | marked for removal. | |
f21179a4 HMH |
1598 | |
1599 | 0x020400: Marker for 16 LEDs support. Also, LEDs that are known | |
1600 | to not exist in a given model are not registered with | |
1601 | the LED sysfs class anymore. | |
0d922e3b HMH |
1602 | |
1603 | 0x020500: Updated hotkey driver, hotkey_mask is always available | |
1604 | and it is always able to disable hot keys. Very old | |
1605 | thinkpads are properly supported. hotkey_bios_mask | |
1606 | is deprecated and marked for removal. | |
347a2686 HMH |
1607 | |
1608 | 0x020600: Marker for backlight change event support. | |
a112ceee HMH |
1609 | |
1610 | 0x020700: Support for mute-only mixers. | |
c7ac6291 | 1611 | Volume control in read-only mode by default. |
0d204c34 | 1612 | Marker for ALSA mixer support. |
6b99e356 SF |
1613 | |
1614 | 0x030000: Thermal and fan sysfs attributes were moved to the hwmon | |
1615 | device instead of being attached to the backing platform | |
1616 | device. | |
b02f1651 | 1617 | ========= =============================================================== |