Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

at v4.13-rc1 1480 lines 55 kB view raw
1 ThinkPad ACPI Extras Driver 2 3 Version 0.25 4 October 16th, 2013 5 6 Borislav Deianov <borislav@users.sf.net> 7 Henrique de Moraes Holschuh <hmh@hmh.eng.br> 8 http://ibm-acpi.sf.net/ 9 10 11This 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 192.6.22, and release 0.14. It was moved to drivers/platform/x86 for 20kernel 2.6.29 and release 0.22. 21 22The driver is named "thinkpad-acpi". In some places, like module 23names and log messages, "thinkpad_acpi" is used because of userspace 24issues. 25 26"tpacpi" is used as a shorthand where "thinkpad-acpi" would be too 27long due to length limitations on some Linux kernel versions. 28 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 37 - video output switching, expansion control 38 - ThinkLight on and off 39 - CMOS/UCMS control 40 - LED control 41 - ACPI sounds 42 - temperature sensors 43 - Experimental: embedded controller register dump 44 - LCD brightness control 45 - Volume control 46 - Fan control and monitoring: fan speed, fan enable/disable 47 - WAN enable and disable 48 - UWB enable and disable 49 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 56 - a copy of your ACPI tables, using the "acpidump" utility 57 - a copy of the output of dmidecode, with serial numbers 58 and UUIDs masked off 59 - 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 69sources, 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 73 74Features 75-------- 76 77The driver exports two different interfaces to userspace, which can be 78used to access the features it provides. One is a legacy procfs-based 79interface, which will be removed at some time in the future. The other 80is a new sysfs-based interface which is not complete yet. 81 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. 110 111The 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, 115for 2.6.23+ this is /sys/bus/platform/drivers/thinkpad_acpi/ and 116/sys/bus/platform/drivers/thinkpad_hwmon/ 117 118Sysfs device attributes are on the thinkpad_acpi device sysfs attribute 119space, for 2.6.23+ this is /sys/devices/platform/thinkpad_acpi/. 120 121Sysfs device attributes for the sensors and fan are on the 122thinkpad_hwmon device's sysfs attribute space, but you should locate it 123looking for a hwmon device with the name attribute of "thinkpad", or 124better yet, through libsensors. 125 126 127Driver version 128-------------- 129 130procfs: /proc/acpi/ibm/driver 131sysfs driver attribute: version 132 133The driver name and version. No commands can be written to this file. 134 135 136Sysfs 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 152Changes 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 167 168Hot keys 169-------- 170 171procfs: /proc/acpi/ibm/hotkey 172sysfs device attribute: hotkey_* 173 174In a ThinkPad, the ACPI HKEY handler is responsible for communicating 175some 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 180The driver enables the HKEY ("hot key") event reporting automatically 181when loaded, and disables it when it is removed. 182 183The driver will report HKEY events in the following format: 184 185 ibm/hotkey HKEY 00000080 0000xxxx 186 187Some of these events refer to hot key presses, but not all of them. 188 189The 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. 193 194The 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!). 199 200Not 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 202by 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. 208 209Note that unmasking some keys prevents their default behavior. For 210example, if Fn+F5 is unmasked, that key will no longer enable/disable 211Bluetooth by itself in firmware. 212 213Note 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. 218 219procfs notes: 220 221The following commands can be written to the /proc/acpi/ibm/hotkey file: 222 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 227 228The 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 234The 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 239sysfs notes: 240 241 hotkey_bios_enabled: 242 DEPRECATED, WILL BE REMOVED SOON. 243 244 Returns 0. 245 246 hotkey_bios_mask: 247 DEPRECATED, DON'T USE, WILL BE REMOVED IN THE FUTURE. 248 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. 254 255 hotkey_enable: 256 DEPRECATED, WILL BE REMOVED SOON. 257 258 0: returns -EPERM 259 1: does nothing 260 261 hotkey_mask: 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. 266 267 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 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 280 used by the driver. 281 282 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 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. 292 293 Warning: when in NVRAM mode, the volume up/down/mute 294 keys are synthesized according to changes in the mixer, 295 which uses a single volume up or volume down hotkey 296 press to unmute, as per the ThinkPad volume mixer user 297 interface. When in ACPI event mode, volume up/down/mute 298 events are reported by the firmware and can behave 299 differently (and that behaviour changes with firmware 300 version -- not just with firmware models -- as well as 301 OSI(Linux) state). 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 may 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 317 hotkey_radio_sw: 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. 322 323 This attribute has poll()/select() support. 324 325 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 332 wakeup_reason: 333 Set to 1 if the system is waking up because the user 334 requested a bay ejection. Set to 2 if the system is 335 waking up because the user requested the system to 336 undock. Set to zero for normal wake-ups or wake-ups 337 due to unknown reasons. 338 339 This attribute has poll()/select() support. 340 341 wakeup_hotunplug_complete: 342 Set to 1 if the system was waken up because of an 343 undock or bay ejection request, and that request 344 was successfully completed. At this point, it might 345 be useful to send the system back to sleep, at the 346 user's choice. Refer to HKEY events 0x4003 and 347 0x3003, below. 348 349 This attribute has poll()/select() support. 350 351input layer notes: 352 353A Hot key is mapped to a single input layer EV_KEY event, possibly 354followed by an EV_MSC MSC_SCAN event that shall contain that key's scan 355code. An EV_SYN event will always be generated to mark the end of the 356event block. 357 358Do not use the EV_MSC MSC_SCAN events to process keys. They are to be 359used as a helper to remap keys, only. They are particularly useful when 360remapping KEY_UNKNOWN keys. 361 362The events are available in an input device, with the following id: 363 364 Bus: BUS_HOST 365 vendor: 0x1014 (PCI_VENDOR_ID_IBM) or 366 0x17aa (PCI_VENDOR_ID_LENOVO) 367 product: 0x5054 ("TP") 368 version: 0x4101 369 370The version will have its LSB incremented if the keymap changes in a 371backwards-compatible way. The MSB shall always be 0x41 for this input 372device. If the MSB is not 0x41, do not use the device as described in 373this section, as it is either something else (e.g. another input device 374exported by a thinkpad driver, such as HDAPS) or its functionality has 375been changed in a non-backwards compatible way. 376 377Adding other event types for other functionalities shall be considered a 378backwards-compatible change for this input device. 379 380Thinkpad-acpi Hot Key event map (version 0x4101): 381 382ACPI Scan 383event code Key Notes 384 3850x1001 0x00 FN+F1 - 386 3870x1002 0x01 FN+F2 IBM: battery (rare) 388 Lenovo: Screen lock 389 3900x1003 0x02 FN+F3 Many IBM models always report 391 this hot key, even with hot keys 392 disabled or with Fn+F3 masked 393 off 394 IBM: screen lock, often turns 395 off the ThinkLight as side-effect 396 Lenovo: battery 397 3980x1004 0x03 FN+F4 Sleep button (ACPI sleep button 399 semantics, i.e. sleep-to-RAM). 400 It always generates some kind 401 of event, either the hot key 402 event or an ACPI sleep button 403 event. The firmware may 404 refuse to generate further FN+F4 405 key presses until a S3 or S4 ACPI 406 sleep cycle is performed or some 407 time passes. 408 4090x1005 0x04 FN+F5 Radio. Enables/disables 410 the internal Bluetooth hardware 411 and W-WAN card if left in control 412 of the firmware. Does not affect 413 the WLAN card. 414 Should be used to turn on/off all 415 radios (Bluetooth+W-WAN+WLAN), 416 really. 417 4180x1006 0x05 FN+F6 - 419 4200x1007 0x06 FN+F7 Video output cycle. 421 Do you feel lucky today? 422 4230x1008 0x07 FN+F8 IBM: toggle screen expand 424 Lenovo: configure UltraNav, 425 or toggle screen expand 426 4270x1009 0x08 FN+F9 - 428 .. .. .. 4290x100B 0x0A FN+F11 - 430 4310x100C 0x0B FN+F12 Sleep to disk. You are always 432 supposed to handle it yourself, 433 either through the ACPI event, 434 or through a hotkey event. 435 The firmware may refuse to 436 generate further FN+F12 key 437 press events until a S3 or S4 438 ACPI sleep cycle is performed, 439 or some time passes. 440 4410x100D 0x0C FN+BACKSPACE - 4420x100E 0x0D FN+INSERT - 4430x100F 0x0E FN+DELETE - 444 4450x1010 0x0F FN+HOME Brightness up. This key is 446 always handled by the firmware 447 in IBM ThinkPads, even when 448 unmasked. Just leave it alone. 449 For Lenovo ThinkPads with a new 450 BIOS, it has to be handled either 451 by the ACPI OSI, or by userspace. 452 The driver does the right thing, 453 never mess with this. 4540x1011 0x10 FN+END Brightness down. See brightness 455 up for details. 456 4570x1012 0x11 FN+PGUP ThinkLight toggle. This key is 458 always handled by the firmware, 459 even when unmasked. 460 4610x1013 0x12 FN+PGDOWN - 462 4630x1014 0x13 FN+SPACE Zoom key 464 4650x1015 0x14 VOLUME UP Internal mixer volume up. This 466 key is always handled by the 467 firmware, even when unmasked. 468 NOTE: Lenovo seems to be changing 469 this. 4700x1016 0x15 VOLUME DOWN Internal mixer volume up. This 471 key is always handled by the 472 firmware, even when unmasked. 473 NOTE: Lenovo seems to be changing 474 this. 4750x1017 0x16 MUTE Mute internal mixer. This 476 key is always handled by the 477 firmware, even when unmasked. 478 4790x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key 480 4810x1019 0x18 unknown 482.. .. .. 4830x1020 0x1F unknown 484 485The ThinkPad firmware does not allow one to differentiate when most hot 486keys are pressed or released (either that, or we don't know how to, yet). 487For these keys, the driver generates a set of events for a key press and 488immediately issues the same set of events for a key release. It is 489unknown by the driver if the ThinkPad firmware triggered these events on 490hot key press or release, but the firmware will do it for either one, not 491both. 492 493If a key is mapped to KEY_RESERVED, it generates no input events at all. 494If a key is mapped to KEY_UNKNOWN, it generates an input event that 495includes an scan code. If a key is mapped to anything else, it will 496generate input device EV_KEY events. 497 498In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW 499events for switches: 500 501SW_RFKILL_ALL T60 and later hardware rfkill rocker switch 502SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A 503 504Non hotkey ACPI HKEY event map: 505------------------------------- 506 507Events that are never propagated by the driver: 508 5090x2304 System is waking up from suspend to undock 5100x2305 System is waking up from suspend to eject bay 5110x2404 System is waking up from hibernation to undock 5120x2405 System is waking up from hibernation to eject bay 5130x5001 Lid closed 5140x5002 Lid opened 5150x5009 Tablet swivel: switched to tablet mode 5160x500A Tablet swivel: switched to normal mode 5170x5010 Brightness level changed/control event 5180x6000 KEYBOARD: Numlock key pressed 5190x6005 KEYBOARD: Fn key pressed (TO BE VERIFIED) 5200x7000 Radio Switch may have changed state 521 522 523Events that are propagated by the driver to userspace: 524 5250x2313 ALARM: System is waking up from suspend because 526 the battery is nearly empty 5270x2413 ALARM: System is waking up from hibernation because 528 the battery is nearly empty 5290x3003 Bay ejection (see 0x2x05) complete, can sleep again 5300x3006 Bay hotplug request (hint to power up SATA link when 531 the optical drive tray is ejected) 5320x4003 Undocked (see 0x2x04), can sleep again 5330x4010 Docked into hotplug port replicator (non-ACPI dock) 5340x4011 Undocked from hotplug port replicator (non-ACPI dock) 5350x500B Tablet pen inserted into its storage bay 5360x500C Tablet pen removed from its storage bay 5370x6011 ALARM: battery is too hot 5380x6012 ALARM: battery is extremely hot 5390x6021 ALARM: a sensor is too hot 5400x6022 ALARM: a sensor is extremely hot 5410x6030 System thermal table changed 5420x6040 Nvidia Optimus/AC adapter related (TO BE VERIFIED) 5430x60C0 X1 Yoga 2016, Tablet mode status changed 544 545Battery nearly empty alarms are a last resort attempt to get the 546operating system to hibernate or shutdown cleanly (0x2313), or shutdown 547cleanly (0x2413) before power is lost. They must be acted upon, as the 548wake up caused by the firmware will have negated most safety nets... 549 550When any of the "too hot" alarms happen, according to Lenovo the user 551should suspend or hibernate the laptop (and in the case of battery 552alarms, unplug the AC adapter) to let it cool down. These alarms do 553signal that something is wrong, they should never happen on normal 554operating conditions. 555 556The "extremely hot" alarms are emergencies. According to Lenovo, the 557operating system is to force either an immediate suspend or hibernate 558cycle, or a system shutdown. Obviously, something is very wrong if this 559happens. 560 561 562Brightness hotkey notes: 563 564Don't mess with the brightness hotkeys in a Thinkpad. If you want 565notifications for OSD, use the sysfs backlight class event support. 566 567The driver will issue KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN events 568automatically for the cases were userspace has to do something to 569implement brightness changes. When you override these events, you will 570either fail to handle properly the ThinkPads that require explicit 571action to change backlight brightness, or the ThinkPads that require 572that no action be taken to work properly. 573 574 575Bluetooth 576--------- 577 578procfs: /proc/acpi/ibm/bluetooth 579sysfs device attribute: bluetooth_enable (deprecated) 580sysfs rfkill class: switch "tpacpi_bluetooth_sw" 581 582This feature shows the presence and current state of a ThinkPad 583Bluetooth device in the internal ThinkPad CDC slot. 584 585If the ThinkPad supports it, the Bluetooth state is stored in NVRAM, 586so it is kept across reboots and power-off. 587 588Procfs notes: 589 590If Bluetooth is installed, the following commands can be used: 591 592 echo enable > /proc/acpi/ibm/bluetooth 593 echo disable > /proc/acpi/ibm/bluetooth 594 595Sysfs notes: 596 597 If the Bluetooth CDC card is installed, it can be enabled / 598 disabled through the "bluetooth_enable" thinkpad-acpi device 599 attribute, and its current status can also be queried. 600 601 enable: 602 0: disables Bluetooth / Bluetooth is disabled 603 1: enables Bluetooth / Bluetooth is enabled. 604 605 Note: this interface has been superseded by the generic rfkill 606 class. It has been deprecated, and it will be removed in year 607 2010. 608 609 rfkill controller switch "tpacpi_bluetooth_sw": refer to 610 Documentation/rfkill.txt for details. 611 612 613Video output control -- /proc/acpi/ibm/video 614-------------------------------------------- 615 616This feature allows control over the devices used for video output - 617LCD, CRT or DVI (if available). The following commands are available: 618 619 echo lcd_enable > /proc/acpi/ibm/video 620 echo lcd_disable > /proc/acpi/ibm/video 621 echo crt_enable > /proc/acpi/ibm/video 622 echo crt_disable > /proc/acpi/ibm/video 623 echo dvi_enable > /proc/acpi/ibm/video 624 echo dvi_disable > /proc/acpi/ibm/video 625 echo auto_enable > /proc/acpi/ibm/video 626 echo auto_disable > /proc/acpi/ibm/video 627 echo expand_toggle > /proc/acpi/ibm/video 628 echo video_switch > /proc/acpi/ibm/video 629 630NOTE: Access to this feature is restricted to processes owning the 631CAP_SYS_ADMIN capability for safety reasons, as it can interact badly 632enough with some versions of X.org to crash it. 633 634Each video output device can be enabled or disabled individually. 635Reading /proc/acpi/ibm/video shows the status of each device. 636 637Automatic video switching can be enabled or disabled. When automatic 638video switching is enabled, certain events (e.g. opening the lid, 639docking or undocking) cause the video output device to change 640automatically. While this can be useful, it also causes flickering 641and, on the X40, video corruption. By disabling automatic switching, 642the flickering or video corruption can be avoided. 643 644The video_switch command cycles through the available video outputs 645(it simulates the behavior of Fn-F7). 646 647Video expansion can be toggled through this feature. This controls 648whether the display is expanded to fill the entire LCD screen when a 649mode with less than full resolution is used. Note that the current 650video expansion status cannot be determined through this feature. 651 652Note that on many models (particularly those using Radeon graphics 653chips) the X driver configures the video card in a way which prevents 654Fn-F7 from working. This also disables the video output switching 655features of this driver, as it uses the same ACPI methods as 656Fn-F7. Video switching on the console should still work. 657 658UPDATE: refer to https://bugs.freedesktop.org/show_bug.cgi?id=2000 659 660 661ThinkLight control 662------------------ 663 664procfs: /proc/acpi/ibm/light 665sysfs attributes: as per LED class, for the "tpacpi::thinklight" LED 666 667procfs notes: 668 669The ThinkLight status can be read and set through the procfs interface. A 670few models which do not make the status available will show the ThinkLight 671status as "unknown". The available commands are: 672 673 echo on > /proc/acpi/ibm/light 674 echo off > /proc/acpi/ibm/light 675 676sysfs notes: 677 678The ThinkLight sysfs interface is documented by the LED class 679documentation, in Documentation/leds/leds-class.txt. The ThinkLight LED name 680is "tpacpi::thinklight". 681 682Due to limitations in the sysfs LED class, if the status of the ThinkLight 683cannot be read or if it is unknown, thinkpad-acpi will report it as "off". 684It is impossible to know if the status returned through sysfs is valid. 685 686 687CMOS/UCMS control 688----------------- 689 690procfs: /proc/acpi/ibm/cmos 691sysfs device attribute: cmos_command 692 693This feature is mostly used internally by the ACPI firmware to keep the legacy 694CMOS NVRAM bits in sync with the current machine state, and to record this 695state so that the ThinkPad will retain such settings across reboots. 696 697Some of these commands actually perform actions in some ThinkPad models, but 698this is expected to disappear more and more in newer models. As an example, in 699a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for 700real, but commands 0 to 2 don't control the mixer anymore (they have been 701phased out) and just update the NVRAM. 702 703The range of valid cmos command numbers is 0 to 21, but not all have an 704effect and the behavior varies from model to model. Here is the behavior 705on the X40 (tpb is the ThinkPad Buttons utility): 706 707 0 - Related to "Volume down" key press 708 1 - Related to "Volume up" key press 709 2 - Related to "Mute on" key press 710 3 - Related to "Access IBM" key press 711 4 - Related to "LCD brightness up" key press 712 5 - Related to "LCD brightness down" key press 713 11 - Related to "toggle screen expansion" key press/function 714 12 - Related to "ThinkLight on" 715 13 - Related to "ThinkLight off" 716 14 - Related to "ThinkLight" key press (toggle ThinkLight) 717 718The cmos command interface is prone to firmware split-brain problems, as 719in newer ThinkPads it is just a compatibility layer. Do not use it, it is 720exported just as a debug tool. 721 722 723LED control 724----------- 725 726procfs: /proc/acpi/ibm/led 727sysfs attributes: as per LED class, see below for names 728 729Some of the LED indicators can be controlled through this feature. On 730some older ThinkPad models, it is possible to query the status of the 731LED indicators as well. Newer ThinkPads cannot query the real status 732of the LED indicators. 733 734Because misuse of the LEDs could induce an unaware user to perform 735dangerous actions (like undocking or ejecting a bay device while the 736buses are still active), or mask an important alarm (such as a nearly 737empty battery, or a broken battery), access to most LEDs is 738restricted. 739 740Unrestricted access to all LEDs requires that thinkpad-acpi be 741compiled with the CONFIG_THINKPAD_ACPI_UNSAFE_LEDS option enabled. 742Distributions must never enable this option. Individual users that 743are aware of the consequences are welcome to enabling it. 744 745Audio mute and microphone mute LEDs are supported, but currently not 746visible to userspace. They are used by the snd-hda-intel audio driver. 747 748procfs notes: 749 750The available commands are: 751 752 echo '<LED number> on' >/proc/acpi/ibm/led 753 echo '<LED number> off' >/proc/acpi/ibm/led 754 echo '<LED number> blink' >/proc/acpi/ibm/led 755 756The <LED number> range is 0 to 15. The set of LEDs that can be 757controlled varies from model to model. Here is the common ThinkPad 758mapping: 759 760 0 - power 761 1 - battery (orange) 762 2 - battery (green) 763 3 - UltraBase/dock 764 4 - UltraBay 765 5 - UltraBase battery slot 766 6 - (unknown) 767 7 - standby 768 8 - dock status 1 769 9 - dock status 2 770 10, 11 - (unknown) 771 12 - thinkvantage 772 13, 14, 15 - (unknown) 773 774All of the above can be turned on and off and can be made to blink. 775 776sysfs notes: 777 778The ThinkPad LED sysfs interface is described in detail by the LED class 779documentation, in Documentation/leds/leds-class.txt. 780 781The LEDs are named (in LED ID order, from 0 to 12): 782"tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt", 783"tpacpi::dock_active", "tpacpi::bay_active", "tpacpi::dock_batt", 784"tpacpi::unknown_led", "tpacpi::standby", "tpacpi::dock_status1", 785"tpacpi::dock_status2", "tpacpi::unknown_led2", "tpacpi::unknown_led3", 786"tpacpi::thinkvantage". 787 788Due to limitations in the sysfs LED class, if the status of the LED 789indicators cannot be read due to an error, thinkpad-acpi will report it as 790a brightness of zero (same as LED off). 791 792If the thinkpad firmware doesn't support reading the current status, 793trying to read the current LED brightness will just return whatever 794brightness was last written to that attribute. 795 796These LEDs can blink using hardware acceleration. To request that a 797ThinkPad indicator LED should blink in hardware accelerated mode, use the 798"timer" trigger, and leave the delay_on and delay_off parameters set to 799zero (to request hardware acceleration autodetection). 800 801LEDs that are known not to exist in a given ThinkPad model are not 802made available through the sysfs interface. If you have a dock and you 803notice there are LEDs listed for your ThinkPad that do not exist (and 804are not in the dock), or if you notice that there are missing LEDs, 805a report to ibm-acpi-devel@lists.sourceforge.net is appreciated. 806 807 808ACPI sounds -- /proc/acpi/ibm/beep 809---------------------------------- 810 811The BEEP method is used internally by the ACPI firmware to provide 812audible alerts in various situations. This feature allows the same 813sounds to be triggered manually. 814 815The commands are non-negative integer numbers: 816 817 echo <number> >/proc/acpi/ibm/beep 818 819The valid <number> range is 0 to 17. Not all numbers trigger sounds 820and the sounds vary from model to model. Here is the behavior on the 821X40: 822 823 0 - stop a sound in progress (but use 17 to stop 16) 824 2 - two beeps, pause, third beep ("low battery") 825 3 - single beep 826 4 - high, followed by low-pitched beep ("unable") 827 5 - single beep 828 6 - very high, followed by high-pitched beep ("AC/DC") 829 7 - high-pitched beep 830 9 - three short beeps 831 10 - very long beep 832 12 - low-pitched beep 833 15 - three high-pitched beeps repeating constantly, stop with 0 834 16 - one medium-pitched beep repeating constantly, stop with 17 835 17 - stop 16 836 837 838Temperature sensors 839------------------- 840 841procfs: /proc/acpi/ibm/thermal 842sysfs device attributes: (hwmon "thinkpad") temp*_input 843 844Most ThinkPads include six or more separate temperature sensors but only 845expose the CPU temperature through the standard ACPI methods. This 846feature shows readings from up to eight different sensors on older 847ThinkPads, and up to sixteen different sensors on newer ThinkPads. 848 849For example, on the X40, a typical output may be: 850temperatures: 42 42 45 41 36 -128 33 -128 851 852On the T43/p, a typical output may be: 853temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128 854 855The mapping of thermal sensors to physical locations varies depending on 856system-board model (and thus, on ThinkPad model). 857 858http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that 859tries to track down these locations for various models. 860 861Most (newer?) models seem to follow this pattern: 862 8631: CPU 8642: (depends on model) 8653: (depends on model) 8664: GPU 8675: Main battery: main sensor 8686: Bay battery: main sensor 8697: Main battery: secondary sensor 8708: Bay battery: secondary sensor 8719-15: (depends on model) 872 873For the R51 (source: Thomas Gruber): 8742: Mini-PCI 8753: Internal HDD 876 877For the T43, T43/p (source: Shmidoax/Thinkwiki.org) 878http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p 8792: System board, left side (near PCMCIA slot), reported as HDAPS temp 8803: PCMCIA slot 8819: MCH (northbridge) to DRAM Bus 88210: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI 883 card, under touchpad 88411: Power regulator, underside of system board, below F2 key 885 886The A31 has a very atypical layout for the thermal sensors 887(source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31) 8881: CPU 8892: Main Battery: main sensor 8903: Power Converter 8914: Bay Battery: main sensor 8925: MCH (northbridge) 8936: PCMCIA/ambient 8947: Main Battery: secondary sensor 8958: Bay Battery: secondary sensor 896 897 898Procfs notes: 899 Readings from sensors that are not available return -128. 900 No commands can be written to this file. 901 902Sysfs notes: 903 Sensors that are not available return the ENXIO error. This 904 status may change at runtime, as there are hotplug thermal 905 sensors, like those inside the batteries and docks. 906 907 thinkpad-acpi thermal sensors are reported through the hwmon 908 subsystem, and follow all of the hwmon guidelines at 909 Documentation/hwmon. 910 911EXPERIMENTAL: Embedded controller register dump 912----------------------------------------------- 913 914This feature is not included in the thinkpad driver anymore. 915Instead the EC can be accessed through /sys/kernel/debug/ec with 916a userspace tool which can be found here: 917ftp://ftp.suse.com/pub/people/trenn/sources/ec 918 919Use it to determine the register holding the fan 920speed on some models. To do that, do the following: 921 - make sure the battery is fully charged 922 - make sure the fan is running 923 - use above mentioned tool to read out the EC 924 925Often fan and temperature values vary between 926readings. Since temperatures don't change vary fast, you can take 927several quick dumps to eliminate them. 928 929You can use a similar method to figure out the meaning of other 930embedded controller registers - e.g. make sure nothing else changes 931except the charging or discharging battery to determine which 932registers contain the current battery capacity, etc. If you experiment 933with this, do send me your results (including some complete dumps with 934a description of the conditions when they were taken.) 935 936 937LCD brightness control 938---------------------- 939 940procfs: /proc/acpi/ibm/brightness 941sysfs backlight device "thinkpad_screen" 942 943This feature allows software control of the LCD brightness on ThinkPad 944models which don't have a hardware brightness slider. 945 946It has some limitations: the LCD backlight cannot be actually turned 947on or off by this interface, it just controls the backlight brightness 948level. 949 950On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control 951has eight brightness levels, ranging from 0 to 7. Some of the levels 952may not be distinct. Later Lenovo models that implement the ACPI 953display backlight brightness control methods have 16 levels, ranging 954from 0 to 15. 955 956For IBM ThinkPads, there are two interfaces to the firmware for direct 957brightness control, EC and UCMS (or CMOS). To select which one should be 958used, use the brightness_mode module parameter: brightness_mode=1 selects 959EC mode, brightness_mode=2 selects UCMS mode, brightness_mode=3 selects EC 960mode with NVRAM backing (so that brightness changes are remembered across 961shutdown/reboot). 962 963The driver tries to select which interface to use from a table of 964defaults for each ThinkPad model. If it makes a wrong choice, please 965report this as a bug, so that we can fix it. 966 967Lenovo ThinkPads only support brightness_mode=2 (UCMS). 968 969When display backlight brightness controls are available through the 970standard ACPI interface, it is best to use it instead of this direct 971ThinkPad-specific interface. The driver will disable its native 972backlight brightness control interface if it detects that the standard 973ACPI interface is available in the ThinkPad. 974 975If you want to use the thinkpad-acpi backlight brightness control 976instead of the generic ACPI video backlight brightness control for some 977reason, you should use the acpi_backlight=vendor kernel parameter. 978 979The brightness_enable module parameter can be used to control whether 980the LCD brightness control feature will be enabled when available. 981brightness_enable=0 forces it to be disabled. brightness_enable=1 982forces it to be enabled when available, even if the standard ACPI 983interface is also available. 984 985Procfs notes: 986 987 The available commands are: 988 989 echo up >/proc/acpi/ibm/brightness 990 echo down >/proc/acpi/ibm/brightness 991 echo 'level <level>' >/proc/acpi/ibm/brightness 992 993Sysfs notes: 994 995The interface is implemented through the backlight sysfs class, which is 996poorly documented at this time. 997 998Locate the thinkpad_screen device under /sys/class/backlight, and inside 999it there will be the following attributes: 1000 1001 max_brightness: 1002 Reads the maximum brightness the hardware can be set to. 1003 The minimum is always zero. 1004 1005 actual_brightness: 1006 Reads what brightness the screen is set to at this instant. 1007 1008 brightness: 1009 Writes request the driver to change brightness to the 1010 given value. Reads will tell you what brightness the 1011 driver is trying to set the display to when "power" is set 1012 to zero and the display has not been dimmed by a kernel 1013 power management event. 1014 1015 power: 1016 power management mode, where 0 is "display on", and 1 to 3 1017 will dim the display backlight to brightness level 0 1018 because thinkpad-acpi cannot really turn the backlight 1019 off. Kernel power management events can temporarily 1020 increase the current power management level, i.e. they can 1021 dim the display. 1022 1023 1024WARNING: 1025 1026 Whatever you do, do NOT ever call thinkpad-acpi backlight-level change 1027 interface and the ACPI-based backlight level change interface 1028 (available on newer BIOSes, and driven by the Linux ACPI video driver) 1029 at the same time. The two will interact in bad ways, do funny things, 1030 and maybe reduce the life of the backlight lamps by needlessly kicking 1031 its level up and down at every change. 1032 1033 1034Volume control (Console Audio control) 1035-------------------------------------- 1036 1037procfs: /proc/acpi/ibm/volume 1038ALSA: "ThinkPad Console Audio Control", default ID: "ThinkPadEC" 1039 1040NOTE: by default, the volume control interface operates in read-only 1041mode, as it is supposed to be used for on-screen-display purposes. 1042The read/write mode can be enabled through the use of the 1043"volume_control=1" module parameter. 1044 1045NOTE: distros are urged to not enable volume_control by default, this 1046should be done by the local admin only. The ThinkPad UI is for the 1047console audio control to be done through the volume keys only, and for 1048the desktop environment to just provide on-screen-display feedback. 1049Software volume control should be done only in the main AC97/HDA 1050mixer. 1051 1052 1053About the ThinkPad Console Audio control: 1054 1055ThinkPads have a built-in amplifier and muting circuit that drives the 1056console headphone and speakers. This circuit is after the main AC97 1057or HDA mixer in the audio path, and under exclusive control of the 1058firmware. 1059 1060ThinkPads have three special hotkeys to interact with the console 1061audio control: volume up, volume down and mute. 1062 1063It is worth noting that the normal way the mute function works (on 1064ThinkPads that do not have a "mute LED") is: 1065 10661. Press mute to mute. It will *always* mute, you can press it as 1067 many times as you want, and the sound will remain mute. 1068 10692. Press either volume key to unmute the ThinkPad (it will _not_ 1070 change the volume, it will just unmute). 1071 1072This is a very superior design when compared to the cheap software-only 1073mute-toggle solution found on normal consumer laptops: you can be 1074absolutely sure the ThinkPad will not make noise if you press the mute 1075button, no matter the previous state. 1076 1077The IBM ThinkPads, and the earlier Lenovo ThinkPads have variable-gain 1078amplifiers driving the speakers and headphone output, and the firmware 1079also handles volume control for the headphone and speakers on these 1080ThinkPads without any help from the operating system (this volume 1081control stage exists after the main AC97 or HDA mixer in the audio 1082path). 1083 1084The newer Lenovo models only have firmware mute control, and depend on 1085the main HDA mixer to do volume control (which is done by the operating 1086system). In this case, the volume keys are filtered out for unmute 1087key press (there are some firmware bugs in this area) and delivered as 1088normal key presses to the operating system (thinkpad-acpi is not 1089involved). 1090 1091 1092The ThinkPad-ACPI volume control: 1093 1094The preferred way to interact with the Console Audio control is the 1095ALSA interface. 1096 1097The legacy procfs interface allows one to read the current state, 1098and if volume control is enabled, accepts the following commands: 1099 1100 echo up >/proc/acpi/ibm/volume 1101 echo down >/proc/acpi/ibm/volume 1102 echo mute >/proc/acpi/ibm/volume 1103 echo unmute >/proc/acpi/ibm/volume 1104 echo 'level <level>' >/proc/acpi/ibm/volume 1105 1106The <level> number range is 0 to 14 although not all of them may be 1107distinct. To unmute the volume after the mute command, use either the 1108up or down command (the level command will not unmute the volume), or 1109the unmute command. 1110 1111You can use the volume_capabilities parameter to tell the driver 1112whether your thinkpad has volume control or mute-only control: 1113volume_capabilities=1 for mixers with mute and volume control, 1114volume_capabilities=2 for mixers with only mute control. 1115 1116If the driver misdetects the capabilities for your ThinkPad model, 1117please report this to ibm-acpi-devel@lists.sourceforge.net, so that we 1118can update the driver. 1119 1120There are two strategies for volume control. To select which one 1121should be used, use the volume_mode module parameter: volume_mode=1 1122selects EC mode, and volume_mode=3 selects EC mode with NVRAM backing 1123(so that volume/mute changes are remembered across shutdown/reboot). 1124 1125The driver will operate in volume_mode=3 by default. If that does not 1126work well on your ThinkPad model, please report this to 1127ibm-acpi-devel@lists.sourceforge.net. 1128 1129The driver supports the standard ALSA module parameters. If the ALSA 1130mixer is disabled, the driver will disable all volume functionality. 1131 1132 1133Fan control and monitoring: fan speed, fan enable/disable 1134--------------------------------------------------------- 1135 1136procfs: /proc/acpi/ibm/fan 1137sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1, 1138 pwm1_enable, fan2_input 1139sysfs hwmon driver attributes: fan_watchdog 1140 1141NOTE NOTE NOTE: fan control operations are disabled by default for 1142safety reasons. To enable them, the module parameter "fan_control=1" 1143must be given to thinkpad-acpi. 1144 1145This feature attempts to show the current fan speed, control mode and 1146other fan data that might be available. The speed is read directly 1147from the hardware registers of the embedded controller. This is known 1148to work on later R, T, X and Z series ThinkPads but may show a bogus 1149value on other models. 1150 1151Some Lenovo ThinkPads support a secondary fan. This fan cannot be 1152controlled separately, it shares the main fan control. 1153 1154Fan levels: 1155 1156Most ThinkPad fans work in "levels" at the firmware interface. Level 0 1157stops the fan. The higher the level, the higher the fan speed, although 1158adjacent levels often map to the same fan speed. 7 is the highest 1159level, where the fan reaches the maximum recommended speed. 1160 1161Level "auto" means the EC changes the fan level according to some 1162internal algorithm, usually based on readings from the thermal sensors. 1163 1164There is also a "full-speed" level, also known as "disengaged" level. 1165In this level, the EC disables the speed-locked closed-loop fan control, 1166and drives the fan as fast as it can go, which might exceed hardware 1167limits, so use this level with caution. 1168 1169The fan usually ramps up or down slowly from one speed to another, and 1170it is normal for the EC to take several seconds to react to fan 1171commands. The full-speed level may take up to two minutes to ramp up to 1172maximum speed, and in some ThinkPads, the tachometer readings go stale 1173while the EC is transitioning to the full-speed level. 1174 1175WARNING WARNING WARNING: do not leave the fan disabled unless you are 1176monitoring all of the temperature sensor readings and you are ready to 1177enable it if necessary to avoid overheating. 1178 1179An enabled fan in level "auto" may stop spinning if the EC decides the 1180ThinkPad is cool enough and doesn't need the extra airflow. This is 1181normal, and the EC will spin the fan up if the various thermal readings 1182rise too much. 1183 1184On the X40, this seems to depend on the CPU and HDD temperatures. 1185Specifically, the fan is turned on when either the CPU temperature 1186climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The 1187fan is turned off when the CPU temperature drops to 49 degrees and the 1188HDD temperature drops to 41 degrees. These thresholds cannot 1189currently be controlled. 1190 1191The ThinkPad's ACPI DSDT code will reprogram the fan on its own when 1192certain conditions are met. It will override any fan programming done 1193through thinkpad-acpi. 1194 1195The thinkpad-acpi kernel driver can be programmed to revert the fan 1196level to a safe setting if userspace does not issue one of the procfs 1197fan commands: "enable", "disable", "level" or "watchdog", or if there 1198are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is 1199set to 1, manual mode) within a configurable amount of time of up to 1200120 seconds. This functionality is called fan safety watchdog. 1201 1202Note that the watchdog timer stops after it enables the fan. It will be 1203rearmed again automatically (using the same interval) when one of the 1204above mentioned fan commands is received. The fan watchdog is, 1205therefore, not suitable to protect against fan mode changes made through 1206means other than the "enable", "disable", and "level" procfs fan 1207commands, or the hwmon fan control sysfs interface. 1208 1209Procfs notes: 1210 1211The fan may be enabled or disabled with the following commands: 1212 1213 echo enable >/proc/acpi/ibm/fan 1214 echo disable >/proc/acpi/ibm/fan 1215 1216Placing a fan on level 0 is the same as disabling it. Enabling a fan 1217will try to place it in a safe level if it is too slow or disabled. 1218 1219The fan level can be controlled with the command: 1220 1221 echo 'level <level>' > /proc/acpi/ibm/fan 1222 1223Where <level> is an integer from 0 to 7, or one of the words "auto" or 1224"full-speed" (without the quotes). Not all ThinkPads support the "auto" 1225and "full-speed" levels. The driver accepts "disengaged" as an alias for 1226"full-speed", and reports it as "disengaged" for backwards 1227compatibility. 1228 1229On the X31 and X40 (and ONLY on those models), the fan speed can be 1230controlled to a certain degree. Once the fan is running, it can be 1231forced to run faster or slower with the following command: 1232 1233 echo 'speed <speed>' > /proc/acpi/ibm/fan 1234 1235The sustainable range of fan speeds on the X40 appears to be from about 12363700 to about 7350. Values outside this range either do not have any 1237effect or the fan speed eventually settles somewhere in that range. The 1238fan cannot be stopped or started with this command. This functionality 1239is incomplete, and not available through the sysfs interface. 1240 1241To program the safety watchdog, use the "watchdog" command. 1242 1243 echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan 1244 1245If you want to disable the watchdog, use 0 as the interval. 1246 1247Sysfs notes: 1248 1249The sysfs interface follows the hwmon subsystem guidelines for the most 1250part, and the exception is the fan safety watchdog. 1251 1252Writes to any of the sysfs attributes may return the EINVAL error if 1253that operation is not supported in a given ThinkPad or if the parameter 1254is out-of-bounds, and EPERM if it is forbidden. They may also return 1255EINTR (interrupted system call), and EIO (I/O error while trying to talk 1256to the firmware). 1257 1258Features not yet implemented by the driver return ENOSYS. 1259 1260hwmon device attribute pwm1_enable: 1261 0: PWM offline (fan is set to full-speed mode) 1262 1: Manual PWM control (use pwm1 to set fan level) 1263 2: Hardware PWM control (EC "auto" mode) 1264 3: reserved (Software PWM control, not implemented yet) 1265 1266 Modes 0 and 2 are not supported by all ThinkPads, and the 1267 driver is not always able to detect this. If it does know a 1268 mode is unsupported, it will return -EINVAL. 1269 1270hwmon device attribute pwm1: 1271 Fan level, scaled from the firmware values of 0-7 to the hwmon 1272 scale of 0-255. 0 means fan stopped, 255 means highest normal 1273 speed (level 7). 1274 1275 This attribute only commands the fan if pmw1_enable is set to 1 1276 (manual PWM control). 1277 1278hwmon device attribute fan1_input: 1279 Fan tachometer reading, in RPM. May go stale on certain 1280 ThinkPads while the EC transitions the PWM to offline mode, 1281 which can take up to two minutes. May return rubbish on older 1282 ThinkPads. 1283 1284hwmon device attribute fan2_input: 1285 Fan tachometer reading, in RPM, for the secondary fan. 1286 Available only on some ThinkPads. If the secondary fan is 1287 not installed, will always read 0. 1288 1289hwmon driver attribute fan_watchdog: 1290 Fan safety watchdog timer interval, in seconds. Minimum is 1291 1 second, maximum is 120 seconds. 0 disables the watchdog. 1292 1293To stop the fan: set pwm1 to zero, and pwm1_enable to 1. 1294 1295To start the fan in a safe mode: set pwm1_enable to 2. If that fails 1296with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255 1297would be the safest choice, though). 1298 1299 1300WAN 1301--- 1302 1303procfs: /proc/acpi/ibm/wan 1304sysfs device attribute: wwan_enable (deprecated) 1305sysfs rfkill class: switch "tpacpi_wwan_sw" 1306 1307This feature shows the presence and current state of the built-in 1308Wireless WAN device. 1309 1310If the ThinkPad supports it, the WWAN state is stored in NVRAM, 1311so it is kept across reboots and power-off. 1312 1313It was tested on a Lenovo ThinkPad X60. It should probably work on other 1314ThinkPad models which come with this module installed. 1315 1316Procfs notes: 1317 1318If the W-WAN card is installed, the following commands can be used: 1319 1320 echo enable > /proc/acpi/ibm/wan 1321 echo disable > /proc/acpi/ibm/wan 1322 1323Sysfs notes: 1324 1325 If the W-WAN card is installed, it can be enabled / 1326 disabled through the "wwan_enable" thinkpad-acpi device 1327 attribute, and its current status can also be queried. 1328 1329 enable: 1330 0: disables WWAN card / WWAN card is disabled 1331 1: enables WWAN card / WWAN card is enabled. 1332 1333 Note: this interface has been superseded by the generic rfkill 1334 class. It has been deprecated, and it will be removed in year 1335 2010. 1336 1337 rfkill controller switch "tpacpi_wwan_sw": refer to 1338 Documentation/rfkill.txt for details. 1339 1340 1341EXPERIMENTAL: UWB 1342----------------- 1343 1344This feature is considered EXPERIMENTAL because it has not been extensively 1345tested and validated in various ThinkPad models yet. The feature may not 1346work as expected. USE WITH CAUTION! To use this feature, you need to supply 1347the experimental=1 parameter when loading the module. 1348 1349sysfs rfkill class: switch "tpacpi_uwb_sw" 1350 1351This feature exports an rfkill controller for the UWB device, if one is 1352present and enabled in the BIOS. 1353 1354Sysfs notes: 1355 1356 rfkill controller switch "tpacpi_uwb_sw": refer to 1357 Documentation/rfkill.txt for details. 1358 1359Adaptive keyboard 1360----------------- 1361 1362sysfs device attribute: adaptive_kbd_mode 1363 1364This sysfs attribute controls the keyboard "face" that will be shown on the 1365Lenovo X1 Carbon 2nd gen (2014)'s adaptive keyboard. The value can be read 1366and set. 1367 13681 = Home mode 13692 = Web-browser mode 13703 = Web-conference mode 13714 = Function mode 13725 = Layflat mode 1373 1374For more details about which buttons will appear depending on the mode, please 1375review the laptop's user guide: 1376http://www.lenovo.com/shop/americas/content/user_guides/x1carbon_2_ug_en.pdf 1377 1378Multiple Commands, Module Parameters 1379------------------------------------ 1380 1381Multiple commands can be written to the proc files in one shot by 1382separating them with commas, for example: 1383 1384 echo enable,0xffff > /proc/acpi/ibm/hotkey 1385 echo lcd_disable,crt_enable > /proc/acpi/ibm/video 1386 1387Commands can also be specified when loading the thinkpad-acpi module, 1388for example: 1389 1390 modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable 1391 1392 1393Enabling debugging output 1394------------------------- 1395 1396The module takes a debug parameter which can be used to selectively 1397enable various classes of debugging output, for example: 1398 1399 modprobe thinkpad_acpi debug=0xffff 1400 1401will enable all debugging output classes. It takes a bitmask, so 1402to enable more than one output class, just add their values. 1403 1404 Debug bitmask Description 1405 0x8000 Disclose PID of userspace programs 1406 accessing some functions of the driver 1407 0x0001 Initialization and probing 1408 0x0002 Removal 1409 0x0004 RF Transmitter control (RFKILL) 1410 (bluetooth, WWAN, UWB...) 1411 0x0008 HKEY event interface, hotkeys 1412 0x0010 Fan control 1413 0x0020 Backlight brightness 1414 0x0040 Audio mixer/volume control 1415 1416There is also a kernel build option to enable more debugging 1417information, which may be necessary to debug driver problems. 1418 1419The level of debugging information output by the driver can be changed 1420at runtime through sysfs, using the driver attribute debug_level. The 1421attribute takes the same bitmask as the debug module parameter above. 1422 1423 1424Force loading of module 1425----------------------- 1426 1427If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify 1428the module parameter force_load=1. Regardless of whether this works or 1429not, please contact ibm-acpi-devel@lists.sourceforge.net with a report. 1430 1431 1432Sysfs interface changelog: 1433 14340x000100: Initial sysfs support, as a single platform driver and 1435 device. 14360x000200: Hot key support for 32 hot keys, and radio slider switch 1437 support. 14380x010000: Hot keys are now handled by default over the input 1439 layer, the radio switch generates input event EV_RADIO, 1440 and the driver enables hot key handling by default in 1441 the firmware. 1442 14430x020000: ABI fix: added a separate hwmon platform device and 1444 driver, which must be located by name (thinkpad) 1445 and the hwmon class for libsensors4 (lm-sensors 3) 1446 compatibility. Moved all hwmon attributes to this 1447 new platform device. 1448 14490x020100: Marker for thinkpad-acpi with hot key NVRAM polling 1450 support. If you must, use it to know you should not 1451 start a userspace NVRAM poller (allows to detect when 1452 NVRAM is compiled out by the user because it is 1453 unneeded/undesired in the first place). 14540x020101: Marker for thinkpad-acpi with hot key NVRAM polling 1455 and proper hotkey_mask semantics (version 8 of the 1456 NVRAM polling patch). Some development snapshots of 1457 0.18 had an earlier version that did strange things 1458 to hotkey_mask. 1459 14600x020200: Add poll()/select() support to the following attributes: 1461 hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason 1462 14630x020300: hotkey enable/disable support removed, attributes 1464 hotkey_bios_enabled and hotkey_enable deprecated and 1465 marked for removal. 1466 14670x020400: Marker for 16 LEDs support. Also, LEDs that are known 1468 to not exist in a given model are not registered with 1469 the LED sysfs class anymore. 1470 14710x020500: Updated hotkey driver, hotkey_mask is always available 1472 and it is always able to disable hot keys. Very old 1473 thinkpads are properly supported. hotkey_bios_mask 1474 is deprecated and marked for removal. 1475 14760x020600: Marker for backlight change event support. 1477 14780x020700: Support for mute-only mixers. 1479 Volume control in read-only mode by default. 1480 Marker for ALSA mixer support.