Documentation/thinkpad-acpi.txt

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