Documentation/thinkpad-acpi.txt

   1                      ThinkPad ACPI Extras Driver
   2
   3                             Version 0.18
   4                          October 08th, 2007
   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
  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.
  15
  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.
  20
  21
  22 Status
  23 ------
  24
  25 The features currently supported are the following (see below for
  26 detailed description):
  27
  28         - Fn key combinations
  29         - Bluetooth enable and disable
  30         - video output switching, expansion control
  31         - ThinkLight on and off
  32         - limited docking and undocking
  33         - UltraBay eject
  34         - CMOS control
  35         - LED control
  36         - ACPI sounds
  37         - temperature sensors
  38         - Experimental: embedded controller register dump
  39         - LCD brightness control
  40         - Volume control
  41         - Fan control and monitoring: fan speed, fan enable/disable
  42         - Experimental: WAN enable and disable
  43
  44 A compatibility table by model and feature is maintained on the web
  45 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
  46 reports, especially if they add to or correct the compatibility table.
  47 Please include the following information in your report:
  48
  49         - ThinkPad model name
  50         - a copy of your DSDT, from /proc/acpi/dsdt
  51         - a copy of the output of dmidecode, with serial numbers
  52           and UUIDs masked off
  53         - which driver features work and which don't
  54         - the observed behavior of non-working features
  55
  56 Any other comments or patches are also more than welcome.
  57
  58
  59 Installation
  60 ------------
  61
  62 If you are compiling this driver as included in the Linux kernel
  63 sources, simply enable the CONFIG_THINKPAD_ACPI option, and optionally
  64 enable the CONFIG_THINKPAD_ACPI_BAY option if you want the
  65 thinkpad-specific bay functionality.
  66
  67 Features
  68 --------
  69
  70 The driver exports two different interfaces to userspace, which can be
  71 used to access the features it provides.  One is a legacy procfs-based
  72 interface, which will be removed at some time in the distant future.
  73 The other is a new sysfs-based interface which is not complete yet.
  74
  75 The procfs interface creates the /proc/acpi/ibm directory.  There is a
  76 file under that directory for each feature it supports.  The procfs
  77 interface is mostly frozen, and will change very little if at all: it
  78 will not be extended to add any new functionality in the driver, instead
  79 all new functionality will be implemented on the sysfs interface.
  80
  81 The sysfs interface tries to blend in the generic Linux sysfs subsystems
  82 and classes as much as possible.  Since some of these subsystems are not
  83 yet ready or stabilized, it is expected that this interface will change,
  84 and any and all userspace programs must deal with it.
  85
  86
  87 Notes about the sysfs interface:
  88
  89 Unlike what was done with the procfs interface, correctness when talking
  90 to the sysfs interfaces will be enforced, as will correctness in the
  91 thinkpad-acpi's implementation of sysfs interfaces.
  92
  93 Also, any bugs in the thinkpad-acpi sysfs driver code or in the
  94 thinkpad-acpi's implementation of the sysfs interfaces will be fixed for
  95 maximum correctness, even if that means changing an interface in
  96 non-compatible ways.  As these interfaces mature both in the kernel and
  97 in thinkpad-acpi, such changes should become quite rare.
  98
  99 Applications interfacing to the thinkpad-acpi sysfs interfaces must
 100 follow all sysfs guidelines and correctly process all errors (the sysfs
 101 interface makes extensive use of errors).  File descriptors and open /
 102 close operations to the sysfs inodes must also be properly implemented.
 103
 104 The version of thinkpad-acpi's sysfs interface is exported by the driver
 105 as a driver attribute (see below).
 106
 107 Sysfs driver attributes are on the driver's sysfs attribute space,
 108 for 2.6.23 this is /sys/bus/platform/drivers/thinkpad_acpi/ and
 109 /sys/bus/platform/drivers/thinkpad_hwmon/
 110
 111 Sysfs device attributes are on the thinkpad_acpi device sysfs attribute
 112 space, for 2.6.23 this is /sys/devices/platform/thinkpad_acpi/.
 113
 114 Sysfs device attributes for the sensors and fan are on the
 115 thinkpad_hwmon device's sysfs attribute space, but you should locate it
 116 looking for a hwmon device with the name attribute of "thinkpad".
 117
 118 Driver version
 119 --------------
 120
 121 procfs: /proc/acpi/ibm/driver
 122 sysfs driver attribute: version
 123
 124 The driver name and version. No commands can be written to this file.
 125
 126 Sysfs interface version
 127 -----------------------
 128
 129 sysfs driver attribute: interface_version
 130
 131 Version of the thinkpad-acpi sysfs interface, as an unsigned long
 132 (output in hex format: 0xAAAABBCC), where:
 133         AAAA - major revision
 134         BB - minor revision
 135         CC - bugfix revision
 136
 137 The sysfs interface version changelog for the driver can be found at the
 138 end of this document.  Changes to the sysfs interface done by the kernel
 139 subsystems are not documented here, nor are they tracked by this
 140 attribute.
 141
 142 Changes to the thinkpad-acpi sysfs interface are only considered
 143 non-experimental when they are submitted to Linux mainline, at which
 144 point the changes in this interface are documented and interface_version
 145 may be updated.  If you are using any thinkpad-acpi features not yet
 146 sent to mainline for merging, you do so on your own risk: these features
 147 may disappear, or be implemented in a different and incompatible way by
 148 the time they are merged in Linux mainline.
 149
 150 Changes that are backwards-compatible by nature (e.g. the addition of
 151 attributes that do not change the way the other attributes work) do not
 152 always warrant an update of interface_version.  Therefore, one must
 153 expect that an attribute might not be there, and deal with it properly
 154 (an attribute not being there *is* a valid way to make it clear that a
 155 feature is not available in sysfs).
 156
 157 Hot keys
 158 --------
 159
 160 procfs: /proc/acpi/ibm/hotkey
 161 sysfs device attribute: hotkey_*
 162
 163 In a ThinkPad, the ACPI HKEY handler is responsible for comunicating
 164 some important events and also keyboard hot key presses to the operating
 165 system.  Enabling the hotkey functionality of thinkpad-acpi signals the
 166 firmware that such a driver is present, and modifies how the ThinkPad
 167 firmware will behave in many situations.
 168
 169 The driver enables the hot key feature automatically when loaded.  The
 170 feature can later be disabled and enabled back at runtime.  The driver
 171 will also restore the hot key feature to its previous state and mask
 172 when it is unloaded.
 173
 174 When the hotkey feature is enabled and the hot key mask is set (see
 175 below), the driver will report HKEY events in the following format:
 176
 177         ibm/hotkey HKEY 00000080 0000xxxx
 178
 179 Some of these events refer to hot key presses, but not all.
 180
 181 The driver will generate events over the input layer for hot keys and
 182 radio switches, and over the ACPI netlink layer for other events.  The
 183 input layer support accepts the standard IOCTLs to remap the keycodes
 184 assigned to each hot key.
 185
 186 The hot key bit mask allows some control over which hot keys generate
 187 events.  If a key is "masked" (bit set to 0 in the mask), the firmware
 188 will handle it.  If it is "unmasked", it signals the firmware that
 189 thinkpad-acpi would prefer to handle it, if the firmware would be so
 190 kind to allow it (and it often doesn't!).
 191
 192 Not all bits in the mask can be modified.  Not all bits that can be
 193 modified do anything.  Not all hot keys can be individually controlled
 194 by the mask.  Some models do not support the mask at all, and in those
 195 models, hot keys cannot be controlled individually.  The behaviour of
 196 the mask is, therefore, higly dependent on the ThinkPad model.
 197
 198 Note that unmasking some keys prevents their default behavior.  For
 199 example, if Fn+F5 is unmasked, that key will no longer enable/disable
 200 Bluetooth by itself.
 201
 202 Note also that not all Fn key combinations are supported through ACPI.
 203 For example, on the X40, the brightness, volume and "Access IBM" buttons
 204 do not generate ACPI events even with this driver.  They *can* be used
 205 through the "ThinkPad Buttons" utility, see http://www.nongnu.org/tpb/
 206
 207 procfs notes:
 208
 209 The following commands can be written to the /proc/acpi/ibm/hotkey file:
 210
 211         echo enable > /proc/acpi/ibm/hotkey -- enable the hot keys feature
 212         echo disable > /proc/acpi/ibm/hotkey -- disable the hot keys feature
 213         echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
 214         echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
 215         ... any other 8-hex-digit mask ...
 216         echo reset > /proc/acpi/ibm/hotkey -- restore the original mask
 217
 218 sysfs notes:
 219
 220         hotkey_bios_enabled:
 221                 Returns the status of the hot keys feature when
 222                 thinkpad-acpi was loaded.  Upon module unload, the hot
 223                 key feature status will be restored to this value.
 224
 225                 0: hot keys were disabled
 226                 1: hot keys were enabled (unusual)
 227
 228         hotkey_bios_mask:
 229                 Returns the hot keys mask when thinkpad-acpi was loaded.
 230                 Upon module unload, the hot keys mask will be restored
 231                 to this value.
 232
 233         hotkey_enable:
 234                 Enables/disables the hot keys feature in the ACPI
 235                 firmware, and reports current status of the hot keys
 236                 feature.  Has no effect on the NVRAM hot key polling
 237                 functionality.
 238
 239                 0: disables the hot keys feature / feature disabled
 240                 1: enables the hot keys feature / feature enabled
 241
 242         hotkey_mask:
 243                 bit mask to enable driver-handling (and depending on
 244                 the firmware, ACPI event generation) for each hot key
 245                 (see above).  Returns the current status of the hot keys
 246                 mask, and allows one to modify it.
 247
 248                 Note: when NVRAM polling is active, the firmware mask
 249                 may be slightly different than the value returned by
 250                 hotkey_mask, as the driver will retain enabled bits
 251                 for hotkeys that are under NVRAM polling even if the
 252                 firmware refuses them.
 253
 254         hotkey_all_mask:
 255                 bit mask that should enable event reporting for all
 256                 supported hot keys, when echoed to hotkey_mask above.
 257                 Unless you know which events need to be handled
 258                 passively (because the firmware *will* handle them
 259                 anyway), do *not* use hotkey_all_mask.  Use
 260                 hotkey_recommended_mask, instead. You have been warned.
 261
 262         hotkey_recommended_mask:
 263                 bit mask that should enable event reporting for all
 264                 supported hot keys, except those which are always
 265                 handled by the firmware anyway.  Echo it to
 266                 hotkey_mask above, to use.
 267
 268         hotkey_source_mask:
 269                 bit mask that selects which hot keys will the driver
 270                 poll the NVRAM for.  This is auto-detected by the driver
 271                 based on the capabilities reported by the ACPI firmware,
 272                 but it can be overridden at runtime.
 273
 274                 Hot keys whose bits are set in both hotkey_source_mask
 275                 and also on hotkey_mask are polled for in NVRAM.  Only a
 276                 few hot keys are available through CMOS NVRAM polling.
 277
 278                 Warning: when in NVRAM mode, the volume up/down/mute
 279                 keys are synthesized according to changes in the mixer,
 280                 so you have to use volume up or volume down to unmute,
 281                 as per the ThinkPad volume mixer user interface.  When
 282                 in ACPI event mode, volume up/down/mute are reported as
 283                 separate events, but this behaviour may be corrected in
 284                 future releases of this driver, in which case the
 285                 ThinkPad volume mixer user interface semanthics will be
 286                 enforced.
 287
 288         hotkey_poll_freq:
 289                 frequency in Hz for hot key polling. It must be between
 290                 0 and 25 Hz.  Polling is only carried out when strictly
 291                 needed.
 292
 293                 Setting hotkey_poll_freq to zero disables polling, and
 294                 will cause hot key presses that require NVRAM polling
 295                 to never be reported.
 296
 297                 Setting hotkey_poll_freq too low will cause repeated
 298                 pressings of the same hot key to be misreported as a
 299                 single key press, or to not even be detected at all.
 300                 The recommended polling frequency is 10Hz.
 301
 302         hotkey_radio_sw:
 303                 if the ThinkPad has a hardware radio switch, this
 304                 attribute will read 0 if the switch is in the "radios
 305                 disabled" postition, and 1 if the switch is in the
 306                 "radios enabled" position.
 307
 308         hotkey_report_mode:
 309                 Returns the state of the procfs ACPI event report mode
 310                 filter for hot keys.  If it is set to 1 (the default),
 311                 all hot key presses are reported both through the input
 312                 layer and also as ACPI events through procfs (but not
 313                 through netlink).  If it is set to 2, hot key presses
 314                 are reported only through the input layer.
 315
 316                 This attribute is read-only in kernels 2.6.23 or later,
 317                 and read-write on earlier kernels.
 318
 319                 May return -EPERM (write access locked out by module
 320                 parameter) or -EACCES (read-only).
 321
 322 input layer notes:
 323
 324 A Hot key is mapped to a single input layer EV_KEY event, possibly
 325 followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
 326 code.  An EV_SYN event will always be generated to mark the end of the
 327 event block.
 328
 329 Do not use the EV_MSC MSC_SCAN events to process keys.  They are to be
 330 used as a helper to remap keys, only.  They are particularly useful when
 331 remapping KEY_UNKNOWN keys.
 332
 333 The events are available in an input device, with the following id:
 334
 335         Bus:            BUS_HOST
 336         vendor:         0x1014 (PCI_VENDOR_ID_IBM)  or
 337                         0x17aa (PCI_VENDOR_ID_LENOVO)
 338         product:        0x5054 ("TP")
 339         version:        0x4101
 340
 341 The version will have its LSB incremented if the keymap changes in a
 342 backwards-compatible way.  The MSB shall always be 0x41 for this input
 343 device.  If the MSB is not 0x41, do not use the device as described in
 344 this section, as it is either something else (e.g. another input device
 345 exported by a thinkpad driver, such as HDAPS) or its functionality has
 346 been changed in a non-backwards compatible way.
 347
 348 Adding other event types for other functionalities shall be considered a
 349 backwards-compatible change for this input device.
 350
 351 Thinkpad-acpi Hot Key event map (version 0x4101):
 352
 353 ACPI    Scan
 354 event   code    Key             Notes
 355
 356 0x1001  0x00    FN+F1           -
 357 0x1002  0x01    FN+F2           IBM: battery (rare)
 358                                 Lenovo: Screen lock
 359
 360 0x1003  0x02    FN+F3           Many IBM models always report
 361                                 this hot key, even with hot keys
 362                                 disabled or with Fn+F3 masked
 363                                 off
 364                                 IBM: screen lock
 365                                 Lenovo: battery
 366
 367 0x1004  0x03    FN+F4           Sleep button (ACPI sleep button
 368                                 semanthics, i.e. sleep-to-RAM).
 369                                 It is always generate some kind
 370                                 of event, either the hot key
 371                                 event or a ACPI sleep button
 372                                 event. The firmware may
 373                                 refuse to generate further FN+F4
 374                                 key presses until a S3 or S4 ACPI
 375                                 sleep cycle is performed or some
 376                                 time passes.
 377
 378 0x1005  0x04    FN+F5           Radio.  Enables/disables
 379                                 the internal BlueTooth hardware
 380                                 and W-WAN card if left in control
 381                                 of the firmware.  Does not affect
 382                                 the WLAN card.
 383                                 Should be used to turn on/off all
 384                                 radios (bluetooth+W-WAN+WLAN),
 385                                 really.
 386
 387 0x1006  0x05    FN+F6           -
 388
 389 0x1007  0x06    FN+F7           Video output cycle.
 390                                 Do you feel lucky today?
 391
 392 0x1008  0x07    FN+F8           IBM: toggle screen expand
 393                                 Lenovo: configure ultranav
 394
 395 0x1009  0x08    FN+F9           -
 396         ..      ..              ..
 397 0x100B  0x0A    FN+F11          -
 398
 399 0x100C  0x0B    FN+F12          Sleep to disk.  You are always
 400                                 supposed to handle it yourself,
 401                                 either through the ACPI event,
 402                                 or through a hotkey event.
 403                                 The firmware may refuse to
 404                                 generate further FN+F4 key
 405                                 press events until a S3 or S4
 406                                 ACPI sleep cycle is performed,
 407                                 or some time passes.
 408
 409 0x100D  0x0C    FN+BACKSPACE    -
 410 0x100E  0x0D    FN+INSERT       -
 411 0x100F  0x0E    FN+DELETE       -
 412
 413 0x1010  0x0F    FN+HOME         Brightness up.  This key is
 414                                 always handled by the firmware
 415                                 in IBM ThinkPads, even when
 416                                 unmasked.  Just leave it alone.
 417                                 For Lenovo ThinkPads with a new
 418                                 BIOS, it has to be handled either
 419                                 by the ACPI OSI, or by userspace.
 420 0x1011  0x10    FN+END          Brightness down.  See brightness
 421                                 up for details.
 422
 423 0x1012  0x11    FN+PGUP         Thinklight toggle.  This key is
 424                                 always handled by the firmware,
 425                                 even when unmasked.
 426
 427 0x1013  0x12    FN+PGDOWN       -
 428
 429 0x1014  0x13    FN+SPACE        Zoom key
 430
 431 0x1015  0x14    VOLUME UP       Internal mixer volume up. This
 432                                 key is always handled by the
 433                                 firmware, even when unmasked.
 434                                 NOTE: Lenovo seems to be changing
 435                                 this.
 436 0x1016  0x15    VOLUME DOWN     Internal mixer volume up. This
 437                                 key is always handled by the
 438                                 firmware, even when unmasked.
 439                                 NOTE: Lenovo seems to be changing
 440                                 this.
 441 0x1017  0x16    MUTE            Mute internal mixer. This
 442                                 key is always handled by the
 443                                 firmware, even when unmasked.
 444
 445 0x1018  0x17    THINKPAD        Thinkpad/Access IBM/Lenovo key
 446
 447 0x1019  0x18    unknown
 448 ..      ..      ..
 449 0x1020  0x1F    unknown
 450
 451 The ThinkPad firmware does not allow one to differentiate when most hot
 452 keys are pressed or released (either that, or we don't know how to, yet).
 453 For these keys, the driver generates a set of events for a key press and
 454 immediately issues the same set of events for a key release.  It is
 455 unknown by the driver if the ThinkPad firmware triggered these events on
 456 hot key press or release, but the firmware will do it for either one, not
 457 both.
 458
 459 If a key is mapped to KEY_RESERVED, it generates no input events at all.
 460 If a key is mapped to KEY_UNKNOWN, it generates an input event that
 461 includes an scan code.  If a key is mapped to anything else, it will
 462 generate input device EV_KEY events.
 463
 464 Non hot-key ACPI HKEY event map:
 465 0x5001          Lid closed
 466 0x5002          Lid opened
 467 0x7000          Radio Switch may have changed state
 468
 469 The above events are not propagated by the driver, except for legacy
 470 compatibility purposes when hotkey_report_mode is set to 1.
 471
 472 0x5010          Brightness level changed (newer Lenovo BIOSes)
 473
 474 The above events are propagated by the driver.
 475
 476 Compatibility notes:
 477
 478 ibm-acpi and thinkpad-acpi 0.15 (mainline kernels before 2.6.23) never
 479 supported the input layer, and sent events over the procfs ACPI event
 480 interface.
 481
 482 To avoid sending duplicate events over the input layer and the ACPI
 483 event interface, thinkpad-acpi 0.16 implements a module parameter
 484 (hotkey_report_mode), and also a sysfs device attribute with the same
 485 name.
 486
 487 Make no mistake here: userspace is expected to switch to using the input
 488 layer interface of thinkpad-acpi, together with the ACPI netlink event
 489 interface in kernels 2.6.23 and later, or with the ACPI procfs event
 490 interface in kernels 2.6.22 and earlier.
 491
 492 If no hotkey_report_mode module parameter is specified (or it is set to
 493 zero), the driver defaults to mode 1 (see below), and on kernels 2.6.22
 494 and earlier, also allows one to change the hotkey_report_mode through
 495 sysfs.  In kernels 2.6.23 and later, where the netlink ACPI event
 496 interface is available, hotkey_report_mode cannot be changed through
 497 sysfs (it is read-only).
 498
 499 If the hotkey_report_mode module parameter is set to 1 or 2, it cannot
 500 be changed later through sysfs (any writes will return -EPERM to signal
 501 that hotkey_report_mode was locked.  On 2.6.23 and later, where
 502 hotkey_report_mode cannot be changed at all, writes will return -EACES).
 503
 504 hotkey_report_mode set to 1 makes the driver export through the procfs
 505 ACPI event interface all hot key presses (which are *also* sent to the
 506 input layer).  This is a legacy compatibility behaviour, and it is also
 507 the default mode of operation for the driver.
 508
 509 hotkey_report_mode set to 2 makes the driver filter out the hot key
 510 presses from the procfs ACPI event interface, so these events will only
 511 be sent through the input layer.  Userspace that has been updated to use
 512 the thinkpad-acpi input layer interface should set hotkey_report_mode to
 513 2.
 514
 515 Hot key press events are never sent to the ACPI netlink event interface.
 516 Really up-to-date userspace under kernel 2.6.23 and later is to use the
 517 netlink interface and the input layer interface, and don't bother at all
 518 with hotkey_report_mode.
 519
 520
 521 Bluetooth
 522 ---------
 523
 524 procfs: /proc/acpi/ibm/bluetooth
 525 sysfs device attribute: bluetooth_enable
 526
 527 This feature shows the presence and current state of a ThinkPad
 528 Bluetooth device in the internal ThinkPad CDC slot.
 529
 530 Procfs notes:
 531
 532 If Bluetooth is installed, the following commands can be used:
 533
 534         echo enable > /proc/acpi/ibm/bluetooth
 535         echo disable > /proc/acpi/ibm/bluetooth
 536
 537 Sysfs notes:
 538
 539         If the Bluetooth CDC card is installed, it can be enabled /
 540         disabled through the "bluetooth_enable" thinkpad-acpi device
 541         attribute, and its current status can also be queried.
 542
 543         enable:
 544                 0: disables Bluetooth / Bluetooth is disabled
 545                 1: enables Bluetooth / Bluetooth is enabled.
 546
 547         Note: this interface will be probably be superseeded by the
 548         generic rfkill class, so it is NOT to be considered stable yet.
 549
 550 Video output control -- /proc/acpi/ibm/video
 551 --------------------------------------------
 552
 553 This feature allows control over the devices used for video output -
 554 LCD, CRT or DVI (if available). The following commands are available:
 555
 556         echo lcd_enable > /proc/acpi/ibm/video
 557         echo lcd_disable > /proc/acpi/ibm/video
 558         echo crt_enable > /proc/acpi/ibm/video
 559         echo crt_disable > /proc/acpi/ibm/video
 560         echo dvi_enable > /proc/acpi/ibm/video
 561         echo dvi_disable > /proc/acpi/ibm/video
 562         echo auto_enable > /proc/acpi/ibm/video
 563         echo auto_disable > /proc/acpi/ibm/video
 564         echo expand_toggle > /proc/acpi/ibm/video
 565         echo video_switch > /proc/acpi/ibm/video
 566
 567 Each video output device can be enabled or disabled individually.
 568 Reading /proc/acpi/ibm/video shows the status of each device.
 569
 570 Automatic video switching can be enabled or disabled.  When automatic
 571 video switching is enabled, certain events (e.g. opening the lid,
 572 docking or undocking) cause the video output device to change
 573 automatically. While this can be useful, it also causes flickering
 574 and, on the X40, video corruption. By disabling automatic switching,
 575 the flickering or video corruption can be avoided.
 576
 577 The video_switch command cycles through the available video outputs
 578 (it simulates the behavior of Fn-F7).
 579
 580 Video expansion can be toggled through this feature. This controls
 581 whether the display is expanded to fill the entire LCD screen when a
 582 mode with less than full resolution is used. Note that the current
 583 video expansion status cannot be determined through this feature.
 584
 585 Note that on many models (particularly those using Radeon graphics
 586 chips) the X driver configures the video card in a way which prevents
 587 Fn-F7 from working. This also disables the video output switching
 588 features of this driver, as it uses the same ACPI methods as
 589 Fn-F7. Video switching on the console should still work.
 590
 591 UPDATE: There's now a patch for the X.org Radeon driver which
 592 addresses this issue. Some people are reporting success with the patch
 593 while others are still having problems. For more information:
 594
 595 https://bugs.freedesktop.org/show_bug.cgi?id=2000
 596
 597 ThinkLight control -- /proc/acpi/ibm/light
 598 ------------------------------------------
 599
 600 The current status of the ThinkLight can be found in this file. A few
 601 models which do not make the status available will show it as
 602 "unknown". The available commands are:
 603
 604         echo on  > /proc/acpi/ibm/light
 605         echo off > /proc/acpi/ibm/light
 606
 607 Docking / undocking -- /proc/acpi/ibm/dock
 608 ------------------------------------------
 609
 610 Docking and undocking (e.g. with the X4 UltraBase) requires some
 611 actions to be taken by the operating system to safely make or break
 612 the electrical connections with the dock.
 613
 614 The docking feature of this driver generates the following ACPI events:
 615
 616         ibm/dock GDCK 00000003 00000001 -- eject request
 617         ibm/dock GDCK 00000003 00000002 -- undocked
 618         ibm/dock GDCK 00000000 00000003 -- docked
 619
 620 NOTE: These events will only be generated if the laptop was docked
 621 when originally booted. This is due to the current lack of support for
 622 hot plugging of devices in the Linux ACPI framework. If the laptop was
 623 booted while not in the dock, the following message is shown in the
 624 logs:
 625
 626         Mar 17 01:42:34 aero kernel: thinkpad_acpi: dock device not present
 627
 628 In this case, no dock-related events are generated but the dock and
 629 undock commands described below still work. They can be executed
 630 manually or triggered by Fn key combinations (see the example acpid
 631 configuration files included in the driver tarball package available
 632 on the web site).
 633
 634 When the eject request button on the dock is pressed, the first event
 635 above is generated. The handler for this event should issue the
 636 following command:
 637
 638         echo undock > /proc/acpi/ibm/dock
 639
 640 After the LED on the dock goes off, it is safe to eject the laptop.
 641 Note: if you pressed this key by mistake, go ahead and eject the
 642 laptop, then dock it back in. Otherwise, the dock may not function as
 643 expected.
 644
 645 When the laptop is docked, the third event above is generated. The
 646 handler for this event should issue the following command to fully
 647 enable the dock:
 648
 649         echo dock > /proc/acpi/ibm/dock
 650
 651 The contents of the /proc/acpi/ibm/dock file shows the current status
 652 of the dock, as provided by the ACPI framework.
 653
 654 The docking support in this driver does not take care of enabling or
 655 disabling any other devices you may have attached to the dock. For
 656 example, a CD drive plugged into the UltraBase needs to be disabled or
 657 enabled separately. See the provided example acpid configuration files
 658 for how this can be accomplished.
 659
 660 There is no support yet for PCI devices that may be attached to a
 661 docking station, e.g. in the ThinkPad Dock II. The driver currently
 662 does not recognize, enable or disable such devices. This means that
 663 the only docking stations currently supported are the X-series
 664 UltraBase docks and "dumb" port replicators like the Mini Dock (the
 665 latter don't need any ACPI support, actually).
 666
 667 UltraBay eject -- /proc/acpi/ibm/bay
 668 ------------------------------------
 669
 670 Inserting or ejecting an UltraBay device requires some actions to be
 671 taken by the operating system to safely make or break the electrical
 672 connections with the device.
 673
 674 This feature generates the following ACPI events:
 675
 676         ibm/bay MSTR 00000003 00000000 -- eject request
 677         ibm/bay MSTR 00000001 00000000 -- eject lever inserted
 678
 679 NOTE: These events will only be generated if the UltraBay was present
 680 when the laptop was originally booted (on the X series, the UltraBay
 681 is in the dock, so it may not be present if the laptop was undocked).
 682 This is due to the current lack of support for hot plugging of devices
 683 in the Linux ACPI framework. If the laptop was booted without the
 684 UltraBay, the following message is shown in the logs:
 685
 686         Mar 17 01:42:34 aero kernel: thinkpad_acpi: bay device not present
 687
 688 In this case, no bay-related events are generated but the eject
 689 command described below still works. It can be executed manually or
 690 triggered by a hot key combination.
 691
 692 Sliding the eject lever generates the first event shown above. The
 693 handler for this event should take whatever actions are necessary to
 694 shut down the device in the UltraBay (e.g. call idectl), then issue
 695 the following command:
 696
 697         echo eject > /proc/acpi/ibm/bay
 698
 699 After the LED on the UltraBay goes off, it is safe to pull out the
 700 device.
 701
 702 When the eject lever is inserted, the second event above is
 703 generated. The handler for this event should take whatever actions are
 704 necessary to enable the UltraBay device (e.g. call idectl).
 705
 706 The contents of the /proc/acpi/ibm/bay file shows the current status
 707 of the UltraBay, as provided by the ACPI framework.
 708
 709 EXPERIMENTAL warm eject support on the 600e/x, A22p and A3x (To use
 710 this feature, you need to supply the experimental=1 parameter when
 711 loading the module):
 712
 713 These models do not have a button near the UltraBay device to request
 714 a hot eject but rather require the laptop to be put to sleep
 715 (suspend-to-ram) before the bay device is ejected or inserted).
 716 The sequence of steps to eject the device is as follows:
 717
 718         echo eject > /proc/acpi/ibm/bay
 719         put the ThinkPad to sleep
 720         remove the drive
 721         resume from sleep
 722         cat /proc/acpi/ibm/bay should show that the drive was removed
 723
 724 On the A3x, both the UltraBay 2000 and UltraBay Plus devices are
 725 supported. Use "eject2" instead of "eject" for the second bay.
 726
 727 Note: the UltraBay eject support on the 600e/x, A22p and A3x is
 728 EXPERIMENTAL and may not work as expected. USE WITH CAUTION!
 729
 730 CMOS control
 731 ------------
 732
 733 procfs: /proc/acpi/ibm/cmos
 734 sysfs device attribute: cmos_command
 735
 736 This feature is mostly used internally by the ACPI firmware to keep the legacy
 737 CMOS NVRAM bits in sync with the current machine state, and to record this
 738 state so that the ThinkPad will retain such settings across reboots.
 739
 740 Some of these commands actually perform actions in some ThinkPad models, but
 741 this is expected to disappear more and more in newer models.  As an example, in
 742 a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
 743 real, but commands 0 to 2 don't control the mixer anymore (they have been
 744 phased out) and just update the NVRAM.
 745
 746 The range of valid cmos command numbers is 0 to 21, but not all have an
 747 effect and the behavior varies from model to model.  Here is the behavior
 748 on the X40 (tpb is the ThinkPad Buttons utility):
 749
 750         0 - Related to "Volume down" key press
 751         1 - Related to "Volume up" key press
 752         2 - Related to "Mute on" key press
 753         3 - Related to "Access IBM" key press
 754         4 - Related to "LCD brightness up" key pess
 755         5 - Related to "LCD brightness down" key press
 756         11 - Related to "toggle screen expansion" key press/function
 757         12 - Related to "ThinkLight on"
 758         13 - Related to "ThinkLight off"
 759         14 - Related to "ThinkLight" key press (toggle thinklight)
 760
 761 The cmos command interface is prone to firmware split-brain problems, as
 762 in newer ThinkPads it is just a compatibility layer.  Do not use it, it is
 763 exported just as a debug tool.
 764
 765 LED control -- /proc/acpi/ibm/led
 766 ---------------------------------
 767
 768 Some of the LED indicators can be controlled through this feature. The
 769 available commands are:
 770
 771         echo '<led number> on' >/proc/acpi/ibm/led
 772         echo '<led number> off' >/proc/acpi/ibm/led
 773         echo '<led number> blink' >/proc/acpi/ibm/led
 774
 775 The <led number> range is 0 to 7. The set of LEDs that can be
 776 controlled varies from model to model. Here is the mapping on the X40:
 777
 778         0 - power
 779         1 - battery (orange)
 780         2 - battery (green)
 781         3 - UltraBase
 782         4 - UltraBay
 783         7 - standby
 784
 785 All of the above can be turned on and off and can be made to blink.
 786
 787 ACPI sounds -- /proc/acpi/ibm/beep
 788 ----------------------------------
 789
 790 The BEEP method is used internally by the ACPI firmware to provide
 791 audible alerts in various situations. This feature allows the same
 792 sounds to be triggered manually.
 793
 794 The commands are non-negative integer numbers:
 795
 796         echo <number> >/proc/acpi/ibm/beep
 797
 798 The valid <number> range is 0 to 17. Not all numbers trigger sounds
 799 and the sounds vary from model to model. Here is the behavior on the
 800 X40:
 801
 802         0 - stop a sound in progress (but use 17 to stop 16)
 803         2 - two beeps, pause, third beep ("low battery")
 804         3 - single beep
 805         4 - high, followed by low-pitched beep ("unable")
 806         5 - single beep
 807         6 - very high, followed by high-pitched beep ("AC/DC")
 808         7 - high-pitched beep
 809         9 - three short beeps
 810         10 - very long beep
 811         12 - low-pitched beep
 812         15 - three high-pitched beeps repeating constantly, stop with 0
 813         16 - one medium-pitched beep repeating constantly, stop with 17
 814         17 - stop 16
 815
 816 Temperature sensors
 817 -------------------
 818
 819 procfs: /proc/acpi/ibm/thermal
 820 sysfs device attributes: (hwmon "thinkpad") temp*_input
 821
 822 Most ThinkPads include six or more separate temperature sensors but only
 823 expose the CPU temperature through the standard ACPI methods.  This
 824 feature shows readings from up to eight different sensors on older
 825 ThinkPads, and up to sixteen different sensors on newer ThinkPads.
 826
 827 For example, on the X40, a typical output may be:
 828 temperatures:   42 42 45 41 36 -128 33 -128
 829
 830 On the T43/p, a typical output may be:
 831 temperatures:   48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
 832
 833 The mapping of thermal sensors to physical locations varies depending on
 834 system-board model (and thus, on ThinkPad model).
 835
 836 http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
 837 tries to track down these locations for various models.
 838
 839 Most (newer?) models seem to follow this pattern:
 840
 841 1:  CPU
 842 2:  (depends on model)
 843 3:  (depends on model)
 844 4:  GPU
 845 5:  Main battery: main sensor
 846 6:  Bay battery: main sensor
 847 7:  Main battery: secondary sensor
 848 8:  Bay battery: secondary sensor
 849 9-15: (depends on model)
 850
 851 For the R51 (source: Thomas Gruber):
 852 2:  Mini-PCI
 853 3:  Internal HDD
 854
 855 For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
 856 http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
 857 2:  System board, left side (near PCMCIA slot), reported as HDAPS temp
 858 3:  PCMCIA slot
 859 9:  MCH (northbridge) to DRAM Bus
 860 10: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
 861     card, under touchpad
 862 11: Power regulator, underside of system board, below F2 key
 863
 864 The A31 has a very atypical layout for the thermal sensors
 865 (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
 866 1:  CPU
 867 2:  Main Battery: main sensor
 868 3:  Power Converter
 869 4:  Bay Battery: main sensor
 870 5:  MCH (northbridge)
 871 6:  PCMCIA/ambient
 872 7:  Main Battery: secondary sensor
 873 8:  Bay Battery: secondary sensor
 874
 875
 876 Procfs notes:
 877         Readings from sensors that are not available return -128.
 878         No commands can be written to this file.
 879
 880 Sysfs notes:
 881         Sensors that are not available return the ENXIO error.  This
 882         status may change at runtime, as there are hotplug thermal
 883         sensors, like those inside the batteries and docks.
 884
 885         thinkpad-acpi thermal sensors are reported through the hwmon
 886         subsystem, and follow all of the hwmon guidelines at
 887         Documentation/hwmon.
 888
 889
 890 EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
 891 ------------------------------------------------------------------------
 892
 893 This feature is marked EXPERIMENTAL because the implementation
 894 directly accesses hardware registers and may not work as expected. USE
 895 WITH CAUTION! To use this feature, you need to supply the
 896 experimental=1 parameter when loading the module.
 897
 898 This feature dumps the values of 256 embedded controller
 899 registers. Values which have changed since the last time the registers
 900 were dumped are marked with a star:
 901
 902 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
 903 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
 904 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
 905 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
 906 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
 907 EC 0x30:  01  07  1a  00  30  04  00  00 *85  00  00  10  00  50  00  00
 908 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
 909 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03 *bc *02 *bc
 910 EC 0x60: *02 *bc *02  00  00  00  00  00  00  00  00  00  00  00  00  00
 911 EC 0x70:  00  00  00  00  00  12  30  40 *24 *26 *2c *27 *20  80 *1f  80
 912 EC 0x80:  00  00  00  06 *37 *0e  03  00  00  00  0e  07  00  00  00  00
 913 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 914 EC 0xa0: *ff  09  ff  09  ff  ff *64  00 *00 *00 *a2  41 *ff *ff *e0  00
 915 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 916 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 917 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 918 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
 919 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
 920
 921 This feature can be used to determine the register holding the fan
 922 speed on some models. To do that, do the following:
 923
 924         - make sure the battery is fully charged
 925         - make sure the fan is running
 926         - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
 927
 928 The first step makes sure various charging-related values don't
 929 vary. The second ensures that the fan-related values do vary, since
 930 the fan speed fluctuates a bit. The third will (hopefully) mark the
 931 fan register with a star:
 932
 933 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
 934 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
 935 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
 936 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
 937 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
 938 EC 0x30:  01  07  1a  00  30  04  00  00  85  00  00  10  00  50  00  00
 939 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
 940 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03  bc  02  bc
 941 EC 0x60:  02  bc  02  00  00  00  00  00  00  00  00  00  00  00  00  00
 942 EC 0x70:  00  00  00  00  00  12  30  40  24  27  2c  27  21  80  1f  80
 943 EC 0x80:  00  00  00  06 *be  0d  03  00  00  00  0e  07  00  00  00  00
 944 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 945 EC 0xa0:  ff  09  ff  09  ff  ff  64  00  00  00  a2  41  ff  ff  e0  00
 946 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 947 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 948 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 949 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
 950 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
 951
 952 Another set of values that varies often is the temperature
 953 readings. Since temperatures don't change vary fast, you can take
 954 several quick dumps to eliminate them.
 955
 956 You can use a similar method to figure out the meaning of other
 957 embedded controller registers - e.g. make sure nothing else changes
 958 except the charging or discharging battery to determine which
 959 registers contain the current battery capacity, etc. If you experiment
 960 with this, do send me your results (including some complete dumps with
 961 a description of the conditions when they were taken.)
 962
 963 LCD brightness control
 964 ----------------------
 965
 966 procfs: /proc/acpi/ibm/brightness
 967 sysfs backlight device "thinkpad_screen"
 968
 969 This feature allows software control of the LCD brightness on ThinkPad
 970 models which don't have a hardware brightness slider.
 971
 972 It has some limitations: the LCD backlight cannot be actually turned on or
 973 off by this interface, and in many ThinkPad models, the "dim while on
 974 battery" functionality will be enabled by the BIOS when this interface is
 975 used, and cannot be controlled.
 976
 977 On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
 978 has eight brightness levels, ranging from 0 to 7.  Some of the levels
 979 may not be distinct.  Later Lenovo models that implement the ACPI
 980 display backlight brightness control methods have 16 levels, ranging
 981 from 0 to 15.
 982
 983 There are two interfaces to the firmware for direct brightness control,
 984 EC and CMOS.  To select which one should be used, use the
 985 brightness_mode module parameter: brightness_mode=1 selects EC mode,
 986 brightness_mode=2 selects CMOS mode, brightness_mode=3 selects both EC
 987 and CMOS.  The driver tries to autodetect which interface to use.
 988
 989 When display backlight brightness controls are available through the
 990 standard ACPI interface, it is best to use it instead of this direct
 991 ThinkPad-specific interface.  The driver will disable its native
 992 backlight brightness control interface if it detects that the standard
 993 ACPI interface is available in the ThinkPad.
 994
 995 The brightness_enable module parameter can be used to control whether
 996 the LCD brightness control feature will be enabled when available.
 997 brightness_enable=0 forces it to be disabled.  brightness_enable=1
 998 forces it to be enabled when available, even if the standard ACPI
 999 interface is also available.
1000
1001 Procfs notes:
1002
1003         The available commands are:
1004
1005         echo up   >/proc/acpi/ibm/brightness
1006         echo down >/proc/acpi/ibm/brightness
1007         echo 'level <level>' >/proc/acpi/ibm/brightness
1008
1009 Sysfs notes:
1010
1011 The interface is implemented through the backlight sysfs class, which is
1012 poorly documented at this time.
1013
1014 Locate the thinkpad_screen device under /sys/class/backlight, and inside
1015 it there will be the following attributes:
1016
1017         max_brightness:
1018                 Reads the maximum brightness the hardware can be set to.
1019                 The minimum is always zero.
1020
1021         actual_brightness:
1022                 Reads what brightness the screen is set to at this instant.
1023
1024         brightness:
1025                 Writes request the driver to change brightness to the
1026                 given value.  Reads will tell you what brightness the
1027                 driver is trying to set the display to when "power" is set
1028                 to zero and the display has not been dimmed by a kernel
1029                 power management event.
1030
1031         power:
1032                 power management mode, where 0 is "display on", and 1 to 3
1033                 will dim the display backlight to brightness level 0
1034                 because thinkpad-acpi cannot really turn the backlight
1035                 off.  Kernel power management events can temporarily
1036                 increase the current power management level, i.e. they can
1037                 dim the display.
1038
1039
1040 Volume control -- /proc/acpi/ibm/volume
1041 ---------------------------------------
1042
1043 This feature allows volume control on ThinkPad models which don't have
1044 a hardware volume knob. The available commands are:
1045
1046         echo up   >/proc/acpi/ibm/volume
1047         echo down >/proc/acpi/ibm/volume
1048         echo mute >/proc/acpi/ibm/volume
1049         echo 'level <level>' >/proc/acpi/ibm/volume
1050
1051 The <level> number range is 0 to 15 although not all of them may be
1052 distinct. The unmute the volume after the mute command, use either the
1053 up or down command (the level command will not unmute the volume).
1054 The current volume level and mute state is shown in the file.
1055
1056 Fan control and monitoring: fan speed, fan enable/disable
1057 ---------------------------------------------------------
1058
1059 procfs: /proc/acpi/ibm/fan
1060 sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
1061                           pwm1_enable
1062 sysfs hwmon driver attributes: fan_watchdog
1063
1064 NOTE NOTE NOTE: fan control operations are disabled by default for
1065 safety reasons.  To enable them, the module parameter "fan_control=1"
1066 must be given to thinkpad-acpi.
1067
1068 This feature attempts to show the current fan speed, control mode and
1069 other fan data that might be available.  The speed is read directly
1070 from the hardware registers of the embedded controller.  This is known
1071 to work on later R, T, X and Z series ThinkPads but may show a bogus
1072 value on other models.
1073
1074 Fan levels:
1075
1076 Most ThinkPad fans work in "levels" at the firmware interface.  Level 0
1077 stops the fan.  The higher the level, the higher the fan speed, although
1078 adjacent levels often map to the same fan speed.  7 is the highest
1079 level, where the fan reaches the maximum recommended speed.
1080
1081 Level "auto" means the EC changes the fan level according to some
1082 internal algorithm, usually based on readings from the thermal sensors.
1083
1084 There is also a "full-speed" level, also known as "disengaged" level.
1085 In this level, the EC disables the speed-locked closed-loop fan control,
1086 and drives the fan as fast as it can go, which might exceed hardware
1087 limits, so use this level with caution.
1088
1089 The fan usually ramps up or down slowly from one speed to another, and
1090 it is normal for the EC to take several seconds to react to fan
1091 commands.  The full-speed level may take up to two minutes to ramp up to
1092 maximum speed, and in some ThinkPads, the tachometer readings go stale
1093 while the EC is transitioning to the full-speed level.
1094
1095 WARNING WARNING WARNING: do not leave the fan disabled unless you are
1096 monitoring all of the temperature sensor readings and you are ready to
1097 enable it if necessary to avoid overheating.
1098
1099 An enabled fan in level "auto" may stop spinning if the EC decides the
1100 ThinkPad is cool enough and doesn't need the extra airflow.  This is
1101 normal, and the EC will spin the fan up if the various thermal readings
1102 rise too much.
1103
1104 On the X40, this seems to depend on the CPU and HDD temperatures.
1105 Specifically, the fan is turned on when either the CPU temperature
1106 climbs to 56 degrees or the HDD temperature climbs to 46 degrees.  The
1107 fan is turned off when the CPU temperature drops to 49 degrees and the
1108 HDD temperature drops to 41 degrees.  These thresholds cannot
1109 currently be controlled.
1110
1111 The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
1112 certain conditions are met.  It will override any fan programming done
1113 through thinkpad-acpi.
1114
1115 The thinkpad-acpi kernel driver can be programmed to revert the fan
1116 level to a safe setting if userspace does not issue one of the procfs
1117 fan commands: "enable", "disable", "level" or "watchdog", or if there
1118 are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
1119 set to 1, manual mode) within a configurable amount of time of up to
1120 120 seconds.  This functionality is called fan safety watchdog.
1121
1122 Note that the watchdog timer stops after it enables the fan.  It will be
1123 rearmed again automatically (using the same interval) when one of the
1124 above mentioned fan commands is received.  The fan watchdog is,
1125 therefore, not suitable to protect against fan mode changes made through
1126 means other than the "enable", "disable", and "level" procfs fan
1127 commands, or the hwmon fan control sysfs interface.
1128
1129 Procfs notes:
1130
1131 The fan may be enabled or disabled with the following commands:
1132
1133         echo enable  >/proc/acpi/ibm/fan
1134         echo disable >/proc/acpi/ibm/fan
1135
1136 Placing a fan on level 0 is the same as disabling it.  Enabling a fan
1137 will try to place it in a safe level if it is too slow or disabled.
1138
1139 The fan level can be controlled with the command:
1140
1141         echo 'level <level>' > /proc/acpi/ibm/fan
1142
1143 Where <level> is an integer from 0 to 7, or one of the words "auto" or
1144 "full-speed" (without the quotes).  Not all ThinkPads support the "auto"
1145 and "full-speed" levels.  The driver accepts "disengaged" as an alias for
1146 "full-speed", and reports it as "disengaged" for backwards
1147 compatibility.
1148
1149 On the X31 and X40 (and ONLY on those models), the fan speed can be
1150 controlled to a certain degree.  Once the fan is running, it can be
1151 forced to run faster or slower with the following command:
1152
1153         echo 'speed <speed>' > /proc/acpi/ibm/fan
1154
1155 The sustainable range of fan speeds on the X40 appears to be from about
1156 3700 to about 7350. Values outside this range either do not have any
1157 effect or the fan speed eventually settles somewhere in that range.  The
1158 fan cannot be stopped or started with this command.  This functionality
1159 is incomplete, and not available through the sysfs interface.
1160
1161 To program the safety watchdog, use the "watchdog" command.
1162
1163         echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1164
1165 If you want to disable the watchdog, use 0 as the interval.
1166
1167 Sysfs notes:
1168
1169 The sysfs interface follows the hwmon subsystem guidelines for the most
1170 part, and the exception is the fan safety watchdog.
1171
1172 Writes to any of the sysfs attributes may return the EINVAL error if
1173 that operation is not supported in a given ThinkPad or if the parameter
1174 is out-of-bounds, and EPERM if it is forbidden.  They may also return
1175 EINTR (interrupted system call), and EIO (I/O error while trying to talk
1176 to the firmware).
1177
1178 Features not yet implemented by the driver return ENOSYS.
1179
1180 hwmon device attribute pwm1_enable:
1181         0: PWM offline (fan is set to full-speed mode)
1182         1: Manual PWM control (use pwm1 to set fan level)
1183         2: Hardware PWM control (EC "auto" mode)
1184         3: reserved (Software PWM control, not implemented yet)
1185
1186         Modes 0 and 2 are not supported by all ThinkPads, and the
1187         driver is not always able to detect this.  If it does know a
1188         mode is unsupported, it will return -EINVAL.
1189
1190 hwmon device attribute pwm1:
1191         Fan level, scaled from the firmware values of 0-7 to the hwmon
1192         scale of 0-255.  0 means fan stopped, 255 means highest normal
1193         speed (level 7).
1194
1195         This attribute only commands the fan if pmw1_enable is set to 1
1196         (manual PWM control).
1197
1198 hwmon device attribute fan1_input:
1199         Fan tachometer reading, in RPM.  May go stale on certain
1200         ThinkPads while the EC transitions the PWM to offline mode,
1201         which can take up to two minutes.  May return rubbish on older
1202         ThinkPads.
1203
1204 hwmon driver attribute fan_watchdog:
1205         Fan safety watchdog timer interval, in seconds.  Minimum is
1206         1 second, maximum is 120 seconds.  0 disables the watchdog.
1207
1208 To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
1209
1210 To start the fan in a safe mode: set pwm1_enable to 2.  If that fails
1211 with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
1212 would be the safest choice, though).
1213
1214
1215 EXPERIMENTAL: WAN
1216 -----------------
1217
1218 procfs: /proc/acpi/ibm/wan
1219 sysfs device attribute: wwan_enable
1220
1221 This feature is marked EXPERIMENTAL because the implementation
1222 directly accesses hardware registers and may not work as expected. USE
1223 WITH CAUTION! To use this feature, you need to supply the
1224 experimental=1 parameter when loading the module.
1225
1226 This feature shows the presence and current state of a W-WAN (Sierra
1227 Wireless EV-DO) device.
1228
1229 It was tested on a Lenovo Thinkpad X60. It should probably work on other
1230 Thinkpad models which come with this module installed.
1231
1232 Procfs notes:
1233
1234 If the W-WAN card is installed, the following commands can be used:
1235
1236         echo enable > /proc/acpi/ibm/wan
1237         echo disable > /proc/acpi/ibm/wan
1238
1239 Sysfs notes:
1240
1241         If the W-WAN card is installed, it can be enabled /
1242         disabled through the "wwan_enable" thinkpad-acpi device
1243         attribute, and its current status can also be queried.
1244
1245         enable:
1246                 0: disables WWAN card / WWAN card is disabled
1247                 1: enables WWAN card / WWAN card is enabled.
1248
1249         Note: this interface will be probably be superseeded by the
1250         generic rfkill class, so it is NOT to be considered stable yet.
1251
1252 Multiple Commands, Module Parameters
1253 ------------------------------------
1254
1255 Multiple commands can be written to the proc files in one shot by
1256 separating them with commas, for example:
1257
1258         echo enable,0xffff > /proc/acpi/ibm/hotkey
1259         echo lcd_disable,crt_enable > /proc/acpi/ibm/video
1260
1261 Commands can also be specified when loading the thinkpad-acpi module,
1262 for example:
1263
1264         modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
1265
1266 Enabling debugging output
1267 -------------------------
1268
1269 The module takes a debug parameter which can be used to selectively
1270 enable various classes of debugging output, for example:
1271
1272          modprobe ibm_acpi debug=0xffff
1273
1274 will enable all debugging output classes.  It takes a bitmask, so
1275 to enable more than one output class, just add their values.
1276
1277         Debug bitmask           Description
1278         0x0001                  Initialization and probing
1279         0x0002                  Removal
1280
1281 There is also a kernel build option to enable more debugging
1282 information, which may be necessary to debug driver problems.
1283
1284 The level of debugging information output by the driver can be changed
1285 at runtime through sysfs, using the driver attribute debug_level.  The
1286 attribute takes the same bitmask as the debug module parameter above.
1287
1288 Force loading of module
1289 -----------------------
1290
1291 If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1292 the module parameter force_load=1.  Regardless of whether this works or
1293 not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
1294
1295
1296 Sysfs interface changelog:
1297
1298 0x000100:       Initial sysfs support, as a single platform driver and
1299                 device.
1300 0x000200:       Hot key support for 32 hot keys, and radio slider switch
1301                 support.
1302 0x010000:       Hot keys are now handled by default over the input
1303                 layer, the radio switch generates input event EV_RADIO,
1304                 and the driver enables hot key handling by default in
1305                 the firmware.
1306
1307 0x020000:       ABI fix: added a separate hwmon platform device and
1308                 driver, which must be located by name (thinkpad)
1309                 and the hwmon class for libsensors4 (lm-sensors 3)
1310                 compatibility.  Moved all hwmon attributes to this
1311                 new platform device.
1312
1313 0x200100:       Marker for thinkpad-acpi with hot key NVRAM polling
1314                 support.  If you must, use it to know you should not
1315                 start an userspace NVRAM poller (allows to detect when
1316                 NVRAM is compiled out by the user because it is
1317                 unneeded/undesired in the first place).