git.oblomov.eu Git - linux-2.6/blob - Documentation/ibm-acpi.txt

   1                     IBM ThinkPad ACPI Extras Driver
   2
   3                             Version 0.12
   4                            17 August 2005
   5
   6                Borislav Deianov <borislav@users.sf.net>
   7                       http://ibm-acpi.sf.net/
   8
   9
  10 This is a Linux ACPI driver for the IBM ThinkPad laptops. It supports
  11 various features of these laptops which are accessible through the
  12 ACPI framework but not otherwise supported by the generic Linux ACPI
  13 drivers.
  14
  15
  16 Status
  17 ------
  18
  19 The features currently supported are the following (see below for
  20 detailed description):
  21
  22         - Fn key combinations
  23         - Bluetooth enable and disable
  24         - video output switching, expansion control
  25         - ThinkLight on and off
  26         - limited docking and undocking
  27         - UltraBay eject
  28         - CMOS control
  29         - LED control
  30         - ACPI sounds
  31         - temperature sensors
  32         - Experimental: embedded controller register dump
  33         - LCD brightness control
  34         - Volume control
  35         - Experimental: fan speed, fan enable/disable
  36         - Experimental: WAN enable and disable
  37
  38 A compatibility table by model and feature is maintained on the web
  39 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
  40 reports, especially if they add to or correct the compatibility table.
  41 Please include the following information in your report:
  42
  43         - ThinkPad model name
  44         - a copy of your DSDT, from /proc/acpi/dsdt
  45         - which driver features work and which don't
  46         - the observed behavior of non-working features
  47
  48 Any other comments or patches are also more than welcome.
  49
  50
  51 Installation
  52 ------------
  53
  54 If you are compiling this driver as included in the Linux kernel
  55 sources, simply enable the CONFIG_ACPI_IBM option (Power Management /
  56 ACPI / IBM ThinkPad Laptop Extras).
  57
  58 Features
  59 --------
  60
  61 The driver creates the /proc/acpi/ibm directory. There is a file under
  62 that directory for each feature described below. Note that while the
  63 driver is still in the alpha stage, the exact proc file format and
  64 commands supported by the various features is guaranteed to change
  65 frequently.
  66
  67 Driver version -- /proc/acpi/ibm/driver
  68 ---------------------------------------
  69
  70 The driver name and version. No commands can be written to this file.
  71
  72 Hot keys -- /proc/acpi/ibm/hotkey
  73 ---------------------------------
  74
  75 Without this driver, only the Fn-F4 key (sleep button) generates an
  76 ACPI event. With the driver loaded, the hotkey feature enabled and the
  77 mask set (see below), the various hot keys generate ACPI events in the
  78 following format:
  79
  80         ibm/hotkey HKEY 00000080 0000xxxx
  81
  82 The last four digits vary depending on the key combination pressed.
  83 All labeled Fn-Fx key combinations generate distinct events. In
  84 addition, the lid microswitch and some docking station buttons may
  85 also generate such events.
  86
  87 The following commands can be written to this file:
  88
  89         echo enable > /proc/acpi/ibm/hotkey -- enable the hot keys feature
  90         echo disable > /proc/acpi/ibm/hotkey -- disable the hot keys feature
  91         echo 0xffff > /proc/acpi/ibm/hotkey -- enable all possible hot keys
  92         echo 0x0000 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
  93         ... any other 4-hex-digit mask ...
  94         echo reset > /proc/acpi/ibm/hotkey -- restore the original mask
  95
  96 The bit mask allows some control over which hot keys generate ACPI
  97 events. Not all bits in the mask can be modified. Not all bits that
  98 can be modified do anything. Not all hot keys can be individually
  99 controlled by the mask. Most recent ThinkPad models honor the
 100 following bits (assuming the hot keys feature has been enabled):
 101
 102         key     bit     behavior when set       behavior when unset
 103
 104         Fn-F3                   always generates ACPI event
 105         Fn-F4                   always generates ACPI event
 106         Fn-F5   0010    generate ACPI event     enable/disable Bluetooth
 107         Fn-F7   0040    generate ACPI event     switch LCD and external display
 108         Fn-F8   0080    generate ACPI event     expand screen or none
 109         Fn-F9   0100    generate ACPI event     none
 110         Fn-F12                  always generates ACPI event
 111
 112 Some models do not support all of the above. For example, the T30 does
 113 not support Fn-F5 and Fn-F9. Other models do not support the mask at
 114 all. On those models, hot keys cannot be controlled individually.
 115
 116 Note that enabling ACPI events for some keys prevents their default
 117 behavior. For example, if events for Fn-F5 are enabled, that key will
 118 no longer enable/disable Bluetooth by itself. This can still be done
 119 from an acpid handler for the ibm/hotkey event.
 120
 121 Note also that not all Fn key combinations are supported through
 122 ACPI. For example, on the X40, the brightness, volume and "Access IBM"
 123 buttons do not generate ACPI events even with this driver. They *can*
 124 be used through the "ThinkPad Buttons" utility, see
 125 http://www.nongnu.org/tpb/
 126
 127 Bluetooth -- /proc/acpi/ibm/bluetooth
 128 -------------------------------------
 129
 130 This feature shows the presence and current state of a Bluetooth
 131 device. If Bluetooth is installed, the following commands can be used:
 132
 133         echo enable > /proc/acpi/ibm/bluetooth
 134         echo disable > /proc/acpi/ibm/bluetooth
 135
 136 Video output control -- /proc/acpi/ibm/video
 137 --------------------------------------------
 138
 139 This feature allows control over the devices used for video output -
 140 LCD, CRT or DVI (if available). The following commands are available:
 141
 142         echo lcd_enable > /proc/acpi/ibm/video
 143         echo lcd_disable > /proc/acpi/ibm/video
 144         echo crt_enable > /proc/acpi/ibm/video
 145         echo crt_disable > /proc/acpi/ibm/video
 146         echo dvi_enable > /proc/acpi/ibm/video
 147         echo dvi_disable > /proc/acpi/ibm/video
 148         echo auto_enable > /proc/acpi/ibm/video
 149         echo auto_disable > /proc/acpi/ibm/video
 150         echo expand_toggle > /proc/acpi/ibm/video
 151         echo video_switch > /proc/acpi/ibm/video
 152
 153 Each video output device can be enabled or disabled individually.
 154 Reading /proc/acpi/ibm/video shows the status of each device.
 155
 156 Automatic video switching can be enabled or disabled.  When automatic
 157 video switching is enabled, certain events (e.g. opening the lid,
 158 docking or undocking) cause the video output device to change
 159 automatically. While this can be useful, it also causes flickering
 160 and, on the X40, video corruption. By disabling automatic switching,
 161 the flickering or video corruption can be avoided.
 162
 163 The video_switch command cycles through the available video outputs
 164 (it simulates the behavior of Fn-F7).
 165
 166 Video expansion can be toggled through this feature. This controls
 167 whether the display is expanded to fill the entire LCD screen when a
 168 mode with less than full resolution is used. Note that the current
 169 video expansion status cannot be determined through this feature.
 170
 171 Note that on many models (particularly those using Radeon graphics
 172 chips) the X driver configures the video card in a way which prevents
 173 Fn-F7 from working. This also disables the video output switching
 174 features of this driver, as it uses the same ACPI methods as
 175 Fn-F7. Video switching on the console should still work.
 176
 177 UPDATE: There's now a patch for the X.org Radeon driver which
 178 addresses this issue. Some people are reporting success with the patch
 179 while others are still having problems. For more information:
 180
 181 https://bugs.freedesktop.org/show_bug.cgi?id=2000
 182
 183 ThinkLight control -- /proc/acpi/ibm/light
 184 ------------------------------------------
 185
 186 The current status of the ThinkLight can be found in this file. A few
 187 models which do not make the status available will show it as
 188 "unknown". The available commands are:
 189
 190         echo on  > /proc/acpi/ibm/light
 191         echo off > /proc/acpi/ibm/light
 192
 193 Docking / undocking -- /proc/acpi/ibm/dock
 194 ------------------------------------------
 195
 196 Docking and undocking (e.g. with the X4 UltraBase) requires some
 197 actions to be taken by the operating system to safely make or break
 198 the electrical connections with the dock.
 199
 200 The docking feature of this driver generates the following ACPI events:
 201
 202         ibm/dock GDCK 00000003 00000001 -- eject request
 203         ibm/dock GDCK 00000003 00000002 -- undocked
 204         ibm/dock GDCK 00000000 00000003 -- docked
 205
 206 NOTE: These events will only be generated if the laptop was docked
 207 when originally booted. This is due to the current lack of support for
 208 hot plugging of devices in the Linux ACPI framework. If the laptop was
 209 booted while not in the dock, the following message is shown in the
 210 logs:
 211
 212         Mar 17 01:42:34 aero kernel: ibm_acpi: dock device not present
 213
 214 In this case, no dock-related events are generated but the dock and
 215 undock commands described below still work. They can be executed
 216 manually or triggered by Fn key combinations (see the example acpid
 217 configuration files included in the driver tarball package available
 218 on the web site).
 219
 220 When the eject request button on the dock is pressed, the first event
 221 above is generated. The handler for this event should issue the
 222 following command:
 223
 224         echo undock > /proc/acpi/ibm/dock
 225
 226 After the LED on the dock goes off, it is safe to eject the laptop.
 227 Note: if you pressed this key by mistake, go ahead and eject the
 228 laptop, then dock it back in. Otherwise, the dock may not function as
 229 expected.
 230
 231 When the laptop is docked, the third event above is generated. The
 232 handler for this event should issue the following command to fully
 233 enable the dock:
 234
 235         echo dock > /proc/acpi/ibm/dock
 236
 237 The contents of the /proc/acpi/ibm/dock file shows the current status
 238 of the dock, as provided by the ACPI framework.
 239
 240 The docking support in this driver does not take care of enabling or
 241 disabling any other devices you may have attached to the dock. For
 242 example, a CD drive plugged into the UltraBase needs to be disabled or
 243 enabled separately. See the provided example acpid configuration files
 244 for how this can be accomplished.
 245
 246 There is no support yet for PCI devices that may be attached to a
 247 docking station, e.g. in the ThinkPad Dock II. The driver currently
 248 does not recognize, enable or disable such devices. This means that
 249 the only docking stations currently supported are the X-series
 250 UltraBase docks and "dumb" port replicators like the Mini Dock (the
 251 latter don't need any ACPI support, actually).
 252
 253 UltraBay eject -- /proc/acpi/ibm/bay
 254 ------------------------------------
 255
 256 Inserting or ejecting an UltraBay device requires some actions to be
 257 taken by the operating system to safely make or break the electrical
 258 connections with the device.
 259
 260 This feature generates the following ACPI events:
 261
 262         ibm/bay MSTR 00000003 00000000 -- eject request
 263         ibm/bay MSTR 00000001 00000000 -- eject lever inserted
 264
 265 NOTE: These events will only be generated if the UltraBay was present
 266 when the laptop was originally booted (on the X series, the UltraBay
 267 is in the dock, so it may not be present if the laptop was undocked).
 268 This is due to the current lack of support for hot plugging of devices
 269 in the Linux ACPI framework. If the laptop was booted without the
 270 UltraBay, the following message is shown in the logs:
 271
 272         Mar 17 01:42:34 aero kernel: ibm_acpi: bay device not present
 273
 274 In this case, no bay-related events are generated but the eject
 275 command described below still works. It can be executed manually or
 276 triggered by a hot key combination.
 277
 278 Sliding the eject lever generates the first event shown above. The
 279 handler for this event should take whatever actions are necessary to
 280 shut down the device in the UltraBay (e.g. call idectl), then issue
 281 the following command:
 282
 283         echo eject > /proc/acpi/ibm/bay
 284
 285 After the LED on the UltraBay goes off, it is safe to pull out the
 286 device.
 287
 288 When the eject lever is inserted, the second event above is
 289 generated. The handler for this event should take whatever actions are
 290 necessary to enable the UltraBay device (e.g. call idectl).
 291
 292 The contents of the /proc/acpi/ibm/bay file shows the current status
 293 of the UltraBay, as provided by the ACPI framework.
 294
 295 EXPERIMENTAL warm eject support on the 600e/x, A22p and A3x (To use
 296 this feature, you need to supply the experimental=1 parameter when
 297 loading the module):
 298
 299 These models do not have a button near the UltraBay device to request
 300 a hot eject but rather require the laptop to be put to sleep
 301 (suspend-to-ram) before the bay device is ejected or inserted).
 302 The sequence of steps to eject the device is as follows:
 303
 304         echo eject > /proc/acpi/ibm/bay
 305         put the ThinkPad to sleep
 306         remove the drive
 307         resume from sleep
 308         cat /proc/acpi/ibm/bay should show that the drive was removed
 309
 310 On the A3x, both the UltraBay 2000 and UltraBay Plus devices are
 311 supported. Use "eject2" instead of "eject" for the second bay.
 312
 313 Note: the UltraBay eject support on the 600e/x, A22p and A3x is
 314 EXPERIMENTAL and may not work as expected. USE WITH CAUTION!
 315
 316 CMOS control -- /proc/acpi/ibm/cmos
 317 -----------------------------------
 318
 319 This feature is used internally by the ACPI firmware to control the
 320 ThinkLight on most newer ThinkPad models. It may also control LCD
 321 brightness, sounds volume and more, but only on some models.
 322
 323 The commands are non-negative integer numbers:
 324
 325         echo 0 >/proc/acpi/ibm/cmos
 326         echo 1 >/proc/acpi/ibm/cmos
 327         echo 2 >/proc/acpi/ibm/cmos
 328         ...
 329
 330 The range of valid numbers is 0 to 21, but not all have an effect and
 331 the behavior varies from model to model. Here is the behavior on the
 332 X40 (tpb is the ThinkPad Buttons utility):
 333
 334         0 - no effect but tpb reports "Volume down"
 335         1 - no effect but tpb reports "Volume up"
 336         2 - no effect but tpb reports "Mute on"
 337         3 - simulate pressing the "Access IBM" button
 338         4 - LCD brightness up
 339         5 - LCD brightness down
 340         11 - toggle screen expansion
 341         12 - ThinkLight on
 342         13 - ThinkLight off
 343         14 - no effect but tpb reports ThinkLight status change
 344
 345 LED control -- /proc/acpi/ibm/led
 346 ---------------------------------
 347
 348 Some of the LED indicators can be controlled through this feature. The
 349 available commands are:
 350
 351         echo '<led number> on' >/proc/acpi/ibm/led
 352         echo '<led number> off' >/proc/acpi/ibm/led
 353         echo '<led number> blink' >/proc/acpi/ibm/led
 354
 355 The <led number> range is 0 to 7. The set of LEDs that can be
 356 controlled varies from model to model. Here is the mapping on the X40:
 357
 358         0 - power
 359         1 - battery (orange)
 360         2 - battery (green)
 361         3 - UltraBase
 362         4 - UltraBay
 363         7 - standby
 364
 365 All of the above can be turned on and off and can be made to blink.
 366
 367 ACPI sounds -- /proc/acpi/ibm/beep
 368 ----------------------------------
 369
 370 The BEEP method is used internally by the ACPI firmware to provide
 371 audible alerts in various situations. This feature allows the same
 372 sounds to be triggered manually.
 373
 374 The commands are non-negative integer numbers:
 375
 376         echo <number> >/proc/acpi/ibm/beep
 377
 378 The valid <number> range is 0 to 17. Not all numbers trigger sounds
 379 and the sounds vary from model to model. Here is the behavior on the
 380 X40:
 381
 382         0 - stop a sound in progress (but use 17 to stop 16)
 383         2 - two beeps, pause, third beep ("low battery")
 384         3 - single beep
 385         4 - high, followed by low-pitched beep ("unable")
 386         5 - single beep
 387         6 - very high, followed by high-pitched beep ("AC/DC")
 388         7 - high-pitched beep
 389         9 - three short beeps
 390         10 - very long beep
 391         12 - low-pitched beep
 392         15 - three high-pitched beeps repeating constantly, stop with 0
 393         16 - one medium-pitched beep repeating constantly, stop with 17
 394         17 - stop 16
 395
 396 Temperature sensors -- /proc/acpi/ibm/thermal
 397 ---------------------------------------------
 398
 399 Most ThinkPads include six or more separate temperature sensors but
 400 only expose the CPU temperature through the standard ACPI methods.
 401 This feature shows readings from up to eight different sensors on older
 402 ThinkPads, and it has experimental support for up to sixteen different
 403 sensors on newer ThinkPads.  Readings from sensors that are not available
 404 return -128.
 405
 406 No commands can be written to this file.
 407
 408 EXPERIMENTAL: The 16-sensors feature is marked EXPERIMENTAL because the
 409 implementation directly accesses hardware registers and may not work as
 410 expected. USE WITH CAUTION! To use this feature, you need to supply the
 411 experimental=1 parameter when loading the module.  When EXPERIMENTAL
 412 mode is enabled, reading the first 8 sensors on newer ThinkPads will
 413 also use an new experimental thermal sensor access mode.
 414
 415 For example, on the X40, a typical output may be:
 416 temperatures:   42 42 45 41 36 -128 33 -128
 417
 418 EXPERIMENTAL: On the T43/p, a typical output may be:
 419 temperatures:   48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
 420
 421 The mapping of thermal sensors to physical locations varies depending on
 422 system-board model (and thus, on ThinkPad model).
 423
 424 http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
 425 tries to track down these locations for various models.
 426
 427 Most (newer?) models seem to follow this pattern:
 428
 429 1:  CPU
 430 2:  (depends on model)
 431 3:  (depends on model)
 432 4:  GPU
 433 5:  Main battery: main sensor
 434 6:  Bay battery: main sensor
 435 7:  Main battery: secondary sensor
 436 8:  Bay battery: secondary sensor
 437 9-15: (depends on model)
 438
 439 For the R51 (source: Thomas Gruber):
 440 2:  Mini-PCI
 441 3:  Internal HDD
 442
 443 For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
 444 http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
 445 2:  System board, left side (near PCMCIA slot), reported as HDAPS temp
 446 3:  PCMCIA slot
 447 9:  MCH (northbridge) to DRAM Bus
 448 10: ICH (southbridge), under Mini-PCI card, under touchpad
 449 11: Power regulator, underside of system board, below F2 key
 450
 451 The A31 has a very atypical layout for the thermal sensors
 452 (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
 453 1:  CPU
 454 2:  Main Battery: main sensor
 455 3:  Power Converter
 456 4:  Bay Battery: main sensor
 457 5:  MCH (northbridge)
 458 6:  PCMCIA/ambient
 459 7:  Main Battery: secondary sensor
 460 8:  Bay Battery: secondary sensor
 461
 462
 463 EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
 464 ------------------------------------------------------------------------
 465
 466 This feature is marked EXPERIMENTAL because the implementation
 467 directly accesses hardware registers and may not work as expected. USE
 468 WITH CAUTION! To use this feature, you need to supply the
 469 experimental=1 parameter when loading the module.
 470
 471 This feature dumps the values of 256 embedded controller
 472 registers. Values which have changed since the last time the registers
 473 were dumped are marked with a star:
 474
 475 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
 476 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
 477 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
 478 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
 479 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
 480 EC 0x30:  01  07  1a  00  30  04  00  00 *85  00  00  10  00  50  00  00
 481 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
 482 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03 *bc *02 *bc
 483 EC 0x60: *02 *bc *02  00  00  00  00  00  00  00  00  00  00  00  00  00
 484 EC 0x70:  00  00  00  00  00  12  30  40 *24 *26 *2c *27 *20  80 *1f  80
 485 EC 0x80:  00  00  00  06 *37 *0e  03  00  00  00  0e  07  00  00  00  00
 486 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 487 EC 0xa0: *ff  09  ff  09  ff  ff *64  00 *00 *00 *a2  41 *ff *ff *e0  00
 488 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 489 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 490 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 491 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
 492 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
 493
 494 This feature can be used to determine the register holding the fan
 495 speed on some models. To do that, do the following:
 496
 497         - make sure the battery is fully charged
 498         - make sure the fan is running
 499         - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
 500
 501 The first step makes sure various charging-related values don't
 502 vary. The second ensures that the fan-related values do vary, since
 503 the fan speed fluctuates a bit. The third will (hopefully) mark the
 504 fan register with a star:
 505
 506 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
 507 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
 508 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
 509 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
 510 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
 511 EC 0x30:  01  07  1a  00  30  04  00  00  85  00  00  10  00  50  00  00
 512 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
 513 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03  bc  02  bc
 514 EC 0x60:  02  bc  02  00  00  00  00  00  00  00  00  00  00  00  00  00
 515 EC 0x70:  00  00  00  00  00  12  30  40  24  27  2c  27  21  80  1f  80
 516 EC 0x80:  00  00  00  06 *be  0d  03  00  00  00  0e  07  00  00  00  00
 517 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 518 EC 0xa0:  ff  09  ff  09  ff  ff  64  00  00  00  a2  41  ff  ff  e0  00
 519 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 520 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 521 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
 522 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
 523 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
 524
 525 Another set of values that varies often is the temperature
 526 readings. Since temperatures don't change vary fast, you can take
 527 several quick dumps to eliminate them.
 528
 529 You can use a similar method to figure out the meaning of other
 530 embedded controller registers - e.g. make sure nothing else changes
 531 except the charging or discharging battery to determine which
 532 registers contain the current battery capacity, etc. If you experiment
 533 with this, do send me your results (including some complete dumps with
 534 a description of the conditions when they were taken.)
 535
 536 LCD brightness control -- /proc/acpi/ibm/brightness
 537 ---------------------------------------------------
 538
 539 This feature allows software control of the LCD brightness on ThinkPad
 540 models which don't have a hardware brightness slider. The available
 541 commands are:
 542
 543         echo up   >/proc/acpi/ibm/brightness
 544         echo down >/proc/acpi/ibm/brightness
 545         echo 'level <level>' >/proc/acpi/ibm/brightness
 546
 547 The <level> number range is 0 to 7, although not all of them may be
 548 distinct. The current brightness level is shown in the file.
 549
 550 Volume control -- /proc/acpi/ibm/volume
 551 ---------------------------------------
 552
 553 This feature allows volume control on ThinkPad models which don't have
 554 a hardware volume knob. The available commands are:
 555
 556         echo up   >/proc/acpi/ibm/volume
 557         echo down >/proc/acpi/ibm/volume
 558         echo mute >/proc/acpi/ibm/volume
 559         echo 'level <level>' >/proc/acpi/ibm/volume
 560
 561 The <level> number range is 0 to 15 although not all of them may be
 562 distinct. The unmute the volume after the mute command, use either the
 563 up or down command (the level command will not unmute the volume).
 564 The current volume level and mute state is shown in the file.
 565
 566 EXPERIMENTAL: fan speed, fan enable/disable -- /proc/acpi/ibm/fan
 567 -----------------------------------------------------------------
 568
 569 This feature is marked EXPERIMENTAL because the implementation
 570 directly accesses hardware registers and may not work as expected. USE
 571 WITH CAUTION! To use this feature, you need to supply the
 572 experimental=1 parameter when loading the module.
 573
 574 This feature attempts to show the current fan speed, control mode and
 575 other fan data that might be available.  The speed is read directly
 576 from the hardware registers of the embedded controller.  This is known
 577 to work on later R, T and X series ThinkPads but may show a bogus
 578 value on other models.
 579
 580 Most ThinkPad fans work in "levels".  Level 0 stops the fan.  The higher
 581 the level, the higher the fan speed, although adjacent levels often map
 582 to the same fan speed.  7 is the highest level, where the fan reaches
 583 the maximum recommended speed.  Level "auto" means the EC changes the
 584 fan level according to some internal algorithm, usually based on
 585 readings from the thermal sensors.  Level "disengaged" means the EC
 586 disables the speed-locked closed-loop fan control, and drives the fan as
 587 fast as it can go, which might exceed hardware limits, so use this level
 588 with caution.
 589
 590 The fan usually ramps up or down slowly from one speed to another,
 591 and it is normal for the EC to take several seconds to react to fan
 592 commands.
 593
 594 The fan may be enabled or disabled with the following commands:
 595
 596         echo enable  >/proc/acpi/ibm/fan
 597         echo disable >/proc/acpi/ibm/fan
 598
 599 Placing a fan on level 0 is the same as disabling it.  Enabling a fan
 600 will try to place it in a safe level if it is too slow or disabled.
 601
 602 WARNING WARNING WARNING: do not leave the fan disabled unless you are
 603 monitoring all of the temperature sensor readings and you are ready to
 604 enable it if necessary to avoid overheating.
 605
 606 An enabled fan in level "auto" may stop spinning if the EC decides the
 607 ThinkPad is cool enough and doesn't need the extra airflow.  This is
 608 normal, and the EC will spin the fan up if the varios thermal readings
 609 rise too much.
 610
 611 On the X40, this seems to depend on the CPU and HDD temperatures.
 612 Specifically, the fan is turned on when either the CPU temperature
 613 climbs to 56 degrees or the HDD temperature climbs to 46 degrees.  The
 614 fan is turned off when the CPU temperature drops to 49 degrees and the
 615 HDD temperature drops to 41 degrees.  These thresholds cannot
 616 currently be controlled.
 617
 618 The fan level can be controlled with the command:
 619
 620         echo 'level <level>' > /proc/acpi/ibm/thermal
 621
 622 Where <level> is an integer from 0 to 7, or one of the words "auto"
 623 or "disengaged" (without the quotes).  Not all ThinkPads support the
 624 "auto" and "disengaged" levels.
 625
 626 On the X31 and X40 (and ONLY on those models), the fan speed can be
 627 controlled to a certain degree. Once the fan is running, it can be
 628 forced to run faster or slower with the following command:
 629
 630         echo 'speed <speed>' > /proc/acpi/ibm/thermal
 631
 632 The sustainable range of fan speeds on the X40 appears to be from
 633 about 3700 to about 7350. Values outside this range either do not have
 634 any effect or the fan speed eventually settles somewhere in that
 635 range. The fan cannot be stopped or started with this command.
 636
 637 The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
 638 certain conditions are met.  It will override any fan programming done
 639 through ibm-acpi.
 640
 641 EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan
 642 ---------------------------------------
 643
 644 This feature is marked EXPERIMENTAL because the implementation
 645 directly accesses hardware registers and may not work as expected. USE
 646 WITH CAUTION! To use this feature, you need to supply the
 647 experimental=1 parameter when loading the module.
 648
 649 This feature shows the presence and current state of a WAN (Sierra
 650 Wireless EV-DO) device. If WAN is installed, the following commands can
 651 be used:
 652
 653         echo enable > /proc/acpi/ibm/wan
 654         echo disable > /proc/acpi/ibm/wan
 655
 656 It was tested on a Lenovo Thinkpad X60. It should probably work on other
 657 Thinkpad models which come with this module installed.
 658
 659 Multiple Commands, Module Parameters
 660 ------------------------------------
 661
 662 Multiple commands can be written to the proc files in one shot by
 663 separating them with commas, for example:
 664
 665         echo enable,0xffff > /proc/acpi/ibm/hotkey
 666         echo lcd_disable,crt_enable > /proc/acpi/ibm/video
 667
 668 Commands can also be specified when loading the ibm_acpi module, for
 669 example:
 670
 671         modprobe ibm_acpi hotkey=enable,0xffff video=auto_disable
 672
 673 The ibm-acpi kernel driver can be programmed to revert the fan level
 674 to a safe setting if userspace does not issue one of the fan commands:
 675 "enable", "disable", "level" or "watchdog" within a configurable
 676 ammount of time.  To do this, use the "watchdog" command.
 677
 678         echo 'watchdog <interval>' > /proc/acpi/ibm/fan
 679
 680 Interval is the ammount of time in seconds to wait for one of the
 681 above mentioned fan commands before reseting the fan level to a safe
 682 one.  If set to zero, the watchdog is disabled (default).  When the
 683 watchdog timer runs out, it does the exact equivalent of the "enable"
 684 fan command.
 685
 686 Note that the watchdog timer stops after it enables the fan.  It will
 687 be rearmed again automatically (using the same interval) when one of
 688 the above mentioned fan commands is received.  The fan watchdog is,
 689 therefore, not suitable to protect against fan mode changes made
 690 through means other than the "enable", "disable", and "level" fan
 691 commands.
 692
 693
 694 Example Configuration
 695 ---------------------
 696
 697 The ACPI support in the kernel is intended to be used in conjunction
 698 with a user-space daemon, acpid. The configuration files for this
 699 daemon control what actions are taken in response to various ACPI
 700 events. An example set of configuration files are included in the
 701 config/ directory of the tarball package available on the web
 702 site. Note that these are provided for illustration purposes only and
 703 may need to be adapted to your particular setup.
 704
 705 The following utility scripts are used by the example action
 706 scripts (included with ibm-acpi for completeness):
 707
 708         /usr/local/sbin/idectl -- from the hdparm source distribution,
 709                 see http://www.ibiblio.org/pub/Linux/system/hardware
 710         /usr/local/sbin/laptop_mode -- from the Linux kernel source
 711                 distribution, see Documentation/laptop-mode.txt
 712         /sbin/service -- comes with Redhat/Fedora distributions
 713         /usr/sbin/hibernate -- from the Software Suspend 2 distribution,
 714                 see http://softwaresuspend.berlios.de/
 715
 716 Toan T Nguyen <ntt@physics.ucla.edu> notes that Suse uses the
 717 powersave program to suspend ('powersave --suspend-to-ram') or
 718 hibernate ('powersave --suspend-to-disk'). This means that the
 719 hibernate script is not needed on that distribution.
 720
 721 Henrik Brix Andersen <brix@gentoo.org> has written a Gentoo ACPI event
 722 handler script for the X31. You can get the latest version from
 723 http://dev.gentoo.org/~brix/files/x31.sh
 724
 725 David Schweikert <dws@ee.eth.ch> has written an alternative blank.sh
 726 script which works on Debian systems. This scripts has now been
 727 extended to also work on Fedora systems and included as the default
 728 blank.sh in the distribution.