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