blob: 606af162838220c812dc6c47539ea7d6b6895efb [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 Holschuhff80f132007-09-04 11:13:15 -0300316 hotkey_report_mode:
317 Returns the state of the procfs ACPI event report mode
318 filter for hot keys. If it is set to 1 (the default),
319 all hot key presses are reported both through the input
320 layer and also as ACPI events through procfs (but not
321 through netlink). If it is set to 2, hot key presses
322 are reported only through the input layer.
323
324 This attribute is read-only in kernels 2.6.23 or later,
325 and read-write on earlier kernels.
326
327 May return -EPERM (write access locked out by module
328 parameter) or -EACCES (read-only).
329
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200330 wakeup_reason:
331 Set to 1 if the system is waking up because the user
332 requested a bay ejection. Set to 2 if the system is
333 waking up because the user requested the system to
334 undock. Set to zero for normal wake-ups or wake-ups
335 due to unknown reasons.
336
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200337 This attribute has poll()/select() support.
338
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200339 wakeup_hotunplug_complete:
340 Set to 1 if the system was waken up because of an
341 undock or bay ejection request, and that request
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200342 was successfully completed. At this point, it might
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -0200343 be useful to send the system back to sleep, at the
344 user's choice. Refer to HKEY events 0x4003 and
345 0x3003, below.
346
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -0200347 This attribute has poll()/select() support.
348
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300349input layer notes:
350
351A Hot key is mapped to a single input layer EV_KEY event, possibly
352followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
353code. An EV_SYN event will always be generated to mark the end of the
354event block.
355
356Do not use the EV_MSC MSC_SCAN events to process keys. They are to be
357used as a helper to remap keys, only. They are particularly useful when
358remapping KEY_UNKNOWN keys.
359
360The events are available in an input device, with the following id:
361
362 Bus: BUS_HOST
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300363 vendor: 0x1014 (PCI_VENDOR_ID_IBM) or
364 0x17aa (PCI_VENDOR_ID_LENOVO)
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300365 product: 0x5054 ("TP")
366 version: 0x4101
367
368The version will have its LSB incremented if the keymap changes in a
369backwards-compatible way. The MSB shall always be 0x41 for this input
370device. If the MSB is not 0x41, do not use the device as described in
371this section, as it is either something else (e.g. another input device
372exported by a thinkpad driver, such as HDAPS) or its functionality has
373been changed in a non-backwards compatible way.
374
375Adding other event types for other functionalities shall be considered a
376backwards-compatible change for this input device.
377
378Thinkpad-acpi Hot Key event map (version 0x4101):
379
380ACPI Scan
381event code Key Notes
382
3830x1001 0x00 FN+F1 -
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03003840x1002 0x01 FN+F2 IBM: battery (rare)
385 Lenovo: Screen lock
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300386
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03003870x1003 0x02 FN+F3 Many IBM models always report
388 this hot key, even with hot keys
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300389 disabled or with Fn+F3 masked
390 off
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300391 IBM: screen lock
392 Lenovo: battery
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300393
3940x1004 0x03 FN+F4 Sleep button (ACPI sleep button
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200395 semantics, i.e. sleep-to-RAM).
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300396 It is always generate some kind
397 of event, either the hot key
398 event or a ACPI sleep button
399 event. The firmware may
400 refuse to generate further FN+F4
401 key presses until a S3 or S4 ACPI
402 sleep cycle is performed or some
403 time passes.
404
4050x1005 0x04 FN+F5 Radio. Enables/disables
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200406 the internal Bluetooth hardware
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300407 and W-WAN card if left in control
408 of the firmware. Does not affect
409 the WLAN card.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300410 Should be used to turn on/off all
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200411 radios (Bluetooth+W-WAN+WLAN),
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300412 really.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300413
4140x1006 0x05 FN+F6 -
415
4160x1007 0x06 FN+F7 Video output cycle.
417 Do you feel lucky today?
418
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -03004190x1008 0x07 FN+F8 IBM: toggle screen expand
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200420 Lenovo: configure UltraNav
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300421
4220x1009 0x08 FN+F9 -
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300423 .. .. ..
4240x100B 0x0A FN+F11 -
425
4260x100C 0x0B FN+F12 Sleep to disk. You are always
427 supposed to handle it yourself,
428 either through the ACPI event,
429 or through a hotkey event.
430 The firmware may refuse to
431 generate further FN+F4 key
432 press events until a S3 or S4
433 ACPI sleep cycle is performed,
434 or some time passes.
435
4360x100D 0x0C FN+BACKSPACE -
4370x100E 0x0D FN+INSERT -
4380x100F 0x0E FN+DELETE -
439
4400x1010 0x0F FN+HOME Brightness up. This key is
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300441 always handled by the firmware
442 in IBM ThinkPads, even when
443 unmasked. Just leave it alone.
444 For Lenovo ThinkPads with a new
445 BIOS, it has to be handled either
446 by the ACPI OSI, or by userspace.
4470x1011 0x10 FN+END Brightness down. See brightness
448 up for details.
449
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004500x1012 0x11 FN+PGUP ThinkLight toggle. This key is
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300451 always handled by the firmware,
452 even when unmasked.
453
4540x1013 0x12 FN+PGDOWN -
455
4560x1014 0x13 FN+SPACE Zoom key
457
4580x1015 0x14 VOLUME UP Internal mixer volume up. This
459 key is always handled by the
460 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300461 NOTE: Lenovo seems to be changing
462 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004630x1016 0x15 VOLUME DOWN Internal mixer volume up. This
464 key is always handled by the
465 firmware, even when unmasked.
Henrique de Moraes Holschuhedf0e0e2007-07-18 23:45:44 -0300466 NOTE: Lenovo seems to be changing
467 this.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03004680x1017 0x16 MUTE Mute internal mixer. This
469 key is always handled by the
470 firmware, even when unmasked.
471
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02004720x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300473
4740x1019 0x18 unknown
475.. .. ..
4760x1020 0x1F unknown
477
478The ThinkPad firmware does not allow one to differentiate when most hot
479keys are pressed or released (either that, or we don't know how to, yet).
480For these keys, the driver generates a set of events for a key press and
481immediately issues the same set of events for a key release. It is
482unknown by the driver if the ThinkPad firmware triggered these events on
483hot key press or release, but the firmware will do it for either one, not
484both.
485
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300486If a key is mapped to KEY_RESERVED, it generates no input events at all.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300487If a key is mapped to KEY_UNKNOWN, it generates an input event that
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300488includes an scan code. If a key is mapped to anything else, it will
489generate input device EV_KEY events.
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300490
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200491In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
492events for switches:
493
494SW_RADIO T60 and later hardare rfkill rocker switch
495SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A
496
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -0300497Non hot-key ACPI HKEY event map:
4980x5001 Lid closed
4990x5002 Lid opened
Henrique de Moraes Holschuhb3ec6f92008-02-16 02:17:55 -02005000x5009 Tablet swivel: switched to tablet mode
5010x500A Tablet swivel: switched to normal mode
Henrique de Moraes Holschuh6a38abb2007-07-18 23:45:35 -03005020x7000 Radio Switch may have changed state
503
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300504The above events are not propagated by the driver, except for legacy
505compatibility purposes when hotkey_report_mode is set to 1.
506
Henrique de Moraes Holschuha713b4d2008-01-08 13:02:52 -02005070x2304 System is waking up from suspend to undock
5080x2305 System is waking up from suspend to eject bay
5090x2404 System is waking up from hibernation to undock
5100x2405 System is waking up from hibernation to eject bay
511
512The above events are never propagated by the driver.
513
5140x3003 Bay ejection (see 0x2x05) complete, can sleep again
5150x4003 Undocked (see 0x2x04), can sleep again
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02005160x500B Tablet pen inserted into its storage bay
Henrique de Moraes Holschuhd1edb2b2008-01-08 13:02:53 -02005170x500C Tablet pen removed from its storage bay
Henrique de Moraes Holschuh3b64b512008-01-08 13:02:51 -02005180x5010 Brightness level changed (newer Lenovo BIOSes)
519
520The above events are propagated by the driver.
521
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300522Compatibility notes:
523
524ibm-acpi and thinkpad-acpi 0.15 (mainline kernels before 2.6.23) never
525supported the input layer, and sent events over the procfs ACPI event
526interface.
527
528To avoid sending duplicate events over the input layer and the ACPI
529event interface, thinkpad-acpi 0.16 implements a module parameter
530(hotkey_report_mode), and also a sysfs device attribute with the same
531name.
532
533Make no mistake here: userspace is expected to switch to using the input
534layer interface of thinkpad-acpi, together with the ACPI netlink event
535interface in kernels 2.6.23 and later, or with the ACPI procfs event
536interface in kernels 2.6.22 and earlier.
537
538If no hotkey_report_mode module parameter is specified (or it is set to
539zero), the driver defaults to mode 1 (see below), and on kernels 2.6.22
540and earlier, also allows one to change the hotkey_report_mode through
541sysfs. In kernels 2.6.23 and later, where the netlink ACPI event
542interface is available, hotkey_report_mode cannot be changed through
543sysfs (it is read-only).
544
545If the hotkey_report_mode module parameter is set to 1 or 2, it cannot
546be changed later through sysfs (any writes will return -EPERM to signal
547that hotkey_report_mode was locked. On 2.6.23 and later, where
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200548hotkey_report_mode cannot be changed at all, writes will return -EACCES).
Henrique de Moraes Holschuhff80f132007-09-04 11:13:15 -0300549
550hotkey_report_mode set to 1 makes the driver export through the procfs
551ACPI event interface all hot key presses (which are *also* sent to the
552input layer). This is a legacy compatibility behaviour, and it is also
553the default mode of operation for the driver.
554
555hotkey_report_mode set to 2 makes the driver filter out the hot key
556presses from the procfs ACPI event interface, so these events will only
557be sent through the input layer. Userspace that has been updated to use
558the thinkpad-acpi input layer interface should set hotkey_report_mode to
5592.
560
561Hot key press events are never sent to the ACPI netlink event interface.
562Really up-to-date userspace under kernel 2.6.23 and later is to use the
563netlink interface and the input layer interface, and don't bother at all
564with hotkey_report_mode.
565
Henrique de Moraes Holschuha0416422007-04-27 22:00:16 -0300566
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300567Bluetooth
568---------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300570procfs: /proc/acpi/ibm/bluetooth
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300571sysfs device attribute: bluetooth_enable
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300572
573This feature shows the presence and current state of a ThinkPad
574Bluetooth device in the internal ThinkPad CDC slot.
575
576Procfs notes:
577
578If Bluetooth is installed, the following commands can be used:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580 echo enable > /proc/acpi/ibm/bluetooth
581 echo disable > /proc/acpi/ibm/bluetooth
582
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300583Sysfs notes:
584
585 If the Bluetooth CDC card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300586 disabled through the "bluetooth_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300587 attribute, and its current status can also be queried.
588
589 enable:
590 0: disables Bluetooth / Bluetooth is disabled
591 1: enables Bluetooth / Bluetooth is enabled.
592
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200593 Note: this interface will be probably be superseded by the
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -0300594 generic rfkill class, so it is NOT to be considered stable yet.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -0300595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596Video output control -- /proc/acpi/ibm/video
597--------------------------------------------
598
599This feature allows control over the devices used for video output -
600LCD, CRT or DVI (if available). The following commands are available:
601
602 echo lcd_enable > /proc/acpi/ibm/video
603 echo lcd_disable > /proc/acpi/ibm/video
604 echo crt_enable > /proc/acpi/ibm/video
605 echo crt_disable > /proc/acpi/ibm/video
606 echo dvi_enable > /proc/acpi/ibm/video
607 echo dvi_disable > /proc/acpi/ibm/video
608 echo auto_enable > /proc/acpi/ibm/video
609 echo auto_disable > /proc/acpi/ibm/video
610 echo expand_toggle > /proc/acpi/ibm/video
611 echo video_switch > /proc/acpi/ibm/video
612
613Each video output device can be enabled or disabled individually.
614Reading /proc/acpi/ibm/video shows the status of each device.
615
616Automatic video switching can be enabled or disabled. When automatic
617video switching is enabled, certain events (e.g. opening the lid,
618docking or undocking) cause the video output device to change
619automatically. While this can be useful, it also causes flickering
620and, on the X40, video corruption. By disabling automatic switching,
621the flickering or video corruption can be avoided.
622
623The video_switch command cycles through the available video outputs
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400624(it simulates the behavior of Fn-F7).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626Video expansion can be toggled through this feature. This controls
627whether the display is expanded to fill the entire LCD screen when a
628mode with less than full resolution is used. Note that the current
629video expansion status cannot be determined through this feature.
630
631Note that on many models (particularly those using Radeon graphics
632chips) the X driver configures the video card in a way which prevents
633Fn-F7 from working. This also disables the video output switching
634features of this driver, as it uses the same ACPI methods as
635Fn-F7. Video switching on the console should still work.
636
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400637UPDATE: There's now a patch for the X.org Radeon driver which
638addresses this issue. Some people are reporting success with the patch
639while others are still having problems. For more information:
640
641https://bugs.freedesktop.org/show_bug.cgi?id=2000
642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643ThinkLight control -- /proc/acpi/ibm/light
644------------------------------------------
645
646The current status of the ThinkLight can be found in this file. A few
647models which do not make the status available will show it as
648"unknown". The available commands are:
649
650 echo on > /proc/acpi/ibm/light
651 echo off > /proc/acpi/ibm/light
652
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400653Docking / undocking -- /proc/acpi/ibm/dock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654------------------------------------------
655
656Docking and undocking (e.g. with the X4 UltraBase) requires some
657actions to be taken by the operating system to safely make or break
658the electrical connections with the dock.
659
660The docking feature of this driver generates the following ACPI events:
661
662 ibm/dock GDCK 00000003 00000001 -- eject request
663 ibm/dock GDCK 00000003 00000002 -- undocked
664 ibm/dock GDCK 00000000 00000003 -- docked
665
666NOTE: These events will only be generated if the laptop was docked
667when originally booted. This is due to the current lack of support for
668hot plugging of devices in the Linux ACPI framework. If the laptop was
669booted while not in the dock, the following message is shown in the
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400670logs:
671
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -0300672 Mar 17 01:42:34 aero kernel: thinkpad_acpi: dock device not present
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400673
674In this case, no dock-related events are generated but the dock and
675undock commands described below still work. They can be executed
676manually or triggered by Fn key combinations (see the example acpid
677configuration files included in the driver tarball package available
678on the web site).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
680When the eject request button on the dock is pressed, the first event
681above is generated. The handler for this event should issue the
682following command:
683
684 echo undock > /proc/acpi/ibm/dock
685
686After the LED on the dock goes off, it is safe to eject the laptop.
687Note: if you pressed this key by mistake, go ahead and eject the
688laptop, then dock it back in. Otherwise, the dock may not function as
689expected.
690
691When the laptop is docked, the third event above is generated. The
692handler for this event should issue the following command to fully
693enable the dock:
694
695 echo dock > /proc/acpi/ibm/dock
696
697The contents of the /proc/acpi/ibm/dock file shows the current status
698of the dock, as provided by the ACPI framework.
699
700The docking support in this driver does not take care of enabling or
701disabling any other devices you may have attached to the dock. For
702example, a CD drive plugged into the UltraBase needs to be disabled or
703enabled separately. See the provided example acpid configuration files
704for how this can be accomplished.
705
706There is no support yet for PCI devices that may be attached to a
707docking station, e.g. in the ThinkPad Dock II. The driver currently
708does not recognize, enable or disable such devices. This means that
709the only docking stations currently supported are the X-series
710UltraBase docks and "dumb" port replicators like the Mini Dock (the
711latter don't need any ACPI support, actually).
712
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400713UltraBay eject -- /proc/acpi/ibm/bay
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714------------------------------------
715
716Inserting or ejecting an UltraBay device requires some actions to be
717taken by the operating system to safely make or break the electrical
718connections with the device.
719
720This feature generates the following ACPI events:
721
722 ibm/bay MSTR 00000003 00000000 -- eject request
723 ibm/bay MSTR 00000001 00000000 -- eject lever inserted
724
725NOTE: These events will only be generated if the UltraBay was present
726when the laptop was originally booted (on the X series, the UltraBay
727is in the dock, so it may not be present if the laptop was undocked).
728This is due to the current lack of support for hot plugging of devices
729in the Linux ACPI framework. If the laptop was booted without the
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400730UltraBay, the following message is shown in the logs:
731
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -0300732 Mar 17 01:42:34 aero kernel: thinkpad_acpi: bay device not present
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400733
734In this case, no bay-related events are generated but the eject
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735command described below still works. It can be executed manually or
736triggered by a hot key combination.
737
738Sliding the eject lever generates the first event shown above. The
739handler for this event should take whatever actions are necessary to
740shut down the device in the UltraBay (e.g. call idectl), then issue
741the following command:
742
743 echo eject > /proc/acpi/ibm/bay
744
745After the LED on the UltraBay goes off, it is safe to pull out the
746device.
747
748When the eject lever is inserted, the second event above is
749generated. The handler for this event should take whatever actions are
750necessary to enable the UltraBay device (e.g. call idectl).
751
752The contents of the /proc/acpi/ibm/bay file shows the current status
753of the UltraBay, as provided by the ACPI framework.
754
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400755EXPERIMENTAL warm eject support on the 600e/x, A22p and A3x (To use
756this feature, you need to supply the experimental=1 parameter when
757loading the module):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400759These models do not have a button near the UltraBay device to request
760a hot eject but rather require the laptop to be put to sleep
761(suspend-to-ram) before the bay device is ejected or inserted).
762The sequence of steps to eject the device is as follows:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400764 echo eject > /proc/acpi/ibm/bay
765 put the ThinkPad to sleep
766 remove the drive
767 resume from sleep
768 cat /proc/acpi/ibm/bay should show that the drive was removed
769
770On the A3x, both the UltraBay 2000 and UltraBay Plus devices are
771supported. Use "eject2" instead of "eject" for the second bay.
772
773Note: the UltraBay eject support on the 600e/x, A22p and A3x is
774EXPERIMENTAL and may not work as expected. USE WITH CAUTION!
775
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300776CMOS control
777------------
778
779procfs: /proc/acpi/ibm/cmos
780sysfs device attribute: cmos_command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300782This feature is mostly used internally by the ACPI firmware to keep the legacy
783CMOS NVRAM bits in sync with the current machine state, and to record this
784state so that the ThinkPad will retain such settings across reboots.
785
786Some of these commands actually perform actions in some ThinkPad models, but
787this is expected to disappear more and more in newer models. As an example, in
788a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
789real, but commands 0 to 2 don't control the mixer anymore (they have been
790phased out) and just update the NVRAM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300792The range of valid cmos command numbers is 0 to 21, but not all have an
793effect and the behavior varies from model to model. Here is the behavior
794on the X40 (tpb is the ThinkPad Buttons utility):
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300796 0 - Related to "Volume down" key press
797 1 - Related to "Volume up" key press
798 2 - Related to "Mute on" key press
799 3 - Related to "Access IBM" key press
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200800 4 - Related to "LCD brightness up" key press
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300801 5 - Related to "LCD brightness down" key press
802 11 - Related to "toggle screen expansion" key press/function
803 12 - Related to "ThinkLight on"
804 13 - Related to "ThinkLight off"
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -0200805 14 - Related to "ThinkLight" key press (toggle ThinkLight)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300807The cmos command interface is prone to firmware split-brain problems, as
Henrique de Moraes Holschuhd54b7d72007-07-18 23:45:33 -0300808in newer ThinkPads it is just a compatibility layer. Do not use it, it is
809exported just as a debug tool.
Henrique de Moraes Holschuhb6160042007-04-24 11:48:19 -0300810
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400811LED control -- /proc/acpi/ibm/led
812---------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
814Some of the LED indicators can be controlled through this feature. The
815available commands are:
816
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400817 echo '<led number> on' >/proc/acpi/ibm/led
818 echo '<led number> off' >/proc/acpi/ibm/led
819 echo '<led number> blink' >/proc/acpi/ibm/led
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400821The <led number> range is 0 to 7. The set of LEDs that can be
822controlled varies from model to model. Here is the mapping on the X40:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
824 0 - power
825 1 - battery (orange)
826 2 - battery (green)
827 3 - UltraBase
828 4 - UltraBay
829 7 - standby
830
831All of the above can be turned on and off and can be made to blink.
832
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400833ACPI sounds -- /proc/acpi/ibm/beep
834----------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836The BEEP method is used internally by the ACPI firmware to provide
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400837audible alerts in various situations. This feature allows the same
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838sounds to be triggered manually.
839
840The commands are non-negative integer numbers:
841
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400842 echo <number> >/proc/acpi/ibm/beep
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400844The valid <number> range is 0 to 17. Not all numbers trigger sounds
845and the sounds vary from model to model. Here is the behavior on the
846X40:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400848 0 - stop a sound in progress (but use 17 to stop 16)
849 2 - two beeps, pause, third beep ("low battery")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 3 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400851 4 - high, followed by low-pitched beep ("unable")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 5 - single beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400853 6 - very high, followed by high-pitched beep ("AC/DC")
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 7 - high-pitched beep
855 9 - three short beeps
856 10 - very long beep
857 12 - low-pitched beep
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400858 15 - three high-pitched beeps repeating constantly, stop with 0
859 16 - one medium-pitched beep repeating constantly, stop with 17
860 17 - stop 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300862Temperature sensors
863-------------------
864
865procfs: /proc/acpi/ibm/thermal
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -0300866sysfs device attributes: (hwmon "thinkpad") temp*_input
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300868Most ThinkPads include six or more separate temperature sensors but only
869expose the CPU temperature through the standard ACPI methods. This
870feature shows readings from up to eight different sensors on older
871ThinkPads, and up to sixteen different sensors on newer ThinkPads.
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200872
873For example, on the X40, a typical output may be:
874temperatures: 42 42 45 41 36 -128 33 -128
875
Henrique de Moraes Holschuh3d6f99c2007-07-18 23:45:46 -0300876On the T43/p, a typical output may be:
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200877temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
878
879The mapping of thermal sensors to physical locations varies depending on
880system-board model (and thus, on ThinkPad model).
881
882http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
883tries to track down these locations for various models.
884
885Most (newer?) models seem to follow this pattern:
886
8871: CPU
8882: (depends on model)
8893: (depends on model)
8904: GPU
8915: Main battery: main sensor
8926: Bay battery: main sensor
8937: Main battery: secondary sensor
8948: Bay battery: secondary sensor
8959-15: (depends on model)
896
897For the R51 (source: Thomas Gruber):
8982: Mini-PCI
8993: Internal HDD
900
901For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
902http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
9032: System board, left side (near PCMCIA slot), reported as HDAPS temp
9043: PCMCIA slot
9059: MCH (northbridge) to DRAM Bus
Henrique de Moraes Holschuhb8b26402007-07-18 23:45:28 -030090610: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
907 card, under touchpad
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -020090811: Power regulator, underside of system board, below F2 key
909
Henrique de Moraes Holschuh88679a12006-11-24 11:47:09 -0200910The A31 has a very atypical layout for the thermal sensors
911(source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
9121: CPU
9132: Main Battery: main sensor
9143: Power Converter
9154: Bay Battery: main sensor
9165: MCH (northbridge)
9176: PCMCIA/ambient
9187: Main Battery: secondary sensor
9198: Bay Battery: secondary sensor
920
Henrique de Moraes Holschuh60eb0b32006-11-24 11:47:08 -0200921
Henrique de Moraes Holschuh2c37aa42007-04-24 11:48:16 -0300922Procfs notes:
923 Readings from sensors that are not available return -128.
924 No commands can be written to this file.
925
926Sysfs notes:
927 Sensors that are not available return the ENXIO error. This
928 status may change at runtime, as there are hotplug thermal
929 sensors, like those inside the batteries and docks.
930
931 thinkpad-acpi thermal sensors are reported through the hwmon
932 subsystem, and follow all of the hwmon guidelines at
933 Documentation/hwmon.
934
935
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +0200936EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400937------------------------------------------------------------------------
938
939This feature is marked EXPERIMENTAL because the implementation
940directly accesses hardware registers and may not work as expected. USE
941WITH CAUTION! To use this feature, you need to supply the
942experimental=1 parameter when loading the module.
943
944This feature dumps the values of 256 embedded controller
945registers. Values which have changed since the last time the registers
946were dumped are marked with a star:
947
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -0300948[root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400949EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
950EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
951EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
952EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
953EC 0x30: 01 07 1a 00 30 04 00 00 *85 00 00 10 00 50 00 00
954EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
955EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 *bc *02 *bc
956EC 0x60: *02 *bc *02 00 00 00 00 00 00 00 00 00 00 00 00 00
957EC 0x70: 00 00 00 00 00 12 30 40 *24 *26 *2c *27 *20 80 *1f 80
958EC 0x80: 00 00 00 06 *37 *0e 03 00 00 00 0e 07 00 00 00 00
959EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
960EC 0xa0: *ff 09 ff 09 ff ff *64 00 *00 *00 *a2 41 *ff *ff *e0 00
961EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
962EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
963EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
964EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
965EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
966
967This feature can be used to determine the register holding the fan
968speed on some models. To do that, do the following:
969
970 - make sure the battery is fully charged
971 - make sure the fan is running
972 - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
973
974The first step makes sure various charging-related values don't
975vary. The second ensures that the fan-related values do vary, since
976the fan speed fluctuates a bit. The third will (hopefully) mark the
977fan register with a star:
978
Henrique de Moraes Holschuh837ca6d2007-03-23 17:33:54 -0300979[root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
Borislav Deianov78f81cc2005-08-17 00:00:00 -0400980EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
981EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
982EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
983EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
984EC 0x30: 01 07 1a 00 30 04 00 00 85 00 00 10 00 50 00 00
985EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
986EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 bc 02 bc
987EC 0x60: 02 bc 02 00 00 00 00 00 00 00 00 00 00 00 00 00
988EC 0x70: 00 00 00 00 00 12 30 40 24 27 2c 27 21 80 1f 80
989EC 0x80: 00 00 00 06 *be 0d 03 00 00 00 0e 07 00 00 00 00
990EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
991EC 0xa0: ff 09 ff 09 ff ff 64 00 00 00 a2 41 ff ff e0 00
992EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
993EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
994EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
995EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
996EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
997
998Another set of values that varies often is the temperature
999readings. Since temperatures don't change vary fast, you can take
1000several quick dumps to eliminate them.
1001
1002You can use a similar method to figure out the meaning of other
1003embedded controller registers - e.g. make sure nothing else changes
1004except the charging or discharging battery to determine which
1005registers contain the current battery capacity, etc. If you experiment
1006with this, do send me your results (including some complete dumps with
1007a description of the conditions when they were taken.)
1008
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001009LCD brightness control
1010----------------------
1011
1012procfs: /proc/acpi/ibm/brightness
1013sysfs backlight device "thinkpad_screen"
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001014
1015This feature allows software control of the LCD brightness on ThinkPad
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001016models which don't have a hardware brightness slider.
1017
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001018It has some limitations: the LCD backlight cannot be actually turned on or
1019off by this interface, and in many ThinkPad models, the "dim while on
1020battery" functionality will be enabled by the BIOS when this interface is
1021used, and cannot be controlled.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001022
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001023On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
1024has eight brightness levels, ranging from 0 to 7. Some of the levels
1025may not be distinct. Later Lenovo models that implement the ACPI
1026display backlight brightness control methods have 16 levels, ranging
1027from 0 to 15.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001028
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001029There are two interfaces to the firmware for direct brightness control,
1030EC and CMOS. To select which one should be used, use the
1031brightness_mode module parameter: brightness_mode=1 selects EC mode,
1032brightness_mode=2 selects CMOS mode, brightness_mode=3 selects both EC
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001033and CMOS. The driver tries to auto-detect which interface to use.
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001034
1035When display backlight brightness controls are available through the
1036standard ACPI interface, it is best to use it instead of this direct
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -02001037ThinkPad-specific interface. The driver will disable its native
1038backlight brightness control interface if it detects that the standard
1039ACPI interface is available in the ThinkPad.
Henrique de Moraes Holschuh24d3b772007-07-18 23:45:43 -03001040
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -02001041The brightness_enable module parameter can be used to control whether
1042the LCD brightness control feature will be enabled when available.
Henrique de Moraes Holschuhe11e2112007-10-30 17:46:22 -02001043brightness_enable=0 forces it to be disabled. brightness_enable=1
1044forces it to be enabled when available, even if the standard ACPI
1045interface is also available.
Henrique de Moraes Holschuh87cc5372007-10-30 18:02:07 -02001046
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001047Procfs notes:
1048
1049 The available commands are:
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001050
1051 echo up >/proc/acpi/ibm/brightness
1052 echo down >/proc/acpi/ibm/brightness
1053 echo 'level <level>' >/proc/acpi/ibm/brightness
1054
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001055Sysfs notes:
1056
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001057The interface is implemented through the backlight sysfs class, which is
1058poorly documented at this time.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001059
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001060Locate the thinkpad_screen device under /sys/class/backlight, and inside
1061it there will be the following attributes:
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001062
1063 max_brightness:
1064 Reads the maximum brightness the hardware can be set to.
1065 The minimum is always zero.
1066
1067 actual_brightness:
1068 Reads what brightness the screen is set to at this instant.
1069
1070 brightness:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001071 Writes request the driver to change brightness to the
1072 given value. Reads will tell you what brightness the
1073 driver is trying to set the display to when "power" is set
1074 to zero and the display has not been dimmed by a kernel
1075 power management event.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001076
1077 power:
Henrique de Moraes Holschuha3f104c2007-10-30 17:46:20 -02001078 power management mode, where 0 is "display on", and 1 to 3
1079 will dim the display backlight to brightness level 0
1080 because thinkpad-acpi cannot really turn the backlight
1081 off. Kernel power management events can temporarily
1082 increase the current power management level, i.e. they can
1083 dim the display.
Henrique de Moraes Holschuh7d5a0152007-04-24 11:48:20 -03001084
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001085
Stefan Schmidt24f7ff02006-09-22 12:19:15 +02001086Volume control -- /proc/acpi/ibm/volume
1087---------------------------------------
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001088
1089This feature allows volume control on ThinkPad models which don't have
1090a hardware volume knob. The available commands are:
1091
1092 echo up >/proc/acpi/ibm/volume
1093 echo down >/proc/acpi/ibm/volume
1094 echo mute >/proc/acpi/ibm/volume
1095 echo 'level <level>' >/proc/acpi/ibm/volume
1096
1097The <level> number range is 0 to 15 although not all of them may be
1098distinct. The unmute the volume after the mute command, use either the
1099up or down command (the level command will not unmute the volume).
1100The current volume level and mute state is shown in the file.
1101
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001102Fan control and monitoring: fan speed, fan enable/disable
1103---------------------------------------------------------
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001104
1105procfs: /proc/acpi/ibm/fan
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001106sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
1107 pwm1_enable
1108sysfs hwmon driver attributes: fan_watchdog
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001109
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001110NOTE NOTE NOTE: fan control operations are disabled by default for
1111safety reasons. To enable them, the module parameter "fan_control=1"
1112must be given to thinkpad-acpi.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001113
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001114This feature attempts to show the current fan speed, control mode and
1115other fan data that might be available. The speed is read directly
1116from the hardware registers of the embedded controller. This is known
Henrique de Moraes Holschuhecf2a802007-04-27 22:00:09 -03001117to work on later R, T, X and Z series ThinkPads but may show a bogus
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001118value on other models.
1119
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001120Fan levels:
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001121
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001122Most ThinkPad fans work in "levels" at the firmware interface. Level 0
1123stops the fan. The higher the level, the higher the fan speed, although
1124adjacent levels often map to the same fan speed. 7 is the highest
1125level, where the fan reaches the maximum recommended speed.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001126
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001127Level "auto" means the EC changes the fan level according to some
1128internal algorithm, usually based on readings from the thermal sensors.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001129
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001130There is also a "full-speed" level, also known as "disengaged" level.
1131In this level, the EC disables the speed-locked closed-loop fan control,
1132and drives the fan as fast as it can go, which might exceed hardware
1133limits, so use this level with caution.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001134
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001135The fan usually ramps up or down slowly from one speed to another, and
1136it is normal for the EC to take several seconds to react to fan
1137commands. The full-speed level may take up to two minutes to ramp up to
1138maximum speed, and in some ThinkPads, the tachometer readings go stale
1139while the EC is transitioning to the full-speed level.
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001140
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001141WARNING WARNING WARNING: do not leave the fan disabled unless you are
1142monitoring all of the temperature sensor readings and you are ready to
1143enable it if necessary to avoid overheating.
1144
1145An enabled fan in level "auto" may stop spinning if the EC decides the
1146ThinkPad is cool enough and doesn't need the extra airflow. This is
Matt LaPlante01dd2fb2007-10-20 01:34:40 +02001147normal, and the EC will spin the fan up if the various thermal readings
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001148rise too much.
1149
1150On the X40, this seems to depend on the CPU and HDD temperatures.
1151Specifically, the fan is turned on when either the CPU temperature
1152climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The
1153fan is turned off when the CPU temperature drops to 49 degrees and the
1154HDD temperature drops to 41 degrees. These thresholds cannot
1155currently be controlled.
1156
Henrique de Moraes Holschuha12095c2006-11-24 11:47:13 -02001157The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
1158certain conditions are met. It will override any fan programming done
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001159through thinkpad-acpi.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001161The thinkpad-acpi kernel driver can be programmed to revert the fan
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001162level to a safe setting if userspace does not issue one of the procfs
1163fan commands: "enable", "disable", "level" or "watchdog", or if there
1164are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
1165set to 1, manual mode) within a configurable amount of time of up to
1166120 seconds. This functionality is called fan safety watchdog.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001167
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001168Note that the watchdog timer stops after it enables the fan. It will be
1169rearmed again automatically (using the same interval) when one of the
1170above mentioned fan commands is received. The fan watchdog is,
1171therefore, not suitable to protect against fan mode changes made through
1172means other than the "enable", "disable", and "level" procfs fan
1173commands, or the hwmon fan control sysfs interface.
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001174
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001175Procfs notes:
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001176
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001177The fan may be enabled or disabled with the following commands:
1178
1179 echo enable >/proc/acpi/ibm/fan
1180 echo disable >/proc/acpi/ibm/fan
1181
1182Placing a fan on level 0 is the same as disabling it. Enabling a fan
1183will try to place it in a safe level if it is too slow or disabled.
1184
1185The fan level can be controlled with the command:
1186
1187 echo 'level <level>' > /proc/acpi/ibm/fan
1188
1189Where <level> is an integer from 0 to 7, or one of the words "auto" or
1190"full-speed" (without the quotes). Not all ThinkPads support the "auto"
1191and "full-speed" levels. The driver accepts "disengaged" as an alias for
1192"full-speed", and reports it as "disengaged" for backwards
1193compatibility.
1194
1195On the X31 and X40 (and ONLY on those models), the fan speed can be
1196controlled to a certain degree. Once the fan is running, it can be
1197forced to run faster or slower with the following command:
1198
1199 echo 'speed <speed>' > /proc/acpi/ibm/fan
1200
1201The sustainable range of fan speeds on the X40 appears to be from about
12023700 to about 7350. Values outside this range either do not have any
1203effect or the fan speed eventually settles somewhere in that range. The
1204fan cannot be stopped or started with this command. This functionality
1205is incomplete, and not available through the sysfs interface.
1206
1207To program the safety watchdog, use the "watchdog" command.
1208
1209 echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1210
1211If you want to disable the watchdog, use 0 as the interval.
1212
1213Sysfs notes:
1214
1215The sysfs interface follows the hwmon subsystem guidelines for the most
1216part, and the exception is the fan safety watchdog.
1217
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001218Writes to any of the sysfs attributes may return the EINVAL error if
1219that operation is not supported in a given ThinkPad or if the parameter
1220is out-of-bounds, and EPERM if it is forbidden. They may also return
1221EINTR (interrupted system call), and EIO (I/O error while trying to talk
1222to the firmware).
1223
1224Features not yet implemented by the driver return ENOSYS.
1225
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001226hwmon device attribute pwm1_enable:
1227 0: PWM offline (fan is set to full-speed mode)
1228 1: Manual PWM control (use pwm1 to set fan level)
1229 2: Hardware PWM control (EC "auto" mode)
1230 3: reserved (Software PWM control, not implemented yet)
1231
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001232 Modes 0 and 2 are not supported by all ThinkPads, and the
1233 driver is not always able to detect this. If it does know a
1234 mode is unsupported, it will return -EINVAL.
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001235
1236hwmon device attribute pwm1:
1237 Fan level, scaled from the firmware values of 0-7 to the hwmon
1238 scale of 0-255. 0 means fan stopped, 255 means highest normal
1239 speed (level 7).
1240
1241 This attribute only commands the fan if pmw1_enable is set to 1
1242 (manual PWM control).
1243
1244hwmon device attribute fan1_input:
1245 Fan tachometer reading, in RPM. May go stale on certain
1246 ThinkPads while the EC transitions the PWM to offline mode,
1247 which can take up to two minutes. May return rubbish on older
1248 ThinkPads.
1249
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001250hwmon driver attribute fan_watchdog:
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001251 Fan safety watchdog timer interval, in seconds. Minimum is
1252 1 second, maximum is 120 seconds. 0 disables the watchdog.
1253
1254To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
1255
1256To start the fan in a safe mode: set pwm1_enable to 2. If that fails
Henrique de Moraes Holschuhb39fe582007-04-27 22:00:13 -03001257with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
1258would be the safest choice, though).
Henrique de Moraes Holschuhfe98a522007-04-24 11:48:17 -03001259
Henrique de Moraes Holschuh38f996e2007-03-23 17:33:59 -03001260
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001261EXPERIMENTAL: WAN
1262-----------------
1263
1264procfs: /proc/acpi/ibm/wan
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001265sysfs device attribute: wwan_enable
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001266
1267This feature is marked EXPERIMENTAL because the implementation
1268directly accesses hardware registers and may not work as expected. USE
1269WITH CAUTION! To use this feature, you need to supply the
1270experimental=1 parameter when loading the module.
1271
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001272This feature shows the presence and current state of a W-WAN (Sierra
1273Wireless EV-DO) device.
1274
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001275It was tested on a Lenovo ThinkPad X60. It should probably work on other
1276ThinkPad models which come with this module installed.
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001277
1278Procfs notes:
1279
1280If the W-WAN card is installed, the following commands can be used:
Stefan Schmidt28b779d2006-09-22 12:19:16 +02001281
1282 echo enable > /proc/acpi/ibm/wan
1283 echo disable > /proc/acpi/ibm/wan
1284
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001285Sysfs notes:
1286
1287 If the W-WAN card is installed, it can be enabled /
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001288 disabled through the "wwan_enable" thinkpad-acpi device
Henrique de Moraes Holschuhd3a6ade2007-04-27 22:00:17 -03001289 attribute, and its current status can also be queried.
1290
1291 enable:
1292 0: disables WWAN card / WWAN card is disabled
1293 1: enables WWAN card / WWAN card is enabled.
1294
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001295 Note: this interface will be probably be superseded by the
Henrique de Moraes Holschuhcc4c24e2007-05-30 20:50:14 -03001296 generic rfkill class, so it is NOT to be considered stable yet.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
Borislav Deianov78f81cc2005-08-17 00:00:00 -04001298Multiple Commands, Module Parameters
1299------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
1301Multiple commands can be written to the proc files in one shot by
1302separating them with commas, for example:
1303
1304 echo enable,0xffff > /proc/acpi/ibm/hotkey
1305 echo lcd_disable,crt_enable > /proc/acpi/ibm/video
1306
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001307Commands can also be specified when loading the thinkpad-acpi module,
1308for example:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
Henrique de Moraes Holschuh643f12d2007-03-29 01:58:43 -03001310 modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001312Enabling debugging output
1313-------------------------
1314
Simon Arlott0f035b82007-10-20 01:30:25 +02001315The module takes a debug parameter which can be used to selectively
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001316enable various classes of debugging output, for example:
1317
Henrique de Moraes Holschuh5f249272008-02-16 02:17:51 -02001318 modprobe thinkpad_acpi debug=0xffff
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001319
1320will enable all debugging output classes. It takes a bitmask, so
1321to enable more than one output class, just add their values.
1322
Henrique de Moraes Holschuhfe08bc42007-04-21 11:08:32 -03001323 Debug bitmask Description
1324 0x0001 Initialization and probing
1325 0x0002 Removal
1326
Henrique de Moraes Holschuh132ce092007-04-21 11:08:30 -03001327There is also a kernel build option to enable more debugging
1328information, which may be necessary to debug driver problems.
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001329
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001330The level of debugging information output by the driver can be changed
1331at runtime through sysfs, using the driver attribute debug_level. The
1332attribute takes the same bitmask as the debug module parameter above.
1333
Henrique de Moraes Holschuh0dcef772007-04-21 11:08:34 -03001334Force loading of module
1335-----------------------
1336
1337If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1338the module parameter force_load=1. Regardless of whether this works or
1339not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
Henrique de Moraes Holschuh176750d2007-04-24 11:48:13 -03001340
1341
1342Sysfs interface changelog:
1343
13440x000100: Initial sysfs support, as a single platform driver and
1345 device.
Henrique de Moraes Holschuh94b08712007-07-18 23:45:32 -030013460x000200: Hot key support for 32 hot keys, and radio slider switch
1347 support.
Henrique de Moraes Holschuh741553c2007-07-18 23:45:39 -030013480x010000: Hot keys are now handled by default over the input
1349 layer, the radio switch generates input event EV_RADIO,
1350 and the driver enables hot key handling by default in
1351 the firmware.
Henrique de Moraes Holschuh7fd40022007-09-25 06:38:03 -03001352
13530x020000: ABI fix: added a separate hwmon platform device and
1354 driver, which must be located by name (thinkpad)
1355 and the hwmon class for libsensors4 (lm-sensors 3)
1356 compatibility. Moved all hwmon attributes to this
1357 new platform device.
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001358
13590x020100: Marker for thinkpad-acpi with hot key NVRAM polling
1360 support. If you must, use it to know you should not
1361 start an userspace NVRAM poller (allows to detect when
1362 NVRAM is compiled out by the user because it is
1363 unneeded/undesired in the first place).
13640x020101: Marker for thinkpad-acpi with hot key NVRAM polling
Henrique de Moraes Holschuhd0788cf2008-02-16 02:17:56 -02001365 and proper hotkey_mask semantics (version 8 of the
Henrique de Moraes Holschuh01e88f22008-01-08 13:02:41 -02001366 NVRAM polling patch). Some development snapshots of
1367 0.18 had an earlier version that did strange things
1368 to hotkey_mask.
Henrique de Moraes Holschuh50ebec02008-01-08 13:02:55 -02001369
13700x020200: Add poll()/select() support to the following attributes:
1371 hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason