blob: 00b6dfed573cf595594714df451621eb2f991893 [file] [log] [blame]
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001 ThinkPad ACPI Extras Driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07002
David Henningsson420f9732013-10-16 23:10:31 +02003 Version 0.25
4 October 16th, 2013
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
6 Borislav Deianov <borislav@users.sf.net>
Henrique de Moraes Holschuhc78d5c92007-07-18 23:45:47 -03007 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
8 http://ibm-acpi.sf.net/
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -030011This is a Linux driver for the IBM and Lenovo ThinkPad laptops. It
12supports various features of these laptops which are accessible
13through the ACPI and ACPI EC framework, but not otherwise fully
14supported by the generic Linux ACPI drivers.
15
16This driver used to be named ibm-acpi until kernel 2.6.21 and release
170.13-20070314. It used to be in the drivers/acpi tree, but it was
18moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel
Henrique de Moraes Holschuh9abf0ee2009-01-11 03:00:58 -0200192.6.22, and release 0.14. It was moved to drivers/platform/x86 for
Henrique de Moraes Holschuhaa2fbce2009-01-11 03:01:10 -020020kernel 2.6.29 and release 0.22.
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Henrique de Moraes Holschuh95e57ab2008-04-26 01:02:22 -030022The driver is named "thinkpad-acpi". In some places, like module
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +000023names and log messages, "thinkpad_acpi" is used because of userspace
24issues.
Henrique de Moraes Holschuh95e57ab2008-04-26 01:02:22 -030025
26"tpacpi" is used as a shorthand where "thinkpad-acpi" would be too
27long due to length limitations on some Linux kernel versions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29Status
30------
31
32The features currently supported are the following (see below for
33detailed description):
34
35 - Fn key combinations
36 - Bluetooth enable and disable
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -030037 - video output switching, expansion control
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 - ThinkLight on and off
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +000039 - CMOS/UCMS control
Borislav Deianov78f81cc2005-08-17 00:00:00 -040040 - LED control
41 - ACPI sounds
42 - temperature sensors
43 - Experimental: embedded controller register dump
Stefan Schmidt24f7ff02006-09-22 12:19:15 +020044 - LCD brightness control
45 - Volume control
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -030046 - Fan control and monitoring: fan speed, fan enable/disable
Jeremy Fitzhardinge9662e082008-08-27 21:04:49 -070047 - WAN enable and disable
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +000048 - UWB enable and disable
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50A compatibility table by model and feature is maintained on the web
51site, http://ibm-acpi.sf.net/. I appreciate any success or failure
52reports, especially if they add to or correct the compatibility table.
53Please include the following information in your report:
54
55 - ThinkPad model name
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +000056 - a copy of your ACPI tables, using the "acpidump" utility
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -030057 - a copy of the output of dmidecode, with serial numbers
58 and UUIDs masked off
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 - which driver features work and which don't
60 - the observed behavior of non-working features
61
62Any other comments or patches are also more than welcome.
63
64
65Installation
66------------
67
68If you are compiling this driver as included in the Linux kernel
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +000069sources, look for the CONFIG_THINKPAD_ACPI Kconfig option.
70It is located on the menu path: "Device Drivers" -> "X86 Platform
71Specific Device Drivers" -> "ThinkPad ACPI Laptop Extras".
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74Features
75--------
76
Henrique de Moraes Holschuh54ae1502007-04-24 11:48:12 -030077The driver exports two different interfaces to userspace, which can be
78used to access the features it provides. One is a legacy procfs-based
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +000079interface, which will be removed at some time in the future. The other
80is a new sysfs-based interface which is not complete yet.
Henrique de Moraes Holschuh54ae1502007-04-24 11:48:12 -030081
82The procfs interface creates the /proc/acpi/ibm directory. There is a
83file under that directory for each feature it supports. The procfs
84interface is mostly frozen, and will change very little if at all: it
85will not be extended to add any new functionality in the driver, instead
86all new functionality will be implemented on the sysfs interface.
87
88The sysfs interface tries to blend in the generic Linux sysfs subsystems
89and classes as much as possible. Since some of these subsystems are not
90yet ready or stabilized, it is expected that this interface will change,
91and any and all userspace programs must deal with it.
92
93
94Notes about the sysfs interface:
95
96Unlike what was done with the procfs interface, correctness when talking
97to the sysfs interfaces will be enforced, as will correctness in the
98thinkpad-acpi's implementation of sysfs interfaces.
99
100Also, any bugs in the thinkpad-acpi sysfs driver code or in the
101thinkpad-acpi's implementation of the sysfs interfaces will be fixed for
102maximum correctness, even if that means changing an interface in
103non-compatible ways. As these interfaces mature both in the kernel and
104in thinkpad-acpi, such changes should become quite rare.
105
106Applications interfacing to the thinkpad-acpi sysfs interfaces must
107follow all sysfs guidelines and correctly process all errors (the sysfs
108interface makes extensive use of errors). File descriptors and open /
109close operations to the sysfs inodes must also be properly implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300111The version of thinkpad-acpi's sysfs interface is exported by the driver
112as a driver attribute (see below).
113
114Sysfs driver attributes are on the driver's sysfs attribute space,
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000115for 2.6.23+ this is /sys/bus/platform/drivers/thinkpad_acpi/ and
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300116/sys/bus/platform/drivers/thinkpad_hwmon/
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300117
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300118Sysfs device attributes are on the thinkpad_acpi device sysfs attribute
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000119space, for 2.6.23+ this is /sys/devices/platform/thinkpad_acpi/.
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300120
121Sysfs device attributes for the sensors and fan are on the
122thinkpad_hwmon device's sysfs attribute space, but you should locate it
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000123looking for a hwmon device with the name attribute of "thinkpad", or
Stanislav Fomichev6b99e352017-06-20 20:45:13 -0700124better yet, through libsensors. For 4.14+ sysfs attributes were moved to the
125hwmon device (/sys/bus/platform/devices/thinkpad_hwmon/hwmon/hwmon? or
126/sys/class/hwmon/hwmon?).
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300127
128Driver version
129--------------
130
131procfs: /proc/acpi/ibm/driver
132sysfs driver attribute: version
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134The driver name and version. No commands can be written to this file.
135
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000136
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300137Sysfs interface version
138-----------------------
139
140sysfs driver attribute: interface_version
141
142Version of the thinkpad-acpi sysfs interface, as an unsigned long
143(output in hex format: 0xAAAABBCC), where:
144 AAAA - major revision
145 BB - minor revision
146 CC - bugfix revision
147
148The sysfs interface version changelog for the driver can be found at the
149end of this document. Changes to the sysfs interface done by the kernel
150subsystems are not documented here, nor are they tracked by this
151attribute.
152
Henrique de Moraes Holschuh94b08712007-07-18 23:45:32 -0300153Changes to the thinkpad-acpi sysfs interface are only considered
154non-experimental when they are submitted to Linux mainline, at which
155point the changes in this interface are documented and interface_version
156may be updated. If you are using any thinkpad-acpi features not yet
157sent to mainline for merging, you do so on your own risk: these features
158may disappear, or be implemented in a different and incompatible way by
159the time they are merged in Linux mainline.
160
161Changes that are backwards-compatible by nature (e.g. the addition of
162attributes that do not change the way the other attributes work) do not
163always warrant an update of interface_version. Therefore, one must
164expect that an attribute might not be there, and deal with it properly
165(an attribute not being there *is* a valid way to make it clear that a
166feature is not available in sysfs).
167
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000168
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300169Hot keys
170--------
171
172procfs: /proc/acpi/ibm/hotkey
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300173sysfs device attribute: hotkey_*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200175In a ThinkPad, the ACPI HKEY handler is responsible for communicating
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300176some important events and also keyboard hot key presses to the operating
177system. Enabling the hotkey functionality of thinkpad-acpi signals the
178firmware that such a driver is present, and modifies how the ThinkPad
179firmware will behave in many situations.
180
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000181The driver enables the HKEY ("hot key") event reporting automatically
182when loaded, and disables it when it is removed.
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300183
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000184The driver will report HKEY events in the following format:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 ibm/hotkey HKEY 00000080 0000xxxx
187
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000188Some of these events refer to hot key presses, but not all of them.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300189
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300190The driver will generate events over the input layer for hot keys and
191radio switches, and over the ACPI netlink layer for other events. The
192input layer support accepts the standard IOCTLs to remap the keycodes
193assigned to each hot key.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300194
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300195The hot key bit mask allows some control over which hot keys generate
196events. If a key is "masked" (bit set to 0 in the mask), the firmware
197will handle it. If it is "unmasked", it signals the firmware that
198thinkpad-acpi would prefer to handle it, if the firmware would be so
199kind to allow it (and it often doesn't!).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300201Not all bits in the mask can be modified. Not all bits that can be
202modified do anything. Not all hot keys can be individually controlled
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300203by the mask. Some models do not support the mask at all. The behaviour
204of the mask is, therefore, highly dependent on the ThinkPad model.
205
206The driver will filter out any unmasked hotkeys, so even if the firmware
207doesn't allow disabling an specific hotkey, the driver will not report
208events for unmasked hotkeys.
Henrique de Moraes Holschuhae92bd12007-07-18 23:45:29 -0300209
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300210Note that unmasking some keys prevents their default behavior. For
211example, if Fn+F5 is unmasked, that key will no longer enable/disable
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300212Bluetooth by itself in firmware.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300214Note also that not all Fn key combinations are supported through ACPI
215depending on the ThinkPad model and firmware version. On those
216ThinkPads, it is still possible to support some extra hotkeys by
217polling the "CMOS NVRAM" at least 10 times per second. The driver
218attempts to enables this functionality automatically when required.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300220procfs notes:
221
222The following commands can be written to the /proc/acpi/ibm/hotkey file:
223
Henrique de Moraes Holschuhae92bd12007-07-18 23:45:29 -0300224 echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
225 echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
226 ... any other 8-hex-digit mask ...
Henrique de Moraes Holschuh20c9aa42009-09-12 15:22:16 -0300227 echo reset > /proc/acpi/ibm/hotkey -- restore the recommended mask
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300228
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000229The following commands have been deprecated and will cause the kernel
230to log a warning:
231
232 echo enable > /proc/acpi/ibm/hotkey -- does nothing
233 echo disable > /proc/acpi/ibm/hotkey -- returns an error
234
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200235The procfs interface does not support NVRAM polling control. So as to
236maintain maximum bug-to-bug compatibility, it does not report any masks,
237nor does it allow one to manipulate the hot key mask when the firmware
238does not support masks at all, even if NVRAM polling is in use.
239
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300240sysfs notes:
241
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300242 hotkey_bios_enabled:
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000243 DEPRECATED, WILL BE REMOVED SOON.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300244
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000245 Returns 0.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300246
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300247 hotkey_bios_mask:
Henrique de Moraes Holschuh06777be2009-09-12 15:22:15 -0300248 DEPRECATED, DON'T USE, WILL BE REMOVED IN THE FUTURE.
249
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300250 Returns the hot keys mask when thinkpad-acpi was loaded.
251 Upon module unload, the hot keys mask will be restored
Henrique de Moraes Holschuh06777be2009-09-12 15:22:15 -0300252 to this value. This is always 0x80c, because those are
253 the hotkeys that were supported by ancient firmware
254 without mask support.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300255
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300256 hotkey_enable:
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000257 DEPRECATED, WILL BE REMOVED SOON.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300258
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000259 0: returns -EPERM
260 1: does nothing
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300261
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300262 hotkey_mask:
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300263 bit mask to enable reporting (and depending on
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200264 the firmware, ACPI event generation) for each hot key
265 (see above). Returns the current status of the hot keys
266 mask, and allows one to modify it.
267
Henrique de Moraes Holschuh9b010de2007-07-18 23:45:30 -0300268 hotkey_all_mask:
269 bit mask that should enable event reporting for all
270 supported hot keys, when echoed to hotkey_mask above.
271 Unless you know which events need to be handled
272 passively (because the firmware *will* handle them
273 anyway), do *not* use hotkey_all_mask. Use
274 hotkey_recommended_mask, instead. You have been warned.
275
276 hotkey_recommended_mask:
277 bit mask that should enable event reporting for all
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300278 supported hot keys, except those which are always
279 handled by the firmware anyway. Echo it to
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300280 hotkey_mask above, to use. This is the default mask
281 used by the driver.
Henrique de Moraes Holschuh9b010de2007-07-18 23:45:30 -0300282
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200283 hotkey_source_mask:
284 bit mask that selects which hot keys will the driver
285 poll the NVRAM for. This is auto-detected by the driver
286 based on the capabilities reported by the ACPI firmware,
287 but it can be overridden at runtime.
288
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300289 Hot keys whose bits are set in hotkey_source_mask are
290 polled for in NVRAM, and reported as hotkey events if
291 enabled in hotkey_mask. Only a few hot keys are
292 available through CMOS NVRAM polling.
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200293
294 Warning: when in NVRAM mode, the volume up/down/mute
295 keys are synthesized according to changes in the mixer,
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300296 which uses a single volume up or volume down hotkey
297 press to unmute, as per the ThinkPad volume mixer user
298 interface. When in ACPI event mode, volume up/down/mute
299 events are reported by the firmware and can behave
300 differently (and that behaviour changes with firmware
301 version -- not just with firmware models -- as well as
302 OSI(Linux) state).
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200303
304 hotkey_poll_freq:
305 frequency in Hz for hot key polling. It must be between
306 0 and 25 Hz. Polling is only carried out when strictly
307 needed.
308
309 Setting hotkey_poll_freq to zero disables polling, and
310 will cause hot key presses that require NVRAM polling
311 to never be reported.
312
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300313 Setting hotkey_poll_freq too low may cause repeated
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200314 pressings of the same hot key to be misreported as a
315 single key press, or to not even be detected at all.
316 The recommended polling frequency is 10Hz.
317
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300318 hotkey_radio_sw:
Henrique de Moraes Holschuhd147da72008-02-16 02:17:57 -0200319 If the ThinkPad has a hardware radio switch, this
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300320 attribute will read 0 if the switch is in the "radios
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200321 disabled" position, and 1 if the switch is in the
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300322 "radios enabled" position.
323
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200324 This attribute has poll()/select() support.
325
Henrique de Moraes Holschuh6c231bd2008-02-16 02:17:58 -0200326 hotkey_tablet_mode:
327 If the ThinkPad has tablet capabilities, this attribute
328 will read 0 if the ThinkPad is in normal mode, and
329 1 if the ThinkPad is in tablet mode.
330
331 This attribute has poll()/select() support.
332
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200333 wakeup_reason:
334 Set to 1 if the system is waking up because the user
335 requested a bay ejection. Set to 2 if the system is
336 waking up because the user requested the system to
337 undock. Set to zero for normal wake-ups or wake-ups
338 due to unknown reasons.
339
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200340 This attribute has poll()/select() support.
341
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200342 wakeup_hotunplug_complete:
343 Set to 1 if the system was waken up because of an
344 undock or bay ejection request, and that request
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200345 was successfully completed. At this point, it might
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200346 be useful to send the system back to sleep, at the
347 user's choice. Refer to HKEY events 0x4003 and
348 0x3003, below.
349
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200350 This attribute has poll()/select() support.
351
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300352input layer notes:
353
354A Hot key is mapped to a single input layer EV_KEY event, possibly
355followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
356code. An EV_SYN event will always be generated to mark the end of the
357event block.
358
359Do not use the EV_MSC MSC_SCAN events to process keys. They are to be
360used as a helper to remap keys, only. They are particularly useful when
361remapping KEY_UNKNOWN keys.
362
363The events are available in an input device, with the following id:
364
365 Bus: BUS_HOST
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300366 vendor: 0x1014 (PCI_VENDOR_ID_IBM) or
367 0x17aa (PCI_VENDOR_ID_LENOVO)
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300368 product: 0x5054 ("TP")
369 version: 0x4101
370
371The version will have its LSB incremented if the keymap changes in a
372backwards-compatible way. The MSB shall always be 0x41 for this input
373device. If the MSB is not 0x41, do not use the device as described in
374this section, as it is either something else (e.g. another input device
375exported by a thinkpad driver, such as HDAPS) or its functionality has
376been changed in a non-backwards compatible way.
377
378Adding other event types for other functionalities shall be considered a
379backwards-compatible change for this input device.
380
381Thinkpad-acpi Hot Key event map (version 0x4101):
382
383ACPI Scan
384event code Key Notes
385
3860x1001 0x00 FN+F1 -
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300387
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03003880x1002 0x01 FN+F2 IBM: battery (rare)
389 Lenovo: Screen lock
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300390
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03003910x1003 0x02 FN+F3 Many IBM models always report
392 this hot key, even with hot keys
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300393 disabled or with Fn+F3 masked
394 off
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300395 IBM: screen lock, often turns
396 off the ThinkLight as side-effect
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300397 Lenovo: battery
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300398
3990x1004 0x03 FN+F4 Sleep button (ACPI sleep button
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200400 semantics, i.e. sleep-to-RAM).
Kumar Appaiah123aeec2011-11-04 11:22:09 -0700401 It always generates some kind
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300402 of event, either the hot key
Kumar Appaiah123aeec2011-11-04 11:22:09 -0700403 event or an ACPI sleep button
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300404 event. The firmware may
405 refuse to generate further FN+F4
406 key presses until a S3 or S4 ACPI
407 sleep cycle is performed or some
408 time passes.
409
4100x1005 0x04 FN+F5 Radio. Enables/disables
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200411 the internal Bluetooth hardware
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300412 and W-WAN card if left in control
413 of the firmware. Does not affect
414 the WLAN card.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300415 Should be used to turn on/off all
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200416 radios (Bluetooth+W-WAN+WLAN),
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300417 really.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300418
4190x1006 0x05 FN+F6 -
420
4210x1007 0x06 FN+F7 Video output cycle.
422 Do you feel lucky today?
423
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004240x1008 0x07 FN+F8 IBM: toggle screen expand
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300425 Lenovo: configure UltraNav,
426 or toggle screen expand
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300427
4280x1009 0x08 FN+F9 -
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300429 .. .. ..
4300x100B 0x0A FN+F11 -
431
4320x100C 0x0B FN+F12 Sleep to disk. You are always
433 supposed to handle it yourself,
434 either through the ACPI event,
435 or through a hotkey event.
436 The firmware may refuse to
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300437 generate further FN+F12 key
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300438 press events until a S3 or S4
439 ACPI sleep cycle is performed,
440 or some time passes.
441
4420x100D 0x0C FN+BACKSPACE -
4430x100E 0x0D FN+INSERT -
4440x100F 0x0E FN+DELETE -
445
4460x1010 0x0F FN+HOME Brightness up. This key is
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300447 always handled by the firmware
448 in IBM ThinkPads, even when
449 unmasked. Just leave it alone.
450 For Lenovo ThinkPads with a new
451 BIOS, it has to be handled either
452 by the ACPI OSI, or by userspace.
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +0000453 The driver does the right thing,
454 never mess with this.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004550x1011 0x10 FN+END Brightness down. See brightness
456 up for details.
457
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004580x1012 0x11 FN+PGUP ThinkLight toggle. This key is
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300459 always handled by the firmware,
460 even when unmasked.
461
4620x1013 0x12 FN+PGDOWN -
463
4640x1014 0x13 FN+SPACE Zoom key
465
4660x1015 0x14 VOLUME UP Internal mixer volume up. This
467 key is always handled by the
468 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300469 NOTE: Lenovo seems to be changing
470 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004710x1016 0x15 VOLUME DOWN Internal mixer volume up. This
472 key is always handled by the
473 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300474 NOTE: Lenovo seems to be changing
475 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004760x1017 0x16 MUTE Mute internal mixer. This
477 key is always handled by the
478 firmware, even when unmasked.
479
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004800x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300481
4820x1019 0x18 unknown
483.. .. ..
4840x1020 0x1F unknown
485
486The ThinkPad firmware does not allow one to differentiate when most hot
487keys are pressed or released (either that, or we don't know how to, yet).
488For these keys, the driver generates a set of events for a key press and
489immediately issues the same set of events for a key release. It is
490unknown by the driver if the ThinkPad firmware triggered these events on
491hot key press or release, but the firmware will do it for either one, not
492both.
493
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300494If a key is mapped to KEY_RESERVED, it generates no input events at all.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300495If a key is mapped to KEY_UNKNOWN, it generates an input event that
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300496includes an scan code. If a key is mapped to anything else, it will
497generate input device EV_KEY events.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300498
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200499In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
500events for switches:
501
Matt LaPlante19f59462009-04-27 15:06:31 +0200502SW_RFKILL_ALL T60 and later hardware rfkill rocker switch
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200503SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A
504
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300505Non hotkey ACPI HKEY event map:
506-------------------------------
507
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300508Events that are never propagated by the driver:
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300509
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -02005100x2304 System is waking up from suspend to undock
5110x2305 System is waking up from suspend to eject bay
5120x2404 System is waking up from hibernation to undock
5130x2405 System is waking up from hibernation to eject bay
Thomas Renninger8b5301c2013-07-03 14:48:39 +02005140x5001 Lid closed
5150x5002 Lid opened
5160x5009 Tablet swivel: switched to tablet mode
5170x500A Tablet swivel: switched to normal mode
Henrique de Moraes Holschuh176dd982009-09-20 14:09:24 -03005180x5010 Brightness level changed/control event
Henrique de Moraes Holschuh2d43f672011-06-05 16:22:34 -03005190x6000 KEYBOARD: Numlock key pressed
5200x6005 KEYBOARD: Fn key pressed (TO BE VERIFIED)
Thomas Renninger8b5301c2013-07-03 14:48:39 +02005210x7000 Radio Switch may have changed state
522
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200523
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300524Events that are propagated by the driver to userspace:
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200525
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -03005260x2313 ALARM: System is waking up from suspend because
527 the battery is nearly empty
5280x2413 ALARM: System is waking up from hibernation because
529 the battery is nearly empty
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -02005300x3003 Bay ejection (see 0x2x05) complete, can sleep again
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -03005310x3006 Bay hotplug request (hint to power up SATA link when
532 the optical drive tray is ejected)
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -02005330x4003 Undocked (see 0x2x04), can sleep again
Henrique de Moraes Holschuha50245a2011-06-05 16:22:35 -03005340x4010 Docked into hotplug port replicator (non-ACPI dock)
5350x4011 Undocked from hotplug port replicator (non-ACPI dock)
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02005360x500B Tablet pen inserted into its storage bay
Henrique de Moraes Holschuhd1edb2b2008-01-08 13:02:53 -02005370x500C Tablet pen removed from its storage bay
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -03005380x6011 ALARM: battery is too hot
5390x6012 ALARM: battery is extremely hot
5400x6021 ALARM: a sensor is too hot
5410x6022 ALARM: a sensor is extremely hot
5420x6030 System thermal table changed
Henrique de Moraes Holschuh2d43f672011-06-05 16:22:34 -03005430x6040 Nvidia Optimus/AC adapter related (TO BE VERIFIED)
Lyudeb03f4d42016-11-11 15:15:03 -05005440x60C0 X1 Yoga 2016, Tablet mode status changed
Henrique de Moraes Holschuh3b64b512008-01-08 13:02:51 -0200545
Henrique de Moraes Holschuh69df49e2010-05-16 19:45:38 -0300546Battery nearly empty alarms are a last resort attempt to get the
547operating system to hibernate or shutdown cleanly (0x2313), or shutdown
548cleanly (0x2413) before power is lost. They must be acted upon, as the
549wake up caused by the firmware will have negated most safety nets...
550
551When any of the "too hot" alarms happen, according to Lenovo the user
552should suspend or hibernate the laptop (and in the case of battery
553alarms, unplug the AC adapter) to let it cool down. These alarms do
554signal that something is wrong, they should never happen on normal
555operating conditions.
556
557The "extremely hot" alarms are emergencies. According to Lenovo, the
558operating system is to force either an immediate suspend or hibernate
559cycle, or a system shutdown. Obviously, something is very wrong if this
560happens.
Henrique de Moraes Holschuh3b64b512008-01-08 13:02:51 -0200561
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300562
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -0300563Brightness hotkey notes:
564
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +0000565Don't mess with the brightness hotkeys in a Thinkpad. If you want
566notifications for OSD, use the sysfs backlight class event support.
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -0300567
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +0000568The driver will issue KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN events
569automatically for the cases were userspace has to do something to
570implement brightness changes. When you override these events, you will
571either fail to handle properly the ThinkPads that require explicit
572action to change backlight brightness, or the ThinkPads that require
573that no action be taken to work properly.
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -0300574
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000575
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300576Bluetooth
577---------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300579procfs: /proc/acpi/ibm/bluetooth
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -0300580sysfs device attribute: bluetooth_enable (deprecated)
581sysfs rfkill class: switch "tpacpi_bluetooth_sw"
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300582
583This feature shows the presence and current state of a ThinkPad
584Bluetooth device in the internal ThinkPad CDC slot.
585
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000586If the ThinkPad supports it, the Bluetooth state is stored in NVRAM,
587so it is kept across reboots and power-off.
588
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300589Procfs notes:
590
591If Bluetooth is installed, the following commands can be used:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
593 echo enable > /proc/acpi/ibm/bluetooth
594 echo disable > /proc/acpi/ibm/bluetooth
595
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300596Sysfs notes:
597
598 If the Bluetooth CDC card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300599 disabled through the "bluetooth_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300600 attribute, and its current status can also be queried.
601
602 enable:
603 0: disables Bluetooth / Bluetooth is disabled
604 1: enables Bluetooth / Bluetooth is enabled.
605
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -0300606 Note: this interface has been superseded by the generic rfkill
607 class. It has been deprecated, and it will be removed in year
608 2010.
609
610 rfkill controller switch "tpacpi_bluetooth_sw": refer to
611 Documentation/rfkill.txt for details.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300612
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614Video output control -- /proc/acpi/ibm/video
615--------------------------------------------
616
617This feature allows control over the devices used for video output -
618LCD, CRT or DVI (if available). The following commands are available:
619
620 echo lcd_enable > /proc/acpi/ibm/video
621 echo lcd_disable > /proc/acpi/ibm/video
622 echo crt_enable > /proc/acpi/ibm/video
623 echo crt_disable > /proc/acpi/ibm/video
624 echo dvi_enable > /proc/acpi/ibm/video
625 echo dvi_disable > /proc/acpi/ibm/video
626 echo auto_enable > /proc/acpi/ibm/video
627 echo auto_disable > /proc/acpi/ibm/video
628 echo expand_toggle > /proc/acpi/ibm/video
629 echo video_switch > /proc/acpi/ibm/video
630
Henrique de Moraes Holschuhb525c062010-02-25 22:22:22 -0300631NOTE: Access to this feature is restricted to processes owning the
632CAP_SYS_ADMIN capability for safety reasons, as it can interact badly
633enough with some versions of X.org to crash it.
634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635Each video output device can be enabled or disabled individually.
636Reading /proc/acpi/ibm/video shows the status of each device.
637
638Automatic video switching can be enabled or disabled. When automatic
639video switching is enabled, certain events (e.g. opening the lid,
640docking or undocking) cause the video output device to change
641automatically. While this can be useful, it also causes flickering
642and, on the X40, video corruption. By disabling automatic switching,
643the flickering or video corruption can be avoided.
644
645The video_switch command cycles through the available video outputs
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400646(it simulates the behavior of Fn-F7).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
648Video expansion can be toggled through this feature. This controls
649whether the display is expanded to fill the entire LCD screen when a
650mode with less than full resolution is used. Note that the current
651video expansion status cannot be determined through this feature.
652
653Note that on many models (particularly those using Radeon graphics
654chips) the X driver configures the video card in a way which prevents
655Fn-F7 from working. This also disables the video output switching
656features of this driver, as it uses the same ACPI methods as
657Fn-F7. Video switching on the console should still work.
658
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000659UPDATE: refer to https://bugs.freedesktop.org/show_bug.cgi?id=2000
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400660
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400661
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300662ThinkLight control
663------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300665procfs: /proc/acpi/ibm/light
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300666sysfs attributes: as per LED class, for the "tpacpi::thinklight" LED
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300667
668procfs notes:
669
670The ThinkLight status can be read and set through the procfs interface. A
671few models which do not make the status available will show the ThinkLight
672status as "unknown". The available commands are:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
674 echo on > /proc/acpi/ibm/light
675 echo off > /proc/acpi/ibm/light
676
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300677sysfs notes:
678
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300679The ThinkLight sysfs interface is documented by the LED class
Paul Bolle395cf962011-08-15 02:02:26 +0200680documentation, in Documentation/leds/leds-class.txt. The ThinkLight LED name
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300681is "tpacpi::thinklight".
682
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000683Due to limitations in the sysfs LED class, if the status of the ThinkLight
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300684cannot be read or if it is unknown, thinkpad-acpi will report it as "off".
685It is impossible to know if the status returned through sysfs is valid.
686
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000687
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000688CMOS/UCMS control
689-----------------
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300690
691procfs: /proc/acpi/ibm/cmos
692sysfs device attribute: cmos_command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300694This feature is mostly used internally by the ACPI firmware to keep the legacy
695CMOS NVRAM bits in sync with the current machine state, and to record this
696state so that the ThinkPad will retain such settings across reboots.
697
698Some of these commands actually perform actions in some ThinkPad models, but
699this is expected to disappear more and more in newer models. As an example, in
700a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
701real, but commands 0 to 2 don't control the mixer anymore (they have been
702phased out) and just update the NVRAM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300704The range of valid cmos command numbers is 0 to 21, but not all have an
705effect and the behavior varies from model to model. Here is the behavior
706on the X40 (tpb is the ThinkPad Buttons utility):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300708 0 - Related to "Volume down" key press
709 1 - Related to "Volume up" key press
710 2 - Related to "Mute on" key press
711 3 - Related to "Access IBM" key press
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200712 4 - Related to "LCD brightness up" key press
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300713 5 - Related to "LCD brightness down" key press
714 11 - Related to "toggle screen expansion" key press/function
715 12 - Related to "ThinkLight on"
716 13 - Related to "ThinkLight off"
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200717 14 - Related to "ThinkLight" key press (toggle ThinkLight)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300719The cmos command interface is prone to firmware split-brain problems, as
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300720in newer ThinkPads it is just a compatibility layer. Do not use it, it is
721exported just as a debug tool.
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300722
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000723
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300724LED control
725-----------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300727procfs: /proc/acpi/ibm/led
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300728sysfs attributes: as per LED class, see below for names
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300729
730Some of the LED indicators can be controlled through this feature. On
731some older ThinkPad models, it is possible to query the status of the
732LED indicators as well. Newer ThinkPads cannot query the real status
733of the LED indicators.
734
Henrique de Moraes Holschuha4d5eff2009-04-04 04:25:49 +0000735Because misuse of the LEDs could induce an unaware user to perform
736dangerous actions (like undocking or ejecting a bay device while the
737buses are still active), or mask an important alarm (such as a nearly
738empty battery, or a broken battery), access to most LEDs is
739restricted.
740
741Unrestricted access to all LEDs requires that thinkpad-acpi be
742compiled with the CONFIG_THINKPAD_ACPI_UNSAFE_LEDS option enabled.
743Distributions must never enable this option. Individual users that
744are aware of the consequences are welcome to enabling it.
745
David Henningsson420f9732013-10-16 23:10:31 +0200746Audio mute and microphone mute LEDs are supported, but currently not
747visible to userspace. They are used by the snd-hda-intel audio driver.
748
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300749procfs notes:
750
751The available commands are:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300753 echo '<LED number> on' >/proc/acpi/ibm/led
754 echo '<LED number> off' >/proc/acpi/ibm/led
755 echo '<LED number> blink' >/proc/acpi/ibm/led
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300757The <LED number> range is 0 to 15. The set of LEDs that can be
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300758controlled varies from model to model. Here is the common ThinkPad
759mapping:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
761 0 - power
762 1 - battery (orange)
763 2 - battery (green)
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300764 3 - UltraBase/dock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 4 - UltraBay
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300766 5 - UltraBase battery slot
767 6 - (unknown)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 7 - standby
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300769 8 - dock status 1
770 9 - dock status 2
771 10, 11 - (unknown)
772 12 - thinkvantage
773 13, 14, 15 - (unknown)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
775All of the above can be turned on and off and can be made to blink.
776
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300777sysfs notes:
778
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300779The ThinkPad LED sysfs interface is described in detail by the LED class
Paul Bolle395cf962011-08-15 02:02:26 +0200780documentation, in Documentation/leds/leds-class.txt.
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300781
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300782The LEDs are named (in LED ID order, from 0 to 12):
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300783"tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt",
784"tpacpi::dock_active", "tpacpi::bay_active", "tpacpi::dock_batt",
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300785"tpacpi::unknown_led", "tpacpi::standby", "tpacpi::dock_status1",
786"tpacpi::dock_status2", "tpacpi::unknown_led2", "tpacpi::unknown_led3",
787"tpacpi::thinkvantage".
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300788
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300789Due to limitations in the sysfs LED class, if the status of the LED
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300790indicators cannot be read due to an error, thinkpad-acpi will report it as
791a brightness of zero (same as LED off).
792
793If the thinkpad firmware doesn't support reading the current status,
794trying to read the current LED brightness will just return whatever
795brightness was last written to that attribute.
796
797These LEDs can blink using hardware acceleration. To request that a
798ThinkPad indicator LED should blink in hardware accelerated mode, use the
799"timer" trigger, and leave the delay_on and delay_off parameters set to
800zero (to request hardware acceleration autodetection).
801
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300802LEDs that are known not to exist in a given ThinkPad model are not
803made available through the sysfs interface. If you have a dock and you
804notice there are LEDs listed for your ThinkPad that do not exist (and
805are not in the dock), or if you notice that there are missing LEDs,
806a report to ibm-acpi-devel@lists.sourceforge.net is appreciated.
807
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000808
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400809ACPI sounds -- /proc/acpi/ibm/beep
810----------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
812The BEEP method is used internally by the ACPI firmware to provide
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400813audible alerts in various situations. This feature allows the same
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814sounds to be triggered manually.
815
816The commands are non-negative integer numbers:
817
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400818 echo <number> >/proc/acpi/ibm/beep
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400820The valid <number> range is 0 to 17. Not all numbers trigger sounds
821and the sounds vary from model to model. Here is the behavior on the
822X40:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400824 0 - stop a sound in progress (but use 17 to stop 16)
825 2 - two beeps, pause, third beep ("low battery")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 3 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400827 4 - high, followed by low-pitched beep ("unable")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 5 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400829 6 - very high, followed by high-pitched beep ("AC/DC")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 7 - high-pitched beep
831 9 - three short beeps
832 10 - very long beep
833 12 - low-pitched beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400834 15 - three high-pitched beeps repeating constantly, stop with 0
835 16 - one medium-pitched beep repeating constantly, stop with 17
836 17 - stop 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000838
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300839Temperature sensors
840-------------------
841
842procfs: /proc/acpi/ibm/thermal
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300843sysfs device attributes: (hwmon "thinkpad") temp*_input
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300845Most ThinkPads include six or more separate temperature sensors but only
846expose the CPU temperature through the standard ACPI methods. This
847feature shows readings from up to eight different sensors on older
848ThinkPads, and up to sixteen different sensors on newer ThinkPads.
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200849
850For example, on the X40, a typical output may be:
851temperatures: 42 42 45 41 36 -128 33 -128
852
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300853On the T43/p, a typical output may be:
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200854temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
855
856The mapping of thermal sensors to physical locations varies depending on
857system-board model (and thus, on ThinkPad model).
858
859http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
860tries to track down these locations for various models.
861
862Most (newer?) models seem to follow this pattern:
863
8641: CPU
8652: (depends on model)
8663: (depends on model)
8674: GPU
8685: Main battery: main sensor
8696: Bay battery: main sensor
8707: Main battery: secondary sensor
8718: Bay battery: secondary sensor
8729-15: (depends on model)
873
874For the R51 (source: Thomas Gruber):
8752: Mini-PCI
8763: Internal HDD
877
878For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
879http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
8802: System board, left side (near PCMCIA slot), reported as HDAPS temp
8813: PCMCIA slot
8829: MCH (northbridge) to DRAM Bus
Henrique de Moraes Holschuhb8b26402007-07-18 23:45:28 -030088310: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
884 card, under touchpad
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -020088511: Power regulator, underside of system board, below F2 key
886
Henrique de Moraes Holschuh88679a12006-11-24 11:47:09 -0200887The A31 has a very atypical layout for the thermal sensors
888(source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
8891: CPU
8902: Main Battery: main sensor
8913: Power Converter
8924: Bay Battery: main sensor
8935: MCH (northbridge)
8946: PCMCIA/ambient
8957: Main Battery: secondary sensor
8968: Bay Battery: secondary sensor
897
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200898
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300899Procfs notes:
900 Readings from sensors that are not available return -128.
901 No commands can be written to this file.
902
903Sysfs notes:
904 Sensors that are not available return the ENXIO error. This
905 status may change at runtime, as there are hotplug thermal
906 sensors, like those inside the batteries and docks.
907
908 thinkpad-acpi thermal sensors are reported through the hwmon
909 subsystem, and follow all of the hwmon guidelines at
910 Documentation/hwmon.
911
Thomas Renningera420e462010-07-16 13:11:35 +0200912EXPERIMENTAL: Embedded controller register dump
913-----------------------------------------------
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300914
Thomas Renningera420e462010-07-16 13:11:35 +0200915This feature is not included in the thinkpad driver anymore.
916Instead the EC can be accessed through /sys/kernel/debug/ec with
917a userspace tool which can be found here:
918ftp://ftp.suse.com/pub/people/trenn/sources/ec
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400919
Thomas Renningera420e462010-07-16 13:11:35 +0200920Use it to determine the register holding the fan
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400921speed on some models. To do that, do the following:
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400922 - make sure the battery is fully charged
923 - make sure the fan is running
Thomas Renningera420e462010-07-16 13:11:35 +0200924 - use above mentioned tool to read out the EC
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400925
Thomas Renningera420e462010-07-16 13:11:35 +0200926Often fan and temperature values vary between
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400927readings. Since temperatures don't change vary fast, you can take
928several quick dumps to eliminate them.
929
930You can use a similar method to figure out the meaning of other
931embedded controller registers - e.g. make sure nothing else changes
932except the charging or discharging battery to determine which
933registers contain the current battery capacity, etc. If you experiment
934with this, do send me your results (including some complete dumps with
935a description of the conditions when they were taken.)
936
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000937
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -0300938LCD brightness control
939----------------------
940
941procfs: /proc/acpi/ibm/brightness
942sysfs backlight device "thinkpad_screen"
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400943
944This feature allows software control of the LCD brightness on ThinkPad
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -0300945models which don't have a hardware brightness slider.
946
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000947It has some limitations: the LCD backlight cannot be actually turned
948on or off by this interface, it just controls the backlight brightness
949level.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -0300950
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -0200951On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
952has eight brightness levels, ranging from 0 to 7. Some of the levels
953may not be distinct. Later Lenovo models that implement the ACPI
954display backlight brightness control methods have 16 levels, ranging
955from 0 to 15.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -0300956
Henrique de Moraes Holschuhd7880f12009-06-18 00:40:16 -0300957For IBM ThinkPads, there are two interfaces to the firmware for direct
958brightness control, EC and UCMS (or CMOS). To select which one should be
959used, use the brightness_mode module parameter: brightness_mode=1 selects
960EC mode, brightness_mode=2 selects UCMS mode, brightness_mode=3 selects EC
961mode with NVRAM backing (so that brightness changes are remembered across
962shutdown/reboot).
Henrique de Moraes Holschuh0e501832009-04-04 04:25:53 +0000963
964The driver tries to select which interface to use from a table of
965defaults for each ThinkPad model. If it makes a wrong choice, please
966report this as a bug, so that we can fix it.
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -0200967
Henrique de Moraes Holschuhd7880f12009-06-18 00:40:16 -0300968Lenovo ThinkPads only support brightness_mode=2 (UCMS).
969
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -0200970When display backlight brightness controls are available through the
971standard ACPI interface, it is best to use it instead of this direct
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -0200972ThinkPad-specific interface. The driver will disable its native
973backlight brightness control interface if it detects that the standard
974ACPI interface is available in the ThinkPad.
Henrique de Moraes Holschuh24d3b772007-07-18 23:45:43 -0300975
Henrique de Moraes Holschuh217f0962010-08-09 23:48:19 -0300976If you want to use the thinkpad-acpi backlight brightness control
977instead of the generic ACPI video backlight brightness control for some
978reason, you should use the acpi_backlight=vendor kernel parameter.
979
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -0200980The brightness_enable module parameter can be used to control whether
981the LCD brightness control feature will be enabled when available.
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -0200982brightness_enable=0 forces it to be disabled. brightness_enable=1
983forces it to be enabled when available, even if the standard ACPI
984interface is also available.
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -0200985
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -0300986Procfs notes:
987
988 The available commands are:
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400989
990 echo up >/proc/acpi/ibm/brightness
991 echo down >/proc/acpi/ibm/brightness
992 echo 'level <level>' >/proc/acpi/ibm/brightness
993
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -0300994Sysfs notes:
995
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -0200996The interface is implemented through the backlight sysfs class, which is
997poorly documented at this time.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -0300998
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -0200999Locate the thinkpad_screen device under /sys/class/backlight, and inside
1000it there will be the following attributes:
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001001
1002 max_brightness:
1003 Reads the maximum brightness the hardware can be set to.
1004 The minimum is always zero.
1005
1006 actual_brightness:
1007 Reads what brightness the screen is set to at this instant.
1008
1009 brightness:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001010 Writes request the driver to change brightness to the
1011 given value. Reads will tell you what brightness the
1012 driver is trying to set the display to when "power" is set
1013 to zero and the display has not been dimmed by a kernel
1014 power management event.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001015
1016 power:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001017 power management mode, where 0 is "display on", and 1 to 3
1018 will dim the display backlight to brightness level 0
1019 because thinkpad-acpi cannot really turn the backlight
1020 off. Kernel power management events can temporarily
1021 increase the current power management level, i.e. they can
1022 dim the display.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001023
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001024
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -03001025WARNING:
1026
1027 Whatever you do, do NOT ever call thinkpad-acpi backlight-level change
1028 interface and the ACPI-based backlight level change interface
1029 (available on newer BIOSes, and driven by the Linux ACPI video driver)
1030 at the same time. The two will interact in bad ways, do funny things,
1031 and maybe reduce the life of the backlight lamps by needlessly kicking
1032 its level up and down at every change.
1033
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001034
Henrique de Moraes Holschuh169220f2009-12-26 22:52:16 -02001035Volume control (Console Audio control)
1036--------------------------------------
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001037
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001038procfs: /proc/acpi/ibm/volume
Henrique de Moraes Holschuh0d204c32009-12-15 21:51:11 -02001039ALSA: "ThinkPad Console Audio Control", default ID: "ThinkPadEC"
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001040
Henrique de Moraes Holschuhc7ac6292009-12-15 21:51:10 -02001041NOTE: by default, the volume control interface operates in read-only
1042mode, as it is supposed to be used for on-screen-display purposes.
1043The read/write mode can be enabled through the use of the
1044"volume_control=1" module parameter.
1045
1046NOTE: distros are urged to not enable volume_control by default, this
1047should be done by the local admin only. The ThinkPad UI is for the
1048console audio control to be done through the volume keys only, and for
1049the desktop environment to just provide on-screen-display feedback.
1050Software volume control should be done only in the main AC97/HDA
1051mixer.
1052
Henrique de Moraes Holschuh169220f2009-12-26 22:52:16 -02001053
1054About the ThinkPad Console Audio control:
1055
1056ThinkPads have a built-in amplifier and muting circuit that drives the
1057console headphone and speakers. This circuit is after the main AC97
1058or HDA mixer in the audio path, and under exclusive control of the
1059firmware.
1060
1061ThinkPads have three special hotkeys to interact with the console
1062audio control: volume up, volume down and mute.
1063
1064It is worth noting that the normal way the mute function works (on
1065ThinkPads that do not have a "mute LED") is:
1066
10671. Press mute to mute. It will *always* mute, you can press it as
1068 many times as you want, and the sound will remain mute.
1069
10702. Press either volume key to unmute the ThinkPad (it will _not_
1071 change the volume, it will just unmute).
1072
1073This is a very superior design when compared to the cheap software-only
1074mute-toggle solution found on normal consumer laptops: you can be
1075absolutely sure the ThinkPad will not make noise if you press the mute
1076button, no matter the previous state.
1077
1078The IBM ThinkPads, and the earlier Lenovo ThinkPads have variable-gain
1079amplifiers driving the speakers and headphone output, and the firmware
1080also handles volume control for the headphone and speakers on these
1081ThinkPads without any help from the operating system (this volume
1082control stage exists after the main AC97 or HDA mixer in the audio
1083path).
1084
1085The newer Lenovo models only have firmware mute control, and depend on
1086the main HDA mixer to do volume control (which is done by the operating
1087system). In this case, the volume keys are filtered out for unmute
1088key press (there are some firmware bugs in this area) and delivered as
1089normal key presses to the operating system (thinkpad-acpi is not
1090involved).
1091
1092
1093The ThinkPad-ACPI volume control:
1094
1095The preferred way to interact with the Console Audio control is the
1096ALSA interface.
1097
1098The legacy procfs interface allows one to read the current state,
1099and if volume control is enabled, accepts the following commands:
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001100
1101 echo up >/proc/acpi/ibm/volume
1102 echo down >/proc/acpi/ibm/volume
1103 echo mute >/proc/acpi/ibm/volume
Henrique de Moraes Holschuha112cee2009-12-15 21:51:09 -02001104 echo unmute >/proc/acpi/ibm/volume
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001105 echo 'level <level>' >/proc/acpi/ibm/volume
1106
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001107The <level> number range is 0 to 14 although not all of them may be
Henrique de Moraes Holschuh169220f2009-12-26 22:52:16 -02001108distinct. To unmute the volume after the mute command, use either the
Henrique de Moraes Holschuha112cee2009-12-15 21:51:09 -02001109up or down command (the level command will not unmute the volume), or
1110the unmute command.
1111
Henrique de Moraes Holschuha112cee2009-12-15 21:51:09 -02001112You can use the volume_capabilities parameter to tell the driver
1113whether your thinkpad has volume control or mute-only control:
1114volume_capabilities=1 for mixers with mute and volume control,
1115volume_capabilities=2 for mixers with only mute control.
1116
1117If the driver misdetects the capabilities for your ThinkPad model,
1118please report this to ibm-acpi-devel@lists.sourceforge.net, so that we
1119can update the driver.
1120
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001121There are two strategies for volume control. To select which one
1122should be used, use the volume_mode module parameter: volume_mode=1
1123selects EC mode, and volume_mode=3 selects EC mode with NVRAM backing
1124(so that volume/mute changes are remembered across shutdown/reboot).
1125
1126The driver will operate in volume_mode=3 by default. If that does not
1127work well on your ThinkPad model, please report this to
1128ibm-acpi-devel@lists.sourceforge.net.
1129
Henrique de Moraes Holschuh0d204c32009-12-15 21:51:11 -02001130The driver supports the standard ALSA module parameters. If the ALSA
1131mixer is disabled, the driver will disable all volume functionality.
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001132
1133
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001134Fan control and monitoring: fan speed, fan enable/disable
1135---------------------------------------------------------
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001136
1137procfs: /proc/acpi/ibm/fan
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001138sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
Henrique de Moraes Holschuhd7377242009-06-18 00:40:17 -03001139 pwm1_enable, fan2_input
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001140sysfs hwmon driver attributes: fan_watchdog
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001141
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001142NOTE NOTE NOTE: fan control operations are disabled by default for
1143safety reasons. To enable them, the module parameter "fan_control=1"
1144must be given to thinkpad-acpi.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001145
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001146This feature attempts to show the current fan speed, control mode and
1147other fan data that might be available. The speed is read directly
1148from the hardware registers of the embedded controller. This is known
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001149to work on later R, T, X and Z series ThinkPads but may show a bogus
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001150value on other models.
1151
Henrique de Moraes Holschuhd7377242009-06-18 00:40:17 -03001152Some Lenovo ThinkPads support a secondary fan. This fan cannot be
1153controlled separately, it shares the main fan control.
1154
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001155Fan levels:
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001156
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001157Most ThinkPad fans work in "levels" at the firmware interface. Level 0
1158stops the fan. The higher the level, the higher the fan speed, although
1159adjacent levels often map to the same fan speed. 7 is the highest
1160level, where the fan reaches the maximum recommended speed.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001161
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001162Level "auto" means the EC changes the fan level according to some
1163internal algorithm, usually based on readings from the thermal sensors.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001164
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001165There is also a "full-speed" level, also known as "disengaged" level.
1166In this level, the EC disables the speed-locked closed-loop fan control,
1167and drives the fan as fast as it can go, which might exceed hardware
1168limits, so use this level with caution.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001169
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001170The fan usually ramps up or down slowly from one speed to another, and
1171it is normal for the EC to take several seconds to react to fan
1172commands. The full-speed level may take up to two minutes to ramp up to
1173maximum speed, and in some ThinkPads, the tachometer readings go stale
1174while the EC is transitioning to the full-speed level.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001175
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001176WARNING WARNING WARNING: do not leave the fan disabled unless you are
1177monitoring all of the temperature sensor readings and you are ready to
1178enable it if necessary to avoid overheating.
1179
1180An enabled fan in level "auto" may stop spinning if the EC decides the
1181ThinkPad is cool enough and doesn't need the extra airflow. This is
Matt LaPlante01dd2fb2007-10-20 01:34:40 +02001182normal, and the EC will spin the fan up if the various thermal readings
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001183rise too much.
1184
1185On the X40, this seems to depend on the CPU and HDD temperatures.
1186Specifically, the fan is turned on when either the CPU temperature
1187climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The
1188fan is turned off when the CPU temperature drops to 49 degrees and the
1189HDD temperature drops to 41 degrees. These thresholds cannot
1190currently be controlled.
1191
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001192The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
1193certain conditions are met. It will override any fan programming done
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001194through thinkpad-acpi.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001196The thinkpad-acpi kernel driver can be programmed to revert the fan
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001197level to a safe setting if userspace does not issue one of the procfs
1198fan commands: "enable", "disable", "level" or "watchdog", or if there
1199are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
1200set to 1, manual mode) within a configurable amount of time of up to
1201120 seconds. This functionality is called fan safety watchdog.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001202
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001203Note that the watchdog timer stops after it enables the fan. It will be
1204rearmed again automatically (using the same interval) when one of the
1205above mentioned fan commands is received. The fan watchdog is,
1206therefore, not suitable to protect against fan mode changes made through
1207means other than the "enable", "disable", and "level" procfs fan
1208commands, or the hwmon fan control sysfs interface.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001209
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001210Procfs notes:
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001211
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001212The fan may be enabled or disabled with the following commands:
1213
1214 echo enable >/proc/acpi/ibm/fan
1215 echo disable >/proc/acpi/ibm/fan
1216
1217Placing a fan on level 0 is the same as disabling it. Enabling a fan
1218will try to place it in a safe level if it is too slow or disabled.
1219
1220The fan level can be controlled with the command:
1221
1222 echo 'level <level>' > /proc/acpi/ibm/fan
1223
1224Where <level> is an integer from 0 to 7, or one of the words "auto" or
1225"full-speed" (without the quotes). Not all ThinkPads support the "auto"
1226and "full-speed" levels. The driver accepts "disengaged" as an alias for
1227"full-speed", and reports it as "disengaged" for backwards
1228compatibility.
1229
1230On the X31 and X40 (and ONLY on those models), the fan speed can be
1231controlled to a certain degree. Once the fan is running, it can be
1232forced to run faster or slower with the following command:
1233
1234 echo 'speed <speed>' > /proc/acpi/ibm/fan
1235
1236The sustainable range of fan speeds on the X40 appears to be from about
12373700 to about 7350. Values outside this range either do not have any
1238effect or the fan speed eventually settles somewhere in that range. The
1239fan cannot be stopped or started with this command. This functionality
1240is incomplete, and not available through the sysfs interface.
1241
1242To program the safety watchdog, use the "watchdog" command.
1243
1244 echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1245
1246If you want to disable the watchdog, use 0 as the interval.
1247
1248Sysfs notes:
1249
1250The sysfs interface follows the hwmon subsystem guidelines for the most
1251part, and the exception is the fan safety watchdog.
1252
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001253Writes to any of the sysfs attributes may return the EINVAL error if
1254that operation is not supported in a given ThinkPad or if the parameter
1255is out-of-bounds, and EPERM if it is forbidden. They may also return
1256EINTR (interrupted system call), and EIO (I/O error while trying to talk
1257to the firmware).
1258
1259Features not yet implemented by the driver return ENOSYS.
1260
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001261hwmon device attribute pwm1_enable:
1262 0: PWM offline (fan is set to full-speed mode)
1263 1: Manual PWM control (use pwm1 to set fan level)
1264 2: Hardware PWM control (EC "auto" mode)
1265 3: reserved (Software PWM control, not implemented yet)
1266
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001267 Modes 0 and 2 are not supported by all ThinkPads, and the
1268 driver is not always able to detect this. If it does know a
1269 mode is unsupported, it will return -EINVAL.
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001270
1271hwmon device attribute pwm1:
1272 Fan level, scaled from the firmware values of 0-7 to the hwmon
1273 scale of 0-255. 0 means fan stopped, 255 means highest normal
1274 speed (level 7).
1275
1276 This attribute only commands the fan if pmw1_enable is set to 1
1277 (manual PWM control).
1278
1279hwmon device attribute fan1_input:
1280 Fan tachometer reading, in RPM. May go stale on certain
1281 ThinkPads while the EC transitions the PWM to offline mode,
1282 which can take up to two minutes. May return rubbish on older
1283 ThinkPads.
1284
Henrique de Moraes Holschuhd7377242009-06-18 00:40:17 -03001285hwmon device attribute fan2_input:
1286 Fan tachometer reading, in RPM, for the secondary fan.
1287 Available only on some ThinkPads. If the secondary fan is
1288 not installed, will always read 0.
1289
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001290hwmon driver attribute fan_watchdog:
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001291 Fan safety watchdog timer interval, in seconds. Minimum is
1292 1 second, maximum is 120 seconds. 0 disables the watchdog.
1293
1294To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
1295
1296To start the fan in a safe mode: set pwm1_enable to 2. If that fails
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001297with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
1298would be the safest choice, though).
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001299
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001300
Jeremy Fitzhardinge9662e082008-08-27 21:04:49 -07001301WAN
1302---
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001303
1304procfs: /proc/acpi/ibm/wan
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -03001305sysfs device attribute: wwan_enable (deprecated)
1306sysfs rfkill class: switch "tpacpi_wwan_sw"
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001307
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001308This feature shows the presence and current state of the built-in
1309Wireless WAN device.
1310
1311If the ThinkPad supports it, the WWAN state is stored in NVRAM,
1312so it is kept across reboots and power-off.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001313
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001314It was tested on a Lenovo ThinkPad X60. It should probably work on other
1315ThinkPad models which come with this module installed.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001316
1317Procfs notes:
1318
1319If the W-WAN card is installed, the following commands can be used:
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001320
1321 echo enable > /proc/acpi/ibm/wan
1322 echo disable > /proc/acpi/ibm/wan
1323
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001324Sysfs notes:
1325
1326 If the W-WAN card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001327 disabled through the "wwan_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001328 attribute, and its current status can also be queried.
1329
1330 enable:
1331 0: disables WWAN card / WWAN card is disabled
1332 1: enables WWAN card / WWAN card is enabled.
1333
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -03001334 Note: this interface has been superseded by the generic rfkill
1335 class. It has been deprecated, and it will be removed in year
1336 2010.
1337
1338 rfkill controller switch "tpacpi_wwan_sw": refer to
1339 Documentation/rfkill.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001341
Henrique de Moraes Holschuh0045c0a2009-01-11 03:01:03 -02001342EXPERIMENTAL: UWB
1343-----------------
1344
Kees Cookaa8820c2013-01-16 18:53:12 -08001345This feature is considered EXPERIMENTAL because it has not been extensively
Henrique de Moraes Holschuh0045c0a2009-01-11 03:01:03 -02001346tested and validated in various ThinkPad models yet. The feature may not
1347work as expected. USE WITH CAUTION! To use this feature, you need to supply
1348the experimental=1 parameter when loading the module.
1349
1350sysfs rfkill class: switch "tpacpi_uwb_sw"
1351
1352This feature exports an rfkill controller for the UWB device, if one is
1353present and enabled in the BIOS.
1354
1355Sysfs notes:
1356
1357 rfkill controller switch "tpacpi_uwb_sw": refer to
1358 Documentation/rfkill.txt for details.
1359
Bastien Nocerab790cee2015-03-02 14:45:27 +01001360Adaptive keyboard
1361-----------------
1362
1363sysfs device attribute: adaptive_kbd_mode
1364
1365This sysfs attribute controls the keyboard "face" that will be shown on the
1366Lenovo X1 Carbon 2nd gen (2014)'s adaptive keyboard. The value can be read
1367and set.
1368
13691 = Home mode
13702 = Web-browser mode
13713 = Web-conference mode
13724 = Function mode
13735 = Layflat mode
1374
1375For more details about which buttons will appear depending on the mode, please
1376review the laptop's user guide:
1377http://www.lenovo.com/shop/americas/content/user_guides/x1carbon_2_ug_en.pdf
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001378
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001379Multiple Commands, Module Parameters
1380------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
1382Multiple commands can be written to the proc files in one shot by
1383separating them with commas, for example:
1384
1385 echo enable,0xffff > /proc/acpi/ibm/hotkey
1386 echo lcd_disable,crt_enable > /proc/acpi/ibm/video
1387
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001388Commands can also be specified when loading the thinkpad-acpi module,
1389for example:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001391 modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001393
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001394Enabling debugging output
1395-------------------------
1396
Simon Arlott0f035b82007-10-20 01:30:25 +02001397The module takes a debug parameter which can be used to selectively
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001398enable various classes of debugging output, for example:
1399
Henrique de Moraes Holschuh5f249272008-02-16 02:17:51 -02001400 modprobe thinkpad_acpi debug=0xffff
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001401
1402will enable all debugging output classes. It takes a bitmask, so
1403to enable more than one output class, just add their values.
1404
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001405 Debug bitmask Description
Henrique de Moraes Holschuh73a94d82009-04-04 04:25:47 +00001406 0x8000 Disclose PID of userspace programs
1407 accessing some functions of the driver
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001408 0x0001 Initialization and probing
1409 0x0002 Removal
Henrique de Moraes Holschuhbee4cd9b2009-04-04 04:25:50 +00001410 0x0004 RF Transmitter control (RFKILL)
1411 (bluetooth, WWAN, UWB...)
Henrique de Moraes Holschuh56e2c202009-04-04 04:25:51 +00001412 0x0008 HKEY event interface, hotkeys
Henrique de Moraes Holschuh74a60c02009-04-04 04:25:52 +00001413 0x0010 Fan control
Henrique de Moraes Holschuh0e501832009-04-04 04:25:53 +00001414 0x0020 Backlight brightness
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001415 0x0040 Audio mixer/volume control
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001416
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001417There is also a kernel build option to enable more debugging
1418information, which may be necessary to debug driver problems.
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001419
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001420The level of debugging information output by the driver can be changed
1421at runtime through sysfs, using the driver attribute debug_level. The
1422attribute takes the same bitmask as the debug module parameter above.
1423
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001424
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001425Force loading of module
1426-----------------------
1427
1428If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1429the module parameter force_load=1. Regardless of whether this works or
1430not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001431
1432
1433Sysfs interface changelog:
1434
14350x000100: Initial sysfs support, as a single platform driver and
1436 device.
Henrique de Moraes Holschuh94b08712007-07-18 23:45:32 -030014370x000200: Hot key support for 32 hot keys, and radio slider switch
1438 support.
Henrique de Moraes Holschuh741553c2007-07-18 23:45:39 -030014390x010000: Hot keys are now handled by default over the input
1440 layer, the radio switch generates input event EV_RADIO,
1441 and the driver enables hot key handling by default in
1442 the firmware.
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001443
14440x020000: ABI fix: added a separate hwmon platform device and
1445 driver, which must be located by name (thinkpad)
1446 and the hwmon class for libsensors4 (lm-sensors 3)
1447 compatibility. Moved all hwmon attributes to this
1448 new platform device.
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001449
14500x020100: Marker for thinkpad-acpi with hot key NVRAM polling
1451 support. If you must, use it to know you should not
Frederik Schwarzer0211a9c2008-12-29 22:14:56 +01001452 start a userspace NVRAM poller (allows to detect when
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001453 NVRAM is compiled out by the user because it is
1454 unneeded/undesired in the first place).
14550x020101: Marker for thinkpad-acpi with hot key NVRAM polling
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001456 and proper hotkey_mask semantics (version 8 of the
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001457 NVRAM polling patch). Some development snapshots of
1458 0.18 had an earlier version that did strange things
1459 to hotkey_mask.
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -02001460
14610x020200: Add poll()/select() support to the following attributes:
1462 hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +00001463
14640x020300: hotkey enable/disable support removed, attributes
1465 hotkey_bios_enabled and hotkey_enable deprecated and
1466 marked for removal.
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -03001467
14680x020400: Marker for 16 LEDs support. Also, LEDs that are known
1469 to not exist in a given model are not registered with
1470 the LED sysfs class anymore.
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -03001471
14720x020500: Updated hotkey driver, hotkey_mask is always available
1473 and it is always able to disable hot keys. Very old
1474 thinkpads are properly supported. hotkey_bios_mask
1475 is deprecated and marked for removal.
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +00001476
14770x020600: Marker for backlight change event support.
Henrique de Moraes Holschuha112cee2009-12-15 21:51:09 -02001478
14790x020700: Support for mute-only mixers.
Henrique de Moraes Holschuhc7ac6292009-12-15 21:51:10 -02001480 Volume control in read-only mode by default.
Henrique de Moraes Holschuh0d204c32009-12-15 21:51:11 -02001481 Marker for ALSA mixer support.
Stanislav Fomichev6b99e352017-06-20 20:45:13 -07001482
14830x030000: Thermal and fan sysfs attributes were moved to the hwmon
1484 device instead of being attached to the backing platform
1485 device.