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