blob: 96687d0106a9e634058753f61e592cd5ab4ece73 [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
Henrique de Moraes Holschuhb57f7e72009-04-14 02:44:14 +00003 Version 0.23
4 April 10th, 2009
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
124better yet, through libsensors.
125
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300126
127Driver version
128--------------
129
130procfs: /proc/acpi/ibm/driver
131sysfs driver attribute: version
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133The driver name and version. No commands can be written to this file.
134
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000135
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300136Sysfs interface version
137-----------------------
138
139sysfs driver attribute: interface_version
140
141Version of the thinkpad-acpi sysfs interface, as an unsigned long
142(output in hex format: 0xAAAABBCC), where:
143 AAAA - major revision
144 BB - minor revision
145 CC - bugfix revision
146
147The sysfs interface version changelog for the driver can be found at the
148end of this document. Changes to the sysfs interface done by the kernel
149subsystems are not documented here, nor are they tracked by this
150attribute.
151
Henrique de Moraes Holschuh94b08712007-07-18 23:45:32 -0300152Changes to the thinkpad-acpi sysfs interface are only considered
153non-experimental when they are submitted to Linux mainline, at which
154point the changes in this interface are documented and interface_version
155may be updated. If you are using any thinkpad-acpi features not yet
156sent to mainline for merging, you do so on your own risk: these features
157may disappear, or be implemented in a different and incompatible way by
158the time they are merged in Linux mainline.
159
160Changes that are backwards-compatible by nature (e.g. the addition of
161attributes that do not change the way the other attributes work) do not
162always warrant an update of interface_version. Therefore, one must
163expect that an attribute might not be there, and deal with it properly
164(an attribute not being there *is* a valid way to make it clear that a
165feature is not available in sysfs).
166
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000167
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300168Hot keys
169--------
170
171procfs: /proc/acpi/ibm/hotkey
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300172sysfs device attribute: hotkey_*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200174In a ThinkPad, the ACPI HKEY handler is responsible for communicating
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300175some important events and also keyboard hot key presses to the operating
176system. Enabling the hotkey functionality of thinkpad-acpi signals the
177firmware that such a driver is present, and modifies how the ThinkPad
178firmware will behave in many situations.
179
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000180The driver enables the HKEY ("hot key") event reporting automatically
181when loaded, and disables it when it is removed.
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300182
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000183The driver will report HKEY events in the following format:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185 ibm/hotkey HKEY 00000080 0000xxxx
186
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000187Some of these events refer to hot key presses, but not all of them.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300188
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300189The driver will generate events over the input layer for hot keys and
190radio switches, and over the ACPI netlink layer for other events. The
191input layer support accepts the standard IOCTLs to remap the keycodes
192assigned to each hot key.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300193
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300194The hot key bit mask allows some control over which hot keys generate
195events. If a key is "masked" (bit set to 0 in the mask), the firmware
196will handle it. If it is "unmasked", it signals the firmware that
197thinkpad-acpi would prefer to handle it, if the firmware would be so
198kind to allow it (and it often doesn't!).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300200Not all bits in the mask can be modified. Not all bits that can be
201modified do anything. Not all hot keys can be individually controlled
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300202by the mask. Some models do not support the mask at all. The behaviour
203of the mask is, therefore, highly dependent on the ThinkPad model.
204
205The driver will filter out any unmasked hotkeys, so even if the firmware
206doesn't allow disabling an specific hotkey, the driver will not report
207events for unmasked hotkeys.
Henrique de Moraes Holschuhae92bd12007-07-18 23:45:29 -0300208
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300209Note that unmasking some keys prevents their default behavior. For
210example, if Fn+F5 is unmasked, that key will no longer enable/disable
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300211Bluetooth by itself in firmware.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300213Note also that not all Fn key combinations are supported through ACPI
214depending on the ThinkPad model and firmware version. On those
215ThinkPads, it is still possible to support some extra hotkeys by
216polling the "CMOS NVRAM" at least 10 times per second. The driver
217attempts to enables this functionality automatically when required.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300219procfs notes:
220
221The following commands can be written to the /proc/acpi/ibm/hotkey file:
222
Henrique de Moraes Holschuhae92bd12007-07-18 23:45:29 -0300223 echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
224 echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
225 ... any other 8-hex-digit mask ...
Henrique de Moraes Holschuh20c9aa42009-09-12 15:22:16 -0300226 echo reset > /proc/acpi/ibm/hotkey -- restore the recommended mask
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300227
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000228The following commands have been deprecated and will cause the kernel
229to log a warning:
230
231 echo enable > /proc/acpi/ibm/hotkey -- does nothing
232 echo disable > /proc/acpi/ibm/hotkey -- returns an error
233
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200234The procfs interface does not support NVRAM polling control. So as to
235maintain maximum bug-to-bug compatibility, it does not report any masks,
236nor does it allow one to manipulate the hot key mask when the firmware
237does not support masks at all, even if NVRAM polling is in use.
238
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300239sysfs notes:
240
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300241 hotkey_bios_enabled:
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000242 DEPRECATED, WILL BE REMOVED SOON.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300243
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000244 Returns 0.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300245
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300246 hotkey_bios_mask:
Henrique de Moraes Holschuh06777be2009-09-12 15:22:15 -0300247 DEPRECATED, DON'T USE, WILL BE REMOVED IN THE FUTURE.
248
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300249 Returns the hot keys mask when thinkpad-acpi was loaded.
250 Upon module unload, the hot keys mask will be restored
Henrique de Moraes Holschuh06777be2009-09-12 15:22:15 -0300251 to this value. This is always 0x80c, because those are
252 the hotkeys that were supported by ancient firmware
253 without mask support.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300254
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300255 hotkey_enable:
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000256 DEPRECATED, WILL BE REMOVED SOON.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300257
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +0000258 0: returns -EPERM
259 1: does nothing
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300260
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300261 hotkey_mask:
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300262 bit mask to enable reporting (and depending on
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200263 the firmware, ACPI event generation) for each hot key
264 (see above). Returns the current status of the hot keys
265 mask, and allows one to modify it.
266
Henrique de Moraes Holschuh9b010de2007-07-18 23:45:30 -0300267 hotkey_all_mask:
268 bit mask that should enable event reporting for all
269 supported hot keys, when echoed to hotkey_mask above.
270 Unless you know which events need to be handled
271 passively (because the firmware *will* handle them
272 anyway), do *not* use hotkey_all_mask. Use
273 hotkey_recommended_mask, instead. You have been warned.
274
275 hotkey_recommended_mask:
276 bit mask that should enable event reporting for all
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300277 supported hot keys, except those which are always
278 handled by the firmware anyway. Echo it to
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300279 hotkey_mask above, to use. This is the default mask
280 used by the driver.
Henrique de Moraes Holschuh9b010de2007-07-18 23:45:30 -0300281
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200282 hotkey_source_mask:
283 bit mask that selects which hot keys will the driver
284 poll the NVRAM for. This is auto-detected by the driver
285 based on the capabilities reported by the ACPI firmware,
286 but it can be overridden at runtime.
287
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -0300288 Hot keys whose bits are set in hotkey_source_mask are
289 polled for in NVRAM, and reported as hotkey events if
290 enabled in hotkey_mask. Only a few hot keys are
291 available through CMOS NVRAM polling.
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200292
293 Warning: when in NVRAM mode, the volume up/down/mute
294 keys are synthesized according to changes in the mixer,
295 so you have to use volume up or volume down to unmute,
296 as per the ThinkPad volume mixer user interface. When
297 in ACPI event mode, volume up/down/mute are reported as
298 separate events, but this behaviour may be corrected in
299 future releases of this driver, in which case the
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200300 ThinkPad volume mixer user interface semantics will be
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200301 enforced.
302
303 hotkey_poll_freq:
304 frequency in Hz for hot key polling. It must be between
305 0 and 25 Hz. Polling is only carried out when strictly
306 needed.
307
308 Setting hotkey_poll_freq to zero disables polling, and
309 will cause hot key presses that require NVRAM polling
310 to never be reported.
311
312 Setting hotkey_poll_freq too low will cause repeated
313 pressings of the same hot key to be misreported as a
314 single key press, or to not even be detected at all.
315 The recommended polling frequency is 10Hz.
316
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300317 hotkey_radio_sw:
Henrique de Moraes Holschuhd147da72008-02-16 02:17:57 -0200318 If the ThinkPad has a hardware radio switch, this
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300319 attribute will read 0 if the switch is in the "radios
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200320 disabled" position, and 1 if the switch is in the
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300321 "radios enabled" position.
322
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200323 This attribute has poll()/select() support.
324
Henrique de Moraes Holschuh6c231bd2008-02-16 02:17:58 -0200325 hotkey_tablet_mode:
326 If the ThinkPad has tablet capabilities, this attribute
327 will read 0 if the ThinkPad is in normal mode, and
328 1 if the ThinkPad is in tablet mode.
329
330 This attribute has poll()/select() support.
331
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300332 hotkey_report_mode:
333 Returns the state of the procfs ACPI event report mode
334 filter for hot keys. If it is set to 1 (the default),
335 all hot key presses are reported both through the input
336 layer and also as ACPI events through procfs (but not
337 through netlink). If it is set to 2, hot key presses
338 are reported only through the input layer.
339
340 This attribute is read-only in kernels 2.6.23 or later,
341 and read-write on earlier kernels.
342
343 May return -EPERM (write access locked out by module
344 parameter) or -EACCES (read-only).
345
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200346 wakeup_reason:
347 Set to 1 if the system is waking up because the user
348 requested a bay ejection. Set to 2 if the system is
349 waking up because the user requested the system to
350 undock. Set to zero for normal wake-ups or wake-ups
351 due to unknown reasons.
352
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200353 This attribute has poll()/select() support.
354
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200355 wakeup_hotunplug_complete:
356 Set to 1 if the system was waken up because of an
357 undock or bay ejection request, and that request
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200358 was successfully completed. At this point, it might
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200359 be useful to send the system back to sleep, at the
360 user's choice. Refer to HKEY events 0x4003 and
361 0x3003, below.
362
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200363 This attribute has poll()/select() support.
364
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300365input layer notes:
366
367A Hot key is mapped to a single input layer EV_KEY event, possibly
368followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
369code. An EV_SYN event will always be generated to mark the end of the
370event block.
371
372Do not use the EV_MSC MSC_SCAN events to process keys. They are to be
373used as a helper to remap keys, only. They are particularly useful when
374remapping KEY_UNKNOWN keys.
375
376The events are available in an input device, with the following id:
377
378 Bus: BUS_HOST
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300379 vendor: 0x1014 (PCI_VENDOR_ID_IBM) or
380 0x17aa (PCI_VENDOR_ID_LENOVO)
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300381 product: 0x5054 ("TP")
382 version: 0x4101
383
384The version will have its LSB incremented if the keymap changes in a
385backwards-compatible way. The MSB shall always be 0x41 for this input
386device. If the MSB is not 0x41, do not use the device as described in
387this section, as it is either something else (e.g. another input device
388exported by a thinkpad driver, such as HDAPS) or its functionality has
389been changed in a non-backwards compatible way.
390
391Adding other event types for other functionalities shall be considered a
392backwards-compatible change for this input device.
393
394Thinkpad-acpi Hot Key event map (version 0x4101):
395
396ACPI Scan
397event code Key Notes
398
3990x1001 0x00 FN+F1 -
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004000x1002 0x01 FN+F2 IBM: battery (rare)
401 Lenovo: Screen lock
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300402
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004030x1003 0x02 FN+F3 Many IBM models always report
404 this hot key, even with hot keys
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300405 disabled or with Fn+F3 masked
406 off
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300407 IBM: screen lock
408 Lenovo: battery
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300409
4100x1004 0x03 FN+F4 Sleep button (ACPI sleep button
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200411 semantics, i.e. sleep-to-RAM).
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300412 It is always generate some kind
413 of event, either the hot key
414 event or a ACPI sleep button
415 event. The firmware may
416 refuse to generate further FN+F4
417 key presses until a S3 or S4 ACPI
418 sleep cycle is performed or some
419 time passes.
420
4210x1005 0x04 FN+F5 Radio. Enables/disables
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200422 the internal Bluetooth hardware
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300423 and W-WAN card if left in control
424 of the firmware. Does not affect
425 the WLAN card.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300426 Should be used to turn on/off all
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200427 radios (Bluetooth+W-WAN+WLAN),
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300428 really.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300429
4300x1006 0x05 FN+F6 -
431
4320x1007 0x06 FN+F7 Video output cycle.
433 Do you feel lucky today?
434
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004350x1008 0x07 FN+F8 IBM: toggle screen expand
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200436 Lenovo: configure UltraNav
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300437
4380x1009 0x08 FN+F9 -
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300439 .. .. ..
4400x100B 0x0A FN+F11 -
441
4420x100C 0x0B FN+F12 Sleep to disk. You are always
443 supposed to handle it yourself,
444 either through the ACPI event,
445 or through a hotkey event.
446 The firmware may refuse to
447 generate further FN+F4 key
448 press events until a S3 or S4
449 ACPI sleep cycle is performed,
450 or some time passes.
451
4520x100D 0x0C FN+BACKSPACE -
4530x100E 0x0D FN+INSERT -
4540x100F 0x0E FN+DELETE -
455
4560x1010 0x0F FN+HOME Brightness up. This key is
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300457 always handled by the firmware
458 in IBM ThinkPads, even when
459 unmasked. Just leave it alone.
460 For Lenovo ThinkPads with a new
461 BIOS, it has to be handled either
462 by the ACPI OSI, or by userspace.
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +0000463 The driver does the right thing,
464 never mess with this.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004650x1011 0x10 FN+END Brightness down. See brightness
466 up for details.
467
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004680x1012 0x11 FN+PGUP ThinkLight toggle. This key is
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300469 always handled by the firmware,
470 even when unmasked.
471
4720x1013 0x12 FN+PGDOWN -
473
4740x1014 0x13 FN+SPACE Zoom key
475
4760x1015 0x14 VOLUME UP Internal mixer volume up. This
477 key is always handled by the
478 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300479 NOTE: Lenovo seems to be changing
480 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004810x1016 0x15 VOLUME DOWN Internal mixer volume up. This
482 key is always handled by the
483 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300484 NOTE: Lenovo seems to be changing
485 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004860x1017 0x16 MUTE Mute internal mixer. This
487 key is always handled by the
488 firmware, even when unmasked.
489
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004900x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300491
4920x1019 0x18 unknown
493.. .. ..
4940x1020 0x1F unknown
495
496The ThinkPad firmware does not allow one to differentiate when most hot
497keys are pressed or released (either that, or we don't know how to, yet).
498For these keys, the driver generates a set of events for a key press and
499immediately issues the same set of events for a key release. It is
500unknown by the driver if the ThinkPad firmware triggered these events on
501hot key press or release, but the firmware will do it for either one, not
502both.
503
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300504If a key is mapped to KEY_RESERVED, it generates no input events at all.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300505If a key is mapped to KEY_UNKNOWN, it generates an input event that
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300506includes an scan code. If a key is mapped to anything else, it will
507generate input device EV_KEY events.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300508
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200509In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
510events for switches:
511
Matt LaPlante19f59462009-04-27 15:06:31 +0200512SW_RFKILL_ALL T60 and later hardware rfkill rocker switch
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200513SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A
514
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300515Non hot-key ACPI HKEY event map:
5160x5001 Lid closed
5170x5002 Lid opened
Henrique de Moraes Holschuhb3ec6f92008-02-16 02:17:55 -02005180x5009 Tablet swivel: switched to tablet mode
5190x500A Tablet swivel: switched to normal mode
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03005200x7000 Radio Switch may have changed state
521
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300522The above events are not propagated by the driver, except for legacy
523compatibility purposes when hotkey_report_mode is set to 1.
524
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -02005250x2304 System is waking up from suspend to undock
5260x2305 System is waking up from suspend to eject bay
5270x2404 System is waking up from hibernation to undock
5280x2405 System is waking up from hibernation to eject bay
Henrique de Moraes Holschuh176dd982009-09-20 14:09:24 -03005290x5010 Brightness level changed/control event
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200530
531The above events are never propagated by the driver.
532
5330x3003 Bay ejection (see 0x2x05) complete, can sleep again
5340x4003 Undocked (see 0x2x04), can sleep again
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02005350x500B Tablet pen inserted into its storage bay
Henrique de Moraes Holschuhd1edb2b2008-01-08 13:02:53 -02005360x500C Tablet pen removed from its storage bay
Henrique de Moraes Holschuh3b64b512008-01-08 13:02:51 -0200537
538The above events are propagated by the driver.
539
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300540Compatibility notes:
541
542ibm-acpi and thinkpad-acpi 0.15 (mainline kernels before 2.6.23) never
543supported the input layer, and sent events over the procfs ACPI event
544interface.
545
546To avoid sending duplicate events over the input layer and the ACPI
547event interface, thinkpad-acpi 0.16 implements a module parameter
548(hotkey_report_mode), and also a sysfs device attribute with the same
549name.
550
551Make no mistake here: userspace is expected to switch to using the input
552layer interface of thinkpad-acpi, together with the ACPI netlink event
553interface in kernels 2.6.23 and later, or with the ACPI procfs event
554interface in kernels 2.6.22 and earlier.
555
556If no hotkey_report_mode module parameter is specified (or it is set to
557zero), the driver defaults to mode 1 (see below), and on kernels 2.6.22
558and earlier, also allows one to change the hotkey_report_mode through
559sysfs. In kernels 2.6.23 and later, where the netlink ACPI event
560interface is available, hotkey_report_mode cannot be changed through
561sysfs (it is read-only).
562
563If the hotkey_report_mode module parameter is set to 1 or 2, it cannot
564be changed later through sysfs (any writes will return -EPERM to signal
565that hotkey_report_mode was locked. On 2.6.23 and later, where
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200566hotkey_report_mode cannot be changed at all, writes will return -EACCES).
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300567
568hotkey_report_mode set to 1 makes the driver export through the procfs
569ACPI event interface all hot key presses (which are *also* sent to the
570input layer). This is a legacy compatibility behaviour, and it is also
571the default mode of operation for the driver.
572
573hotkey_report_mode set to 2 makes the driver filter out the hot key
574presses from the procfs ACPI event interface, so these events will only
575be sent through the input layer. Userspace that has been updated to use
576the thinkpad-acpi input layer interface should set hotkey_report_mode to
5772.
578
579Hot key press events are never sent to the ACPI netlink event interface.
580Really up-to-date userspace under kernel 2.6.23 and later is to use the
581netlink interface and the input layer interface, and don't bother at all
582with hotkey_report_mode.
583
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300584
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -0300585Brightness hotkey notes:
586
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +0000587Don't mess with the brightness hotkeys in a Thinkpad. If you want
588notifications for OSD, use the sysfs backlight class event support.
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -0300589
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +0000590The driver will issue KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN events
591automatically for the cases were userspace has to do something to
592implement brightness changes. When you override these events, you will
593either fail to handle properly the ThinkPads that require explicit
594action to change backlight brightness, or the ThinkPads that require
595that no action be taken to work properly.
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -0300596
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000597
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300598Bluetooth
599---------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300601procfs: /proc/acpi/ibm/bluetooth
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -0300602sysfs device attribute: bluetooth_enable (deprecated)
603sysfs rfkill class: switch "tpacpi_bluetooth_sw"
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300604
605This feature shows the presence and current state of a ThinkPad
606Bluetooth device in the internal ThinkPad CDC slot.
607
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000608If the ThinkPad supports it, the Bluetooth state is stored in NVRAM,
609so it is kept across reboots and power-off.
610
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300611Procfs notes:
612
613If Bluetooth is installed, the following commands can be used:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
615 echo enable > /proc/acpi/ibm/bluetooth
616 echo disable > /proc/acpi/ibm/bluetooth
617
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300618Sysfs notes:
619
620 If the Bluetooth CDC card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300621 disabled through the "bluetooth_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300622 attribute, and its current status can also be queried.
623
624 enable:
625 0: disables Bluetooth / Bluetooth is disabled
626 1: enables Bluetooth / Bluetooth is enabled.
627
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -0300628 Note: this interface has been superseded by the generic rfkill
629 class. It has been deprecated, and it will be removed in year
630 2010.
631
632 rfkill controller switch "tpacpi_bluetooth_sw": refer to
633 Documentation/rfkill.txt for details.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300634
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000635
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636Video output control -- /proc/acpi/ibm/video
637--------------------------------------------
638
639This feature allows control over the devices used for video output -
640LCD, CRT or DVI (if available). The following commands are available:
641
642 echo lcd_enable > /proc/acpi/ibm/video
643 echo lcd_disable > /proc/acpi/ibm/video
644 echo crt_enable > /proc/acpi/ibm/video
645 echo crt_disable > /proc/acpi/ibm/video
646 echo dvi_enable > /proc/acpi/ibm/video
647 echo dvi_disable > /proc/acpi/ibm/video
648 echo auto_enable > /proc/acpi/ibm/video
649 echo auto_disable > /proc/acpi/ibm/video
650 echo expand_toggle > /proc/acpi/ibm/video
651 echo video_switch > /proc/acpi/ibm/video
652
653Each video output device can be enabled or disabled individually.
654Reading /proc/acpi/ibm/video shows the status of each device.
655
656Automatic video switching can be enabled or disabled. When automatic
657video switching is enabled, certain events (e.g. opening the lid,
658docking or undocking) cause the video output device to change
659automatically. While this can be useful, it also causes flickering
660and, on the X40, video corruption. By disabling automatic switching,
661the flickering or video corruption can be avoided.
662
663The video_switch command cycles through the available video outputs
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400664(it simulates the behavior of Fn-F7).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
666Video expansion can be toggled through this feature. This controls
667whether the display is expanded to fill the entire LCD screen when a
668mode with less than full resolution is used. Note that the current
669video expansion status cannot be determined through this feature.
670
671Note that on many models (particularly those using Radeon graphics
672chips) the X driver configures the video card in a way which prevents
673Fn-F7 from working. This also disables the video output switching
674features of this driver, as it uses the same ACPI methods as
675Fn-F7. Video switching on the console should still work.
676
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000677UPDATE: refer to https://bugs.freedesktop.org/show_bug.cgi?id=2000
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400678
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400679
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300680ThinkLight control
681------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300683procfs: /proc/acpi/ibm/light
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300684sysfs attributes: as per LED class, for the "tpacpi::thinklight" LED
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300685
686procfs notes:
687
688The ThinkLight status can be read and set through the procfs interface. A
689few models which do not make the status available will show the ThinkLight
690status as "unknown". The available commands are:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
692 echo on > /proc/acpi/ibm/light
693 echo off > /proc/acpi/ibm/light
694
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300695sysfs notes:
696
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300697The ThinkLight sysfs interface is documented by the LED class
698documentation, in Documentation/leds-class.txt. The ThinkLight LED name
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300699is "tpacpi::thinklight".
700
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000701Due to limitations in the sysfs LED class, if the status of the ThinkLight
Henrique de Moraes Holschuhe3065012008-04-26 01:02:24 -0300702cannot be read or if it is unknown, thinkpad-acpi will report it as "off".
703It is impossible to know if the status returned through sysfs is valid.
704
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000705
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000706CMOS/UCMS control
707-----------------
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300708
709procfs: /proc/acpi/ibm/cmos
710sysfs device attribute: cmos_command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300712This feature is mostly used internally by the ACPI firmware to keep the legacy
713CMOS NVRAM bits in sync with the current machine state, and to record this
714state so that the ThinkPad will retain such settings across reboots.
715
716Some of these commands actually perform actions in some ThinkPad models, but
717this is expected to disappear more and more in newer models. As an example, in
718a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
719real, but commands 0 to 2 don't control the mixer anymore (they have been
720phased out) and just update the NVRAM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300722The range of valid cmos command numbers is 0 to 21, but not all have an
723effect and the behavior varies from model to model. Here is the behavior
724on the X40 (tpb is the ThinkPad Buttons utility):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300726 0 - Related to "Volume down" key press
727 1 - Related to "Volume up" key press
728 2 - Related to "Mute on" key press
729 3 - Related to "Access IBM" key press
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200730 4 - Related to "LCD brightness up" key press
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300731 5 - Related to "LCD brightness down" key press
732 11 - Related to "toggle screen expansion" key press/function
733 12 - Related to "ThinkLight on"
734 13 - Related to "ThinkLight off"
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200735 14 - Related to "ThinkLight" key press (toggle ThinkLight)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300737The cmos command interface is prone to firmware split-brain problems, as
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300738in newer ThinkPads it is just a compatibility layer. Do not use it, it is
739exported just as a debug tool.
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300740
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000741
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300742LED control
743-----------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300745procfs: /proc/acpi/ibm/led
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300746sysfs attributes: as per LED class, see below for names
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300747
748Some of the LED indicators can be controlled through this feature. On
749some older ThinkPad models, it is possible to query the status of the
750LED indicators as well. Newer ThinkPads cannot query the real status
751of the LED indicators.
752
Henrique de Moraes Holschuha4d5eff2009-04-04 04:25:49 +0000753Because misuse of the LEDs could induce an unaware user to perform
754dangerous actions (like undocking or ejecting a bay device while the
755buses are still active), or mask an important alarm (such as a nearly
756empty battery, or a broken battery), access to most LEDs is
757restricted.
758
759Unrestricted access to all LEDs requires that thinkpad-acpi be
760compiled with the CONFIG_THINKPAD_ACPI_UNSAFE_LEDS option enabled.
761Distributions must never enable this option. Individual users that
762are aware of the consequences are welcome to enabling it.
763
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300764procfs notes:
765
766The available commands are:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300768 echo '<LED number> on' >/proc/acpi/ibm/led
769 echo '<LED number> off' >/proc/acpi/ibm/led
770 echo '<LED number> blink' >/proc/acpi/ibm/led
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300772The <LED number> range is 0 to 15. The set of LEDs that can be
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300773controlled varies from model to model. Here is the common ThinkPad
774mapping:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
776 0 - power
777 1 - battery (orange)
778 2 - battery (green)
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300779 3 - UltraBase/dock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 4 - UltraBay
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300781 5 - UltraBase battery slot
782 6 - (unknown)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 7 - standby
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300784 8 - dock status 1
785 9 - dock status 2
786 10, 11 - (unknown)
787 12 - thinkvantage
788 13, 14, 15 - (unknown)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
790All of the above can be turned on and off and can be made to blink.
791
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300792sysfs notes:
793
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300794The ThinkPad LED sysfs interface is described in detail by the LED class
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300795documentation, in Documentation/leds-class.txt.
796
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300797The LEDs are named (in LED ID order, from 0 to 12):
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300798"tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt",
799"tpacpi::dock_active", "tpacpi::bay_active", "tpacpi::dock_batt",
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300800"tpacpi::unknown_led", "tpacpi::standby", "tpacpi::dock_status1",
801"tpacpi::dock_status2", "tpacpi::unknown_led2", "tpacpi::unknown_led3",
802"tpacpi::thinkvantage".
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300803
Henrique de Moraes Holschuh65807cc2008-04-26 01:02:26 -0300804Due to limitations in the sysfs LED class, if the status of the LED
Henrique de Moraes Holschuhaf116102008-04-26 01:02:25 -0300805indicators cannot be read due to an error, thinkpad-acpi will report it as
806a brightness of zero (same as LED off).
807
808If the thinkpad firmware doesn't support reading the current status,
809trying to read the current LED brightness will just return whatever
810brightness was last written to that attribute.
811
812These LEDs can blink using hardware acceleration. To request that a
813ThinkPad indicator LED should blink in hardware accelerated mode, use the
814"timer" trigger, and leave the delay_on and delay_off parameters set to
815zero (to request hardware acceleration autodetection).
816
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -0300817LEDs that are known not to exist in a given ThinkPad model are not
818made available through the sysfs interface. If you have a dock and you
819notice there are LEDs listed for your ThinkPad that do not exist (and
820are not in the dock), or if you notice that there are missing LEDs,
821a report to ibm-acpi-devel@lists.sourceforge.net is appreciated.
822
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000823
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400824ACPI sounds -- /proc/acpi/ibm/beep
825----------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827The BEEP method is used internally by the ACPI firmware to provide
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400828audible alerts in various situations. This feature allows the same
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829sounds to be triggered manually.
830
831The commands are non-negative integer numbers:
832
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400833 echo <number> >/proc/acpi/ibm/beep
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400835The valid <number> range is 0 to 17. Not all numbers trigger sounds
836and the sounds vary from model to model. Here is the behavior on the
837X40:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400839 0 - stop a sound in progress (but use 17 to stop 16)
840 2 - two beeps, pause, third beep ("low battery")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 3 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400842 4 - high, followed by low-pitched beep ("unable")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 5 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400844 6 - very high, followed by high-pitched beep ("AC/DC")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 7 - high-pitched beep
846 9 - three short beeps
847 10 - very long beep
848 12 - low-pitched beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400849 15 - three high-pitched beeps repeating constantly, stop with 0
850 16 - one medium-pitched beep repeating constantly, stop with 17
851 17 - stop 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +0000853
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300854Temperature sensors
855-------------------
856
857procfs: /proc/acpi/ibm/thermal
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300858sysfs device attributes: (hwmon "thinkpad") temp*_input
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300860Most ThinkPads include six or more separate temperature sensors but only
861expose the CPU temperature through the standard ACPI methods. This
862feature shows readings from up to eight different sensors on older
863ThinkPads, and up to sixteen different sensors on newer ThinkPads.
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200864
865For example, on the X40, a typical output may be:
866temperatures: 42 42 45 41 36 -128 33 -128
867
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300868On the T43/p, a typical output may be:
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200869temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
870
871The mapping of thermal sensors to physical locations varies depending on
872system-board model (and thus, on ThinkPad model).
873
874http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
875tries to track down these locations for various models.
876
877Most (newer?) models seem to follow this pattern:
878
8791: CPU
8802: (depends on model)
8813: (depends on model)
8824: GPU
8835: Main battery: main sensor
8846: Bay battery: main sensor
8857: Main battery: secondary sensor
8868: Bay battery: secondary sensor
8879-15: (depends on model)
888
889For the R51 (source: Thomas Gruber):
8902: Mini-PCI
8913: Internal HDD
892
893For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
894http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
8952: System board, left side (near PCMCIA slot), reported as HDAPS temp
8963: PCMCIA slot
8979: MCH (northbridge) to DRAM Bus
Henrique de Moraes Holschuhb8b26402007-07-18 23:45:28 -030089810: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
899 card, under touchpad
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -020090011: Power regulator, underside of system board, below F2 key
901
Henrique de Moraes Holschuh88679a12006-11-24 11:47:09 -0200902The A31 has a very atypical layout for the thermal sensors
903(source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
9041: CPU
9052: Main Battery: main sensor
9063: Power Converter
9074: Bay Battery: main sensor
9085: MCH (northbridge)
9096: PCMCIA/ambient
9107: Main Battery: secondary sensor
9118: Bay Battery: secondary sensor
912
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200913
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300914Procfs notes:
915 Readings from sensors that are not available return -128.
916 No commands can be written to this file.
917
918Sysfs notes:
919 Sensors that are not available return the ENXIO error. This
920 status may change at runtime, as there are hotplug thermal
921 sensors, like those inside the batteries and docks.
922
923 thinkpad-acpi thermal sensors are reported through the hwmon
924 subsystem, and follow all of the hwmon guidelines at
925 Documentation/hwmon.
926
927
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +0200928EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400929------------------------------------------------------------------------
930
931This feature is marked EXPERIMENTAL because the implementation
932directly accesses hardware registers and may not work as expected. USE
933WITH CAUTION! To use this feature, you need to supply the
934experimental=1 parameter when loading the module.
935
936This feature dumps the values of 256 embedded controller
937registers. Values which have changed since the last time the registers
938were dumped are marked with a star:
939
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -0300940[root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400941EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
942EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
943EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
944EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
945EC 0x30: 01 07 1a 00 30 04 00 00 *85 00 00 10 00 50 00 00
946EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
947EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 *bc *02 *bc
948EC 0x60: *02 *bc *02 00 00 00 00 00 00 00 00 00 00 00 00 00
949EC 0x70: 00 00 00 00 00 12 30 40 *24 *26 *2c *27 *20 80 *1f 80
950EC 0x80: 00 00 00 06 *37 *0e 03 00 00 00 0e 07 00 00 00 00
951EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
952EC 0xa0: *ff 09 ff 09 ff ff *64 00 *00 *00 *a2 41 *ff *ff *e0 00
953EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
954EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
955EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
956EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
957EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
958
959This feature can be used to determine the register holding the fan
960speed on some models. To do that, do the following:
961
962 - make sure the battery is fully charged
963 - make sure the fan is running
964 - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
965
966The first step makes sure various charging-related values don't
967vary. The second ensures that the fan-related values do vary, since
968the fan speed fluctuates a bit. The third will (hopefully) mark the
969fan register with a star:
970
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -0300971[root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400972EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
973EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
974EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
975EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
976EC 0x30: 01 07 1a 00 30 04 00 00 85 00 00 10 00 50 00 00
977EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
978EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 bc 02 bc
979EC 0x60: 02 bc 02 00 00 00 00 00 00 00 00 00 00 00 00 00
980EC 0x70: 00 00 00 00 00 12 30 40 24 27 2c 27 21 80 1f 80
981EC 0x80: 00 00 00 06 *be 0d 03 00 00 00 0e 07 00 00 00 00
982EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
983EC 0xa0: ff 09 ff 09 ff ff 64 00 00 00 a2 41 ff ff e0 00
984EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
985EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
986EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
987EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
988EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
989
990Another set of values that varies often is the temperature
991readings. Since temperatures don't change vary fast, you can take
992several quick dumps to eliminate them.
993
994You can use a similar method to figure out the meaning of other
995embedded controller registers - e.g. make sure nothing else changes
996except the charging or discharging battery to determine which
997registers contain the current battery capacity, etc. If you experiment
998with this, do send me your results (including some complete dumps with
999a description of the conditions when they were taken.)
1000
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001001
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001002LCD brightness control
1003----------------------
1004
1005procfs: /proc/acpi/ibm/brightness
1006sysfs backlight device "thinkpad_screen"
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001007
1008This feature allows software control of the LCD brightness on ThinkPad
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001009models which don't have a hardware brightness slider.
1010
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001011It has some limitations: the LCD backlight cannot be actually turned
1012on or off by this interface, it just controls the backlight brightness
1013level.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001014
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001015On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
1016has eight brightness levels, ranging from 0 to 7. Some of the levels
1017may not be distinct. Later Lenovo models that implement the ACPI
1018display backlight brightness control methods have 16 levels, ranging
1019from 0 to 15.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001020
Henrique de Moraes Holschuhd7880f12009-06-18 00:40:16 -03001021For IBM ThinkPads, there are two interfaces to the firmware for direct
1022brightness control, EC and UCMS (or CMOS). To select which one should be
1023used, use the brightness_mode module parameter: brightness_mode=1 selects
1024EC mode, brightness_mode=2 selects UCMS mode, brightness_mode=3 selects EC
1025mode with NVRAM backing (so that brightness changes are remembered across
1026shutdown/reboot).
Henrique de Moraes Holschuh0e501832009-04-04 04:25:53 +00001027
1028The driver tries to select which interface to use from a table of
1029defaults for each ThinkPad model. If it makes a wrong choice, please
1030report this as a bug, so that we can fix it.
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001031
Henrique de Moraes Holschuhd7880f12009-06-18 00:40:16 -03001032Lenovo ThinkPads only support brightness_mode=2 (UCMS).
1033
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001034When display backlight brightness controls are available through the
1035standard ACPI interface, it is best to use it instead of this direct
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -02001036ThinkPad-specific interface. The driver will disable its native
1037backlight brightness control interface if it detects that the standard
1038ACPI interface is available in the ThinkPad.
Henrique de Moraes Holschuh24d3b772007-07-18 23:45:43 -03001039
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -02001040The brightness_enable module parameter can be used to control whether
1041the LCD brightness control feature will be enabled when available.
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -02001042brightness_enable=0 forces it to be disabled. brightness_enable=1
1043forces it to be enabled when available, even if the standard ACPI
1044interface is also available.
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -02001045
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001046Procfs notes:
1047
1048 The available commands are:
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001049
1050 echo up >/proc/acpi/ibm/brightness
1051 echo down >/proc/acpi/ibm/brightness
1052 echo 'level <level>' >/proc/acpi/ibm/brightness
1053
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001054Sysfs notes:
1055
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001056The interface is implemented through the backlight sysfs class, which is
1057poorly documented at this time.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001058
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001059Locate the thinkpad_screen device under /sys/class/backlight, and inside
1060it there will be the following attributes:
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001061
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:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001070 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.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001075
1076 power:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001077 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.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001083
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001084
Henrique de Moraes Holschuhb5972792008-04-26 01:02:17 -03001085WARNING:
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
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001094
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001095Volume control
1096--------------
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001097
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001098procfs: /proc/acpi/ibm/volume
1099
1100This feature allows volume control on ThinkPad models with a digital
1101volume knob, as well as mute/unmute control. The available commands are:
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001102
1103 echo up >/proc/acpi/ibm/volume
1104 echo down >/proc/acpi/ibm/volume
1105 echo mute >/proc/acpi/ibm/volume
1106 echo 'level <level>' >/proc/acpi/ibm/volume
1107
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001108The <level> number range is 0 to 14 although not all of them may be
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001109distinct. The unmute the volume after the mute command, use either the
1110up or down command (the level command will not unmute the volume).
1111The current volume level and mute state is shown in the file.
1112
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001113There are two strategies for volume control. To select which one
1114should be used, use the volume_mode module parameter: volume_mode=1
1115selects EC mode, and volume_mode=3 selects EC mode with NVRAM backing
1116(so that volume/mute changes are remembered across shutdown/reboot).
1117
1118The driver will operate in volume_mode=3 by default. If that does not
1119work well on your ThinkPad model, please report this to
1120ibm-acpi-devel@lists.sourceforge.net.
1121
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001122The ALSA mixer interface to this feature is still missing, but patches
1123to add it exist. That problem should be addressed in the not so
1124distant future.
1125
1126
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001127Fan control and monitoring: fan speed, fan enable/disable
1128---------------------------------------------------------
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001129
1130procfs: /proc/acpi/ibm/fan
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001131sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
Henrique de Moraes Holschuhd7377242009-06-18 00:40:17 -03001132 pwm1_enable, fan2_input
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001133sysfs hwmon driver attributes: fan_watchdog
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001134
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001135NOTE NOTE NOTE: fan control operations are disabled by default for
1136safety reasons. To enable them, the module parameter "fan_control=1"
1137must be given to thinkpad-acpi.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001138
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001139This feature attempts to show the current fan speed, control mode and
1140other fan data that might be available. The speed is read directly
1141from the hardware registers of the embedded controller. This is known
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001142to work on later R, T, X and Z series ThinkPads but may show a bogus
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001143value on other models.
1144
Henrique de Moraes Holschuhd7377242009-06-18 00:40:17 -03001145Some Lenovo ThinkPads support a secondary fan. This fan cannot be
1146controlled separately, it shares the main fan control.
1147
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001148Fan levels:
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001149
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001150Most ThinkPad fans work in "levels" at the firmware interface. Level 0
1151stops the fan. The higher the level, the higher the fan speed, although
1152adjacent levels often map to the same fan speed. 7 is the highest
1153level, where the fan reaches the maximum recommended speed.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001154
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001155Level "auto" means the EC changes the fan level according to some
1156internal algorithm, usually based on readings from the thermal sensors.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001157
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001158There is also a "full-speed" level, also known as "disengaged" level.
1159In this level, the EC disables the speed-locked closed-loop fan control,
1160and drives the fan as fast as it can go, which might exceed hardware
1161limits, so use this level with caution.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001162
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001163The fan usually ramps up or down slowly from one speed to another, and
1164it is normal for the EC to take several seconds to react to fan
1165commands. The full-speed level may take up to two minutes to ramp up to
1166maximum speed, and in some ThinkPads, the tachometer readings go stale
1167while the EC is transitioning to the full-speed level.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001168
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001169WARNING WARNING WARNING: do not leave the fan disabled unless you are
1170monitoring all of the temperature sensor readings and you are ready to
1171enable it if necessary to avoid overheating.
1172
1173An enabled fan in level "auto" may stop spinning if the EC decides the
1174ThinkPad is cool enough and doesn't need the extra airflow. This is
Matt LaPlante01dd2fb2007-10-20 01:34:40 +02001175normal, and the EC will spin the fan up if the various thermal readings
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001176rise too much.
1177
1178On the X40, this seems to depend on the CPU and HDD temperatures.
1179Specifically, the fan is turned on when either the CPU temperature
1180climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The
1181fan is turned off when the CPU temperature drops to 49 degrees and the
1182HDD temperature drops to 41 degrees. These thresholds cannot
1183currently be controlled.
1184
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001185The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
1186certain conditions are met. It will override any fan programming done
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001187through thinkpad-acpi.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001189The thinkpad-acpi kernel driver can be programmed to revert the fan
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001190level to a safe setting if userspace does not issue one of the procfs
1191fan commands: "enable", "disable", "level" or "watchdog", or if there
1192are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
1193set to 1, manual mode) within a configurable amount of time of up to
1194120 seconds. This functionality is called fan safety watchdog.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001195
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001196Note that the watchdog timer stops after it enables the fan. It will be
1197rearmed again automatically (using the same interval) when one of the
1198above mentioned fan commands is received. The fan watchdog is,
1199therefore, not suitable to protect against fan mode changes made through
1200means other than the "enable", "disable", and "level" procfs fan
1201commands, or the hwmon fan control sysfs interface.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001202
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001203Procfs notes:
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001204
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001205The fan may be enabled or disabled with the following commands:
1206
1207 echo enable >/proc/acpi/ibm/fan
1208 echo disable >/proc/acpi/ibm/fan
1209
1210Placing a fan on level 0 is the same as disabling it. Enabling a fan
1211will try to place it in a safe level if it is too slow or disabled.
1212
1213The fan level can be controlled with the command:
1214
1215 echo 'level <level>' > /proc/acpi/ibm/fan
1216
1217Where <level> is an integer from 0 to 7, or one of the words "auto" or
1218"full-speed" (without the quotes). Not all ThinkPads support the "auto"
1219and "full-speed" levels. The driver accepts "disengaged" as an alias for
1220"full-speed", and reports it as "disengaged" for backwards
1221compatibility.
1222
1223On the X31 and X40 (and ONLY on those models), the fan speed can be
1224controlled to a certain degree. Once the fan is running, it can be
1225forced to run faster or slower with the following command:
1226
1227 echo 'speed <speed>' > /proc/acpi/ibm/fan
1228
1229The sustainable range of fan speeds on the X40 appears to be from about
12303700 to about 7350. Values outside this range either do not have any
1231effect or the fan speed eventually settles somewhere in that range. The
1232fan cannot be stopped or started with this command. This functionality
1233is incomplete, and not available through the sysfs interface.
1234
1235To program the safety watchdog, use the "watchdog" command.
1236
1237 echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1238
1239If you want to disable the watchdog, use 0 as the interval.
1240
1241Sysfs notes:
1242
1243The sysfs interface follows the hwmon subsystem guidelines for the most
1244part, and the exception is the fan safety watchdog.
1245
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001246Writes to any of the sysfs attributes may return the EINVAL error if
1247that operation is not supported in a given ThinkPad or if the parameter
1248is out-of-bounds, and EPERM if it is forbidden. They may also return
1249EINTR (interrupted system call), and EIO (I/O error while trying to talk
1250to the firmware).
1251
1252Features not yet implemented by the driver return ENOSYS.
1253
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001254hwmon device attribute pwm1_enable:
1255 0: PWM offline (fan is set to full-speed mode)
1256 1: Manual PWM control (use pwm1 to set fan level)
1257 2: Hardware PWM control (EC "auto" mode)
1258 3: reserved (Software PWM control, not implemented yet)
1259
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001260 Modes 0 and 2 are not supported by all ThinkPads, and the
1261 driver is not always able to detect this. If it does know a
1262 mode is unsupported, it will return -EINVAL.
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001263
1264hwmon device attribute pwm1:
1265 Fan level, scaled from the firmware values of 0-7 to the hwmon
1266 scale of 0-255. 0 means fan stopped, 255 means highest normal
1267 speed (level 7).
1268
1269 This attribute only commands the fan if pmw1_enable is set to 1
1270 (manual PWM control).
1271
1272hwmon device attribute fan1_input:
1273 Fan tachometer reading, in RPM. May go stale on certain
1274 ThinkPads while the EC transitions the PWM to offline mode,
1275 which can take up to two minutes. May return rubbish on older
1276 ThinkPads.
1277
Henrique de Moraes Holschuhd7377242009-06-18 00:40:17 -03001278hwmon device attribute fan2_input:
1279 Fan tachometer reading, in RPM, for the secondary fan.
1280 Available only on some ThinkPads. If the secondary fan is
1281 not installed, will always read 0.
1282
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001283hwmon driver attribute fan_watchdog:
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001284 Fan safety watchdog timer interval, in seconds. Minimum is
1285 1 second, maximum is 120 seconds. 0 disables the watchdog.
1286
1287To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
1288
1289To start the fan in a safe mode: set pwm1_enable to 2. If that fails
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001290with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
1291would be the safest choice, though).
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001292
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001293
Jeremy Fitzhardinge9662e082008-08-27 21:04:49 -07001294WAN
1295---
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001296
1297procfs: /proc/acpi/ibm/wan
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -03001298sysfs device attribute: wwan_enable (deprecated)
1299sysfs rfkill class: switch "tpacpi_wwan_sw"
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001300
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001301This feature shows the presence and current state of the built-in
1302Wireless WAN device.
1303
1304If the ThinkPad supports it, the WWAN state is stored in NVRAM,
1305so it is kept across reboots and power-off.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001306
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001307It was tested on a Lenovo ThinkPad X60. It should probably work on other
1308ThinkPad models which come with this module installed.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001309
1310Procfs notes:
1311
1312If the W-WAN card is installed, the following commands can be used:
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001313
1314 echo enable > /proc/acpi/ibm/wan
1315 echo disable > /proc/acpi/ibm/wan
1316
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001317Sysfs notes:
1318
1319 If the W-WAN card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001320 disabled through the "wwan_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001321 attribute, and its current status can also be queried.
1322
1323 enable:
1324 0: disables WWAN card / WWAN card is disabled
1325 1: enables WWAN card / WWAN card is enabled.
1326
Henrique de Moraes Holschuh0e74dc22008-07-21 09:15:51 -03001327 Note: this interface has been superseded by the generic rfkill
1328 class. It has been deprecated, and it will be removed in year
1329 2010.
1330
1331 rfkill controller switch "tpacpi_wwan_sw": refer to
1332 Documentation/rfkill.txt for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001334
Henrique de Moraes Holschuh0045c0a2009-01-11 03:01:03 -02001335EXPERIMENTAL: UWB
1336-----------------
1337
1338This feature is marked EXPERIMENTAL because it has not been extensively
1339tested and validated in various ThinkPad models yet. The feature may not
1340work as expected. USE WITH CAUTION! To use this feature, you need to supply
1341the experimental=1 parameter when loading the module.
1342
1343sysfs rfkill class: switch "tpacpi_uwb_sw"
1344
1345This feature exports an rfkill controller for the UWB device, if one is
1346present and enabled in the BIOS.
1347
1348Sysfs notes:
1349
1350 rfkill controller switch "tpacpi_uwb_sw": refer to
1351 Documentation/rfkill.txt for details.
1352
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001353
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001354Multiple Commands, Module Parameters
1355------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
1357Multiple commands can be written to the proc files in one shot by
1358separating them with commas, for example:
1359
1360 echo enable,0xffff > /proc/acpi/ibm/hotkey
1361 echo lcd_disable,crt_enable > /proc/acpi/ibm/video
1362
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001363Commands can also be specified when loading the thinkpad-acpi module,
1364for example:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001366 modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001368
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001369Enabling debugging output
1370-------------------------
1371
Simon Arlott0f035b82007-10-20 01:30:25 +02001372The module takes a debug parameter which can be used to selectively
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001373enable various classes of debugging output, for example:
1374
Henrique de Moraes Holschuh5f249272008-02-16 02:17:51 -02001375 modprobe thinkpad_acpi debug=0xffff
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001376
1377will enable all debugging output classes. It takes a bitmask, so
1378to enable more than one output class, just add their values.
1379
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001380 Debug bitmask Description
Henrique de Moraes Holschuh73a94d82009-04-04 04:25:47 +00001381 0x8000 Disclose PID of userspace programs
1382 accessing some functions of the driver
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001383 0x0001 Initialization and probing
1384 0x0002 Removal
Henrique de Moraes Holschuhbee4cd92009-04-04 04:25:50 +00001385 0x0004 RF Transmitter control (RFKILL)
1386 (bluetooth, WWAN, UWB...)
Henrique de Moraes Holschuh56e2c202009-04-04 04:25:51 +00001387 0x0008 HKEY event interface, hotkeys
Henrique de Moraes Holschuh74a60c02009-04-04 04:25:52 +00001388 0x0010 Fan control
Henrique de Moraes Holschuh0e501832009-04-04 04:25:53 +00001389 0x0020 Backlight brightness
Henrique de Moraes Holschuh329e4e12009-12-15 21:51:08 -02001390 0x0040 Audio mixer/volume control
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001391
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001392There is also a kernel build option to enable more debugging
1393information, which may be necessary to debug driver problems.
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001394
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001395The level of debugging information output by the driver can be changed
1396at runtime through sysfs, using the driver attribute debug_level. The
1397attribute takes the same bitmask as the debug module parameter above.
1398
Henrique de Moraes Holschuh078ac192009-04-04 04:25:44 +00001399
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001400Force loading of module
1401-----------------------
1402
1403If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1404the module parameter force_load=1. Regardless of whether this works or
1405not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001406
1407
1408Sysfs interface changelog:
1409
14100x000100: Initial sysfs support, as a single platform driver and
1411 device.
Henrique de Moraes Holschuh94b08712007-07-18 23:45:32 -030014120x000200: Hot key support for 32 hot keys, and radio slider switch
1413 support.
Henrique de Moraes Holschuh741553c2007-07-18 23:45:39 -030014140x010000: Hot keys are now handled by default over the input
1415 layer, the radio switch generates input event EV_RADIO,
1416 and the driver enables hot key handling by default in
1417 the firmware.
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001418
14190x020000: ABI fix: added a separate hwmon platform device and
1420 driver, which must be located by name (thinkpad)
1421 and the hwmon class for libsensors4 (lm-sensors 3)
1422 compatibility. Moved all hwmon attributes to this
1423 new platform device.
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001424
14250x020100: Marker for thinkpad-acpi with hot key NVRAM polling
1426 support. If you must, use it to know you should not
Frederik Schwarzer0211a9c2008-12-29 22:14:56 +01001427 start a userspace NVRAM poller (allows to detect when
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001428 NVRAM is compiled out by the user because it is
1429 unneeded/undesired in the first place).
14300x020101: Marker for thinkpad-acpi with hot key NVRAM polling
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001431 and proper hotkey_mask semantics (version 8 of the
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001432 NVRAM polling patch). Some development snapshots of
1433 0.18 had an earlier version that did strange things
1434 to hotkey_mask.
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -02001435
14360x020200: Add poll()/select() support to the following attributes:
1437 hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason
Henrique de Moraes Holschuh2586d562009-04-04 04:25:48 +00001438
14390x020300: hotkey enable/disable support removed, attributes
1440 hotkey_bios_enabled and hotkey_enable deprecated and
1441 marked for removal.
Henrique de Moraes Holschuhf21179a2009-05-30 13:25:08 -03001442
14430x020400: Marker for 16 LEDs support. Also, LEDs that are known
1444 to not exist in a given model are not registered with
1445 the LED sysfs class anymore.
Henrique de Moraes Holschuh0d922e32009-09-20 14:09:25 -03001446
14470x020500: Updated hotkey driver, hotkey_mask is always available
1448 and it is always able to disable hot keys. Very old
1449 thinkpads are properly supported. hotkey_bios_mask
1450 is deprecated and marked for removal.
Henrique de Moraes Holschuh347a2682009-12-09 01:36:24 +00001451
14520x020600: Marker for backlight change event support.