thinkpad-acpi: disable volume control
[linux-2.6.git] / Documentation / laptops / thinkpad-acpi.txt
1                      ThinkPad ACPI Extras Driver
2
3                             Version 0.23
4                           April 10th, 2009
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.  It was moved to drivers/platform/x86 for
20 kernel 2.6.29 and release 0.22.
21
22 The driver is named "thinkpad-acpi".  In some places, like module
23 names and log messages, "thinkpad_acpi" is used because of userspace
24 issues.
25
26 "tpacpi" is used as a shorthand where "thinkpad-acpi" would be too
27 long due to length limitations on some Linux kernel versions.
28
29 Status
30 ------
31
32 The features currently supported are the following (see below for
33 detailed description):
34
35         - Fn key combinations
36         - Bluetooth enable and disable
37         - video output switching, expansion control
38         - ThinkLight on and off
39         - CMOS/UCMS control
40         - LED control
41         - ACPI sounds
42         - temperature sensors
43         - Experimental: embedded controller register dump
44         - LCD brightness control
45         - Volume control
46         - Fan control and monitoring: fan speed, fan enable/disable
47         - WAN enable and disable
48         - UWB enable and disable
49
50 A compatibility table by model and feature is maintained on the web
51 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
52 reports, especially if they add to or correct the compatibility table.
53 Please include the following information in your report:
54
55         - ThinkPad model name
56         - a copy of your ACPI tables, using the "acpidump" utility
57         - a copy of the output of dmidecode, with serial numbers
58           and UUIDs masked off
59         - which driver features work and which don't
60         - the observed behavior of non-working features
61
62 Any other comments or patches are also more than welcome.
63
64
65 Installation
66 ------------
67
68 If you are compiling this driver as included in the Linux kernel
69 sources, look for the CONFIG_THINKPAD_ACPI Kconfig option.
70 It is located on the menu path: "Device Drivers" -> "X86 Platform
71 Specific Device Drivers" -> "ThinkPad ACPI Laptop Extras".
72
73
74 Features
75 --------
76
77 The driver exports two different interfaces to userspace, which can be
78 used to access the features it provides.  One is a legacy procfs-based
79 interface, which will be removed at some time in the future.  The other
80 is a new sysfs-based interface which is not complete yet.
81
82 The procfs interface creates the /proc/acpi/ibm directory.  There is a
83 file under that directory for each feature it supports.  The procfs
84 interface is mostly frozen, and will change very little if at all: it
85 will not be extended to add any new functionality in the driver, instead
86 all new functionality will be implemented on the sysfs interface.
87
88 The sysfs interface tries to blend in the generic Linux sysfs subsystems
89 and classes as much as possible.  Since some of these subsystems are not
90 yet ready or stabilized, it is expected that this interface will change,
91 and any and all userspace programs must deal with it.
92
93
94 Notes about the sysfs interface:
95
96 Unlike what was done with the procfs interface, correctness when talking
97 to the sysfs interfaces will be enforced, as will correctness in the
98 thinkpad-acpi's implementation of sysfs interfaces.
99
100 Also, any bugs in the thinkpad-acpi sysfs driver code or in the
101 thinkpad-acpi's implementation of the sysfs interfaces will be fixed for
102 maximum correctness, even if that means changing an interface in
103 non-compatible ways.  As these interfaces mature both in the kernel and
104 in thinkpad-acpi, such changes should become quite rare.
105
106 Applications interfacing to the thinkpad-acpi sysfs interfaces must
107 follow all sysfs guidelines and correctly process all errors (the sysfs
108 interface makes extensive use of errors).  File descriptors and open /
109 close operations to the sysfs inodes must also be properly implemented.
110
111 The version of thinkpad-acpi's sysfs interface is exported by the driver
112 as a driver attribute (see below).
113
114 Sysfs driver attributes are on the driver's sysfs attribute space,
115 for 2.6.23+ this is /sys/bus/platform/drivers/thinkpad_acpi/ and
116 /sys/bus/platform/drivers/thinkpad_hwmon/
117
118 Sysfs device attributes are on the thinkpad_acpi device sysfs attribute
119 space, for 2.6.23+ this is /sys/devices/platform/thinkpad_acpi/.
120
121 Sysfs device attributes for the sensors and fan are on the
122 thinkpad_hwmon device's sysfs attribute space, but you should locate it
123 looking for a hwmon device with the name attribute of "thinkpad", or
124 better yet, through libsensors.
125
126
127 Driver version
128 --------------
129
130 procfs: /proc/acpi/ibm/driver
131 sysfs driver attribute: version
132
133 The driver name and version. No commands can be written to this file.
134
135
136 Sysfs interface version
137 -----------------------
138
139 sysfs driver attribute: interface_version
140
141 Version of the thinkpad-acpi sysfs interface, as an unsigned long
142 (output in hex format: 0xAAAABBCC), where:
143         AAAA - major revision
144         BB - minor revision
145         CC - bugfix revision
146
147 The sysfs interface version changelog for the driver can be found at the
148 end of this document.  Changes to the sysfs interface done by the kernel
149 subsystems are not documented here, nor are they tracked by this
150 attribute.
151
152 Changes to the thinkpad-acpi sysfs interface are only considered
153 non-experimental when they are submitted to Linux mainline, at which
154 point the changes in this interface are documented and interface_version
155 may be updated.  If you are using any thinkpad-acpi features not yet
156 sent to mainline for merging, you do so on your own risk: these features
157 may disappear, or be implemented in a different and incompatible way by
158 the time they are merged in Linux mainline.
159
160 Changes that are backwards-compatible by nature (e.g. the addition of
161 attributes that do not change the way the other attributes work) do not
162 always warrant an update of interface_version.  Therefore, one must
163 expect that an attribute might not be there, and deal with it properly
164 (an attribute not being there *is* a valid way to make it clear that a
165 feature is not available in sysfs).
166
167
168 Hot keys
169 --------
170
171 procfs: /proc/acpi/ibm/hotkey
172 sysfs device attribute: hotkey_*
173
174 In a ThinkPad, the ACPI HKEY handler is responsible for communicating
175 some important events and also keyboard hot key presses to the operating
176 system.  Enabling the hotkey functionality of thinkpad-acpi signals the
177 firmware that such a driver is present, and modifies how the ThinkPad
178 firmware will behave in many situations.
179
180 The driver enables the HKEY ("hot key") event reporting automatically
181 when loaded, and disables it when it is removed.
182
183 The driver will report HKEY events in the following format:
184
185         ibm/hotkey HKEY 00000080 0000xxxx
186
187 Some of these events refer to hot key presses, but not all of them.
188
189 The driver will generate events over the input layer for hot keys and
190 radio switches, and over the ACPI netlink layer for other events.  The
191 input layer support accepts the standard IOCTLs to remap the keycodes
192 assigned to each hot key.
193
194 The hot key bit mask allows some control over which hot keys generate
195 events.  If a key is "masked" (bit set to 0 in the mask), the firmware
196 will handle it.  If it is "unmasked", it signals the firmware that
197 thinkpad-acpi would prefer to handle it, if the firmware would be so
198 kind to allow it (and it often doesn't!).
199
200 Not all bits in the mask can be modified.  Not all bits that can be
201 modified do anything.  Not all hot keys can be individually controlled
202 by the mask.  Some models do not support the mask at all.  The behaviour
203 of the mask is, therefore, highly dependent on the ThinkPad model.
204
205 The driver will filter out any unmasked hotkeys, so even if the firmware
206 doesn't allow disabling an specific hotkey, the driver will not report
207 events for unmasked hotkeys.
208
209 Note that unmasking some keys prevents their default behavior.  For
210 example, if Fn+F5 is unmasked, that key will no longer enable/disable
211 Bluetooth by itself in firmware.
212
213 Note also that not all Fn key combinations are supported through ACPI
214 depending on the ThinkPad model and firmware version.  On those
215 ThinkPads, it is still possible to support some extra hotkeys by
216 polling the "CMOS NVRAM" at least 10 times per second.  The driver
217 attempts to enables this functionality automatically when required.
218
219 procfs notes:
220
221 The following commands can be written to the /proc/acpi/ibm/hotkey file:
222
223         echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
224         echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
225         ... any other 8-hex-digit mask ...
226         echo reset > /proc/acpi/ibm/hotkey -- restore the recommended mask
227
228 The following commands have been deprecated and will cause the kernel
229 to log a warning:
230
231         echo enable > /proc/acpi/ibm/hotkey -- does nothing
232         echo disable > /proc/acpi/ibm/hotkey -- returns an error
233
234 The procfs interface does not support NVRAM polling control.  So as to
235 maintain maximum bug-to-bug compatibility, it does not report any masks,
236 nor does it allow one to manipulate the hot key mask when the firmware
237 does not support masks at all, even if NVRAM polling is in use.
238
239 sysfs notes:
240
241         hotkey_bios_enabled:
242                 DEPRECATED, WILL BE REMOVED SOON.
243
244                 Returns 0.
245
246         hotkey_bios_mask:
247                 DEPRECATED, DON'T USE, WILL BE REMOVED IN THE FUTURE.
248
249                 Returns the hot keys mask when thinkpad-acpi was loaded.
250                 Upon module unload, the hot keys mask will be restored
251                 to this value.   This is always 0x80c, because those are
252                 the hotkeys that were supported by ancient firmware
253                 without mask support.
254
255         hotkey_enable:
256                 DEPRECATED, WILL BE REMOVED SOON.
257
258                 0: returns -EPERM
259                 1: does nothing
260
261         hotkey_mask:
262                 bit mask to enable reporting (and depending on
263                 the firmware, ACPI event generation) for each hot key
264                 (see above).  Returns the current status of the hot keys
265                 mask, and allows one to modify it.
266
267         hotkey_all_mask:
268                 bit mask that should enable event reporting for all
269                 supported hot keys, when echoed to hotkey_mask above.
270                 Unless you know which events need to be handled
271                 passively (because the firmware *will* handle them
272                 anyway), do *not* use hotkey_all_mask.  Use
273                 hotkey_recommended_mask, instead. You have been warned.
274
275         hotkey_recommended_mask:
276                 bit mask that should enable event reporting for all
277                 supported hot keys, except those which are always
278                 handled by the firmware anyway.  Echo it to
279                 hotkey_mask above, to use.  This is the default mask
280                 used by the driver.
281
282         hotkey_source_mask:
283                 bit mask that selects which hot keys will the driver
284                 poll the NVRAM for.  This is auto-detected by the driver
285                 based on the capabilities reported by the ACPI firmware,
286                 but it can be overridden at runtime.
287
288                 Hot keys whose bits are set in hotkey_source_mask are
289                 polled for in NVRAM, and reported as hotkey events if
290                 enabled in hotkey_mask.  Only a few hot keys are
291                 available through CMOS NVRAM polling.
292
293                 Warning: when in NVRAM mode, the volume up/down/mute
294                 keys are synthesized according to changes in the mixer,
295                 so you have to use volume up or volume down to unmute,
296                 as per the ThinkPad volume mixer user interface.  When
297                 in ACPI event mode, volume up/down/mute are reported as
298                 separate events, but this behaviour may be corrected in
299                 future releases of this driver, in which case the
300                 ThinkPad volume mixer user interface semantics will be
301                 enforced.
302
303         hotkey_poll_freq:
304                 frequency in Hz for hot key polling. It must be between
305                 0 and 25 Hz.  Polling is only carried out when strictly
306                 needed.
307
308                 Setting hotkey_poll_freq to zero disables polling, and
309                 will cause hot key presses that require NVRAM polling
310                 to never be reported.
311
312                 Setting hotkey_poll_freq too low will cause repeated
313                 pressings of the same hot key to be misreported as a
314                 single key press, or to not even be detected at all.
315                 The recommended polling frequency is 10Hz.
316
317         hotkey_radio_sw:
318                 If the ThinkPad has a hardware radio switch, this
319                 attribute will read 0 if the switch is in the "radios
320                 disabled" position, and 1 if the switch is in the
321                 "radios enabled" position.
322
323                 This attribute has poll()/select() support.
324
325         hotkey_tablet_mode:
326                 If the ThinkPad has tablet capabilities, this attribute
327                 will read 0 if the ThinkPad is in normal mode, and
328                 1 if the ThinkPad is in tablet mode.
329
330                 This attribute has poll()/select() support.
331
332         hotkey_report_mode:
333                 Returns the state of the procfs ACPI event report mode
334                 filter for hot keys.  If it is set to 1 (the default),
335                 all hot key presses are reported both through the input
336                 layer and also as ACPI events through procfs (but not
337                 through netlink).  If it is set to 2, hot key presses
338                 are reported only through the input layer.
339
340                 This attribute is read-only in kernels 2.6.23 or later,
341                 and read-write on earlier kernels.
342
343                 May return -EPERM (write access locked out by module
344                 parameter) or -EACCES (read-only).
345
346         wakeup_reason:
347                 Set to 1 if the system is waking up because the user
348                 requested a bay ejection.  Set to 2 if the system is
349                 waking up because the user requested the system to
350                 undock.  Set to zero for normal wake-ups or wake-ups
351                 due to unknown reasons.
352
353                 This attribute has poll()/select() support.
354
355         wakeup_hotunplug_complete:
356                 Set to 1 if the system was waken up because of an
357                 undock or bay ejection request, and that request
358                 was successfully completed.  At this point, it might
359                 be useful to send the system back to sleep, at the
360                 user's choice.  Refer to HKEY events 0x4003 and
361                 0x3003, below.
362
363                 This attribute has poll()/select() support.
364
365 input layer notes:
366
367 A Hot key is mapped to a single input layer EV_KEY event, possibly
368 followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
369 code.  An EV_SYN event will always be generated to mark the end of the
370 event block.
371
372 Do not use the EV_MSC MSC_SCAN events to process keys.  They are to be
373 used as a helper to remap keys, only.  They are particularly useful when
374 remapping KEY_UNKNOWN keys.
375
376 The events are available in an input device, with the following id:
377
378         Bus:            BUS_HOST
379         vendor:         0x1014 (PCI_VENDOR_ID_IBM)  or
380                         0x17aa (PCI_VENDOR_ID_LENOVO)
381         product:        0x5054 ("TP")
382         version:        0x4101
383
384 The version will have its LSB incremented if the keymap changes in a
385 backwards-compatible way.  The MSB shall always be 0x41 for this input
386 device.  If the MSB is not 0x41, do not use the device as described in
387 this section, as it is either something else (e.g. another input device
388 exported by a thinkpad driver, such as HDAPS) or its functionality has
389 been changed in a non-backwards compatible way.
390
391 Adding other event types for other functionalities shall be considered a
392 backwards-compatible change for this input device.
393
394 Thinkpad-acpi Hot Key event map (version 0x4101):
395
396 ACPI    Scan
397 event   code    Key             Notes
398
399 0x1001  0x00    FN+F1           -
400 0x1002  0x01    FN+F2           IBM: battery (rare)
401                                 Lenovo: Screen lock
402
403 0x1003  0x02    FN+F3           Many IBM models always report
404                                 this hot key, even with hot keys
405                                 disabled or with Fn+F3 masked
406                                 off
407                                 IBM: screen lock
408                                 Lenovo: battery
409
410 0x1004  0x03    FN+F4           Sleep button (ACPI sleep button
411                                 semantics, i.e. sleep-to-RAM).
412                                 It is always generate some kind
413                                 of event, either the hot key
414                                 event or a ACPI sleep button
415                                 event. The firmware may
416                                 refuse to generate further FN+F4
417                                 key presses until a S3 or S4 ACPI
418                                 sleep cycle is performed or some
419                                 time passes.
420
421 0x1005  0x04    FN+F5           Radio.  Enables/disables
422                                 the internal Bluetooth hardware
423                                 and W-WAN card if left in control
424                                 of the firmware.  Does not affect
425                                 the WLAN card.
426                                 Should be used to turn on/off all
427                                 radios (Bluetooth+W-WAN+WLAN),
428                                 really.
429
430 0x1006  0x05    FN+F6           -
431
432 0x1007  0x06    FN+F7           Video output cycle.
433                                 Do you feel lucky today?
434
435 0x1008  0x07    FN+F8           IBM: toggle screen expand
436                                 Lenovo: configure UltraNav
437
438 0x1009  0x08    FN+F9           -
439         ..      ..              ..
440 0x100B  0x0A    FN+F11          -
441
442 0x100C  0x0B    FN+F12          Sleep to disk.  You are always
443                                 supposed to handle it yourself,
444                                 either through the ACPI event,
445                                 or through a hotkey event.
446                                 The firmware may refuse to
447                                 generate further FN+F4 key
448                                 press events until a S3 or S4
449                                 ACPI sleep cycle is performed,
450                                 or some time passes.
451
452 0x100D  0x0C    FN+BACKSPACE    -
453 0x100E  0x0D    FN+INSERT       -
454 0x100F  0x0E    FN+DELETE       -
455
456 0x1010  0x0F    FN+HOME         Brightness up.  This key is
457                                 always handled by the firmware
458                                 in IBM ThinkPads, even when
459                                 unmasked.  Just leave it alone.
460                                 For Lenovo ThinkPads with a new
461                                 BIOS, it has to be handled either
462                                 by the ACPI OSI, or by userspace.
463                                 The driver does the right thing,
464                                 never mess with this.
465 0x1011  0x10    FN+END          Brightness down.  See brightness
466                                 up for details.
467
468 0x1012  0x11    FN+PGUP         ThinkLight toggle.  This key is
469                                 always handled by the firmware,
470                                 even when unmasked.
471
472 0x1013  0x12    FN+PGDOWN       -
473
474 0x1014  0x13    FN+SPACE        Zoom key
475
476 0x1015  0x14    VOLUME UP       Internal mixer volume up. This
477                                 key is always handled by the
478                                 firmware, even when unmasked.
479                                 NOTE: Lenovo seems to be changing
480                                 this.
481 0x1016  0x15    VOLUME DOWN     Internal mixer volume up. This
482                                 key is always handled by the
483                                 firmware, even when unmasked.
484                                 NOTE: Lenovo seems to be changing
485                                 this.
486 0x1017  0x16    MUTE            Mute internal mixer. This
487                                 key is always handled by the
488                                 firmware, even when unmasked.
489
490 0x1018  0x17    THINKPAD        ThinkPad/Access IBM/Lenovo key
491
492 0x1019  0x18    unknown
493 ..      ..      ..
494 0x1020  0x1F    unknown
495
496 The ThinkPad firmware does not allow one to differentiate when most hot
497 keys are pressed or released (either that, or we don't know how to, yet).
498 For these keys, the driver generates a set of events for a key press and
499 immediately issues the same set of events for a key release.  It is
500 unknown by the driver if the ThinkPad firmware triggered these events on
501 hot key press or release, but the firmware will do it for either one, not
502 both.
503
504 If a key is mapped to KEY_RESERVED, it generates no input events at all.
505 If a key is mapped to KEY_UNKNOWN, it generates an input event that
506 includes an scan code.  If a key is mapped to anything else, it will
507 generate input device EV_KEY events.
508
509 In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
510 events for switches:
511
512 SW_RFKILL_ALL   T60 and later hardware rfkill rocker switch
513 SW_TABLET_MODE  Tablet ThinkPads HKEY events 0x5009 and 0x500A
514
515 Non hot-key ACPI HKEY event map:
516 0x5001          Lid closed
517 0x5002          Lid opened
518 0x5009          Tablet swivel: switched to tablet mode
519 0x500A          Tablet swivel: switched to normal mode
520 0x7000          Radio Switch may have changed state
521
522 The above events are not propagated by the driver, except for legacy
523 compatibility purposes when hotkey_report_mode is set to 1.
524
525 0x2304          System is waking up from suspend to undock
526 0x2305          System is waking up from suspend to eject bay
527 0x2404          System is waking up from hibernation to undock
528 0x2405          System is waking up from hibernation to eject bay
529 0x5010          Brightness level changed/control event
530
531 The above events are never propagated by the driver.
532
533 0x3003          Bay ejection (see 0x2x05) complete, can sleep again
534 0x4003          Undocked (see 0x2x04), can sleep again
535 0x500B          Tablet pen inserted into its storage bay
536 0x500C          Tablet pen removed from its storage bay
537
538 The above events are propagated by the driver.
539
540 Compatibility notes:
541
542 ibm-acpi and thinkpad-acpi 0.15 (mainline kernels before 2.6.23) never
543 supported the input layer, and sent events over the procfs ACPI event
544 interface.
545
546 To avoid sending duplicate events over the input layer and the ACPI
547 event interface, thinkpad-acpi 0.16 implements a module parameter
548 (hotkey_report_mode), and also a sysfs device attribute with the same
549 name.
550
551 Make no mistake here: userspace is expected to switch to using the input
552 layer interface of thinkpad-acpi, together with the ACPI netlink event
553 interface in kernels 2.6.23 and later, or with the ACPI procfs event
554 interface in kernels 2.6.22 and earlier.
555
556 If no hotkey_report_mode module parameter is specified (or it is set to
557 zero), the driver defaults to mode 1 (see below), and on kernels 2.6.22
558 and earlier, also allows one to change the hotkey_report_mode through
559 sysfs.  In kernels 2.6.23 and later, where the netlink ACPI event
560 interface is available, hotkey_report_mode cannot be changed through
561 sysfs (it is read-only).
562
563 If the hotkey_report_mode module parameter is set to 1 or 2, it cannot
564 be changed later through sysfs (any writes will return -EPERM to signal
565 that hotkey_report_mode was locked.  On 2.6.23 and later, where
566 hotkey_report_mode cannot be changed at all, writes will return -EACCES).
567
568 hotkey_report_mode set to 1 makes the driver export through the procfs
569 ACPI event interface all hot key presses (which are *also* sent to the
570 input layer).  This is a legacy compatibility behaviour, and it is also
571 the default mode of operation for the driver.
572
573 hotkey_report_mode set to 2 makes the driver filter out the hot key
574 presses from the procfs ACPI event interface, so these events will only
575 be sent through the input layer.  Userspace that has been updated to use
576 the thinkpad-acpi input layer interface should set hotkey_report_mode to
577 2.
578
579 Hot key press events are never sent to the ACPI netlink event interface.
580 Really up-to-date userspace under kernel 2.6.23 and later is to use the
581 netlink interface and the input layer interface, and don't bother at all
582 with hotkey_report_mode.
583
584
585 Brightness hotkey notes:
586
587 Don't mess with the brightness hotkeys in a Thinkpad.  If you want
588 notifications for OSD, use the sysfs backlight class event support.
589
590 The driver will issue KEY_BRIGHTNESS_UP and KEY_BRIGHTNESS_DOWN events
591 automatically for the cases were userspace has to do something to
592 implement brightness changes.  When you override these events, you will
593 either fail to handle properly the ThinkPads that require explicit
594 action to change backlight brightness, or the ThinkPads that require
595 that no action be taken to work properly.
596
597
598 Bluetooth
599 ---------
600
601 procfs: /proc/acpi/ibm/bluetooth
602 sysfs device attribute: bluetooth_enable (deprecated)
603 sysfs rfkill class: switch "tpacpi_bluetooth_sw"
604
605 This feature shows the presence and current state of a ThinkPad
606 Bluetooth device in the internal ThinkPad CDC slot.
607
608 If the ThinkPad supports it, the Bluetooth state is stored in NVRAM,
609 so it is kept across reboots and power-off.
610
611 Procfs notes:
612
613 If Bluetooth is installed, the following commands can be used:
614
615         echo enable > /proc/acpi/ibm/bluetooth
616         echo disable > /proc/acpi/ibm/bluetooth
617
618 Sysfs notes:
619
620         If the Bluetooth CDC card is installed, it can be enabled /
621         disabled through the "bluetooth_enable" thinkpad-acpi device
622         attribute, and its current status can also be queried.
623
624         enable:
625                 0: disables Bluetooth / Bluetooth is disabled
626                 1: enables Bluetooth / Bluetooth is enabled.
627
628         Note: this interface has been superseded by the generic rfkill
629         class.  It has been deprecated, and it will be removed in year
630         2010.
631
632         rfkill controller switch "tpacpi_bluetooth_sw": refer to
633         Documentation/rfkill.txt for details.
634
635
636 Video output control -- /proc/acpi/ibm/video
637 --------------------------------------------
638
639 This feature allows control over the devices used for video output -
640 LCD, CRT or DVI (if available). The following commands are available:
641
642         echo lcd_enable > /proc/acpi/ibm/video
643         echo lcd_disable > /proc/acpi/ibm/video
644         echo crt_enable > /proc/acpi/ibm/video
645         echo crt_disable > /proc/acpi/ibm/video
646         echo dvi_enable > /proc/acpi/ibm/video
647         echo dvi_disable > /proc/acpi/ibm/video
648         echo auto_enable > /proc/acpi/ibm/video
649         echo auto_disable > /proc/acpi/ibm/video
650         echo expand_toggle > /proc/acpi/ibm/video
651         echo video_switch > /proc/acpi/ibm/video
652
653 Each video output device can be enabled or disabled individually.
654 Reading /proc/acpi/ibm/video shows the status of each device.
655
656 Automatic video switching can be enabled or disabled.  When automatic
657 video switching is enabled, certain events (e.g. opening the lid,
658 docking or undocking) cause the video output device to change
659 automatically. While this can be useful, it also causes flickering
660 and, on the X40, video corruption. By disabling automatic switching,
661 the flickering or video corruption can be avoided.
662
663 The video_switch command cycles through the available video outputs
664 (it simulates the behavior of Fn-F7).
665
666 Video expansion can be toggled through this feature. This controls
667 whether the display is expanded to fill the entire LCD screen when a
668 mode with less than full resolution is used. Note that the current
669 video expansion status cannot be determined through this feature.
670
671 Note that on many models (particularly those using Radeon graphics
672 chips) the X driver configures the video card in a way which prevents
673 Fn-F7 from working. This also disables the video output switching
674 features of this driver, as it uses the same ACPI methods as
675 Fn-F7. Video switching on the console should still work.
676
677 UPDATE: refer to https://bugs.freedesktop.org/show_bug.cgi?id=2000
678
679
680 ThinkLight control
681 ------------------
682
683 procfs: /proc/acpi/ibm/light
684 sysfs attributes: as per LED class, for the "tpacpi::thinklight" LED
685
686 procfs notes:
687
688 The ThinkLight status can be read and set through the procfs interface.  A
689 few models which do not make the status available will show the ThinkLight
690 status as "unknown". The available commands are:
691
692         echo on  > /proc/acpi/ibm/light
693         echo off > /proc/acpi/ibm/light
694
695 sysfs notes:
696
697 The ThinkLight sysfs interface is documented by the LED class
698 documentation, in Documentation/leds-class.txt.  The ThinkLight LED name
699 is "tpacpi::thinklight".
700
701 Due to limitations in the sysfs LED class, if the status of the ThinkLight
702 cannot be read or if it is unknown, thinkpad-acpi will report it as "off".
703 It is impossible to know if the status returned through sysfs is valid.
704
705
706 CMOS/UCMS control
707 -----------------
708
709 procfs: /proc/acpi/ibm/cmos
710 sysfs device attribute: cmos_command
711
712 This feature is mostly used internally by the ACPI firmware to keep the legacy
713 CMOS NVRAM bits in sync with the current machine state, and to record this
714 state so that the ThinkPad will retain such settings across reboots.
715
716 Some of these commands actually perform actions in some ThinkPad models, but
717 this is expected to disappear more and more in newer models.  As an example, in
718 a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
719 real, but commands 0 to 2 don't control the mixer anymore (they have been
720 phased out) and just update the NVRAM.
721
722 The range of valid cmos command numbers is 0 to 21, but not all have an
723 effect and the behavior varies from model to model.  Here is the behavior
724 on the X40 (tpb is the ThinkPad Buttons utility):
725
726         0 - Related to "Volume down" key press
727         1 - Related to "Volume up" key press
728         2 - Related to "Mute on" key press
729         3 - Related to "Access IBM" key press
730         4 - Related to "LCD brightness up" key press
731         5 - Related to "LCD brightness down" key press
732         11 - Related to "toggle screen expansion" key press/function
733         12 - Related to "ThinkLight on"
734         13 - Related to "ThinkLight off"
735         14 - Related to "ThinkLight" key press (toggle ThinkLight)
736
737 The cmos command interface is prone to firmware split-brain problems, as
738 in newer ThinkPads it is just a compatibility layer.  Do not use it, it is
739 exported just as a debug tool.
740
741
742 LED control
743 -----------
744
745 procfs: /proc/acpi/ibm/led
746 sysfs attributes: as per LED class, see below for names
747
748 Some of the LED indicators can be controlled through this feature.  On
749 some older ThinkPad models, it is possible to query the status of the
750 LED indicators as well.  Newer ThinkPads cannot query the real status
751 of the LED indicators.
752
753 Because misuse of the LEDs could induce an unaware user to perform
754 dangerous actions (like undocking or ejecting a bay device while the
755 buses are still active), or mask an important alarm (such as a nearly
756 empty battery, or a broken battery), access to most LEDs is
757 restricted.
758
759 Unrestricted access to all LEDs requires that thinkpad-acpi be
760 compiled with the CONFIG_THINKPAD_ACPI_UNSAFE_LEDS option enabled.
761 Distributions must never enable this option.  Individual users that
762 are aware of the consequences are welcome to enabling it.
763
764 procfs notes:
765
766 The available commands are:
767
768         echo '<LED number> on' >/proc/acpi/ibm/led
769         echo '<LED number> off' >/proc/acpi/ibm/led
770         echo '<LED number> blink' >/proc/acpi/ibm/led
771
772 The <LED number> range is 0 to 15. The set of LEDs that can be
773 controlled varies from model to model. Here is the common ThinkPad
774 mapping:
775
776         0 - power
777         1 - battery (orange)
778         2 - battery (green)
779         3 - UltraBase/dock
780         4 - UltraBay
781         5 - UltraBase battery slot
782         6 - (unknown)
783         7 - standby
784         8 - dock status 1
785         9 - dock status 2
786         10, 11 - (unknown)
787         12 - thinkvantage
788         13, 14, 15 - (unknown)
789
790 All of the above can be turned on and off and can be made to blink.
791
792 sysfs notes:
793
794 The ThinkPad LED sysfs interface is described in detail by the LED class
795 documentation, in Documentation/leds-class.txt.
796
797 The LEDs are named (in LED ID order, from 0 to 12):
798 "tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt",
799 "tpacpi::dock_active", "tpacpi::bay_active", "tpacpi::dock_batt",
800 "tpacpi::unknown_led", "tpacpi::standby", "tpacpi::dock_status1",
801 "tpacpi::dock_status2", "tpacpi::unknown_led2", "tpacpi::unknown_led3",
802 "tpacpi::thinkvantage".
803
804 Due to limitations in the sysfs LED class, if the status of the LED
805 indicators cannot be read due to an error, thinkpad-acpi will report it as
806 a brightness of zero (same as LED off).
807
808 If the thinkpad firmware doesn't support reading the current status,
809 trying to read the current LED brightness will just return whatever
810 brightness was last written to that attribute.
811
812 These LEDs can blink using hardware acceleration.  To request that a
813 ThinkPad indicator LED should blink in hardware accelerated mode, use the
814 "timer" trigger, and leave the delay_on and delay_off parameters set to
815 zero (to request hardware acceleration autodetection).
816
817 LEDs that are known not to exist in a given ThinkPad model are not
818 made available through the sysfs interface.  If you have a dock and you
819 notice there are LEDs listed for your ThinkPad that do not exist (and
820 are not in the dock), or if you notice that there are missing LEDs,
821 a report to ibm-acpi-devel@lists.sourceforge.net is appreciated.
822
823
824 ACPI sounds -- /proc/acpi/ibm/beep
825 ----------------------------------
826
827 The BEEP method is used internally by the ACPI firmware to provide
828 audible alerts in various situations. This feature allows the same
829 sounds to be triggered manually.
830
831 The commands are non-negative integer numbers:
832
833         echo <number> >/proc/acpi/ibm/beep
834
835 The valid <number> range is 0 to 17. Not all numbers trigger sounds
836 and the sounds vary from model to model. Here is the behavior on the
837 X40:
838
839         0 - stop a sound in progress (but use 17 to stop 16)
840         2 - two beeps, pause, third beep ("low battery")
841         3 - single beep
842         4 - high, followed by low-pitched beep ("unable")
843         5 - single beep
844         6 - very high, followed by high-pitched beep ("AC/DC")
845         7 - high-pitched beep
846         9 - three short beeps
847         10 - very long beep
848         12 - low-pitched beep
849         15 - three high-pitched beeps repeating constantly, stop with 0
850         16 - one medium-pitched beep repeating constantly, stop with 17
851         17 - stop 16
852
853
854 Temperature sensors
855 -------------------
856
857 procfs: /proc/acpi/ibm/thermal
858 sysfs device attributes: (hwmon "thinkpad") temp*_input
859
860 Most ThinkPads include six or more separate temperature sensors but only
861 expose the CPU temperature through the standard ACPI methods.  This
862 feature shows readings from up to eight different sensors on older
863 ThinkPads, and up to sixteen different sensors on newer ThinkPads.
864
865 For example, on the X40, a typical output may be:
866 temperatures:   42 42 45 41 36 -128 33 -128
867
868 On the T43/p, a typical output may be:
869 temperatures:   48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
870
871 The mapping of thermal sensors to physical locations varies depending on
872 system-board model (and thus, on ThinkPad model).
873
874 http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
875 tries to track down these locations for various models.
876
877 Most (newer?) models seem to follow this pattern:
878
879 1:  CPU
880 2:  (depends on model)
881 3:  (depends on model)
882 4:  GPU
883 5:  Main battery: main sensor
884 6:  Bay battery: main sensor
885 7:  Main battery: secondary sensor
886 8:  Bay battery: secondary sensor
887 9-15: (depends on model)
888
889 For the R51 (source: Thomas Gruber):
890 2:  Mini-PCI
891 3:  Internal HDD
892
893 For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
894 http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
895 2:  System board, left side (near PCMCIA slot), reported as HDAPS temp
896 3:  PCMCIA slot
897 9:  MCH (northbridge) to DRAM Bus
898 10: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
899     card, under touchpad
900 11: Power regulator, underside of system board, below F2 key
901
902 The A31 has a very atypical layout for the thermal sensors
903 (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
904 1:  CPU
905 2:  Main Battery: main sensor
906 3:  Power Converter
907 4:  Bay Battery: main sensor
908 5:  MCH (northbridge)
909 6:  PCMCIA/ambient
910 7:  Main Battery: secondary sensor
911 8:  Bay Battery: secondary sensor
912
913
914 Procfs notes:
915         Readings from sensors that are not available return -128.
916         No commands can be written to this file.
917
918 Sysfs notes:
919         Sensors that are not available return the ENXIO error.  This
920         status may change at runtime, as there are hotplug thermal
921         sensors, like those inside the batteries and docks.
922
923         thinkpad-acpi thermal sensors are reported through the hwmon
924         subsystem, and follow all of the hwmon guidelines at
925         Documentation/hwmon.
926
927
928 EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
929 ------------------------------------------------------------------------
930
931 This feature is marked EXPERIMENTAL because the implementation
932 directly accesses hardware registers and may not work as expected. USE
933 WITH CAUTION! To use this feature, you need to supply the
934 experimental=1 parameter when loading the module.
935
936 This feature dumps the values of 256 embedded controller
937 registers. Values which have changed since the last time the registers
938 were dumped are marked with a star:
939
940 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
941 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
942 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
943 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
944 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
945 EC 0x30:  01  07  1a  00  30  04  00  00 *85  00  00  10  00  50  00  00
946 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
947 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03 *bc *02 *bc
948 EC 0x60: *02 *bc *02  00  00  00  00  00  00  00  00  00  00  00  00  00
949 EC 0x70:  00  00  00  00  00  12  30  40 *24 *26 *2c *27 *20  80 *1f  80
950 EC 0x80:  00  00  00  06 *37 *0e  03  00  00  00  0e  07  00  00  00  00
951 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
952 EC 0xa0: *ff  09  ff  09  ff  ff *64  00 *00 *00 *a2  41 *ff *ff *e0  00
953 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
954 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
955 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
956 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
957 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
958
959 This feature can be used to determine the register holding the fan
960 speed on some models. To do that, do the following:
961
962         - make sure the battery is fully charged
963         - make sure the fan is running
964         - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
965
966 The first step makes sure various charging-related values don't
967 vary. The second ensures that the fan-related values do vary, since
968 the fan speed fluctuates a bit. The third will (hopefully) mark the
969 fan register with a star:
970
971 [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
972 EC       +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
973 EC 0x00:  a7  47  87  01  fe  96  00  08  01  00  cb  00  00  00  40  00
974 EC 0x10:  00  00  ff  ff  f4  3c  87  09  01  ff  42  01  ff  ff  0d  00
975 EC 0x20:  00  00  00  00  00  00  00  00  00  00  00  03  43  00  00  80
976 EC 0x30:  01  07  1a  00  30  04  00  00  85  00  00  10  00  50  00  00
977 EC 0x40:  00  00  00  00  00  00  14  01  00  04  00  00  00  00  00  00
978 EC 0x50:  00  c0  02  0d  00  01  01  02  02  03  03  03  03  bc  02  bc
979 EC 0x60:  02  bc  02  00  00  00  00  00  00  00  00  00  00  00  00  00
980 EC 0x70:  00  00  00  00  00  12  30  40  24  27  2c  27  21  80  1f  80
981 EC 0x80:  00  00  00  06 *be  0d  03  00  00  00  0e  07  00  00  00  00
982 EC 0x90:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
983 EC 0xa0:  ff  09  ff  09  ff  ff  64  00  00  00  a2  41  ff  ff  e0  00
984 EC 0xb0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
985 EC 0xc0:  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
986 EC 0xd0:  03  00  00  00  00  00  00  00  00  00  00  00  00  00  00  00
987 EC 0xe0:  00  00  00  00  00  00  00  00  11  20  49  04  24  06  55  03
988 EC 0xf0:  31  55  48  54  35  38  57  57  08  2f  45  73  07  65  6c  1a
989
990 Another set of values that varies often is the temperature
991 readings. Since temperatures don't change vary fast, you can take
992 several quick dumps to eliminate them.
993
994 You can use a similar method to figure out the meaning of other
995 embedded controller registers - e.g. make sure nothing else changes
996 except the charging or discharging battery to determine which
997 registers contain the current battery capacity, etc. If you experiment
998 with this, do send me your results (including some complete dumps with
999 a description of the conditions when they were taken.)
1000
1001
1002 LCD brightness control
1003 ----------------------
1004
1005 procfs: /proc/acpi/ibm/brightness
1006 sysfs backlight device "thinkpad_screen"
1007
1008 This feature allows software control of the LCD brightness on ThinkPad
1009 models which don't have a hardware brightness slider.
1010
1011 It has some limitations: the LCD backlight cannot be actually turned
1012 on or off by this interface, it just controls the backlight brightness
1013 level.
1014
1015 On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
1016 has eight brightness levels, ranging from 0 to 7.  Some of the levels
1017 may not be distinct.  Later Lenovo models that implement the ACPI
1018 display backlight brightness control methods have 16 levels, ranging
1019 from 0 to 15.
1020
1021 For IBM ThinkPads, there are two interfaces to the firmware for direct
1022 brightness control, EC and UCMS (or CMOS).  To select which one should be
1023 used, use the brightness_mode module parameter: brightness_mode=1 selects
1024 EC mode, brightness_mode=2 selects UCMS mode, brightness_mode=3 selects EC
1025 mode with NVRAM backing (so that brightness changes are remembered across
1026 shutdown/reboot).
1027
1028 The driver tries to select which interface to use from a table of
1029 defaults for each ThinkPad model.  If it makes a wrong choice, please
1030 report this as a bug, so that we can fix it.
1031
1032 Lenovo ThinkPads only support brightness_mode=2 (UCMS).
1033
1034 When display backlight brightness controls are available through the
1035 standard ACPI interface, it is best to use it instead of this direct
1036 ThinkPad-specific interface.  The driver will disable its native
1037 backlight brightness control interface if it detects that the standard
1038 ACPI interface is available in the ThinkPad.
1039
1040 The brightness_enable module parameter can be used to control whether
1041 the LCD brightness control feature will be enabled when available.
1042 brightness_enable=0 forces it to be disabled.  brightness_enable=1
1043 forces it to be enabled when available, even if the standard ACPI
1044 interface is also available.
1045
1046 Procfs notes:
1047
1048         The available commands are:
1049
1050         echo up   >/proc/acpi/ibm/brightness
1051         echo down >/proc/acpi/ibm/brightness
1052         echo 'level <level>' >/proc/acpi/ibm/brightness
1053
1054 Sysfs notes:
1055
1056 The interface is implemented through the backlight sysfs class, which is
1057 poorly documented at this time.
1058
1059 Locate the thinkpad_screen device under /sys/class/backlight, and inside
1060 it there will be the following attributes:
1061
1062         max_brightness:
1063                 Reads the maximum brightness the hardware can be set to.
1064                 The minimum is always zero.
1065
1066         actual_brightness:
1067                 Reads what brightness the screen is set to at this instant.
1068
1069         brightness:
1070                 Writes request the driver to change brightness to the
1071                 given value.  Reads will tell you what brightness the
1072                 driver is trying to set the display to when "power" is set
1073                 to zero and the display has not been dimmed by a kernel
1074                 power management event.
1075
1076         power:
1077                 power management mode, where 0 is "display on", and 1 to 3
1078                 will dim the display backlight to brightness level 0
1079                 because thinkpad-acpi cannot really turn the backlight
1080                 off.  Kernel power management events can temporarily
1081                 increase the current power management level, i.e. they can
1082                 dim the display.
1083
1084
1085 WARNING:
1086
1087     Whatever you do, do NOT ever call thinkpad-acpi backlight-level change
1088     interface and the ACPI-based backlight level change interface
1089     (available on newer BIOSes, and driven by the Linux ACPI video driver)
1090     at the same time.  The two will interact in bad ways, do funny things,
1091     and maybe reduce the life of the backlight lamps by needlessly kicking
1092     its level up and down at every change.
1093
1094
1095 Volume control
1096 --------------
1097
1098 procfs: /proc/acpi/ibm/volume
1099
1100 NOTE: by default, the volume control interface operates in read-only
1101 mode, as it is supposed to be used for on-screen-display purposes.
1102 The read/write mode can be enabled through the use of the
1103 "volume_control=1" module parameter.
1104
1105 NOTE: distros are urged to not enable volume_control by default, this
1106 should be done by the local admin only.  The ThinkPad UI is for the
1107 console audio control to be done through the volume keys only, and for
1108 the desktop environment to just provide on-screen-display feedback.
1109 Software volume control should be done only in the main AC97/HDA
1110 mixer.
1111
1112 This feature allows volume control on ThinkPad models with a digital
1113 volume knob (when available, not all models have it), as well as
1114 mute/unmute control.  The available commands are:
1115
1116         echo up   >/proc/acpi/ibm/volume
1117         echo down >/proc/acpi/ibm/volume
1118         echo mute >/proc/acpi/ibm/volume
1119         echo unmute >/proc/acpi/ibm/volume
1120         echo 'level <level>' >/proc/acpi/ibm/volume
1121
1122 The <level> number range is 0 to 14 although not all of them may be
1123 distinct. The unmute the volume after the mute command, use either the
1124 up or down command (the level command will not unmute the volume), or
1125 the unmute command.
1126
1127 The current volume level and mute state is shown in the file.
1128
1129 You can use the volume_capabilities parameter to tell the driver
1130 whether your thinkpad has volume control or mute-only control:
1131 volume_capabilities=1 for mixers with mute and volume control,
1132 volume_capabilities=2 for mixers with only mute control.
1133
1134 If the driver misdetects the capabilities for your ThinkPad model,
1135 please report this to ibm-acpi-devel@lists.sourceforge.net, so that we
1136 can update the driver.
1137
1138 There are two strategies for volume control.  To select which one
1139 should be used, use the volume_mode module parameter: volume_mode=1
1140 selects EC mode, and volume_mode=3 selects EC mode with NVRAM backing
1141 (so that volume/mute changes are remembered across shutdown/reboot).
1142
1143 The driver will operate in volume_mode=3 by default. If that does not
1144 work well on your ThinkPad model, please report this to
1145 ibm-acpi-devel@lists.sourceforge.net.
1146
1147 The ALSA mixer interface to this feature is still missing, but patches
1148 to add it exist.  That problem should be addressed in the not so
1149 distant future.
1150
1151
1152 Fan control and monitoring: fan speed, fan enable/disable
1153 ---------------------------------------------------------
1154
1155 procfs: /proc/acpi/ibm/fan
1156 sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
1157                           pwm1_enable, fan2_input
1158 sysfs hwmon driver attributes: fan_watchdog
1159
1160 NOTE NOTE NOTE: fan control operations are disabled by default for
1161 safety reasons.  To enable them, the module parameter "fan_control=1"
1162 must be given to thinkpad-acpi.
1163
1164 This feature attempts to show the current fan speed, control mode and
1165 other fan data that might be available.  The speed is read directly
1166 from the hardware registers of the embedded controller.  This is known
1167 to work on later R, T, X and Z series ThinkPads but may show a bogus
1168 value on other models.
1169
1170 Some Lenovo ThinkPads support a secondary fan.  This fan cannot be
1171 controlled separately, it shares the main fan control.
1172
1173 Fan levels:
1174
1175 Most ThinkPad fans work in "levels" at the firmware interface.  Level 0
1176 stops the fan.  The higher the level, the higher the fan speed, although
1177 adjacent levels often map to the same fan speed.  7 is the highest
1178 level, where the fan reaches the maximum recommended speed.
1179
1180 Level "auto" means the EC changes the fan level according to some
1181 internal algorithm, usually based on readings from the thermal sensors.
1182
1183 There is also a "full-speed" level, also known as "disengaged" level.
1184 In this level, the EC disables the speed-locked closed-loop fan control,
1185 and drives the fan as fast as it can go, which might exceed hardware
1186 limits, so use this level with caution.
1187
1188 The fan usually ramps up or down slowly from one speed to another, and
1189 it is normal for the EC to take several seconds to react to fan
1190 commands.  The full-speed level may take up to two minutes to ramp up to
1191 maximum speed, and in some ThinkPads, the tachometer readings go stale
1192 while the EC is transitioning to the full-speed level.
1193
1194 WARNING WARNING WARNING: do not leave the fan disabled unless you are
1195 monitoring all of the temperature sensor readings and you are ready to
1196 enable it if necessary to avoid overheating.
1197
1198 An enabled fan in level "auto" may stop spinning if the EC decides the
1199 ThinkPad is cool enough and doesn't need the extra airflow.  This is
1200 normal, and the EC will spin the fan up if the various thermal readings
1201 rise too much.
1202
1203 On the X40, this seems to depend on the CPU and HDD temperatures.
1204 Specifically, the fan is turned on when either the CPU temperature
1205 climbs to 56 degrees or the HDD temperature climbs to 46 degrees.  The
1206 fan is turned off when the CPU temperature drops to 49 degrees and the
1207 HDD temperature drops to 41 degrees.  These thresholds cannot
1208 currently be controlled.
1209
1210 The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
1211 certain conditions are met.  It will override any fan programming done
1212 through thinkpad-acpi.
1213
1214 The thinkpad-acpi kernel driver can be programmed to revert the fan
1215 level to a safe setting if userspace does not issue one of the procfs
1216 fan commands: "enable", "disable", "level" or "watchdog", or if there
1217 are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
1218 set to 1, manual mode) within a configurable amount of time of up to
1219 120 seconds.  This functionality is called fan safety watchdog.
1220
1221 Note that the watchdog timer stops after it enables the fan.  It will be
1222 rearmed again automatically (using the same interval) when one of the
1223 above mentioned fan commands is received.  The fan watchdog is,
1224 therefore, not suitable to protect against fan mode changes made through
1225 means other than the "enable", "disable", and "level" procfs fan
1226 commands, or the hwmon fan control sysfs interface.
1227
1228 Procfs notes:
1229
1230 The fan may be enabled or disabled with the following commands:
1231
1232         echo enable  >/proc/acpi/ibm/fan
1233         echo disable >/proc/acpi/ibm/fan
1234
1235 Placing a fan on level 0 is the same as disabling it.  Enabling a fan
1236 will try to place it in a safe level if it is too slow or disabled.
1237
1238 The fan level can be controlled with the command:
1239
1240         echo 'level <level>' > /proc/acpi/ibm/fan
1241
1242 Where <level> is an integer from 0 to 7, or one of the words "auto" or
1243 "full-speed" (without the quotes).  Not all ThinkPads support the "auto"
1244 and "full-speed" levels.  The driver accepts "disengaged" as an alias for
1245 "full-speed", and reports it as "disengaged" for backwards
1246 compatibility.
1247
1248 On the X31 and X40 (and ONLY on those models), the fan speed can be
1249 controlled to a certain degree.  Once the fan is running, it can be
1250 forced to run faster or slower with the following command:
1251
1252         echo 'speed <speed>' > /proc/acpi/ibm/fan
1253
1254 The sustainable range of fan speeds on the X40 appears to be from about
1255 3700 to about 7350. Values outside this range either do not have any
1256 effect or the fan speed eventually settles somewhere in that range.  The
1257 fan cannot be stopped or started with this command.  This functionality
1258 is incomplete, and not available through the sysfs interface.
1259
1260 To program the safety watchdog, use the "watchdog" command.
1261
1262         echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1263
1264 If you want to disable the watchdog, use 0 as the interval.
1265
1266 Sysfs notes:
1267
1268 The sysfs interface follows the hwmon subsystem guidelines for the most
1269 part, and the exception is the fan safety watchdog.
1270
1271 Writes to any of the sysfs attributes may return the EINVAL error if
1272 that operation is not supported in a given ThinkPad or if the parameter
1273 is out-of-bounds, and EPERM if it is forbidden.  They may also return
1274 EINTR (interrupted system call), and EIO (I/O error while trying to talk
1275 to the firmware).
1276
1277 Features not yet implemented by the driver return ENOSYS.
1278
1279 hwmon device attribute pwm1_enable:
1280         0: PWM offline (fan is set to full-speed mode)
1281         1: Manual PWM control (use pwm1 to set fan level)
1282         2: Hardware PWM control (EC "auto" mode)
1283         3: reserved (Software PWM control, not implemented yet)
1284
1285         Modes 0 and 2 are not supported by all ThinkPads, and the
1286         driver is not always able to detect this.  If it does know a
1287         mode is unsupported, it will return -EINVAL.
1288
1289 hwmon device attribute pwm1:
1290         Fan level, scaled from the firmware values of 0-7 to the hwmon
1291         scale of 0-255.  0 means fan stopped, 255 means highest normal
1292         speed (level 7).
1293
1294         This attribute only commands the fan if pmw1_enable is set to 1
1295         (manual PWM control).
1296
1297 hwmon device attribute fan1_input:
1298         Fan tachometer reading, in RPM.  May go stale on certain
1299         ThinkPads while the EC transitions the PWM to offline mode,
1300         which can take up to two minutes.  May return rubbish on older
1301         ThinkPads.
1302
1303 hwmon device attribute fan2_input:
1304         Fan tachometer reading, in RPM, for the secondary fan.
1305         Available only on some ThinkPads.  If the secondary fan is
1306         not installed, will always read 0.
1307
1308 hwmon driver attribute fan_watchdog:
1309         Fan safety watchdog timer interval, in seconds.  Minimum is
1310         1 second, maximum is 120 seconds.  0 disables the watchdog.
1311
1312 To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
1313
1314 To start the fan in a safe mode: set pwm1_enable to 2.  If that fails
1315 with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
1316 would be the safest choice, though).
1317
1318
1319 WAN
1320 ---
1321
1322 procfs: /proc/acpi/ibm/wan
1323 sysfs device attribute: wwan_enable (deprecated)
1324 sysfs rfkill class: switch "tpacpi_wwan_sw"
1325
1326 This feature shows the presence and current state of the built-in
1327 Wireless WAN device.
1328
1329 If the ThinkPad supports it, the WWAN state is stored in NVRAM,
1330 so it is kept across reboots and power-off.
1331
1332 It was tested on a Lenovo ThinkPad X60. It should probably work on other
1333 ThinkPad models which come with this module installed.
1334
1335 Procfs notes:
1336
1337 If the W-WAN card is installed, the following commands can be used:
1338
1339         echo enable > /proc/acpi/ibm/wan
1340         echo disable > /proc/acpi/ibm/wan
1341
1342 Sysfs notes:
1343
1344         If the W-WAN card is installed, it can be enabled /
1345         disabled through the "wwan_enable" thinkpad-acpi device
1346         attribute, and its current status can also be queried.
1347
1348         enable:
1349                 0: disables WWAN card / WWAN card is disabled
1350                 1: enables WWAN card / WWAN card is enabled.
1351
1352         Note: this interface has been superseded by the generic rfkill
1353         class.  It has been deprecated, and it will be removed in year
1354         2010.
1355
1356         rfkill controller switch "tpacpi_wwan_sw": refer to
1357         Documentation/rfkill.txt for details.
1358
1359
1360 EXPERIMENTAL: UWB
1361 -----------------
1362
1363 This feature is marked EXPERIMENTAL because it has not been extensively
1364 tested and validated in various ThinkPad models yet.  The feature may not
1365 work as expected. USE WITH CAUTION! To use this feature, you need to supply
1366 the experimental=1 parameter when loading the module.
1367
1368 sysfs rfkill class: switch "tpacpi_uwb_sw"
1369
1370 This feature exports an rfkill controller for the UWB device, if one is
1371 present and enabled in the BIOS.
1372
1373 Sysfs notes:
1374
1375         rfkill controller switch "tpacpi_uwb_sw": refer to
1376         Documentation/rfkill.txt for details.
1377
1378
1379 Multiple Commands, Module Parameters
1380 ------------------------------------
1381
1382 Multiple commands can be written to the proc files in one shot by
1383 separating them with commas, for example:
1384
1385         echo enable,0xffff > /proc/acpi/ibm/hotkey
1386         echo lcd_disable,crt_enable > /proc/acpi/ibm/video
1387
1388 Commands can also be specified when loading the thinkpad-acpi module,
1389 for example:
1390
1391         modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
1392
1393
1394 Enabling debugging output
1395 -------------------------
1396
1397 The module takes a debug parameter which can be used to selectively
1398 enable various classes of debugging output, for example:
1399
1400          modprobe thinkpad_acpi debug=0xffff
1401
1402 will enable all debugging output classes.  It takes a bitmask, so
1403 to enable more than one output class, just add their values.
1404
1405         Debug bitmask           Description
1406         0x8000                  Disclose PID of userspace programs
1407                                 accessing some functions of the driver
1408         0x0001                  Initialization and probing
1409         0x0002                  Removal
1410         0x0004                  RF Transmitter control (RFKILL)
1411                                 (bluetooth, WWAN, UWB...)
1412         0x0008                  HKEY event interface, hotkeys
1413         0x0010                  Fan control
1414         0x0020                  Backlight brightness
1415         0x0040                  Audio mixer/volume control
1416
1417 There is also a kernel build option to enable more debugging
1418 information, which may be necessary to debug driver problems.
1419
1420 The level of debugging information output by the driver can be changed
1421 at runtime through sysfs, using the driver attribute debug_level.  The
1422 attribute takes the same bitmask as the debug module parameter above.
1423
1424
1425 Force loading of module
1426 -----------------------
1427
1428 If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1429 the module parameter force_load=1.  Regardless of whether this works or
1430 not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
1431
1432
1433 Sysfs interface changelog:
1434
1435 0x000100:       Initial sysfs support, as a single platform driver and
1436                 device.
1437 0x000200:       Hot key support for 32 hot keys, and radio slider switch
1438                 support.
1439 0x010000:       Hot keys are now handled by default over the input
1440                 layer, the radio switch generates input event EV_RADIO,
1441                 and the driver enables hot key handling by default in
1442                 the firmware.
1443
1444 0x020000:       ABI fix: added a separate hwmon platform device and
1445                 driver, which must be located by name (thinkpad)
1446                 and the hwmon class for libsensors4 (lm-sensors 3)
1447                 compatibility.  Moved all hwmon attributes to this
1448                 new platform device.
1449
1450 0x020100:       Marker for thinkpad-acpi with hot key NVRAM polling
1451                 support.  If you must, use it to know you should not
1452                 start a userspace NVRAM poller (allows to detect when
1453                 NVRAM is compiled out by the user because it is
1454                 unneeded/undesired in the first place).
1455 0x020101:       Marker for thinkpad-acpi with hot key NVRAM polling
1456                 and proper hotkey_mask semantics (version 8 of the
1457                 NVRAM polling patch).  Some development snapshots of
1458                 0.18 had an earlier version that did strange things
1459                 to hotkey_mask.
1460
1461 0x020200:       Add poll()/select() support to the following attributes:
1462                 hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason
1463
1464 0x020300:       hotkey enable/disable support removed, attributes
1465                 hotkey_bios_enabled and hotkey_enable deprecated and
1466                 marked for removal.
1467
1468 0x020400:       Marker for 16 LEDs support.  Also, LEDs that are known
1469                 to not exist in a given model are not registered with
1470                 the LED sysfs class anymore.
1471
1472 0x020500:       Updated hotkey driver, hotkey_mask is always available
1473                 and it is always able to disable hot keys.  Very old
1474                 thinkpads are properly supported.  hotkey_bios_mask
1475                 is deprecated and marked for removal.
1476
1477 0x020600:       Marker for backlight change event support.
1478
1479 0x020700:       Support for mute-only mixers.
1480                 Volume control in read-only mode by default.