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