blob: 76cb428435daf4c1dfe9d611fd6a155483e447a2 [file] [log] [blame]
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001 ThinkPad ACPI Extras Driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07002
Henrique de Moraes Holschuh1cee5cc2008-01-08 13:02:57 -02003 Version 0.19
4 January 06th, 2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
6 Borislav Deianov <borislav@users.sf.net>
Henrique de Moraes Holschuhc78d5c92007-07-18 23:45:47 -03007 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
8 http://ibm-acpi.sf.net/
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -030011This is a Linux driver for the IBM and Lenovo ThinkPad laptops. It
12supports various features of these laptops which are accessible
13through the ACPI and ACPI EC framework, but not otherwise fully
14supported by the generic Linux ACPI drivers.
15
16This driver used to be named ibm-acpi until kernel 2.6.21 and release
170.13-20070314. It used to be in the drivers/acpi tree, but it was
18moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel
192.6.22, and release 0.14.
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21
22Status
23------
24
25The features currently supported are the following (see below for
26detailed description):
27
28 - Fn key combinations
29 - Bluetooth enable and disable
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -030030 - video output switching, expansion control
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 - ThinkLight on and off
32 - limited docking and undocking
33 - UltraBay eject
Borislav Deianov78f81cc2005-08-17 00:00:00 -040034 - CMOS control
35 - LED control
36 - ACPI sounds
37 - temperature sensors
38 - Experimental: embedded controller register dump
Stefan Schmidt24f7ff02006-09-22 12:19:15 +020039 - LCD brightness control
40 - Volume control
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -030041 - Fan control and monitoring: fan speed, fan enable/disable
Stefan Schmidt28b779d2006-09-22 12:19:16 +020042 - Experimental: WAN enable and disable
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44A compatibility table by model and feature is maintained on the web
45site, http://ibm-acpi.sf.net/. I appreciate any success or failure
46reports, especially if they add to or correct the compatibility table.
47Please include the following information in your report:
48
49 - ThinkPad model name
50 - a copy of your DSDT, from /proc/acpi/dsdt
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -030051 - a copy of the output of dmidecode, with serial numbers
52 and UUIDs masked off
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 - which driver features work and which don't
54 - the observed behavior of non-working features
55
56Any other comments or patches are also more than welcome.
57
58
59Installation
60------------
61
62If you are compiling this driver as included in the Linux kernel
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -030063sources, simply enable the CONFIG_THINKPAD_ACPI option, and optionally
64enable the CONFIG_THINKPAD_ACPI_BAY option if you want the
65thinkpad-specific bay functionality.
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67Features
68--------
69
Henrique de Moraes Holschuh54ae1502007-04-24 11:48:12 -030070The driver exports two different interfaces to userspace, which can be
71used to access the features it provides. One is a legacy procfs-based
72interface, which will be removed at some time in the distant future.
73The other is a new sysfs-based interface which is not complete yet.
74
75The procfs interface creates the /proc/acpi/ibm directory. There is a
76file under that directory for each feature it supports. The procfs
77interface is mostly frozen, and will change very little if at all: it
78will not be extended to add any new functionality in the driver, instead
79all new functionality will be implemented on the sysfs interface.
80
81The sysfs interface tries to blend in the generic Linux sysfs subsystems
82and classes as much as possible. Since some of these subsystems are not
83yet ready or stabilized, it is expected that this interface will change,
84and any and all userspace programs must deal with it.
85
86
87Notes about the sysfs interface:
88
89Unlike what was done with the procfs interface, correctness when talking
90to the sysfs interfaces will be enforced, as will correctness in the
91thinkpad-acpi's implementation of sysfs interfaces.
92
93Also, any bugs in the thinkpad-acpi sysfs driver code or in the
94thinkpad-acpi's implementation of the sysfs interfaces will be fixed for
95maximum correctness, even if that means changing an interface in
96non-compatible ways. As these interfaces mature both in the kernel and
97in thinkpad-acpi, such changes should become quite rare.
98
99Applications interfacing to the thinkpad-acpi sysfs interfaces must
100follow all sysfs guidelines and correctly process all errors (the sysfs
101interface makes extensive use of errors). File descriptors and open /
102close operations to the sysfs inodes must also be properly implemented.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300104The version of thinkpad-acpi's sysfs interface is exported by the driver
105as a driver attribute (see below).
106
107Sysfs driver attributes are on the driver's sysfs attribute space,
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300108for 2.6.23 this is /sys/bus/platform/drivers/thinkpad_acpi/ and
109/sys/bus/platform/drivers/thinkpad_hwmon/
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300110
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300111Sysfs device attributes are on the thinkpad_acpi device sysfs attribute
112space, for 2.6.23 this is /sys/devices/platform/thinkpad_acpi/.
113
114Sysfs device attributes for the sensors and fan are on the
115thinkpad_hwmon device's sysfs attribute space, but you should locate it
116looking for a hwmon device with the name attribute of "thinkpad".
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300117
118Driver version
119--------------
120
121procfs: /proc/acpi/ibm/driver
122sysfs driver attribute: version
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124The driver name and version. No commands can be written to this file.
125
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -0300126Sysfs interface version
127-----------------------
128
129sysfs driver attribute: interface_version
130
131Version of the thinkpad-acpi sysfs interface, as an unsigned long
132(output in hex format: 0xAAAABBCC), where:
133 AAAA - major revision
134 BB - minor revision
135 CC - bugfix revision
136
137The sysfs interface version changelog for the driver can be found at the
138end of this document. Changes to the sysfs interface done by the kernel
139subsystems are not documented here, nor are they tracked by this
140attribute.
141
Henrique de Moraes Holschuh94b08712007-07-18 23:45:32 -0300142Changes to the thinkpad-acpi sysfs interface are only considered
143non-experimental when they are submitted to Linux mainline, at which
144point the changes in this interface are documented and interface_version
145may be updated. If you are using any thinkpad-acpi features not yet
146sent to mainline for merging, you do so on your own risk: these features
147may disappear, or be implemented in a different and incompatible way by
148the time they are merged in Linux mainline.
149
150Changes that are backwards-compatible by nature (e.g. the addition of
151attributes that do not change the way the other attributes work) do not
152always warrant an update of interface_version. Therefore, one must
153expect that an attribute might not be there, and deal with it properly
154(an attribute not being there *is* a valid way to make it clear that a
155feature is not available in sysfs).
156
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300157Hot keys
158--------
159
160procfs: /proc/acpi/ibm/hotkey
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300161sysfs device attribute: hotkey_*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200163In a ThinkPad, the ACPI HKEY handler is responsible for communicating
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300164some important events and also keyboard hot key presses to the operating
165system. Enabling the hotkey functionality of thinkpad-acpi signals the
166firmware that such a driver is present, and modifies how the ThinkPad
167firmware will behave in many situations.
168
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300169The driver enables the hot key feature automatically when loaded. The
170feature can later be disabled and enabled back at runtime. The driver
171will also restore the hot key feature to its previous state and mask
172when it is unloaded.
173
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300174When the hotkey feature is enabled and the hot key mask is set (see
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300175below), the driver will report HKEY events in the following format:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 ibm/hotkey HKEY 00000080 0000xxxx
178
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300179Some of these events refer to hot key presses, but not all.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300180
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300181The driver will generate events over the input layer for hot keys and
182radio switches, and over the ACPI netlink layer for other events. The
183input layer support accepts the standard IOCTLs to remap the keycodes
184assigned to each hot key.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300185
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300186The hot key bit mask allows some control over which hot keys generate
187events. If a key is "masked" (bit set to 0 in the mask), the firmware
188will handle it. If it is "unmasked", it signals the firmware that
189thinkpad-acpi would prefer to handle it, if the firmware would be so
190kind to allow it (and it often doesn't!).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300192Not all bits in the mask can be modified. Not all bits that can be
193modified do anything. Not all hot keys can be individually controlled
194by the mask. Some models do not support the mask at all, and in those
195models, hot keys cannot be controlled individually. The behaviour of
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200196the mask is, therefore, highly dependent on the ThinkPad model.
Henrique de Moraes Holschuhae92bd12007-07-18 23:45:29 -0300197
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300198Note that unmasking some keys prevents their default behavior. For
199example, if Fn+F5 is unmasked, that key will no longer enable/disable
200Bluetooth by itself.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300202Note also that not all Fn key combinations are supported through ACPI.
203For example, on the X40, the brightness, volume and "Access IBM" buttons
204do not generate ACPI events even with this driver. They *can* be used
205through the "ThinkPad Buttons" utility, see http://www.nongnu.org/tpb/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300207procfs notes:
208
209The following commands can be written to the /proc/acpi/ibm/hotkey file:
210
211 echo enable > /proc/acpi/ibm/hotkey -- enable the hot keys feature
212 echo disable > /proc/acpi/ibm/hotkey -- disable the hot keys feature
Henrique de Moraes Holschuhae92bd12007-07-18 23:45:29 -0300213 echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
214 echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
215 ... any other 8-hex-digit mask ...
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300216 echo reset > /proc/acpi/ibm/hotkey -- restore the original mask
217
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200218The procfs interface does not support NVRAM polling control. So as to
219maintain maximum bug-to-bug compatibility, it does not report any masks,
220nor does it allow one to manipulate the hot key mask when the firmware
221does not support masks at all, even if NVRAM polling is in use.
222
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300223sysfs notes:
224
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300225 hotkey_bios_enabled:
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300226 Returns the status of the hot keys feature when
227 thinkpad-acpi was loaded. Upon module unload, the hot
228 key feature status will be restored to this value.
229
230 0: hot keys were disabled
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300231 1: hot keys were enabled (unusual)
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300232
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300233 hotkey_bios_mask:
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300234 Returns the hot keys mask when thinkpad-acpi was loaded.
235 Upon module unload, the hot keys mask will be restored
236 to this value.
237
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300238 hotkey_enable:
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200239 Enables/disables the hot keys feature in the ACPI
240 firmware, and reports current status of the hot keys
241 feature. Has no effect on the NVRAM hot key polling
242 functionality.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300243
244 0: disables the hot keys feature / feature disabled
245 1: enables the hot keys feature / feature enabled
246
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300247 hotkey_mask:
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200248 bit mask to enable driver-handling (and depending on
249 the firmware, ACPI event generation) for each hot key
250 (see above). Returns the current status of the hot keys
251 mask, and allows one to modify it.
252
253 Note: when NVRAM polling is active, the firmware mask
254 will be different from the value returned by
255 hotkey_mask. The driver will retain enabled bits for
256 hotkeys that are under NVRAM polling even if the
257 firmware refuses them, and will not set these bits on
258 the firmware hot key mask.
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300259
Henrique de Moraes Holschuh9b010de2007-07-18 23:45:30 -0300260 hotkey_all_mask:
261 bit mask that should enable event reporting for all
262 supported hot keys, when echoed to hotkey_mask above.
263 Unless you know which events need to be handled
264 passively (because the firmware *will* handle them
265 anyway), do *not* use hotkey_all_mask. Use
266 hotkey_recommended_mask, instead. You have been warned.
267
268 hotkey_recommended_mask:
269 bit mask that should enable event reporting for all
Henrique de Moraes Holschuh1a343762007-07-18 23:45:36 -0300270 supported hot keys, except those which are always
271 handled by the firmware anyway. Echo it to
272 hotkey_mask above, to use.
Henrique de Moraes Holschuh9b010de2007-07-18 23:45:30 -0300273
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200274 hotkey_source_mask:
275 bit mask that selects which hot keys will the driver
276 poll the NVRAM for. This is auto-detected by the driver
277 based on the capabilities reported by the ACPI firmware,
278 but it can be overridden at runtime.
279
280 Hot keys whose bits are set in both hotkey_source_mask
281 and also on hotkey_mask are polled for in NVRAM. Only a
282 few hot keys are available through CMOS NVRAM polling.
283
284 Warning: when in NVRAM mode, the volume up/down/mute
285 keys are synthesized according to changes in the mixer,
286 so you have to use volume up or volume down to unmute,
287 as per the ThinkPad volume mixer user interface. When
288 in ACPI event mode, volume up/down/mute are reported as
289 separate events, but this behaviour may be corrected in
290 future releases of this driver, in which case the
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200291 ThinkPad volume mixer user interface semantics will be
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -0200292 enforced.
293
294 hotkey_poll_freq:
295 frequency in Hz for hot key polling. It must be between
296 0 and 25 Hz. Polling is only carried out when strictly
297 needed.
298
299 Setting hotkey_poll_freq to zero disables polling, and
300 will cause hot key presses that require NVRAM polling
301 to never be reported.
302
303 Setting hotkey_poll_freq too low will cause repeated
304 pressings of the same hot key to be misreported as a
305 single key press, or to not even be detected at all.
306 The recommended polling frequency is 10Hz.
307
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300308 hotkey_radio_sw:
Henrique de Moraes Holschuhd147da72008-02-16 02:17:57 -0200309 If the ThinkPad has a hardware radio switch, this
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300310 attribute will read 0 if the switch is in the "radios
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200311 disabled" position, and 1 if the switch is in the
Henrique de Moraes Holschuh74941a62007-07-18 23:45:31 -0300312 "radios enabled" position.
313
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200314 This attribute has poll()/select() support.
315
Henrique de Moraes Holschuh6c231bd2008-02-16 02:17:58 -0200316 hotkey_tablet_mode:
317 If the ThinkPad has tablet capabilities, this attribute
318 will read 0 if the ThinkPad is in normal mode, and
319 1 if the ThinkPad is in tablet mode.
320
321 This attribute has poll()/select() support.
322
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300323 hotkey_report_mode:
324 Returns the state of the procfs ACPI event report mode
325 filter for hot keys. If it is set to 1 (the default),
326 all hot key presses are reported both through the input
327 layer and also as ACPI events through procfs (but not
328 through netlink). If it is set to 2, hot key presses
329 are reported only through the input layer.
330
331 This attribute is read-only in kernels 2.6.23 or later,
332 and read-write on earlier kernels.
333
334 May return -EPERM (write access locked out by module
335 parameter) or -EACCES (read-only).
336
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200337 wakeup_reason:
338 Set to 1 if the system is waking up because the user
339 requested a bay ejection. Set to 2 if the system is
340 waking up because the user requested the system to
341 undock. Set to zero for normal wake-ups or wake-ups
342 due to unknown reasons.
343
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200344 This attribute has poll()/select() support.
345
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200346 wakeup_hotunplug_complete:
347 Set to 1 if the system was waken up because of an
348 undock or bay ejection request, and that request
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200349 was successfully completed. At this point, it might
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200350 be useful to send the system back to sleep, at the
351 user's choice. Refer to HKEY events 0x4003 and
352 0x3003, below.
353
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200354 This attribute has poll()/select() support.
355
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300356input layer notes:
357
358A Hot key is mapped to a single input layer EV_KEY event, possibly
359followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
360code. An EV_SYN event will always be generated to mark the end of the
361event block.
362
363Do not use the EV_MSC MSC_SCAN events to process keys. They are to be
364used as a helper to remap keys, only. They are particularly useful when
365remapping KEY_UNKNOWN keys.
366
367The events are available in an input device, with the following id:
368
369 Bus: BUS_HOST
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300370 vendor: 0x1014 (PCI_VENDOR_ID_IBM) or
371 0x17aa (PCI_VENDOR_ID_LENOVO)
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300372 product: 0x5054 ("TP")
373 version: 0x4101
374
375The version will have its LSB incremented if the keymap changes in a
376backwards-compatible way. The MSB shall always be 0x41 for this input
377device. If the MSB is not 0x41, do not use the device as described in
378this section, as it is either something else (e.g. another input device
379exported by a thinkpad driver, such as HDAPS) or its functionality has
380been changed in a non-backwards compatible way.
381
382Adding other event types for other functionalities shall be considered a
383backwards-compatible change for this input device.
384
385Thinkpad-acpi Hot Key event map (version 0x4101):
386
387ACPI Scan
388event code Key Notes
389
3900x1001 0x00 FN+F1 -
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03003910x1002 0x01 FN+F2 IBM: battery (rare)
392 Lenovo: Screen lock
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300393
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03003940x1003 0x02 FN+F3 Many IBM models always report
395 this hot key, even with hot keys
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300396 disabled or with Fn+F3 masked
397 off
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300398 IBM: screen lock
399 Lenovo: battery
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300400
4010x1004 0x03 FN+F4 Sleep button (ACPI sleep button
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200402 semantics, i.e. sleep-to-RAM).
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300403 It is always generate some kind
404 of event, either the hot key
405 event or a ACPI sleep button
406 event. The firmware may
407 refuse to generate further FN+F4
408 key presses until a S3 or S4 ACPI
409 sleep cycle is performed or some
410 time passes.
411
4120x1005 0x04 FN+F5 Radio. Enables/disables
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200413 the internal Bluetooth hardware
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300414 and W-WAN card if left in control
415 of the firmware. Does not affect
416 the WLAN card.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300417 Should be used to turn on/off all
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200418 radios (Bluetooth+W-WAN+WLAN),
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300419 really.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300420
4210x1006 0x05 FN+F6 -
422
4230x1007 0x06 FN+F7 Video output cycle.
424 Do you feel lucky today?
425
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004260x1008 0x07 FN+F8 IBM: toggle screen expand
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200427 Lenovo: configure UltraNav
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300428
4290x1009 0x08 FN+F9 -
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300430 .. .. ..
4310x100B 0x0A FN+F11 -
432
4330x100C 0x0B FN+F12 Sleep to disk. You are always
434 supposed to handle it yourself,
435 either through the ACPI event,
436 or through a hotkey event.
437 The firmware may refuse to
438 generate further FN+F4 key
439 press events until a S3 or S4
440 ACPI sleep cycle is performed,
441 or some time passes.
442
4430x100D 0x0C FN+BACKSPACE -
4440x100E 0x0D FN+INSERT -
4450x100F 0x0E FN+DELETE -
446
4470x1010 0x0F FN+HOME Brightness up. This key is
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300448 always handled by the firmware
449 in IBM ThinkPads, even when
450 unmasked. Just leave it alone.
451 For Lenovo ThinkPads with a new
452 BIOS, it has to be handled either
453 by the ACPI OSI, or by userspace.
4540x1011 0x10 FN+END Brightness down. See brightness
455 up for details.
456
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004570x1012 0x11 FN+PGUP ThinkLight toggle. This key is
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300458 always handled by the firmware,
459 even when unmasked.
460
4610x1013 0x12 FN+PGDOWN -
462
4630x1014 0x13 FN+SPACE Zoom key
464
4650x1015 0x14 VOLUME UP Internal mixer volume up. This
466 key is always handled by the
467 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300468 NOTE: Lenovo seems to be changing
469 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004700x1016 0x15 VOLUME DOWN Internal mixer volume up. This
471 key is always handled by the
472 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300473 NOTE: Lenovo seems to be changing
474 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004750x1017 0x16 MUTE Mute internal mixer. This
476 key is always handled by the
477 firmware, even when unmasked.
478
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004790x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300480
4810x1019 0x18 unknown
482.. .. ..
4830x1020 0x1F unknown
484
485The ThinkPad firmware does not allow one to differentiate when most hot
486keys are pressed or released (either that, or we don't know how to, yet).
487For these keys, the driver generates a set of events for a key press and
488immediately issues the same set of events for a key release. It is
489unknown by the driver if the ThinkPad firmware triggered these events on
490hot key press or release, but the firmware will do it for either one, not
491both.
492
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300493If a key is mapped to KEY_RESERVED, it generates no input events at all.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300494If a key is mapped to KEY_UNKNOWN, it generates an input event that
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300495includes an scan code. If a key is mapped to anything else, it will
496generate input device EV_KEY events.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300497
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200498In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
499events for switches:
500
501SW_RADIO T60 and later hardare rfkill rocker switch
502SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A
503
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300504Non hot-key ACPI HKEY event map:
5050x5001 Lid closed
5060x5002 Lid opened
Henrique de Moraes Holschuhb3ec6f92008-02-16 02:17:55 -02005070x5009 Tablet swivel: switched to tablet mode
5080x500A Tablet swivel: switched to normal mode
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03005090x7000 Radio Switch may have changed state
510
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300511The above events are not propagated by the driver, except for legacy
512compatibility purposes when hotkey_report_mode is set to 1.
513
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -02005140x2304 System is waking up from suspend to undock
5150x2305 System is waking up from suspend to eject bay
5160x2404 System is waking up from hibernation to undock
5170x2405 System is waking up from hibernation to eject bay
518
519The above events are never propagated by the driver.
520
5210x3003 Bay ejection (see 0x2x05) complete, can sleep again
5220x4003 Undocked (see 0x2x04), can sleep again
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02005230x500B Tablet pen inserted into its storage bay
Henrique de Moraes Holschuhd1edb2b2008-01-08 13:02:53 -02005240x500C Tablet pen removed from its storage bay
Henrique de Moraes Holschuh3b64b512008-01-08 13:02:51 -02005250x5010 Brightness level changed (newer Lenovo BIOSes)
526
527The above events are propagated by the driver.
528
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300529Compatibility notes:
530
531ibm-acpi and thinkpad-acpi 0.15 (mainline kernels before 2.6.23) never
532supported the input layer, and sent events over the procfs ACPI event
533interface.
534
535To avoid sending duplicate events over the input layer and the ACPI
536event interface, thinkpad-acpi 0.16 implements a module parameter
537(hotkey_report_mode), and also a sysfs device attribute with the same
538name.
539
540Make no mistake here: userspace is expected to switch to using the input
541layer interface of thinkpad-acpi, together with the ACPI netlink event
542interface in kernels 2.6.23 and later, or with the ACPI procfs event
543interface in kernels 2.6.22 and earlier.
544
545If no hotkey_report_mode module parameter is specified (or it is set to
546zero), the driver defaults to mode 1 (see below), and on kernels 2.6.22
547and earlier, also allows one to change the hotkey_report_mode through
548sysfs. In kernels 2.6.23 and later, where the netlink ACPI event
549interface is available, hotkey_report_mode cannot be changed through
550sysfs (it is read-only).
551
552If the hotkey_report_mode module parameter is set to 1 or 2, it cannot
553be changed later through sysfs (any writes will return -EPERM to signal
554that hotkey_report_mode was locked. On 2.6.23 and later, where
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200555hotkey_report_mode cannot be changed at all, writes will return -EACCES).
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300556
557hotkey_report_mode set to 1 makes the driver export through the procfs
558ACPI event interface all hot key presses (which are *also* sent to the
559input layer). This is a legacy compatibility behaviour, and it is also
560the default mode of operation for the driver.
561
562hotkey_report_mode set to 2 makes the driver filter out the hot key
563presses from the procfs ACPI event interface, so these events will only
564be sent through the input layer. Userspace that has been updated to use
565the thinkpad-acpi input layer interface should set hotkey_report_mode to
5662.
567
568Hot key press events are never sent to the ACPI netlink event interface.
569Really up-to-date userspace under kernel 2.6.23 and later is to use the
570netlink interface and the input layer interface, and don't bother at all
571with hotkey_report_mode.
572
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300573
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300574Bluetooth
575---------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300577procfs: /proc/acpi/ibm/bluetooth
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300578sysfs device attribute: bluetooth_enable
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300579
580This feature shows the presence and current state of a ThinkPad
581Bluetooth device in the internal ThinkPad CDC slot.
582
583Procfs notes:
584
585If Bluetooth is installed, the following commands can be used:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
587 echo enable > /proc/acpi/ibm/bluetooth
588 echo disable > /proc/acpi/ibm/bluetooth
589
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300590Sysfs notes:
591
592 If the Bluetooth CDC card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300593 disabled through the "bluetooth_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300594 attribute, and its current status can also be queried.
595
596 enable:
597 0: disables Bluetooth / Bluetooth is disabled
598 1: enables Bluetooth / Bluetooth is enabled.
599
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200600 Note: this interface will be probably be superseded by the
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300601 generic rfkill class, so it is NOT to be considered stable yet.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603Video output control -- /proc/acpi/ibm/video
604--------------------------------------------
605
606This feature allows control over the devices used for video output -
607LCD, CRT or DVI (if available). The following commands are available:
608
609 echo lcd_enable > /proc/acpi/ibm/video
610 echo lcd_disable > /proc/acpi/ibm/video
611 echo crt_enable > /proc/acpi/ibm/video
612 echo crt_disable > /proc/acpi/ibm/video
613 echo dvi_enable > /proc/acpi/ibm/video
614 echo dvi_disable > /proc/acpi/ibm/video
615 echo auto_enable > /proc/acpi/ibm/video
616 echo auto_disable > /proc/acpi/ibm/video
617 echo expand_toggle > /proc/acpi/ibm/video
618 echo video_switch > /proc/acpi/ibm/video
619
620Each video output device can be enabled or disabled individually.
621Reading /proc/acpi/ibm/video shows the status of each device.
622
623Automatic video switching can be enabled or disabled. When automatic
624video switching is enabled, certain events (e.g. opening the lid,
625docking or undocking) cause the video output device to change
626automatically. While this can be useful, it also causes flickering
627and, on the X40, video corruption. By disabling automatic switching,
628the flickering or video corruption can be avoided.
629
630The video_switch command cycles through the available video outputs
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400631(it simulates the behavior of Fn-F7).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633Video expansion can be toggled through this feature. This controls
634whether the display is expanded to fill the entire LCD screen when a
635mode with less than full resolution is used. Note that the current
636video expansion status cannot be determined through this feature.
637
638Note that on many models (particularly those using Radeon graphics
639chips) the X driver configures the video card in a way which prevents
640Fn-F7 from working. This also disables the video output switching
641features of this driver, as it uses the same ACPI methods as
642Fn-F7. Video switching on the console should still work.
643
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400644UPDATE: There's now a patch for the X.org Radeon driver which
645addresses this issue. Some people are reporting success with the patch
646while others are still having problems. For more information:
647
648https://bugs.freedesktop.org/show_bug.cgi?id=2000
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650ThinkLight control -- /proc/acpi/ibm/light
651------------------------------------------
652
653The current status of the ThinkLight can be found in this file. A few
654models which do not make the status available will show it as
655"unknown". The available commands are:
656
657 echo on > /proc/acpi/ibm/light
658 echo off > /proc/acpi/ibm/light
659
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400660Docking / undocking -- /proc/acpi/ibm/dock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661------------------------------------------
662
663Docking and undocking (e.g. with the X4 UltraBase) requires some
664actions to be taken by the operating system to safely make or break
665the electrical connections with the dock.
666
667The docking feature of this driver generates the following ACPI events:
668
669 ibm/dock GDCK 00000003 00000001 -- eject request
670 ibm/dock GDCK 00000003 00000002 -- undocked
671 ibm/dock GDCK 00000000 00000003 -- docked
672
673NOTE: These events will only be generated if the laptop was docked
674when originally booted. This is due to the current lack of support for
675hot plugging of devices in the Linux ACPI framework. If the laptop was
676booted while not in the dock, the following message is shown in the
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400677logs:
678
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -0300679 Mar 17 01:42:34 aero kernel: thinkpad_acpi: dock device not present
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400680
681In this case, no dock-related events are generated but the dock and
682undock commands described below still work. They can be executed
683manually or triggered by Fn key combinations (see the example acpid
684configuration files included in the driver tarball package available
685on the web site).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
687When the eject request button on the dock is pressed, the first event
688above is generated. The handler for this event should issue the
689following command:
690
691 echo undock > /proc/acpi/ibm/dock
692
693After the LED on the dock goes off, it is safe to eject the laptop.
694Note: if you pressed this key by mistake, go ahead and eject the
695laptop, then dock it back in. Otherwise, the dock may not function as
696expected.
697
698When the laptop is docked, the third event above is generated. The
699handler for this event should issue the following command to fully
700enable the dock:
701
702 echo dock > /proc/acpi/ibm/dock
703
704The contents of the /proc/acpi/ibm/dock file shows the current status
705of the dock, as provided by the ACPI framework.
706
707The docking support in this driver does not take care of enabling or
708disabling any other devices you may have attached to the dock. For
709example, a CD drive plugged into the UltraBase needs to be disabled or
710enabled separately. See the provided example acpid configuration files
711for how this can be accomplished.
712
713There is no support yet for PCI devices that may be attached to a
714docking station, e.g. in the ThinkPad Dock II. The driver currently
715does not recognize, enable or disable such devices. This means that
716the only docking stations currently supported are the X-series
717UltraBase docks and "dumb" port replicators like the Mini Dock (the
718latter don't need any ACPI support, actually).
719
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400720UltraBay eject -- /proc/acpi/ibm/bay
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721------------------------------------
722
723Inserting or ejecting an UltraBay device requires some actions to be
724taken by the operating system to safely make or break the electrical
725connections with the device.
726
727This feature generates the following ACPI events:
728
729 ibm/bay MSTR 00000003 00000000 -- eject request
730 ibm/bay MSTR 00000001 00000000 -- eject lever inserted
731
732NOTE: These events will only be generated if the UltraBay was present
733when the laptop was originally booted (on the X series, the UltraBay
734is in the dock, so it may not be present if the laptop was undocked).
735This is due to the current lack of support for hot plugging of devices
736in the Linux ACPI framework. If the laptop was booted without the
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400737UltraBay, the following message is shown in the logs:
738
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -0300739 Mar 17 01:42:34 aero kernel: thinkpad_acpi: bay device not present
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400740
741In this case, no bay-related events are generated but the eject
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742command described below still works. It can be executed manually or
743triggered by a hot key combination.
744
745Sliding the eject lever generates the first event shown above. The
746handler for this event should take whatever actions are necessary to
747shut down the device in the UltraBay (e.g. call idectl), then issue
748the following command:
749
750 echo eject > /proc/acpi/ibm/bay
751
752After the LED on the UltraBay goes off, it is safe to pull out the
753device.
754
755When the eject lever is inserted, the second event above is
756generated. The handler for this event should take whatever actions are
757necessary to enable the UltraBay device (e.g. call idectl).
758
759The contents of the /proc/acpi/ibm/bay file shows the current status
760of the UltraBay, as provided by the ACPI framework.
761
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400762EXPERIMENTAL warm eject support on the 600e/x, A22p and A3x (To use
763this feature, you need to supply the experimental=1 parameter when
764loading the module):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400766These models do not have a button near the UltraBay device to request
767a hot eject but rather require the laptop to be put to sleep
768(suspend-to-ram) before the bay device is ejected or inserted).
769The sequence of steps to eject the device is as follows:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400771 echo eject > /proc/acpi/ibm/bay
772 put the ThinkPad to sleep
773 remove the drive
774 resume from sleep
775 cat /proc/acpi/ibm/bay should show that the drive was removed
776
777On the A3x, both the UltraBay 2000 and UltraBay Plus devices are
778supported. Use "eject2" instead of "eject" for the second bay.
779
780Note: the UltraBay eject support on the 600e/x, A22p and A3x is
781EXPERIMENTAL and may not work as expected. USE WITH CAUTION!
782
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300783CMOS control
784------------
785
786procfs: /proc/acpi/ibm/cmos
787sysfs device attribute: cmos_command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300789This feature is mostly used internally by the ACPI firmware to keep the legacy
790CMOS NVRAM bits in sync with the current machine state, and to record this
791state so that the ThinkPad will retain such settings across reboots.
792
793Some of these commands actually perform actions in some ThinkPad models, but
794this is expected to disappear more and more in newer models. As an example, in
795a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
796real, but commands 0 to 2 don't control the mixer anymore (they have been
797phased out) and just update the NVRAM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300799The range of valid cmos command numbers is 0 to 21, but not all have an
800effect and the behavior varies from model to model. Here is the behavior
801on the X40 (tpb is the ThinkPad Buttons utility):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300803 0 - Related to "Volume down" key press
804 1 - Related to "Volume up" key press
805 2 - Related to "Mute on" key press
806 3 - Related to "Access IBM" key press
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200807 4 - Related to "LCD brightness up" key press
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300808 5 - Related to "LCD brightness down" key press
809 11 - Related to "toggle screen expansion" key press/function
810 12 - Related to "ThinkLight on"
811 13 - Related to "ThinkLight off"
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200812 14 - Related to "ThinkLight" key press (toggle ThinkLight)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300814The cmos command interface is prone to firmware split-brain problems, as
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300815in newer ThinkPads it is just a compatibility layer. Do not use it, it is
816exported just as a debug tool.
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300817
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400818LED control -- /proc/acpi/ibm/led
819---------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821Some of the LED indicators can be controlled through this feature. The
822available commands are:
823
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400824 echo '<led number> on' >/proc/acpi/ibm/led
825 echo '<led number> off' >/proc/acpi/ibm/led
826 echo '<led number> blink' >/proc/acpi/ibm/led
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400828The <led number> range is 0 to 7. The set of LEDs that can be
829controlled varies from model to model. Here is the mapping on the X40:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
831 0 - power
832 1 - battery (orange)
833 2 - battery (green)
834 3 - UltraBase
835 4 - UltraBay
836 7 - standby
837
838All of the above can be turned on and off and can be made to blink.
839
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400840ACPI sounds -- /proc/acpi/ibm/beep
841----------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
843The BEEP method is used internally by the ACPI firmware to provide
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400844audible alerts in various situations. This feature allows the same
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845sounds to be triggered manually.
846
847The commands are non-negative integer numbers:
848
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400849 echo <number> >/proc/acpi/ibm/beep
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400851The valid <number> range is 0 to 17. Not all numbers trigger sounds
852and the sounds vary from model to model. Here is the behavior on the
853X40:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400855 0 - stop a sound in progress (but use 17 to stop 16)
856 2 - two beeps, pause, third beep ("low battery")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 3 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400858 4 - high, followed by low-pitched beep ("unable")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 5 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400860 6 - very high, followed by high-pitched beep ("AC/DC")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 7 - high-pitched beep
862 9 - three short beeps
863 10 - very long beep
864 12 - low-pitched beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400865 15 - three high-pitched beeps repeating constantly, stop with 0
866 16 - one medium-pitched beep repeating constantly, stop with 17
867 17 - stop 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300869Temperature sensors
870-------------------
871
872procfs: /proc/acpi/ibm/thermal
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300873sysfs device attributes: (hwmon "thinkpad") temp*_input
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300875Most ThinkPads include six or more separate temperature sensors but only
876expose the CPU temperature through the standard ACPI methods. This
877feature shows readings from up to eight different sensors on older
878ThinkPads, and up to sixteen different sensors on newer ThinkPads.
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200879
880For example, on the X40, a typical output may be:
881temperatures: 42 42 45 41 36 -128 33 -128
882
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300883On the T43/p, a typical output may be:
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200884temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
885
886The mapping of thermal sensors to physical locations varies depending on
887system-board model (and thus, on ThinkPad model).
888
889http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
890tries to track down these locations for various models.
891
892Most (newer?) models seem to follow this pattern:
893
8941: CPU
8952: (depends on model)
8963: (depends on model)
8974: GPU
8985: Main battery: main sensor
8996: Bay battery: main sensor
9007: Main battery: secondary sensor
9018: Bay battery: secondary sensor
9029-15: (depends on model)
903
904For the R51 (source: Thomas Gruber):
9052: Mini-PCI
9063: Internal HDD
907
908For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
909http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
9102: System board, left side (near PCMCIA slot), reported as HDAPS temp
9113: PCMCIA slot
9129: MCH (northbridge) to DRAM Bus
Henrique de Moraes Holschuhb8b26402007-07-18 23:45:28 -030091310: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
914 card, under touchpad
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -020091511: Power regulator, underside of system board, below F2 key
916
Henrique de Moraes Holschuh88679a12006-11-24 11:47:09 -0200917The A31 has a very atypical layout for the thermal sensors
918(source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
9191: CPU
9202: Main Battery: main sensor
9213: Power Converter
9224: Bay Battery: main sensor
9235: MCH (northbridge)
9246: PCMCIA/ambient
9257: Main Battery: secondary sensor
9268: Bay Battery: secondary sensor
927
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200928
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300929Procfs notes:
930 Readings from sensors that are not available return -128.
931 No commands can be written to this file.
932
933Sysfs notes:
934 Sensors that are not available return the ENXIO error. This
935 status may change at runtime, as there are hotplug thermal
936 sensors, like those inside the batteries and docks.
937
938 thinkpad-acpi thermal sensors are reported through the hwmon
939 subsystem, and follow all of the hwmon guidelines at
940 Documentation/hwmon.
941
942
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +0200943EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400944------------------------------------------------------------------------
945
946This feature is marked EXPERIMENTAL because the implementation
947directly accesses hardware registers and may not work as expected. USE
948WITH CAUTION! To use this feature, you need to supply the
949experimental=1 parameter when loading the module.
950
951This feature dumps the values of 256 embedded controller
952registers. Values which have changed since the last time the registers
953were dumped are marked with a star:
954
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -0300955[root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400956EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
957EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
958EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
959EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
960EC 0x30: 01 07 1a 00 30 04 00 00 *85 00 00 10 00 50 00 00
961EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
962EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 *bc *02 *bc
963EC 0x60: *02 *bc *02 00 00 00 00 00 00 00 00 00 00 00 00 00
964EC 0x70: 00 00 00 00 00 12 30 40 *24 *26 *2c *27 *20 80 *1f 80
965EC 0x80: 00 00 00 06 *37 *0e 03 00 00 00 0e 07 00 00 00 00
966EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
967EC 0xa0: *ff 09 ff 09 ff ff *64 00 *00 *00 *a2 41 *ff *ff *e0 00
968EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
969EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
970EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
971EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
972EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
973
974This feature can be used to determine the register holding the fan
975speed on some models. To do that, do the following:
976
977 - make sure the battery is fully charged
978 - make sure the fan is running
979 - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
980
981The first step makes sure various charging-related values don't
982vary. The second ensures that the fan-related values do vary, since
983the fan speed fluctuates a bit. The third will (hopefully) mark the
984fan register with a star:
985
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -0300986[root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400987EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
988EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
989EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
990EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
991EC 0x30: 01 07 1a 00 30 04 00 00 85 00 00 10 00 50 00 00
992EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
993EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 bc 02 bc
994EC 0x60: 02 bc 02 00 00 00 00 00 00 00 00 00 00 00 00 00
995EC 0x70: 00 00 00 00 00 12 30 40 24 27 2c 27 21 80 1f 80
996EC 0x80: 00 00 00 06 *be 0d 03 00 00 00 0e 07 00 00 00 00
997EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
998EC 0xa0: ff 09 ff 09 ff ff 64 00 00 00 a2 41 ff ff e0 00
999EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
1000EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
1001EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
1002EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
1003EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
1004
1005Another set of values that varies often is the temperature
1006readings. Since temperatures don't change vary fast, you can take
1007several quick dumps to eliminate them.
1008
1009You can use a similar method to figure out the meaning of other
1010embedded controller registers - e.g. make sure nothing else changes
1011except the charging or discharging battery to determine which
1012registers contain the current battery capacity, etc. If you experiment
1013with this, do send me your results (including some complete dumps with
1014a description of the conditions when they were taken.)
1015
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001016LCD brightness control
1017----------------------
1018
1019procfs: /proc/acpi/ibm/brightness
1020sysfs backlight device "thinkpad_screen"
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001021
1022This feature allows software control of the LCD brightness on ThinkPad
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001023models which don't have a hardware brightness slider.
1024
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001025It has some limitations: the LCD backlight cannot be actually turned on or
1026off by this interface, and in many ThinkPad models, the "dim while on
1027battery" functionality will be enabled by the BIOS when this interface is
1028used, and cannot be controlled.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001029
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001030On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
1031has eight brightness levels, ranging from 0 to 7. Some of the levels
1032may not be distinct. Later Lenovo models that implement the ACPI
1033display backlight brightness control methods have 16 levels, ranging
1034from 0 to 15.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001035
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001036There are two interfaces to the firmware for direct brightness control,
1037EC and CMOS. To select which one should be used, use the
1038brightness_mode module parameter: brightness_mode=1 selects EC mode,
1039brightness_mode=2 selects CMOS mode, brightness_mode=3 selects both EC
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001040and CMOS. The driver tries to auto-detect which interface to use.
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001041
1042When display backlight brightness controls are available through the
1043standard ACPI interface, it is best to use it instead of this direct
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -02001044ThinkPad-specific interface. The driver will disable its native
1045backlight brightness control interface if it detects that the standard
1046ACPI interface is available in the ThinkPad.
Henrique de Moraes Holschuh24d3b772007-07-18 23:45:43 -03001047
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -02001048The brightness_enable module parameter can be used to control whether
1049the LCD brightness control feature will be enabled when available.
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -02001050brightness_enable=0 forces it to be disabled. brightness_enable=1
1051forces it to be enabled when available, even if the standard ACPI
1052interface is also available.
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -02001053
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001054Procfs notes:
1055
1056 The available commands are:
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001057
1058 echo up >/proc/acpi/ibm/brightness
1059 echo down >/proc/acpi/ibm/brightness
1060 echo 'level <level>' >/proc/acpi/ibm/brightness
1061
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001062Sysfs notes:
1063
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001064The interface is implemented through the backlight sysfs class, which is
1065poorly documented at this time.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001066
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001067Locate the thinkpad_screen device under /sys/class/backlight, and inside
1068it there will be the following attributes:
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001069
1070 max_brightness:
1071 Reads the maximum brightness the hardware can be set to.
1072 The minimum is always zero.
1073
1074 actual_brightness:
1075 Reads what brightness the screen is set to at this instant.
1076
1077 brightness:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001078 Writes request the driver to change brightness to the
1079 given value. Reads will tell you what brightness the
1080 driver is trying to set the display to when "power" is set
1081 to zero and the display has not been dimmed by a kernel
1082 power management event.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001083
1084 power:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001085 power management mode, where 0 is "display on", and 1 to 3
1086 will dim the display backlight to brightness level 0
1087 because thinkpad-acpi cannot really turn the backlight
1088 off. Kernel power management events can temporarily
1089 increase the current power management level, i.e. they can
1090 dim the display.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001091
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001092
Stefan Schmidt24f7ff02006-09-22 12:19:15 +02001093Volume control -- /proc/acpi/ibm/volume
1094---------------------------------------
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001095
1096This feature allows volume control on ThinkPad models which don't have
1097a hardware volume knob. The available commands are:
1098
1099 echo up >/proc/acpi/ibm/volume
1100 echo down >/proc/acpi/ibm/volume
1101 echo mute >/proc/acpi/ibm/volume
1102 echo 'level <level>' >/proc/acpi/ibm/volume
1103
1104The <level> number range is 0 to 15 although not all of them may be
1105distinct. The unmute the volume after the mute command, use either the
1106up or down command (the level command will not unmute the volume).
1107The current volume level and mute state is shown in the file.
1108
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001109Fan control and monitoring: fan speed, fan enable/disable
1110---------------------------------------------------------
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001111
1112procfs: /proc/acpi/ibm/fan
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001113sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
1114 pwm1_enable
1115sysfs hwmon driver attributes: fan_watchdog
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001116
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001117NOTE NOTE NOTE: fan control operations are disabled by default for
1118safety reasons. To enable them, the module parameter "fan_control=1"
1119must be given to thinkpad-acpi.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001120
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001121This feature attempts to show the current fan speed, control mode and
1122other fan data that might be available. The speed is read directly
1123from the hardware registers of the embedded controller. This is known
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001124to work on later R, T, X and Z series ThinkPads but may show a bogus
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001125value on other models.
1126
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001127Fan levels:
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001128
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001129Most ThinkPad fans work in "levels" at the firmware interface. Level 0
1130stops the fan. The higher the level, the higher the fan speed, although
1131adjacent levels often map to the same fan speed. 7 is the highest
1132level, where the fan reaches the maximum recommended speed.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001133
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001134Level "auto" means the EC changes the fan level according to some
1135internal algorithm, usually based on readings from the thermal sensors.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001136
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001137There is also a "full-speed" level, also known as "disengaged" level.
1138In this level, the EC disables the speed-locked closed-loop fan control,
1139and drives the fan as fast as it can go, which might exceed hardware
1140limits, so use this level with caution.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001141
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001142The fan usually ramps up or down slowly from one speed to another, and
1143it is normal for the EC to take several seconds to react to fan
1144commands. The full-speed level may take up to two minutes to ramp up to
1145maximum speed, and in some ThinkPads, the tachometer readings go stale
1146while the EC is transitioning to the full-speed level.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001147
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001148WARNING WARNING WARNING: do not leave the fan disabled unless you are
1149monitoring all of the temperature sensor readings and you are ready to
1150enable it if necessary to avoid overheating.
1151
1152An enabled fan in level "auto" may stop spinning if the EC decides the
1153ThinkPad is cool enough and doesn't need the extra airflow. This is
Matt LaPlante01dd2fb2007-10-20 01:34:40 +02001154normal, and the EC will spin the fan up if the various thermal readings
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001155rise too much.
1156
1157On the X40, this seems to depend on the CPU and HDD temperatures.
1158Specifically, the fan is turned on when either the CPU temperature
1159climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The
1160fan is turned off when the CPU temperature drops to 49 degrees and the
1161HDD temperature drops to 41 degrees. These thresholds cannot
1162currently be controlled.
1163
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001164The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
1165certain conditions are met. It will override any fan programming done
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001166through thinkpad-acpi.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001168The thinkpad-acpi kernel driver can be programmed to revert the fan
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001169level to a safe setting if userspace does not issue one of the procfs
1170fan commands: "enable", "disable", "level" or "watchdog", or if there
1171are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
1172set to 1, manual mode) within a configurable amount of time of up to
1173120 seconds. This functionality is called fan safety watchdog.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001174
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001175Note that the watchdog timer stops after it enables the fan. It will be
1176rearmed again automatically (using the same interval) when one of the
1177above mentioned fan commands is received. The fan watchdog is,
1178therefore, not suitable to protect against fan mode changes made through
1179means other than the "enable", "disable", and "level" procfs fan
1180commands, or the hwmon fan control sysfs interface.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001181
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001182Procfs notes:
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001183
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001184The fan may be enabled or disabled with the following commands:
1185
1186 echo enable >/proc/acpi/ibm/fan
1187 echo disable >/proc/acpi/ibm/fan
1188
1189Placing a fan on level 0 is the same as disabling it. Enabling a fan
1190will try to place it in a safe level if it is too slow or disabled.
1191
1192The fan level can be controlled with the command:
1193
1194 echo 'level <level>' > /proc/acpi/ibm/fan
1195
1196Where <level> is an integer from 0 to 7, or one of the words "auto" or
1197"full-speed" (without the quotes). Not all ThinkPads support the "auto"
1198and "full-speed" levels. The driver accepts "disengaged" as an alias for
1199"full-speed", and reports it as "disengaged" for backwards
1200compatibility.
1201
1202On the X31 and X40 (and ONLY on those models), the fan speed can be
1203controlled to a certain degree. Once the fan is running, it can be
1204forced to run faster or slower with the following command:
1205
1206 echo 'speed <speed>' > /proc/acpi/ibm/fan
1207
1208The sustainable range of fan speeds on the X40 appears to be from about
12093700 to about 7350. Values outside this range either do not have any
1210effect or the fan speed eventually settles somewhere in that range. The
1211fan cannot be stopped or started with this command. This functionality
1212is incomplete, and not available through the sysfs interface.
1213
1214To program the safety watchdog, use the "watchdog" command.
1215
1216 echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1217
1218If you want to disable the watchdog, use 0 as the interval.
1219
1220Sysfs notes:
1221
1222The sysfs interface follows the hwmon subsystem guidelines for the most
1223part, and the exception is the fan safety watchdog.
1224
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001225Writes to any of the sysfs attributes may return the EINVAL error if
1226that operation is not supported in a given ThinkPad or if the parameter
1227is out-of-bounds, and EPERM if it is forbidden. They may also return
1228EINTR (interrupted system call), and EIO (I/O error while trying to talk
1229to the firmware).
1230
1231Features not yet implemented by the driver return ENOSYS.
1232
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001233hwmon device attribute pwm1_enable:
1234 0: PWM offline (fan is set to full-speed mode)
1235 1: Manual PWM control (use pwm1 to set fan level)
1236 2: Hardware PWM control (EC "auto" mode)
1237 3: reserved (Software PWM control, not implemented yet)
1238
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001239 Modes 0 and 2 are not supported by all ThinkPads, and the
1240 driver is not always able to detect this. If it does know a
1241 mode is unsupported, it will return -EINVAL.
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001242
1243hwmon device attribute pwm1:
1244 Fan level, scaled from the firmware values of 0-7 to the hwmon
1245 scale of 0-255. 0 means fan stopped, 255 means highest normal
1246 speed (level 7).
1247
1248 This attribute only commands the fan if pmw1_enable is set to 1
1249 (manual PWM control).
1250
1251hwmon device attribute fan1_input:
1252 Fan tachometer reading, in RPM. May go stale on certain
1253 ThinkPads while the EC transitions the PWM to offline mode,
1254 which can take up to two minutes. May return rubbish on older
1255 ThinkPads.
1256
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001257hwmon driver attribute fan_watchdog:
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001258 Fan safety watchdog timer interval, in seconds. Minimum is
1259 1 second, maximum is 120 seconds. 0 disables the watchdog.
1260
1261To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
1262
1263To start the fan in a safe mode: set pwm1_enable to 2. If that fails
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001264with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
1265would be the safest choice, though).
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001266
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001267
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001268EXPERIMENTAL: WAN
1269-----------------
1270
1271procfs: /proc/acpi/ibm/wan
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001272sysfs device attribute: wwan_enable
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001273
1274This feature is marked EXPERIMENTAL because the implementation
1275directly accesses hardware registers and may not work as expected. USE
1276WITH CAUTION! To use this feature, you need to supply the
1277experimental=1 parameter when loading the module.
1278
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001279This feature shows the presence and current state of a W-WAN (Sierra
1280Wireless EV-DO) device.
1281
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001282It was tested on a Lenovo ThinkPad X60. It should probably work on other
1283ThinkPad models which come with this module installed.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001284
1285Procfs notes:
1286
1287If the W-WAN card is installed, the following commands can be used:
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001288
1289 echo enable > /proc/acpi/ibm/wan
1290 echo disable > /proc/acpi/ibm/wan
1291
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001292Sysfs notes:
1293
1294 If the W-WAN card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001295 disabled through the "wwan_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001296 attribute, and its current status can also be queried.
1297
1298 enable:
1299 0: disables WWAN card / WWAN card is disabled
1300 1: enables WWAN card / WWAN card is enabled.
1301
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001302 Note: this interface will be probably be superseded by the
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001303 generic rfkill class, so it is NOT to be considered stable yet.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001305Multiple Commands, Module Parameters
1306------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
1308Multiple commands can be written to the proc files in one shot by
1309separating them with commas, for example:
1310
1311 echo enable,0xffff > /proc/acpi/ibm/hotkey
1312 echo lcd_disable,crt_enable > /proc/acpi/ibm/video
1313
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001314Commands can also be specified when loading the thinkpad-acpi module,
1315for example:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001317 modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001319Enabling debugging output
1320-------------------------
1321
Simon Arlott0f035b82007-10-20 01:30:25 +02001322The module takes a debug parameter which can be used to selectively
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001323enable various classes of debugging output, for example:
1324
Henrique de Moraes Holschuh5f249272008-02-16 02:17:51 -02001325 modprobe thinkpad_acpi debug=0xffff
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001326
1327will enable all debugging output classes. It takes a bitmask, so
1328to enable more than one output class, just add their values.
1329
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001330 Debug bitmask Description
1331 0x0001 Initialization and probing
1332 0x0002 Removal
1333
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001334There is also a kernel build option to enable more debugging
1335information, which may be necessary to debug driver problems.
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001336
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001337The level of debugging information output by the driver can be changed
1338at runtime through sysfs, using the driver attribute debug_level. The
1339attribute takes the same bitmask as the debug module parameter above.
1340
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001341Force loading of module
1342-----------------------
1343
1344If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1345the module parameter force_load=1. Regardless of whether this works or
1346not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001347
1348
1349Sysfs interface changelog:
1350
13510x000100: Initial sysfs support, as a single platform driver and
1352 device.
Henrique de Moraes Holschuh94b08712007-07-18 23:45:32 -030013530x000200: Hot key support for 32 hot keys, and radio slider switch
1354 support.
Henrique de Moraes Holschuh741553c2007-07-18 23:45:39 -030013550x010000: Hot keys are now handled by default over the input
1356 layer, the radio switch generates input event EV_RADIO,
1357 and the driver enables hot key handling by default in
1358 the firmware.
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001359
13600x020000: ABI fix: added a separate hwmon platform device and
1361 driver, which must be located by name (thinkpad)
1362 and the hwmon class for libsensors4 (lm-sensors 3)
1363 compatibility. Moved all hwmon attributes to this
1364 new platform device.
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001365
13660x020100: Marker for thinkpad-acpi with hot key NVRAM polling
1367 support. If you must, use it to know you should not
1368 start an userspace NVRAM poller (allows to detect when
1369 NVRAM is compiled out by the user because it is
1370 unneeded/undesired in the first place).
13710x020101: Marker for thinkpad-acpi with hot key NVRAM polling
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001372 and proper hotkey_mask semantics (version 8 of the
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001373 NVRAM polling patch). Some development snapshots of
1374 0.18 had an earlier version that did strange things
1375 to hotkey_mask.
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -02001376
13770x020200: Add poll()/select() support to the following attributes:
1378 hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason