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