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