1 ThinkPad ACPI Extras Driver
6 Borislav Deianov <borislav@users.sf.net>
7 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
8 http://ibm-acpi.sf.net/
11 This is a Linux driver for the IBM and Lenovo ThinkPad laptops. It
12 supports various features of these laptops which are accessible
13 through the ACPI and ACPI EC framework, but not otherwise fully
14 supported by the generic Linux ACPI drivers.
16 This driver used to be named ibm-acpi until kernel 2.6.21 and release
17 0.13-20070314. It used to be in the drivers/acpi tree, but it was
18 moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel
19 2.6.22, and release 0.14. It was moved to drivers/platform/x86 for
20 kernel 2.6.29 and release 0.22.
22 The driver is named "thinkpad-acpi". In some places, like module
23 names and log messages, "thinkpad_acpi" is used because of userspace
26 "tpacpi" is used as a shorthand where "thinkpad-acpi" would be too
27 long due to length limitations on some Linux kernel versions.
32 The features currently supported are the following (see below for
33 detailed description):
36 - Bluetooth enable and disable
37 - video output switching, expansion control
38 - ThinkLight on and off
43 - Experimental: embedded controller register dump
44 - LCD brightness control
46 - Fan control and monitoring: fan speed, fan enable/disable
47 - WAN enable and disable
48 - UWB enable and disable
50 A compatibility table by model and feature is maintained on the web
51 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
52 reports, especially if they add to or correct the compatibility table.
53 Please include the following information in your report:
56 - a copy of your ACPI tables, using the "acpidump" utility
57 - a copy of the output of dmidecode, with serial numbers
59 - which driver features work and which don't
60 - the observed behavior of non-working features
62 Any other comments or patches are also more than welcome.
68 If you are compiling this driver as included in the Linux kernel
69 sources, look for the CONFIG_THINKPAD_ACPI Kconfig option.
70 It is located on the menu path: "Device Drivers" -> "X86 Platform
71 Specific Device Drivers" -> "ThinkPad ACPI Laptop Extras".
77 The driver exports two different interfaces to userspace, which can be
78 used to access the features it provides. One is a legacy procfs-based
79 interface, which will be removed at some time in the future. The other
80 is a new sysfs-based interface which is not complete yet.
82 The procfs interface creates the /proc/acpi/ibm directory. There is a
83 file under that directory for each feature it supports. The procfs
84 interface is mostly frozen, and will change very little if at all: it
85 will not be extended to add any new functionality in the driver, instead
86 all new functionality will be implemented on the sysfs interface.
88 The sysfs interface tries to blend in the generic Linux sysfs subsystems
89 and classes as much as possible. Since some of these subsystems are not
90 yet ready or stabilized, it is expected that this interface will change,
91 and any and all userspace programs must deal with it.
94 Notes about the sysfs interface:
96 Unlike what was done with the procfs interface, correctness when talking
97 to the sysfs interfaces will be enforced, as will correctness in the
98 thinkpad-acpi's implementation of sysfs interfaces.
100 Also, any bugs in the thinkpad-acpi sysfs driver code or in the
101 thinkpad-acpi's implementation of the sysfs interfaces will be fixed for
102 maximum correctness, even if that means changing an interface in
103 non-compatible ways. As these interfaces mature both in the kernel and
104 in thinkpad-acpi, such changes should become quite rare.
106 Applications interfacing to the thinkpad-acpi sysfs interfaces must
107 follow all sysfs guidelines and correctly process all errors (the sysfs
108 interface makes extensive use of errors). File descriptors and open /
109 close operations to the sysfs inodes must also be properly implemented.
111 The version of thinkpad-acpi's sysfs interface is exported by the driver
112 as a driver attribute (see below).
114 Sysfs driver attributes are on the driver's sysfs attribute space,
115 for 2.6.23+ this is /sys/bus/platform/drivers/thinkpad_acpi/ and
116 /sys/bus/platform/drivers/thinkpad_hwmon/
118 Sysfs device attributes are on the thinkpad_acpi device sysfs attribute
119 space, for 2.6.23+ this is /sys/devices/platform/thinkpad_acpi/.
121 Sysfs device attributes for the sensors and fan are on the
122 thinkpad_hwmon device's sysfs attribute space, but you should locate it
123 looking for a hwmon device with the name attribute of "thinkpad", or
124 better yet, through libsensors.
130 procfs: /proc/acpi/ibm/driver
131 sysfs driver attribute: version
133 The driver name and version. No commands can be written to this file.
136 Sysfs interface version
137 -----------------------
139 sysfs driver attribute: interface_version
141 Version of the thinkpad-acpi sysfs interface, as an unsigned long
142 (output in hex format: 0xAAAABBCC), where:
143 AAAA - major revision
147 The sysfs interface version changelog for the driver can be found at the
148 end of this document. Changes to the sysfs interface done by the kernel
149 subsystems are not documented here, nor are they tracked by this
152 Changes to the thinkpad-acpi sysfs interface are only considered
153 non-experimental when they are submitted to Linux mainline, at which
154 point the changes in this interface are documented and interface_version
155 may be updated. If you are using any thinkpad-acpi features not yet
156 sent to mainline for merging, you do so on your own risk: these features
157 may disappear, or be implemented in a different and incompatible way by
158 the time they are merged in Linux mainline.
160 Changes that are backwards-compatible by nature (e.g. the addition of
161 attributes that do not change the way the other attributes work) do not
162 always warrant an update of interface_version. Therefore, one must
163 expect 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
165 feature is not available in sysfs).
171 procfs: /proc/acpi/ibm/hotkey
172 sysfs device attribute: hotkey_*
174 In a ThinkPad, the ACPI HKEY handler is responsible for communicating
175 some important events and also keyboard hot key presses to the operating
176 system. Enabling the hotkey functionality of thinkpad-acpi signals the
177 firmware that such a driver is present, and modifies how the ThinkPad
178 firmware will behave in many situations.
180 The driver enables the HKEY ("hot key") event reporting automatically
181 when loaded, and disables it when it is removed.
183 The driver will report HKEY events in the following format:
185 ibm/hotkey HKEY 00000080 0000xxxx
187 Some of these events refer to hot key presses, but not all of them.
189 The driver will generate events over the input layer for hot keys and
190 radio switches, and over the ACPI netlink layer for other events. The
191 input layer support accepts the standard IOCTLs to remap the keycodes
192 assigned to each hot key.
194 The hot key bit mask allows some control over which hot keys generate
195 events. If a key is "masked" (bit set to 0 in the mask), the firmware
196 will handle it. If it is "unmasked", it signals the firmware that
197 thinkpad-acpi would prefer to handle it, if the firmware would be so
198 kind to allow it (and it often doesn't!).
200 Not all bits in the mask can be modified. Not all bits that can be
201 modified do anything. Not all hot keys can be individually controlled
202 by the mask. Some models do not support the mask at all. The behaviour
203 of the mask is, therefore, highly dependent on the ThinkPad model.
205 The driver will filter out any unmasked hotkeys, so even if the firmware
206 doesn't allow disabling an specific hotkey, the driver will not report
207 events for unmasked hotkeys.
209 Note that unmasking some keys prevents their default behavior. For
210 example, if Fn+F5 is unmasked, that key will no longer enable/disable
211 Bluetooth by itself in firmware.
213 Note also that not all Fn key combinations are supported through ACPI
214 depending on the ThinkPad model and firmware version. On those
215 ThinkPads, it is still possible to support some extra hotkeys by
216 polling the "CMOS NVRAM" at least 10 times per second. The driver
217 attempts to enables this functionality automatically when required.
221 The following commands can be written to the /proc/acpi/ibm/hotkey file:
223 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 ...
226 echo reset > /proc/acpi/ibm/hotkey -- restore the recommended mask
228 The following commands have been deprecated and will cause the kernel
231 echo enable > /proc/acpi/ibm/hotkey -- does nothing
232 echo disable > /proc/acpi/ibm/hotkey -- returns an error
234 The procfs interface does not support NVRAM polling control. So as to
235 maintain maximum bug-to-bug compatibility, it does not report any masks,
236 nor does it allow one to manipulate the hot key mask when the firmware
237 does not support masks at all, even if NVRAM polling is in use.
242 DEPRECATED, WILL BE REMOVED SOON.
247 DEPRECATED, DON'T USE, WILL BE REMOVED IN THE FUTURE.
249 Returns the hot keys mask when thinkpad-acpi was loaded.
250 Upon module unload, the hot keys mask will be restored
251 to this value. This is always 0x80c, because those are
252 the hotkeys that were supported by ancient firmware
253 without mask support.
256 DEPRECATED, WILL BE REMOVED SOON.
262 bit mask to enable reporting (and depending on
263 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.
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.
275 hotkey_recommended_mask:
276 bit mask that should enable event reporting for all
277 supported hot keys, except those which are always
278 handled by the firmware anyway. Echo it to
279 hotkey_mask above, to use. This is the default 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.
288 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.
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
300 ThinkPad volume mixer user interface semantics will be
304 frequency in Hz for hot key polling. It must be between
305 0 and 25 Hz. Polling is only carried out when strictly
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.
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.
318 If the ThinkPad has a hardware radio switch, this
319 attribute will read 0 if the switch is in the "radios
320 disabled" position, and 1 if the switch is in the
321 "radios enabled" position.
323 This attribute has poll()/select() support.
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.
330 This attribute has poll()/select() support.
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.
340 This attribute is read-only in kernels 2.6.23 or later,
341 and read-write on earlier kernels.
343 May return -EPERM (write access locked out by module
344 parameter) or -EACCES (read-only).
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.
353 This attribute has poll()/select() support.
355 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
358 was successfully completed. At this point, it might
359 be useful to send the system back to sleep, at the
360 user's choice. Refer to HKEY events 0x4003 and
363 This attribute has poll()/select() support.
367 A Hot key is mapped to a single input layer EV_KEY event, possibly
368 followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
369 code. An EV_SYN event will always be generated to mark the end of the
372 Do not use the EV_MSC MSC_SCAN events to process keys. They are to be
373 used as a helper to remap keys, only. They are particularly useful when
374 remapping KEY_UNKNOWN keys.
376 The events are available in an input device, with the following id:
379 vendor: 0x1014 (PCI_VENDOR_ID_IBM) or
380 0x17aa (PCI_VENDOR_ID_LENOVO)
381 product: 0x5054 ("TP")
384 The version will have its LSB incremented if the keymap changes in a
385 backwards-compatible way. The MSB shall always be 0x41 for this input
386 device. If the MSB is not 0x41, do not use the device as described in
387 this section, as it is either something else (e.g. another input device
388 exported by a thinkpad driver, such as HDAPS) or its functionality has
389 been changed in a non-backwards compatible way.
391 Adding other event types for other functionalities shall be considered a
392 backwards-compatible change for this input device.
394 Thinkpad-acpi Hot Key event map (version 0x4101):
400 0x1002 0x01 FN+F2 IBM: battery (rare)
403 0x1003 0x02 FN+F3 Many IBM models always report
404 this hot key, even with hot keys
405 disabled or with Fn+F3 masked
410 0x1004 0x03 FN+F4 Sleep button (ACPI sleep button
411 semantics, i.e. sleep-to-RAM).
412 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
421 0x1005 0x04 FN+F5 Radio. Enables/disables
422 the internal Bluetooth hardware
423 and W-WAN card if left in control
424 of the firmware. Does not affect
426 Should be used to turn on/off all
427 radios (Bluetooth+W-WAN+WLAN),
432 0x1007 0x06 FN+F7 Video output cycle.
433 Do you feel lucky today?
435 0x1008 0x07 FN+F8 IBM: toggle screen expand
436 Lenovo: configure UltraNav
442 0x100C 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,
452 0x100D 0x0C FN+BACKSPACE -
453 0x100E 0x0D FN+INSERT -
454 0x100F 0x0E FN+DELETE -
456 0x1010 0x0F FN+HOME Brightness up. This key is
457 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.
463 0x1011 0x10 FN+END Brightness down. See brightness
466 0x1012 0x11 FN+PGUP ThinkLight toggle. This key is
467 always handled by the firmware,
470 0x1013 0x12 FN+PGDOWN -
472 0x1014 0x13 FN+SPACE Zoom key
474 0x1015 0x14 VOLUME UP Internal mixer volume up. This
475 key is always handled by the
476 firmware, even when unmasked.
477 NOTE: Lenovo seems to be changing
479 0x1016 0x15 VOLUME DOWN Internal mixer volume up. This
480 key is always handled by the
481 firmware, even when unmasked.
482 NOTE: Lenovo seems to be changing
484 0x1017 0x16 MUTE Mute internal mixer. This
485 key is always handled by the
486 firmware, even when unmasked.
488 0x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key
494 The ThinkPad firmware does not allow one to differentiate when most hot
495 keys are pressed or released (either that, or we don't know how to, yet).
496 For these keys, the driver generates a set of events for a key press and
497 immediately issues the same set of events for a key release. It is
498 unknown by the driver if the ThinkPad firmware triggered these events on
499 hot key press or release, but the firmware will do it for either one, not
502 If a key is mapped to KEY_RESERVED, it generates no input events at all.
503 If a key is mapped to KEY_UNKNOWN, it generates an input event that
504 includes an scan code. If a key is mapped to anything else, it will
505 generate input device EV_KEY events.
507 In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
510 SW_RFKILL_ALL T60 and later hardware rfkill rocker switch
511 SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A
513 Non hot-key ACPI HKEY event map:
516 0x5009 Tablet swivel: switched to tablet mode
517 0x500A Tablet swivel: switched to normal mode
518 0x7000 Radio Switch may have changed state
520 The above events are not propagated by the driver, except for legacy
521 compatibility purposes when hotkey_report_mode is set to 1.
523 0x2304 System is waking up from suspend to undock
524 0x2305 System is waking up from suspend to eject bay
525 0x2404 System is waking up from hibernation to undock
526 0x2405 System is waking up from hibernation to eject bay
527 0x5010 Brightness level changed/control event
529 The above events are never propagated by the driver.
531 0x3003 Bay ejection (see 0x2x05) complete, can sleep again
532 0x4003 Undocked (see 0x2x04), can sleep again
533 0x500B Tablet pen inserted into its storage bay
534 0x500C Tablet pen removed from its storage bay
536 The above events are propagated by the driver.
540 ibm-acpi and thinkpad-acpi 0.15 (mainline kernels before 2.6.23) never
541 supported the input layer, and sent events over the procfs ACPI event
544 To avoid sending duplicate events over the input layer and the ACPI
545 event interface, thinkpad-acpi 0.16 implements a module parameter
546 (hotkey_report_mode), and also a sysfs device attribute with the same
549 Make no mistake here: userspace is expected to switch to using the input
550 layer interface of thinkpad-acpi, together with the ACPI netlink event
551 interface in kernels 2.6.23 and later, or with the ACPI procfs event
552 interface in kernels 2.6.22 and earlier.
554 If no hotkey_report_mode module parameter is specified (or it is set to
555 zero), the driver defaults to mode 1 (see below), and on kernels 2.6.22
556 and earlier, also allows one to change the hotkey_report_mode through
557 sysfs. In kernels 2.6.23 and later, where the netlink ACPI event
558 interface is available, hotkey_report_mode cannot be changed through
559 sysfs (it is read-only).
561 If the hotkey_report_mode module parameter is set to 1 or 2, it cannot
562 be changed later through sysfs (any writes will return -EPERM to signal
563 that hotkey_report_mode was locked. On 2.6.23 and later, where
564 hotkey_report_mode cannot be changed at all, writes will return -EACCES).
566 hotkey_report_mode set to 1 makes the driver export through the procfs
567 ACPI event interface all hot key presses (which are *also* sent to the
568 input layer). This is a legacy compatibility behaviour, and it is also
569 the default mode of operation for the driver.
571 hotkey_report_mode set to 2 makes the driver filter out the hot key
572 presses from the procfs ACPI event interface, so these events will only
573 be sent through the input layer. Userspace that has been updated to use
574 the thinkpad-acpi input layer interface should set hotkey_report_mode to
577 Hot key press events are never sent to the ACPI netlink event interface.
578 Really up-to-date userspace under kernel 2.6.23 and later is to use the
579 netlink interface and the input layer interface, and don't bother at all
580 with hotkey_report_mode.
583 Brightness hotkey notes:
585 These are the current sane choices for brightness key mapping in
588 For IBM and Lenovo models *without* ACPI backlight control (the ones on
589 which thinkpad-acpi will autoload its backlight interface by default,
590 and on which ACPI video does not export a backlight interface):
592 1. Don't enable or map the brightness hotkeys in thinkpad-acpi, as
593 these older firmware versions unfortunately won't respect the hotkey
594 mask for brightness keys anyway, and always reacts to them. This
595 usually work fine, unless X.org drivers are doing something to block
596 the BIOS. In that case, use (3) below. This is the default mode of
599 2. Enable the hotkeys, but map them to something else that is NOT
600 KEY_BRIGHTNESS_UP/DOWN or any other keycode that would cause
601 userspace to try to change the backlight level, and use that as an
602 on-screen-display hint.
604 3. IF AND ONLY IF X.org drivers find a way to block the firmware from
605 automatically changing the brightness, enable the hotkeys and map
606 them to KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN, and feed that to
607 something that calls xbacklight. thinkpad-acpi will not be able to
608 change brightness in that case either, so you should disable its
611 For Lenovo models *with* ACPI backlight control:
613 1. Load up ACPI video and use that. ACPI video will report ACPI
614 events for brightness change keys. Do not mess with thinkpad-acpi
615 defaults in this case. thinkpad-acpi should not have anything to do
616 with backlight events in a scenario where ACPI video is loaded:
617 brightness hotkeys must be disabled, and the backlight interface is
618 to be kept disabled as well. This is the default mode of operation.
620 2. Do *NOT* load up ACPI video, enable the hotkeys in thinkpad-acpi,
621 and map them to KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN. Process
622 these keys on userspace somehow (e.g. by calling xbacklight).
623 The driver will do this automatically if it detects that ACPI video
630 procfs: /proc/acpi/ibm/bluetooth
631 sysfs device attribute: bluetooth_enable (deprecated)
632 sysfs rfkill class: switch "tpacpi_bluetooth_sw"
634 This feature shows the presence and current state of a ThinkPad
635 Bluetooth device in the internal ThinkPad CDC slot.
637 If the ThinkPad supports it, the Bluetooth state is stored in NVRAM,
638 so it is kept across reboots and power-off.
642 If Bluetooth is installed, the following commands can be used:
644 echo enable > /proc/acpi/ibm/bluetooth
645 echo disable > /proc/acpi/ibm/bluetooth
649 If the Bluetooth CDC card is installed, it can be enabled /
650 disabled through the "bluetooth_enable" thinkpad-acpi device
651 attribute, and its current status can also be queried.
654 0: disables Bluetooth / Bluetooth is disabled
655 1: enables Bluetooth / Bluetooth is enabled.
657 Note: this interface has been superseded by the generic rfkill
658 class. It has been deprecated, and it will be removed in year
661 rfkill controller switch "tpacpi_bluetooth_sw": refer to
662 Documentation/rfkill.txt for details.
665 Video output control -- /proc/acpi/ibm/video
666 --------------------------------------------
668 This feature allows control over the devices used for video output -
669 LCD, CRT or DVI (if available). The following commands are available:
671 echo lcd_enable > /proc/acpi/ibm/video
672 echo lcd_disable > /proc/acpi/ibm/video
673 echo crt_enable > /proc/acpi/ibm/video
674 echo crt_disable > /proc/acpi/ibm/video
675 echo dvi_enable > /proc/acpi/ibm/video
676 echo dvi_disable > /proc/acpi/ibm/video
677 echo auto_enable > /proc/acpi/ibm/video
678 echo auto_disable > /proc/acpi/ibm/video
679 echo expand_toggle > /proc/acpi/ibm/video
680 echo video_switch > /proc/acpi/ibm/video
682 Each video output device can be enabled or disabled individually.
683 Reading /proc/acpi/ibm/video shows the status of each device.
685 Automatic video switching can be enabled or disabled. When automatic
686 video switching is enabled, certain events (e.g. opening the lid,
687 docking or undocking) cause the video output device to change
688 automatically. While this can be useful, it also causes flickering
689 and, on the X40, video corruption. By disabling automatic switching,
690 the flickering or video corruption can be avoided.
692 The video_switch command cycles through the available video outputs
693 (it simulates the behavior of Fn-F7).
695 Video expansion can be toggled through this feature. This controls
696 whether the display is expanded to fill the entire LCD screen when a
697 mode with less than full resolution is used. Note that the current
698 video expansion status cannot be determined through this feature.
700 Note that on many models (particularly those using Radeon graphics
701 chips) the X driver configures the video card in a way which prevents
702 Fn-F7 from working. This also disables the video output switching
703 features of this driver, as it uses the same ACPI methods as
704 Fn-F7. Video switching on the console should still work.
706 UPDATE: refer to https://bugs.freedesktop.org/show_bug.cgi?id=2000
712 procfs: /proc/acpi/ibm/light
713 sysfs attributes: as per LED class, for the "tpacpi::thinklight" LED
717 The ThinkLight status can be read and set through the procfs interface. A
718 few models which do not make the status available will show the ThinkLight
719 status as "unknown". The available commands are:
721 echo on > /proc/acpi/ibm/light
722 echo off > /proc/acpi/ibm/light
726 The ThinkLight sysfs interface is documented by the LED class
727 documentation, in Documentation/leds-class.txt. The ThinkLight LED name
728 is "tpacpi::thinklight".
730 Due to limitations in the sysfs LED class, if the status of the ThinkLight
731 cannot be read or if it is unknown, thinkpad-acpi will report it as "off".
732 It is impossible to know if the status returned through sysfs is valid.
738 procfs: /proc/acpi/ibm/cmos
739 sysfs device attribute: cmos_command
741 This feature is mostly used internally by the ACPI firmware to keep the legacy
742 CMOS NVRAM bits in sync with the current machine state, and to record this
743 state so that the ThinkPad will retain such settings across reboots.
745 Some of these commands actually perform actions in some ThinkPad models, but
746 this is expected to disappear more and more in newer models. As an example, in
747 a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
748 real, but commands 0 to 2 don't control the mixer anymore (they have been
749 phased out) and just update the NVRAM.
751 The range of valid cmos command numbers is 0 to 21, but not all have an
752 effect and the behavior varies from model to model. Here is the behavior
753 on the X40 (tpb is the ThinkPad Buttons utility):
755 0 - Related to "Volume down" key press
756 1 - Related to "Volume up" key press
757 2 - Related to "Mute on" key press
758 3 - Related to "Access IBM" key press
759 4 - Related to "LCD brightness up" key press
760 5 - Related to "LCD brightness down" key press
761 11 - Related to "toggle screen expansion" key press/function
762 12 - Related to "ThinkLight on"
763 13 - Related to "ThinkLight off"
764 14 - Related to "ThinkLight" key press (toggle ThinkLight)
766 The cmos command interface is prone to firmware split-brain problems, as
767 in newer ThinkPads it is just a compatibility layer. Do not use it, it is
768 exported just as a debug tool.
774 procfs: /proc/acpi/ibm/led
775 sysfs attributes: as per LED class, see below for names
777 Some of the LED indicators can be controlled through this feature. On
778 some older ThinkPad models, it is possible to query the status of the
779 LED indicators as well. Newer ThinkPads cannot query the real status
780 of the LED indicators.
782 Because misuse of the LEDs could induce an unaware user to perform
783 dangerous actions (like undocking or ejecting a bay device while the
784 buses are still active), or mask an important alarm (such as a nearly
785 empty battery, or a broken battery), access to most LEDs is
788 Unrestricted access to all LEDs requires that thinkpad-acpi be
789 compiled with the CONFIG_THINKPAD_ACPI_UNSAFE_LEDS option enabled.
790 Distributions must never enable this option. Individual users that
791 are aware of the consequences are welcome to enabling it.
795 The available commands are:
797 echo '<LED number> on' >/proc/acpi/ibm/led
798 echo '<LED number> off' >/proc/acpi/ibm/led
799 echo '<LED number> blink' >/proc/acpi/ibm/led
801 The <LED number> range is 0 to 15. The set of LEDs that can be
802 controlled varies from model to model. Here is the common ThinkPad
810 5 - UltraBase battery slot
817 13, 14, 15 - (unknown)
819 All of the above can be turned on and off and can be made to blink.
823 The ThinkPad LED sysfs interface is described in detail by the LED class
824 documentation, in Documentation/leds-class.txt.
826 The LEDs are named (in LED ID order, from 0 to 12):
827 "tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt",
828 "tpacpi::dock_active", "tpacpi::bay_active", "tpacpi::dock_batt",
829 "tpacpi::unknown_led", "tpacpi::standby", "tpacpi::dock_status1",
830 "tpacpi::dock_status2", "tpacpi::unknown_led2", "tpacpi::unknown_led3",
831 "tpacpi::thinkvantage".
833 Due to limitations in the sysfs LED class, if the status of the LED
834 indicators cannot be read due to an error, thinkpad-acpi will report it as
835 a brightness of zero (same as LED off).
837 If the thinkpad firmware doesn't support reading the current status,
838 trying to read the current LED brightness will just return whatever
839 brightness was last written to that attribute.
841 These LEDs can blink using hardware acceleration. To request that a
842 ThinkPad indicator LED should blink in hardware accelerated mode, use the
843 "timer" trigger, and leave the delay_on and delay_off parameters set to
844 zero (to request hardware acceleration autodetection).
846 LEDs that are known not to exist in a given ThinkPad model are not
847 made available through the sysfs interface. If you have a dock and you
848 notice there are LEDs listed for your ThinkPad that do not exist (and
849 are not in the dock), or if you notice that there are missing LEDs,
850 a report to ibm-acpi-devel@lists.sourceforge.net is appreciated.
853 ACPI sounds -- /proc/acpi/ibm/beep
854 ----------------------------------
856 The BEEP method is used internally by the ACPI firmware to provide
857 audible alerts in various situations. This feature allows the same
858 sounds to be triggered manually.
860 The commands are non-negative integer numbers:
862 echo <number> >/proc/acpi/ibm/beep
864 The valid <number> range is 0 to 17. Not all numbers trigger sounds
865 and the sounds vary from model to model. Here is the behavior on the
868 0 - stop a sound in progress (but use 17 to stop 16)
869 2 - two beeps, pause, third beep ("low battery")
871 4 - high, followed by low-pitched beep ("unable")
873 6 - very high, followed by high-pitched beep ("AC/DC")
874 7 - high-pitched beep
875 9 - three short beeps
877 12 - low-pitched beep
878 15 - three high-pitched beeps repeating constantly, stop with 0
879 16 - one medium-pitched beep repeating constantly, stop with 17
886 procfs: /proc/acpi/ibm/thermal
887 sysfs device attributes: (hwmon "thinkpad") temp*_input
889 Most ThinkPads include six or more separate temperature sensors but only
890 expose the CPU temperature through the standard ACPI methods. This
891 feature shows readings from up to eight different sensors on older
892 ThinkPads, and up to sixteen different sensors on newer ThinkPads.
894 For example, on the X40, a typical output may be:
895 temperatures: 42 42 45 41 36 -128 33 -128
897 On the T43/p, a typical output may be:
898 temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
900 The mapping of thermal sensors to physical locations varies depending on
901 system-board model (and thus, on ThinkPad model).
903 http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
904 tries to track down these locations for various models.
906 Most (newer?) models seem to follow this pattern:
909 2: (depends on model)
910 3: (depends on model)
912 5: Main battery: main sensor
913 6: Bay battery: main sensor
914 7: Main battery: secondary sensor
915 8: Bay battery: secondary sensor
916 9-15: (depends on model)
918 For the R51 (source: Thomas Gruber):
922 For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
923 http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
924 2: System board, left side (near PCMCIA slot), reported as HDAPS temp
926 9: MCH (northbridge) to DRAM Bus
927 10: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
929 11: Power regulator, underside of system board, below F2 key
931 The A31 has a very atypical layout for the thermal sensors
932 (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
934 2: Main Battery: main sensor
936 4: Bay Battery: main sensor
939 7: Main Battery: secondary sensor
940 8: Bay Battery: secondary sensor
944 Readings from sensors that are not available return -128.
945 No commands can be written to this file.
948 Sensors that are not available return the ENXIO error. This
949 status may change at runtime, as there are hotplug thermal
950 sensors, like those inside the batteries and docks.
952 thinkpad-acpi thermal sensors are reported through the hwmon
953 subsystem, and follow all of the hwmon guidelines at
957 EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
958 ------------------------------------------------------------------------
960 This feature is marked EXPERIMENTAL because the implementation
961 directly accesses hardware registers and may not work as expected. USE
962 WITH CAUTION! To use this feature, you need to supply the
963 experimental=1 parameter when loading the module.
965 This feature dumps the values of 256 embedded controller
966 registers. Values which have changed since the last time the registers
967 were dumped are marked with a star:
969 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
970 EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
971 EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
972 EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
973 EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
974 EC 0x30: 01 07 1a 00 30 04 00 00 *85 00 00 10 00 50 00 00
975 EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
976 EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 *bc *02 *bc
977 EC 0x60: *02 *bc *02 00 00 00 00 00 00 00 00 00 00 00 00 00
978 EC 0x70: 00 00 00 00 00 12 30 40 *24 *26 *2c *27 *20 80 *1f 80
979 EC 0x80: 00 00 00 06 *37 *0e 03 00 00 00 0e 07 00 00 00 00
980 EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
981 EC 0xa0: *ff 09 ff 09 ff ff *64 00 *00 *00 *a2 41 *ff *ff *e0 00
982 EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
983 EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
984 EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
985 EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
986 EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
988 This feature can be used to determine the register holding the fan
989 speed on some models. To do that, do the following:
991 - make sure the battery is fully charged
992 - make sure the fan is running
993 - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
995 The first step makes sure various charging-related values don't
996 vary. The second ensures that the fan-related values do vary, since
997 the fan speed fluctuates a bit. The third will (hopefully) mark the
998 fan register with a star:
1000 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
1001 EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
1002 EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
1003 EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
1004 EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
1005 EC 0x30: 01 07 1a 00 30 04 00 00 85 00 00 10 00 50 00 00
1006 EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
1007 EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 bc 02 bc
1008 EC 0x60: 02 bc 02 00 00 00 00 00 00 00 00 00 00 00 00 00
1009 EC 0x70: 00 00 00 00 00 12 30 40 24 27 2c 27 21 80 1f 80
1010 EC 0x80: 00 00 00 06 *be 0d 03 00 00 00 0e 07 00 00 00 00
1011 EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
1012 EC 0xa0: ff 09 ff 09 ff ff 64 00 00 00 a2 41 ff ff e0 00
1013 EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
1014 EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
1015 EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
1016 EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
1017 EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
1019 Another set of values that varies often is the temperature
1020 readings. Since temperatures don't change vary fast, you can take
1021 several quick dumps to eliminate them.
1023 You can use a similar method to figure out the meaning of other
1024 embedded controller registers - e.g. make sure nothing else changes
1025 except the charging or discharging battery to determine which
1026 registers contain the current battery capacity, etc. If you experiment
1027 with this, do send me your results (including some complete dumps with
1028 a description of the conditions when they were taken.)
1031 LCD brightness control
1032 ----------------------
1034 procfs: /proc/acpi/ibm/brightness
1035 sysfs backlight device "thinkpad_screen"
1037 This feature allows software control of the LCD brightness on ThinkPad
1038 models which don't have a hardware brightness slider.
1040 It has some limitations: the LCD backlight cannot be actually turned
1041 on or off by this interface, it just controls the backlight brightness
1044 On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
1045 has eight brightness levels, ranging from 0 to 7. Some of the levels
1046 may not be distinct. Later Lenovo models that implement the ACPI
1047 display backlight brightness control methods have 16 levels, ranging
1050 For IBM ThinkPads, there are two interfaces to the firmware for direct
1051 brightness control, EC and UCMS (or CMOS). To select which one should be
1052 used, use the brightness_mode module parameter: brightness_mode=1 selects
1053 EC mode, brightness_mode=2 selects UCMS mode, brightness_mode=3 selects EC
1054 mode with NVRAM backing (so that brightness changes are remembered across
1057 The driver tries to select which interface to use from a table of
1058 defaults for each ThinkPad model. If it makes a wrong choice, please
1059 report this as a bug, so that we can fix it.
1061 Lenovo ThinkPads only support brightness_mode=2 (UCMS).
1063 When display backlight brightness controls are available through the
1064 standard ACPI interface, it is best to use it instead of this direct
1065 ThinkPad-specific interface. The driver will disable its native
1066 backlight brightness control interface if it detects that the standard
1067 ACPI interface is available in the ThinkPad.
1069 The brightness_enable module parameter can be used to control whether
1070 the LCD brightness control feature will be enabled when available.
1071 brightness_enable=0 forces it to be disabled. brightness_enable=1
1072 forces it to be enabled when available, even if the standard ACPI
1073 interface is also available.
1077 The available commands are:
1079 echo up >/proc/acpi/ibm/brightness
1080 echo down >/proc/acpi/ibm/brightness
1081 echo 'level <level>' >/proc/acpi/ibm/brightness
1085 The interface is implemented through the backlight sysfs class, which is
1086 poorly documented at this time.
1088 Locate the thinkpad_screen device under /sys/class/backlight, and inside
1089 it there will be the following attributes:
1092 Reads the maximum brightness the hardware can be set to.
1093 The minimum is always zero.
1096 Reads what brightness the screen is set to at this instant.
1099 Writes request the driver to change brightness to the
1100 given value. Reads will tell you what brightness the
1101 driver is trying to set the display to when "power" is set
1102 to zero and the display has not been dimmed by a kernel
1103 power management event.
1106 power management mode, where 0 is "display on", and 1 to 3
1107 will dim the display backlight to brightness level 0
1108 because thinkpad-acpi cannot really turn the backlight
1109 off. Kernel power management events can temporarily
1110 increase the current power management level, i.e. they can
1116 Whatever you do, do NOT ever call thinkpad-acpi backlight-level change
1117 interface and the ACPI-based backlight level change interface
1118 (available on newer BIOSes, and driven by the Linux ACPI video driver)
1119 at the same time. The two will interact in bad ways, do funny things,
1120 and maybe reduce the life of the backlight lamps by needlessly kicking
1121 its level up and down at every change.
1124 Volume control -- /proc/acpi/ibm/volume
1125 ---------------------------------------
1127 This feature allows volume control on ThinkPad models which don't have
1128 a hardware volume knob. The available commands are:
1130 echo up >/proc/acpi/ibm/volume
1131 echo down >/proc/acpi/ibm/volume
1132 echo mute >/proc/acpi/ibm/volume
1133 echo 'level <level>' >/proc/acpi/ibm/volume
1135 The <level> number range is 0 to 15 although not all of them may be
1136 distinct. The unmute the volume after the mute command, use either the
1137 up or down command (the level command will not unmute the volume).
1138 The current volume level and mute state is shown in the file.
1140 The ALSA mixer interface to this feature is still missing, but patches
1141 to add it exist. That problem should be addressed in the not so
1145 Fan control and monitoring: fan speed, fan enable/disable
1146 ---------------------------------------------------------
1148 procfs: /proc/acpi/ibm/fan
1149 sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
1150 pwm1_enable, fan2_input
1151 sysfs hwmon driver attributes: fan_watchdog
1153 NOTE NOTE NOTE: fan control operations are disabled by default for
1154 safety reasons. To enable them, the module parameter "fan_control=1"
1155 must be given to thinkpad-acpi.
1157 This feature attempts to show the current fan speed, control mode and
1158 other fan data that might be available. The speed is read directly
1159 from the hardware registers of the embedded controller. This is known
1160 to work on later R, T, X and Z series ThinkPads but may show a bogus
1161 value on other models.
1163 Some Lenovo ThinkPads support a secondary fan. This fan cannot be
1164 controlled separately, it shares the main fan control.
1168 Most ThinkPad fans work in "levels" at the firmware interface. Level 0
1169 stops the fan. The higher the level, the higher the fan speed, although
1170 adjacent levels often map to the same fan speed. 7 is the highest
1171 level, where the fan reaches the maximum recommended speed.
1173 Level "auto" means the EC changes the fan level according to some
1174 internal algorithm, usually based on readings from the thermal sensors.
1176 There is also a "full-speed" level, also known as "disengaged" level.
1177 In this level, the EC disables the speed-locked closed-loop fan control,
1178 and drives the fan as fast as it can go, which might exceed hardware
1179 limits, so use this level with caution.
1181 The fan usually ramps up or down slowly from one speed to another, and
1182 it is normal for the EC to take several seconds to react to fan
1183 commands. The full-speed level may take up to two minutes to ramp up to
1184 maximum speed, and in some ThinkPads, the tachometer readings go stale
1185 while the EC is transitioning to the full-speed level.
1187 WARNING WARNING WARNING: do not leave the fan disabled unless you are
1188 monitoring all of the temperature sensor readings and you are ready to
1189 enable it if necessary to avoid overheating.
1191 An enabled fan in level "auto" may stop spinning if the EC decides the
1192 ThinkPad is cool enough and doesn't need the extra airflow. This is
1193 normal, and the EC will spin the fan up if the various thermal readings
1196 On the X40, this seems to depend on the CPU and HDD temperatures.
1197 Specifically, the fan is turned on when either the CPU temperature
1198 climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The
1199 fan is turned off when the CPU temperature drops to 49 degrees and the
1200 HDD temperature drops to 41 degrees. These thresholds cannot
1201 currently be controlled.
1203 The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
1204 certain conditions are met. It will override any fan programming done
1205 through thinkpad-acpi.
1207 The thinkpad-acpi kernel driver can be programmed to revert the fan
1208 level to a safe setting if userspace does not issue one of the procfs
1209 fan commands: "enable", "disable", "level" or "watchdog", or if there
1210 are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
1211 set to 1, manual mode) within a configurable amount of time of up to
1212 120 seconds. This functionality is called fan safety watchdog.
1214 Note that the watchdog timer stops after it enables the fan. It will be
1215 rearmed again automatically (using the same interval) when one of the
1216 above mentioned fan commands is received. The fan watchdog is,
1217 therefore, not suitable to protect against fan mode changes made through
1218 means other than the "enable", "disable", and "level" procfs fan
1219 commands, or the hwmon fan control sysfs interface.
1223 The fan may be enabled or disabled with the following commands:
1225 echo enable >/proc/acpi/ibm/fan
1226 echo disable >/proc/acpi/ibm/fan
1228 Placing a fan on level 0 is the same as disabling it. Enabling a fan
1229 will try to place it in a safe level if it is too slow or disabled.
1231 The fan level can be controlled with the command:
1233 echo 'level <level>' > /proc/acpi/ibm/fan
1235 Where <level> is an integer from 0 to 7, or one of the words "auto" or
1236 "full-speed" (without the quotes). Not all ThinkPads support the "auto"
1237 and "full-speed" levels. The driver accepts "disengaged" as an alias for
1238 "full-speed", and reports it as "disengaged" for backwards
1241 On the X31 and X40 (and ONLY on those models), the fan speed can be
1242 controlled to a certain degree. Once the fan is running, it can be
1243 forced to run faster or slower with the following command:
1245 echo 'speed <speed>' > /proc/acpi/ibm/fan
1247 The sustainable range of fan speeds on the X40 appears to be from about
1248 3700 to about 7350. Values outside this range either do not have any
1249 effect or the fan speed eventually settles somewhere in that range. The
1250 fan cannot be stopped or started with this command. This functionality
1251 is incomplete, and not available through the sysfs interface.
1253 To program the safety watchdog, use the "watchdog" command.
1255 echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1257 If you want to disable the watchdog, use 0 as the interval.
1261 The sysfs interface follows the hwmon subsystem guidelines for the most
1262 part, and the exception is the fan safety watchdog.
1264 Writes to any of the sysfs attributes may return the EINVAL error if
1265 that operation is not supported in a given ThinkPad or if the parameter
1266 is out-of-bounds, and EPERM if it is forbidden. They may also return
1267 EINTR (interrupted system call), and EIO (I/O error while trying to talk
1270 Features not yet implemented by the driver return ENOSYS.
1272 hwmon device attribute pwm1_enable:
1273 0: PWM offline (fan is set to full-speed mode)
1274 1: Manual PWM control (use pwm1 to set fan level)
1275 2: Hardware PWM control (EC "auto" mode)
1276 3: reserved (Software PWM control, not implemented yet)
1278 Modes 0 and 2 are not supported by all ThinkPads, and the
1279 driver is not always able to detect this. If it does know a
1280 mode is unsupported, it will return -EINVAL.
1282 hwmon device attribute pwm1:
1283 Fan level, scaled from the firmware values of 0-7 to the hwmon
1284 scale of 0-255. 0 means fan stopped, 255 means highest normal
1287 This attribute only commands the fan if pmw1_enable is set to 1
1288 (manual PWM control).
1290 hwmon device attribute fan1_input:
1291 Fan tachometer reading, in RPM. May go stale on certain
1292 ThinkPads while the EC transitions the PWM to offline mode,
1293 which can take up to two minutes. May return rubbish on older
1296 hwmon device attribute fan2_input:
1297 Fan tachometer reading, in RPM, for the secondary fan.
1298 Available only on some ThinkPads. If the secondary fan is
1299 not installed, will always read 0.
1301 hwmon driver attribute fan_watchdog:
1302 Fan safety watchdog timer interval, in seconds. Minimum is
1303 1 second, maximum is 120 seconds. 0 disables the watchdog.
1305 To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
1307 To start the fan in a safe mode: set pwm1_enable to 2. If that fails
1308 with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
1309 would be the safest choice, though).
1315 procfs: /proc/acpi/ibm/wan
1316 sysfs device attribute: wwan_enable (deprecated)
1317 sysfs rfkill class: switch "tpacpi_wwan_sw"
1319 This feature shows the presence and current state of the built-in
1320 Wireless WAN device.
1322 If the ThinkPad supports it, the WWAN state is stored in NVRAM,
1323 so it is kept across reboots and power-off.
1325 It was tested on a Lenovo ThinkPad X60. It should probably work on other
1326 ThinkPad models which come with this module installed.
1330 If the W-WAN card is installed, the following commands can be used:
1332 echo enable > /proc/acpi/ibm/wan
1333 echo disable > /proc/acpi/ibm/wan
1337 If the W-WAN card is installed, it can be enabled /
1338 disabled through the "wwan_enable" thinkpad-acpi device
1339 attribute, and its current status can also be queried.
1342 0: disables WWAN card / WWAN card is disabled
1343 1: enables WWAN card / WWAN card is enabled.
1345 Note: this interface has been superseded by the generic rfkill
1346 class. It has been deprecated, and it will be removed in year
1349 rfkill controller switch "tpacpi_wwan_sw": refer to
1350 Documentation/rfkill.txt for details.
1356 This feature is marked EXPERIMENTAL because it has not been extensively
1357 tested and validated in various ThinkPad models yet. The feature may not
1358 work as expected. USE WITH CAUTION! To use this feature, you need to supply
1359 the experimental=1 parameter when loading the module.
1361 sysfs rfkill class: switch "tpacpi_uwb_sw"
1363 This feature exports an rfkill controller for the UWB device, if one is
1364 present and enabled in the BIOS.
1368 rfkill controller switch "tpacpi_uwb_sw": refer to
1369 Documentation/rfkill.txt for details.
1372 Multiple Commands, Module Parameters
1373 ------------------------------------
1375 Multiple commands can be written to the proc files in one shot by
1376 separating them with commas, for example:
1378 echo enable,0xffff > /proc/acpi/ibm/hotkey
1379 echo lcd_disable,crt_enable > /proc/acpi/ibm/video
1381 Commands can also be specified when loading the thinkpad-acpi module,
1384 modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
1387 Enabling debugging output
1388 -------------------------
1390 The module takes a debug parameter which can be used to selectively
1391 enable various classes of debugging output, for example:
1393 modprobe thinkpad_acpi debug=0xffff
1395 will enable all debugging output classes. It takes a bitmask, so
1396 to enable more than one output class, just add their values.
1398 Debug bitmask Description
1399 0x8000 Disclose PID of userspace programs
1400 accessing some functions of the driver
1401 0x0001 Initialization and probing
1403 0x0004 RF Transmitter control (RFKILL)
1404 (bluetooth, WWAN, UWB...)
1405 0x0008 HKEY event interface, hotkeys
1407 0x0020 Backlight brightness
1409 There is also a kernel build option to enable more debugging
1410 information, which may be necessary to debug driver problems.
1412 The level of debugging information output by the driver can be changed
1413 at runtime through sysfs, using the driver attribute debug_level. The
1414 attribute takes the same bitmask as the debug module parameter above.
1417 Force loading of module
1418 -----------------------
1420 If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1421 the module parameter force_load=1. Regardless of whether this works or
1422 not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
1425 Sysfs interface changelog:
1427 0x000100: Initial sysfs support, as a single platform driver and
1429 0x000200: Hot key support for 32 hot keys, and radio slider switch
1431 0x010000: Hot keys are now handled by default over the input
1432 layer, the radio switch generates input event EV_RADIO,
1433 and the driver enables hot key handling by default in
1436 0x020000: ABI fix: added a separate hwmon platform device and
1437 driver, which must be located by name (thinkpad)
1438 and the hwmon class for libsensors4 (lm-sensors 3)
1439 compatibility. Moved all hwmon attributes to this
1440 new platform device.
1442 0x020100: Marker for thinkpad-acpi with hot key NVRAM polling
1443 support. If you must, use it to know you should not
1444 start a userspace NVRAM poller (allows to detect when
1445 NVRAM is compiled out by the user because it is
1446 unneeded/undesired in the first place).
1447 0x020101: Marker for thinkpad-acpi with hot key NVRAM polling
1448 and proper hotkey_mask semantics (version 8 of the
1449 NVRAM polling patch). Some development snapshots of
1450 0.18 had an earlier version that did strange things
1453 0x020200: Add poll()/select() support to the following attributes:
1454 hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason
1456 0x020300: hotkey enable/disable support removed, attributes
1457 hotkey_bios_enabled and hotkey_enable deprecated and
1460 0x020400: Marker for 16 LEDs support. Also, LEDs that are known
1461 to not exist in a given model are not registered with
1462 the LED sysfs class anymore.
1464 0x020500: Updated hotkey driver, hotkey_mask is always available
1465 and it is always able to disable hot keys. Very old
1466 thinkpads are properly supported. hotkey_bios_mask
1467 is deprecated and marked for removal.
git.openpandora.org / pandora-kernel.git / blob