Documentation/thinkpad-acpi.txt

   1                      ThinkPad ACPI Extras Driver
   2
   3                             Version 0.14
   4                           April 21st, 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 Hot keys
 138 --------
 139
 140 procfs: /proc/acpi/ibm/hotkey
 141 sysfs device attribute: hotkey_*
 142
 143 Without this driver, only the Fn-F4 key (sleep button) generates an
 144 ACPI event. With the driver loaded, the hotkey feature enabled and the
 145 mask set (see below), the various hot keys generate ACPI events in the
 146 following format:
 147
 148         ibm/hotkey HKEY 00000080 0000xxxx
 149
 150 The last four digits vary depending on the key combination pressed.
 151 All labeled Fn-Fx key combinations generate distinct events. In
 152 addition, the lid microswitch and some docking station buttons may
 153 also generate such events.
 154
 155 The bit mask allows some control over which hot keys generate ACPI
 156 events. Not all bits in the mask can be modified. Not all bits that can
 157 be modified do anything. Not all hot keys can be individually controlled
 158 by the mask. Some models do not support the mask at all. On those
 159 models, hot keys cannot be controlled individually.
 160
 161 Note that enabling ACPI events for some keys prevents their default
 162 behavior. For example, if events for Fn-F5 are enabled, that key will no
 163 longer enable/disable Bluetooth by itself. This can still be done from
 164 an acpid handler for the ibm/hotkey event.
 165
 166 On some models, even enabling/disabling the entire hot key feature may
 167 change the way some keys behave (e.g. in a T43, Fn+F4 will generate an
 168 button/sleep ACPI event if hot keys are disabled, and it will ignore its
 169 mask when hot keys are enabled, so the key always does something.  On a
 170 X40, Fn+F4 respects its mask status, but generates the button/sleep ACPI
 171 event if masked off).
 172
 173 Note also that not all Fn key combinations are supported through
 174 ACPI. For example, on the X40, the brightness, volume and "Access IBM"
 175 buttons do not generate ACPI events even with this driver. They *can*
 176 be used through the "ThinkPad Buttons" utility, see
 177 http://www.nongnu.org/tpb/
 178
 179 procfs notes:
 180
 181 The following commands can be written to the /proc/acpi/ibm/hotkey file:
 182
 183         echo enable > /proc/acpi/ibm/hotkey -- enable the hot keys feature
 184         echo disable > /proc/acpi/ibm/hotkey -- disable the hot keys feature
 185         echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
 186         echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
 187         ... any other 8-hex-digit mask ...
 188         echo reset > /proc/acpi/ibm/hotkey -- restore the original mask
 189
 190 sysfs notes:
 191
 192         hotkey_bios_enabled:
 193                 Returns the status of the hot keys feature when
 194                 thinkpad-acpi was loaded.  Upon module unload, the hot
 195                 key feature status will be restored to this value.
 196
 197                 0: hot keys were disabled
 198                 1: hot keys were enabled
 199
 200         hotkey_bios_mask:
 201                 Returns the hot keys mask when thinkpad-acpi was loaded.
 202                 Upon module unload, the hot keys mask will be restored
 203                 to this value.
 204
 205         hotkey_enable:
 206                 Enables/disables the hot keys feature, and reports
 207                 current status of the hot keys feature.
 208
 209                 0: disables the hot keys feature / feature disabled
 210                 1: enables the hot keys feature / feature enabled
 211
 212         hotkey_mask:
 213                 bit mask to enable ACPI event generation for each hot
 214                 key (see above).  Returns the current status of the hot
 215                 keys mask, and allows one to modify it.
 216
 217         hotkey_all_mask:
 218                 bit mask that should enable event reporting for all
 219                 supported hot keys, when echoed to hotkey_mask above.
 220                 Unless you know which events need to be handled
 221                 passively (because the firmware *will* handle them
 222                 anyway), do *not* use hotkey_all_mask.  Use
 223                 hotkey_recommended_mask, instead. You have been warned.
 224
 225         hotkey_recommended_mask:
 226                 bit mask that should enable event reporting for all
 227                 supported hot keys, except those which are handled by
 228                 the firmware.  Echo it to hotkey_mask above, to use.
 229
 230
 231 Bluetooth
 232 ---------
 233
 234 procfs: /proc/acpi/ibm/bluetooth
 235 sysfs device attribute: bluetooth_enable
 236
 237 This feature shows the presence and current state of a ThinkPad
 238 Bluetooth device in the internal ThinkPad CDC slot.
 239
 240 Procfs notes:
 241
 242 If Bluetooth is installed, the following commands can be used:
 243
 244         echo enable > /proc/acpi/ibm/bluetooth
 245         echo disable > /proc/acpi/ibm/bluetooth
 246
 247 Sysfs notes:
 248
 249         If the Bluetooth CDC card is installed, it can be enabled /
 250         disabled through the "bluetooth_enable" thinkpad-acpi device
 251         attribute, and its current status can also be queried.
 252
 253         enable:
 254                 0: disables Bluetooth / Bluetooth is disabled
 255                 1: enables Bluetooth / Bluetooth is enabled.
 256
 257         Note: this interface will be probably be superseeded by the
 258         generic rfkill class, so it is NOT to be considered stable yet.
 259
 260 Video output control -- /proc/acpi/ibm/video
 261 --------------------------------------------
 262
 263 This feature allows control over the devices used for video output -
 264 LCD, CRT or DVI (if available). The following commands are available:
 265
 266         echo lcd_enable > /proc/acpi/ibm/video
 267         echo lcd_disable > /proc/acpi/ibm/video
 268         echo crt_enable > /proc/acpi/ibm/video
 269         echo crt_disable > /proc/acpi/ibm/video
 270         echo dvi_enable > /proc/acpi/ibm/video
 271         echo dvi_disable > /proc/acpi/ibm/video
 272         echo auto_enable > /proc/acpi/ibm/video
 273         echo auto_disable > /proc/acpi/ibm/video
 274         echo expand_toggle > /proc/acpi/ibm/video
 275         echo video_switch > /proc/acpi/ibm/video
 276
 277 Each video output device can be enabled or disabled individually.
 278 Reading /proc/acpi/ibm/video shows the status of each device.
 279
 280 Automatic video switching can be enabled or disabled.  When automatic
 281 video switching is enabled, certain events (e.g. opening the lid,
 282 docking or undocking) cause the video output device to change
 283 automatically. While this can be useful, it also causes flickering
 284 and, on the X40, video corruption. By disabling automatic switching,
 285 the flickering or video corruption can be avoided.
 286
 287 The video_switch command cycles through the available video outputs
 288 (it simulates the behavior of Fn-F7).
 289
 290 Video expansion can be toggled through this feature. This controls
 291 whether the display is expanded to fill the entire LCD screen when a
 292 mode with less than full resolution is used. Note that the current
 293 video expansion status cannot be determined through this feature.
 294
 295 Note that on many models (particularly those using Radeon graphics
 296 chips) the X driver configures the video card in a way which prevents
 297 Fn-F7 from working. This also disables the video output switching
 298 features of this driver, as it uses the same ACPI methods as
 299 Fn-F7. Video switching on the console should still work.
 300
 301 UPDATE: There's now a patch for the X.org Radeon driver which
 302 addresses this issue. Some people are reporting success with the patch
 303 while others are still having problems. For more information:
 304
 305 https://bugs.freedesktop.org/show_bug.cgi?id=2000
 306
 307 ThinkLight control -- /proc/acpi/ibm/light
 308 ------------------------------------------
 309
 310 The current status of the ThinkLight can be found in this file. A few
 311 models which do not make the status available will show it as
 312 "unknown". The available commands are:
 313
 314         echo on  > /proc/acpi/ibm/light
 315         echo off > /proc/acpi/ibm/light
 316
 317 Docking / undocking -- /proc/acpi/ibm/dock
 318 ------------------------------------------
 319
 320 Docking and undocking (e.g. with the X4 UltraBase) requires some
 321 actions to be taken by the operating system to safely make or break
 322 the electrical connections with the dock.
 323
 324 The docking feature of this driver generates the following ACPI events:
 325
 326         ibm/dock GDCK 00000003 00000001 -- eject request
 327         ibm/dock GDCK 00000003 00000002 -- undocked
 328         ibm/dock GDCK 00000000 00000003 -- docked
 329
 330 NOTE: These events will only be generated if the laptop was docked
 331 when originally booted. This is due to the current lack of support for
 332 hot plugging of devices in the Linux ACPI framework. If the laptop was
 333 booted while not in the dock, the following message is shown in the
 334 logs:
 335
 336         Mar 17 01:42:34 aero kernel: thinkpad_acpi: dock device not present
 337
 338 In this case, no dock-related events are generated but the dock and
 339 undock commands described below still work. They can be executed
 340 manually or triggered by Fn key combinations (see the example acpid
 341 configuration files included in the driver tarball package available
 342 on the web site).
 343
 344 When the eject request button on the dock is pressed, the first event
 345 above is generated. The handler for this event should issue the
 346 following command:
 347
 348         echo undock > /proc/acpi/ibm/dock
 349
 350 After the LED on the dock goes off, it is safe to eject the laptop.
 351 Note: if you pressed this key by mistake, go ahead and eject the
 352 laptop, then dock it back in. Otherwise, the dock may not function as
 353 expected.
 354
 355 When the laptop is docked, the third event above is generated. The
 356 handler for this event should issue the following command to fully
 357 enable the dock:
 358
 359         echo dock > /proc/acpi/ibm/dock
 360
 361 The contents of the /proc/acpi/ibm/dock file shows the current status
 362 of the dock, as provided by the ACPI framework.
 363
 364 The docking support in this driver does not take care of enabling or
 365 disabling any other devices you may have attached to the dock. For
 366 example, a CD drive plugged into the UltraBase needs to be disabled or
 367 enabled separately. See the provided example acpid configuration files
 368 for how this can be accomplished.
 369
 370 There is no support yet for PCI devices that may be attached to a
 371 docking station, e.g. in the ThinkPad Dock II. The driver currently
 372 does not recognize, enable or disable such devices. This means that
 373 the only docking stations currently supported are the X-series
 374 UltraBase docks and "dumb" port replicators like the Mini Dock (the
 375 latter don't need any ACPI support, actually).
 376
 377 UltraBay eject -- /proc/acpi/ibm/bay
 378 ------------------------------------
 379
 380 Inserting or ejecting an UltraBay device requires some actions to be
 381 taken by the operating system to safely make or break the electrical
 382 connections with the device.
 383
 384 This feature generates the following ACPI events:
 385
 386         ibm/bay MSTR 00000003 00000000 -- eject request
 387         ibm/bay MSTR 00000001 00000000 -- eject lever inserted
 388
 389 NOTE: These events will only be generated if the UltraBay was present
 390 when the laptop was originally booted (on the X series, the UltraBay
 391 is in the dock, so it may not be present if the laptop was undocked).
 392 This is due to the current lack of support for hot plugging of devices
 393 in the Linux ACPI framework. If the laptop was booted without the
 394 UltraBay, the following message is shown in the logs:
 395
 396         Mar 17 01:42:34 aero kernel: thinkpad_acpi: bay device not present
 397
 398 In this case, no bay-related events are generated but the eject
 399 command described below still works. It can be executed manually or
 400 triggered by a hot key combination.
 401
 402 Sliding the eject lever generates the first event shown above. The
 403 handler for this event should take whatever actions are necessary to
 404 shut down the device in the UltraBay (e.g. call idectl), then issue
 405 the following command:
 406
 407         echo eject > /proc/acpi/ibm/bay
 408
 409 After the LED on the UltraBay goes off, it is safe to pull out the
 410 device.
 411
 412 When the eject lever is inserted, the second event above is
 413 generated. The handler for this event should take whatever actions are
 414 necessary to enable the UltraBay device (e.g. call idectl).
 415
 416 The contents of the /proc/acpi/ibm/bay file shows the current status
 417 of the UltraBay, as provided by the ACPI framework.
 418
 419 EXPERIMENTAL warm eject support on the 600e/x, A22p and A3x (To use
 420 this feature, you need to supply the experimental=1 parameter when
 421 loading the module):
 422
 423 These models do not have a button near the UltraBay device to request
 424 a hot eject but rather require the laptop to be put to sleep
 425 (suspend-to-ram) before the bay device is ejected or inserted).
 426 The sequence of steps to eject the device is as follows:
 427
 428         echo eject > /proc/acpi/ibm/bay
 429         put the ThinkPad to sleep
 430         remove the drive
 431         resume from sleep
 432         cat /proc/acpi/ibm/bay should show that the drive was removed
 433
 434 On the A3x, both the UltraBay 2000 and UltraBay Plus devices are
 435 supported. Use "eject2" instead of "eject" for the second bay.
 436
 437 Note: the UltraBay eject support on the 600e/x, A22p and A3x is
 438 EXPERIMENTAL and may not work as expected. USE WITH CAUTION!
 439
 440 CMOS control
 441 ------------
 442
 443 procfs: /proc/acpi/ibm/cmos
 444 sysfs device attribute: cmos_command
 445
 446 This feature is used internally by the ACPI firmware to control the
 447 ThinkLight on most newer ThinkPad models. It may also control LCD
 448 brightness, sounds volume and more, but only on some models.
 449
 450 The range of valid cmos command numbers is 0 to 21, but not all have an
 451 effect and the behavior varies from model to model.  Here is the behavior
 452 on the X40 (tpb is the ThinkPad Buttons utility):
 453
 454         0 - no effect but tpb reports "Volume down"
 455         1 - no effect but tpb reports "Volume up"
 456         2 - no effect but tpb reports "Mute on"
 457         3 - simulate pressing the "Access IBM" button
 458         4 - LCD brightness up
 459         5 - LCD brightness down
 460         11 - toggle screen expansion
 461         12 - ThinkLight on
 462         13 - ThinkLight off
 463         14 - no effect but tpb reports ThinkLight status change
 464
 465 The cmos command interface is prone to firmware split-brain problems, as
 466 in newer ThinkPads it is just a compatibility layer.
 467
 468 LED control -- /proc/acpi/ibm/led
 469 ---------------------------------
 470
 471 Some of the LED indicators can be controlled through this feature. The
 472 available commands are:
 473
 474         echo '<led number> on' >/proc/acpi/ibm/led
 475         echo '<led number> off' >/proc/acpi/ibm/led
 476         echo '<led number> blink' >/proc/acpi/ibm/led
 477
 478 The <led number> range is 0 to 7. The set of LEDs that can be
 479 controlled varies from model to model. Here is the mapping on the X40:
 480
 481         0 - power
 482         1 - battery (orange)
 483         2 - battery (green)
 484         3 - UltraBase
 485         4 - UltraBay
 486         7 - standby
 487
 488 All of the above can be turned on and off and can be made to blink.
 489
 490 ACPI sounds -- /proc/acpi/ibm/beep
 491 ----------------------------------
 492
 493 The BEEP method is used internally by the ACPI firmware to provide
 494 audible alerts in various situations. This feature allows the same
 495 sounds to be triggered manually.
 496
 497 The commands are non-negative integer numbers:
 498
 499         echo <number> >/proc/acpi/ibm/beep
 500
 501 The valid <number> range is 0 to 17. Not all numbers trigger sounds
 502 and the sounds vary from model to model. Here is the behavior on the
 503 X40:
 504
 505         0 - stop a sound in progress (but use 17 to stop 16)
 506         2 - two beeps, pause, third beep ("low battery")
 507         3 - single beep
 508         4 - high, followed by low-pitched beep ("unable")
 509         5 - single beep
 510         6 - very high, followed by high-pitched beep ("AC/DC")
 511         7 - high-pitched beep
 512         9 - three short beeps
 513         10 - very long beep
 514         12 - low-pitched beep
 515         15 - three high-pitched beeps repeating constantly, stop with 0
 516         16 - one medium-pitched beep repeating constantly, stop with 17
 517         17 - stop 16
 518
 519 Temperature sensors
 520 -------------------
 521
 522 procfs: /proc/acpi/ibm/thermal
 523 sysfs device attributes: (hwmon) temp*_input
 524
 525 Most ThinkPads include six or more separate temperature sensors but
 526 only expose the CPU temperature through the standard ACPI methods.
 527 This feature shows readings from up to eight different sensors on older
 528 ThinkPads, and it has experimental support for up to sixteen different
 529 sensors on newer ThinkPads.
 530
 531 EXPERIMENTAL: The 16-sensors feature is marked EXPERIMENTAL because the
 532 implementation directly accesses hardware registers and may not work as
 533 expected. USE WITH CAUTION! To use this feature, you need to supply the
 534 experimental=1 parameter when loading the module.  When EXPERIMENTAL
 535 mode is enabled, reading the first 8 sensors on newer ThinkPads will
 536 also use an new experimental thermal sensor access mode.
 537
 538 For example, on the X40, a typical output may be:
 539 temperatures:   42 42 45 41 36 -128 33 -128
 540
 541 EXPERIMENTAL: On the T43/p, a typical output may be:
 542 temperatures:   48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
 543
 544 The mapping of thermal sensors to physical locations varies depending on
 545 system-board model (and thus, on ThinkPad model).
 546
 547 http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
 548 tries to track down these locations for various models.
 549
 550 Most (newer?) models seem to follow this pattern:
 551
 552 1:  CPU
 553 2:  (depends on model)
 554 3:  (depends on model)
 555 4:  GPU
 556 5:  Main battery: main sensor
 557 6:  Bay battery: main sensor
 558 7:  Main battery: secondary sensor
 559 8:  Bay battery: secondary sensor
 560 9-15: (depends on model)
 561
 562 For the R51 (source: Thomas Gruber):
 563 2:  Mini-PCI
 564 3:  Internal HDD
 565
 566 For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
 567 http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
 568 2:  System board, left side (near PCMCIA slot), reported as HDAPS temp
 569 3:  PCMCIA slot
 570 9:  MCH (northbridge) to DRAM Bus
 571 10: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
 572     card, under touchpad
 573 11: Power regulator, underside of system board, below F2 key
 574
 575 The A31 has a very atypical layout for the thermal sensors
 576 (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
 577 1:  CPU
 578 2:  Main Battery: main sensor
 579 3:  Power Converter
 580 4:  Bay Battery: main sensor
 581 5:  MCH (northbridge)
 582 6:  PCMCIA/ambient
 583 7:  Main Battery: secondary sensor
 584 8:  Bay Battery: secondary sensor
 585
 586
 587 Procfs notes:
 588         Readings from sensors that are not available return -128.
 589         No commands can be written to this file.
 590
 591 Sysfs notes:
 592         Sensors that are not available return the ENXIO error.  This
 593         status may change at runtime, as there are hotplug thermal
 594         sensors, like those inside the batteries and docks.
 595
 596         thinkpad-acpi thermal sensors are reported through the hwmon
 597         subsystem, and follow all of the hwmon guidelines at
 598         Documentation/hwmon.
 599
 600
 601 EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
 602 ------------------------------------------------------------------------
 603
 604 This feature is marked EXPERIMENTAL because the implementation
 605 directly accesses hardware registers and may not work as expected. USE
 606 WITH CAUTION! To use this feature, you need to supply the
 607 experimental=1 parameter when loading the module.
 608
 609 This feature dumps the values of 256 embedded controller
 610 registers. Values which have changed since the last time the registers
 611 were dumped are marked with a star:
 612
 613 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
 614 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
 615 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
 616 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
 617 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
 618 EC 0x30:  01  07  1a  00  30  04  00  00 *85  00  00  10  00  50  00  00
 619 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
 620 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03 *bc *02 *bc
 621 EC 0x60: *02 *bc *02  00  00  00  00  00  00  00  00  00  00  00  00  00
 622 EC 0x70:  00  00  00  00  00  12  30  40 *24 *26 *2c *27 *20  80 *1f  80
 623 EC 0x80:  00  00  00  06 *37 *0e  03  00  00  00  0e  07  00  00  00  00
 624 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 625 EC 0xa0: *ff  09  ff  09  ff  ff *64  00 *00 *00 *a2  41 *ff *ff *e0  00
 626 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 627 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 628 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 629 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
 630 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
 631
 632 This feature can be used to determine the register holding the fan
 633 speed on some models. To do that, do the following:
 634
 635         - make sure the battery is fully charged
 636         - make sure the fan is running
 637         - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
 638
 639 The first step makes sure various charging-related values don't
 640 vary. The second ensures that the fan-related values do vary, since
 641 the fan speed fluctuates a bit. The third will (hopefully) mark the
 642 fan register with a star:
 643
 644 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
 645 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
 646 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
 647 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
 648 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
 649 EC 0x30:  01  07  1a  00  30  04  00  00  85  00  00  10  00  50  00  00
 650 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
 651 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03  bc  02  bc
 652 EC 0x60:  02  bc  02  00  00  00  00  00  00  00  00  00  00  00  00  00
 653 EC 0x70:  00  00  00  00  00  12  30  40  24  27  2c  27  21  80  1f  80
 654 EC 0x80:  00  00  00  06 *be  0d  03  00  00  00  0e  07  00  00  00  00
 655 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 656 EC 0xa0:  ff  09  ff  09  ff  ff  64  00  00  00  a2  41  ff  ff  e0  00
 657 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 658 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 659 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 660 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
 661 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
 662
 663 Another set of values that varies often is the temperature
 664 readings. Since temperatures don't change vary fast, you can take
 665 several quick dumps to eliminate them.
 666
 667 You can use a similar method to figure out the meaning of other
 668 embedded controller registers - e.g. make sure nothing else changes
 669 except the charging or discharging battery to determine which
 670 registers contain the current battery capacity, etc. If you experiment
 671 with this, do send me your results (including some complete dumps with
 672 a description of the conditions when they were taken.)
 673
 674 LCD brightness control
 675 ----------------------
 676
 677 procfs: /proc/acpi/ibm/brightness
 678 sysfs backlight device "thinkpad_screen"
 679
 680 This feature allows software control of the LCD brightness on ThinkPad
 681 models which don't have a hardware brightness slider.
 682
 683 It has some limitations: the LCD backlight cannot be actually turned on or off
 684 by this interface, and in many ThinkPad models, the "dim while on battery"
 685 functionality will be enabled by the BIOS when this interface is used, and
 686 cannot be controlled.
 687
 688 The backlight control has eight levels, ranging from 0 to 7.  Some of the
 689 levels may not be distinct.
 690
 691 Procfs notes:
 692
 693         The available commands are:
 694
 695         echo up   >/proc/acpi/ibm/brightness
 696         echo down >/proc/acpi/ibm/brightness
 697         echo 'level <level>' >/proc/acpi/ibm/brightness
 698
 699 Sysfs notes:
 700
 701 The interface is implemented through the backlight sysfs class, which is poorly
 702 documented at this time.
 703
 704 Locate the thinkpad_screen device under /sys/class/backlight, and inside it
 705 there will be the following attributes:
 706
 707         max_brightness:
 708                 Reads the maximum brightness the hardware can be set to.
 709                 The minimum is always zero.
 710
 711         actual_brightness:
 712                 Reads what brightness the screen is set to at this instant.
 713
 714         brightness:
 715                 Writes request the driver to change brightness to the given
 716                 value.  Reads will tell you what brightness the driver is trying
 717                 to set the display to when "power" is set to zero and the display
 718                 has not been dimmed by a kernel power management event.
 719
 720         power:
 721                 power management mode, where 0 is "display on", and 1 to 3 will
 722                 dim the display backlight to brightness level 0 because
 723                 thinkpad-acpi cannot really turn the backlight off.  Kernel
 724                 power management events can temporarily increase the current
 725                 power management level, i.e. they can dim the display.
 726
 727
 728 Volume control -- /proc/acpi/ibm/volume
 729 ---------------------------------------
 730
 731 This feature allows volume control on ThinkPad models which don't have
 732 a hardware volume knob. The available commands are:
 733
 734         echo up   >/proc/acpi/ibm/volume
 735         echo down >/proc/acpi/ibm/volume
 736         echo mute >/proc/acpi/ibm/volume
 737         echo 'level <level>' >/proc/acpi/ibm/volume
 738
 739 The <level> number range is 0 to 15 although not all of them may be
 740 distinct. The unmute the volume after the mute command, use either the
 741 up or down command (the level command will not unmute the volume).
 742 The current volume level and mute state is shown in the file.
 743
 744 Fan control and monitoring: fan speed, fan enable/disable
 745 ---------------------------------------------------------
 746
 747 procfs: /proc/acpi/ibm/fan
 748 sysfs device attributes: (hwmon) fan_input, pwm1, pwm1_enable
 749
 750 NOTE NOTE NOTE: fan control operations are disabled by default for
 751 safety reasons.  To enable them, the module parameter "fan_control=1"
 752 must be given to thinkpad-acpi.
 753
 754 This feature attempts to show the current fan speed, control mode and
 755 other fan data that might be available.  The speed is read directly
 756 from the hardware registers of the embedded controller.  This is known
 757 to work on later R, T, X and Z series ThinkPads but may show a bogus
 758 value on other models.
 759
 760 Fan levels:
 761
 762 Most ThinkPad fans work in "levels" at the firmware interface.  Level 0
 763 stops the fan.  The higher the level, the higher the fan speed, although
 764 adjacent levels often map to the same fan speed.  7 is the highest
 765 level, where the fan reaches the maximum recommended speed.
 766
 767 Level "auto" means the EC changes the fan level according to some
 768 internal algorithm, usually based on readings from the thermal sensors.
 769
 770 There is also a "full-speed" level, also known as "disengaged" level.
 771 In this level, the EC disables the speed-locked closed-loop fan control,
 772 and drives the fan as fast as it can go, which might exceed hardware
 773 limits, so use this level with caution.
 774
 775 The fan usually ramps up or down slowly from one speed to another, and
 776 it is normal for the EC to take several seconds to react to fan
 777 commands.  The full-speed level may take up to two minutes to ramp up to
 778 maximum speed, and in some ThinkPads, the tachometer readings go stale
 779 while the EC is transitioning to the full-speed level.
 780
 781 WARNING WARNING WARNING: do not leave the fan disabled unless you are
 782 monitoring all of the temperature sensor readings and you are ready to
 783 enable it if necessary to avoid overheating.
 784
 785 An enabled fan in level "auto" may stop spinning if the EC decides the
 786 ThinkPad is cool enough and doesn't need the extra airflow.  This is
 787 normal, and the EC will spin the fan up if the varios thermal readings
 788 rise too much.
 789
 790 On the X40, this seems to depend on the CPU and HDD temperatures.
 791 Specifically, the fan is turned on when either the CPU temperature
 792 climbs to 56 degrees or the HDD temperature climbs to 46 degrees.  The
 793 fan is turned off when the CPU temperature drops to 49 degrees and the
 794 HDD temperature drops to 41 degrees.  These thresholds cannot
 795 currently be controlled.
 796
 797 The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
 798 certain conditions are met.  It will override any fan programming done
 799 through thinkpad-acpi.
 800
 801 The thinkpad-acpi kernel driver can be programmed to revert the fan
 802 level to a safe setting if userspace does not issue one of the procfs
 803 fan commands: "enable", "disable", "level" or "watchdog", or if there
 804 are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
 805 set to 1, manual mode) within a configurable amount of time of up to
 806 120 seconds.  This functionality is called fan safety watchdog.
 807
 808 Note that the watchdog timer stops after it enables the fan.  It will be
 809 rearmed again automatically (using the same interval) when one of the
 810 above mentioned fan commands is received.  The fan watchdog is,
 811 therefore, not suitable to protect against fan mode changes made through
 812 means other than the "enable", "disable", and "level" procfs fan
 813 commands, or the hwmon fan control sysfs interface.
 814
 815 Procfs notes:
 816
 817 The fan may be enabled or disabled with the following commands:
 818
 819         echo enable  >/proc/acpi/ibm/fan
 820         echo disable >/proc/acpi/ibm/fan
 821
 822 Placing a fan on level 0 is the same as disabling it.  Enabling a fan
 823 will try to place it in a safe level if it is too slow or disabled.
 824
 825 The fan level can be controlled with the command:
 826
 827         echo 'level <level>' > /proc/acpi/ibm/fan
 828
 829 Where <level> is an integer from 0 to 7, or one of the words "auto" or
 830 "full-speed" (without the quotes).  Not all ThinkPads support the "auto"
 831 and "full-speed" levels.  The driver accepts "disengaged" as an alias for
 832 "full-speed", and reports it as "disengaged" for backwards
 833 compatibility.
 834
 835 On the X31 and X40 (and ONLY on those models), the fan speed can be
 836 controlled to a certain degree.  Once the fan is running, it can be
 837 forced to run faster or slower with the following command:
 838
 839         echo 'speed <speed>' > /proc/acpi/ibm/fan
 840
 841 The sustainable range of fan speeds on the X40 appears to be from about
 842 3700 to about 7350. Values outside this range either do not have any
 843 effect or the fan speed eventually settles somewhere in that range.  The
 844 fan cannot be stopped or started with this command.  This functionality
 845 is incomplete, and not available through the sysfs interface.
 846
 847 To program the safety watchdog, use the "watchdog" command.
 848
 849         echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
 850
 851 If you want to disable the watchdog, use 0 as the interval.
 852
 853 Sysfs notes:
 854
 855 The sysfs interface follows the hwmon subsystem guidelines for the most
 856 part, and the exception is the fan safety watchdog.
 857
 858 Writes to any of the sysfs attributes may return the EINVAL error if
 859 that operation is not supported in a given ThinkPad or if the parameter
 860 is out-of-bounds, and EPERM if it is forbidden.  They may also return
 861 EINTR (interrupted system call), and EIO (I/O error while trying to talk
 862 to the firmware).
 863
 864 Features not yet implemented by the driver return ENOSYS.
 865
 866 hwmon device attribute pwm1_enable:
 867         0: PWM offline (fan is set to full-speed mode)
 868         1: Manual PWM control (use pwm1 to set fan level)
 869         2: Hardware PWM control (EC "auto" mode)
 870         3: reserved (Software PWM control, not implemented yet)
 871
 872         Modes 0 and 2 are not supported by all ThinkPads, and the
 873         driver is not always able to detect this.  If it does know a
 874         mode is unsupported, it will return -EINVAL.
 875
 876 hwmon device attribute pwm1:
 877         Fan level, scaled from the firmware values of 0-7 to the hwmon
 878         scale of 0-255.  0 means fan stopped, 255 means highest normal
 879         speed (level 7).
 880
 881         This attribute only commands the fan if pmw1_enable is set to 1
 882         (manual PWM control).
 883
 884 hwmon device attribute fan1_input:
 885         Fan tachometer reading, in RPM.  May go stale on certain
 886         ThinkPads while the EC transitions the PWM to offline mode,
 887         which can take up to two minutes.  May return rubbish on older
 888         ThinkPads.
 889
 890 driver attribute fan_watchdog:
 891         Fan safety watchdog timer interval, in seconds.  Minimum is
 892         1 second, maximum is 120 seconds.  0 disables the watchdog.
 893
 894 To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
 895
 896 To start the fan in a safe mode: set pwm1_enable to 2.  If that fails
 897 with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
 898 would be the safest choice, though).
 899
 900
 901 EXPERIMENTAL: WAN
 902 -----------------
 903
 904 procfs: /proc/acpi/ibm/wan
 905 sysfs device attribute: wwan_enable
 906
 907 This feature is marked EXPERIMENTAL because the implementation
 908 directly accesses hardware registers and may not work as expected. USE
 909 WITH CAUTION! To use this feature, you need to supply the
 910 experimental=1 parameter when loading the module.
 911
 912 This feature shows the presence and current state of a W-WAN (Sierra
 913 Wireless EV-DO) device.
 914
 915 It was tested on a Lenovo Thinkpad X60. It should probably work on other
 916 Thinkpad models which come with this module installed.
 917
 918 Procfs notes:
 919
 920 If the W-WAN card is installed, the following commands can be used:
 921
 922         echo enable > /proc/acpi/ibm/wan
 923         echo disable > /proc/acpi/ibm/wan
 924
 925 Sysfs notes:
 926
 927         If the W-WAN card is installed, it can be enabled /
 928         disabled through the "wwan_enable" thinkpad-acpi device
 929         attribute, and its current status can also be queried.
 930
 931         enable:
 932                 0: disables WWAN card / WWAN card is disabled
 933                 1: enables WWAN card / WWAN card is enabled.
 934
 935         Note: this interface will be probably be superseeded by the
 936         generic rfkill class, so it is NOT to be considered stable yet.
 937
 938 Multiple Commands, Module Parameters
 939 ------------------------------------
 940
 941 Multiple commands can be written to the proc files in one shot by
 942 separating them with commas, for example:
 943
 944         echo enable,0xffff > /proc/acpi/ibm/hotkey
 945         echo lcd_disable,crt_enable > /proc/acpi/ibm/video
 946
 947 Commands can also be specified when loading the thinkpad-acpi module,
 948 for example:
 949
 950         modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
 951
 952 Enabling debugging output
 953 -------------------------
 954
 955 The module takes a debug paramater which can be used to selectively
 956 enable various classes of debugging output, for example:
 957
 958          modprobe ibm_acpi debug=0xffff
 959
 960 will enable all debugging output classes.  It takes a bitmask, so
 961 to enable more than one output class, just add their values.
 962
 963         Debug bitmask           Description
 964         0x0001                  Initialization and probing
 965         0x0002                  Removal
 966
 967 There is also a kernel build option to enable more debugging
 968 information, which may be necessary to debug driver problems.
 969
 970 The level of debugging information output by the driver can be changed
 971 at runtime through sysfs, using the driver attribute debug_level.  The
 972 attribute takes the same bitmask as the debug module parameter above.
 973
 974 Force loading of module
 975 -----------------------
 976
 977 If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
 978 the module parameter force_load=1.  Regardless of whether this works or
 979 not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
 980
 981
 982 Sysfs interface changelog:
 983
 984 0x000100:       Initial sysfs support, as a single platform driver and
 985                 device.