]>
Commit | Line | Data |
---|---|---|
643f12db | 1 | ThinkPad ACPI Extras Driver |
1da177e4 | 2 | |
643f12db | 3 | Version 0.14 |
54ae1501 | 4 | April 21st, 2007 |
1da177e4 LT |
5 | |
6 | Borislav Deianov <borislav@users.sf.net> | |
38f996ed | 7 | Henrique de Moraes Holschuh <hmh@hmh.eng.br> |
1da177e4 LT |
8 | http://ibm-acpi.sf.net/ |
9 | ||
10 | ||
643f12db HMH |
11 | This is a Linux driver for the IBM and Lenovo ThinkPad laptops. It |
12 | supports various features of these laptops which are accessible | |
13 | through the ACPI and ACPI EC framework, but not otherwise fully | |
14 | supported by the generic Linux ACPI drivers. | |
15 | ||
16 | This driver used to be named ibm-acpi until kernel 2.6.21 and release | |
17 | 0.13-20070314. It used to be in the drivers/acpi tree, but it was | |
18 | moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel | |
19 | 2.6.22, and release 0.14. | |
1da177e4 LT |
20 | |
21 | ||
22 | Status | |
23 | ------ | |
24 | ||
25 | The features currently supported are the following (see below for | |
26 | detailed description): | |
27 | ||
28 | - Fn key combinations | |
29 | - Bluetooth enable and disable | |
837ca6dd | 30 | - video output switching, expansion control |
1da177e4 LT |
31 | - ThinkLight on and off |
32 | - limited docking and undocking | |
33 | - UltraBay eject | |
78f81cc4 BD |
34 | - CMOS control |
35 | - LED control | |
36 | - ACPI sounds | |
37 | - temperature sensors | |
38 | - Experimental: embedded controller register dump | |
24f7ff0a SS |
39 | - LCD brightness control |
40 | - Volume control | |
78f81cc4 | 41 | - Experimental: fan speed, fan enable/disable |
28b779d1 | 42 | - Experimental: WAN enable and disable |
1da177e4 LT |
43 | |
44 | A compatibility table by model and feature is maintained on the web | |
45 | site, http://ibm-acpi.sf.net/. I appreciate any success or failure | |
46 | reports, especially if they add to or correct the compatibility table. | |
47 | Please include the following information in your report: | |
48 | ||
49 | - ThinkPad model name | |
50 | - a copy of your DSDT, from /proc/acpi/dsdt | |
643f12db HMH |
51 | - a copy of the output of dmidecode, with serial numbers |
52 | and UUIDs masked off | |
1da177e4 LT |
53 | - which driver features work and which don't |
54 | - the observed behavior of non-working features | |
55 | ||
56 | Any other comments or patches are also more than welcome. | |
57 | ||
58 | ||
59 | Installation | |
60 | ------------ | |
61 | ||
62 | If you are compiling this driver as included in the Linux kernel | |
643f12db HMH |
63 | sources, simply enable the CONFIG_THINKPAD_ACPI option, and optionally |
64 | enable the CONFIG_THINKPAD_ACPI_BAY option if you want the | |
65 | thinkpad-specific bay functionality. | |
1da177e4 LT |
66 | |
67 | Features | |
68 | -------- | |
69 | ||
54ae1501 HMH |
70 | The driver exports two different interfaces to userspace, which can be |
71 | used to access the features it provides. One is a legacy procfs-based | |
72 | interface, which will be removed at some time in the distant future. | |
73 | The other is a new sysfs-based interface which is not complete yet. | |
74 | ||
75 | The procfs interface creates the /proc/acpi/ibm directory. There is a | |
76 | file under that directory for each feature it supports. The procfs | |
77 | interface is mostly frozen, and will change very little if at all: it | |
78 | will not be extended to add any new functionality in the driver, instead | |
79 | all new functionality will be implemented on the sysfs interface. | |
80 | ||
81 | The sysfs interface tries to blend in the generic Linux sysfs subsystems | |
82 | and classes as much as possible. Since some of these subsystems are not | |
83 | yet ready or stabilized, it is expected that this interface will change, | |
84 | and any and all userspace programs must deal with it. | |
85 | ||
86 | ||
87 | Notes about the sysfs interface: | |
88 | ||
89 | Unlike what was done with the procfs interface, correctness when talking | |
90 | to the sysfs interfaces will be enforced, as will correctness in the | |
91 | thinkpad-acpi's implementation of sysfs interfaces. | |
92 | ||
93 | Also, any bugs in the thinkpad-acpi sysfs driver code or in the | |
94 | thinkpad-acpi's implementation of the sysfs interfaces will be fixed for | |
95 | maximum correctness, even if that means changing an interface in | |
96 | non-compatible ways. As these interfaces mature both in the kernel and | |
97 | in thinkpad-acpi, such changes should become quite rare. | |
98 | ||
99 | Applications interfacing to the thinkpad-acpi sysfs interfaces must | |
100 | follow all sysfs guidelines and correctly process all errors (the sysfs | |
101 | interface makes extensive use of errors). File descriptors and open / | |
102 | close operations to the sysfs inodes must also be properly implemented. | |
1da177e4 | 103 | |
176750d6 HMH |
104 | The version of thinkpad-acpi's sysfs interface is exported by the driver |
105 | as a driver attribute (see below). | |
106 | ||
107 | Sysfs driver attributes are on the driver's sysfs attribute space, | |
108 | for 2.6.20 this is /sys/bus/platform/drivers/thinkpad-acpi/. | |
109 | ||
110 | Sysfs device attributes are on the driver's sysfs attribute space, | |
111 | for 2.6.20 this is /sys/devices/platform/thinkpad-acpi/. | |
112 | ||
113 | Driver version | |
114 | -------------- | |
115 | ||
116 | procfs: /proc/acpi/ibm/driver | |
117 | sysfs driver attribute: version | |
1da177e4 LT |
118 | |
119 | The driver name and version. No commands can be written to this file. | |
120 | ||
176750d6 HMH |
121 | Sysfs interface version |
122 | ----------------------- | |
123 | ||
124 | sysfs driver attribute: interface_version | |
125 | ||
126 | Version of the thinkpad-acpi sysfs interface, as an unsigned long | |
127 | (output in hex format: 0xAAAABBCC), where: | |
128 | AAAA - major revision | |
129 | BB - minor revision | |
130 | CC - bugfix revision | |
131 | ||
132 | The sysfs interface version changelog for the driver can be found at the | |
133 | end of this document. Changes to the sysfs interface done by the kernel | |
134 | subsystems are not documented here, nor are they tracked by this | |
135 | attribute. | |
136 | ||
78f81cc4 | 137 | Hot keys -- /proc/acpi/ibm/hotkey |
1da177e4 LT |
138 | --------------------------------- |
139 | ||
140 | Without this driver, only the Fn-F4 key (sleep button) generates an | |
141 | ACPI event. With the driver loaded, the hotkey feature enabled and the | |
142 | mask set (see below), the various hot keys generate ACPI events in the | |
143 | following format: | |
144 | ||
145 | ibm/hotkey HKEY 00000080 0000xxxx | |
146 | ||
147 | The last four digits vary depending on the key combination pressed. | |
148 | All labeled Fn-Fx key combinations generate distinct events. In | |
149 | addition, the lid microswitch and some docking station buttons may | |
150 | also generate such events. | |
151 | ||
152 | The following commands can be written to this file: | |
153 | ||
154 | echo enable > /proc/acpi/ibm/hotkey -- enable the hot keys feature | |
155 | echo disable > /proc/acpi/ibm/hotkey -- disable the hot keys feature | |
156 | echo 0xffff > /proc/acpi/ibm/hotkey -- enable all possible hot keys | |
157 | echo 0x0000 > /proc/acpi/ibm/hotkey -- disable all possible hot keys | |
158 | ... any other 4-hex-digit mask ... | |
159 | echo reset > /proc/acpi/ibm/hotkey -- restore the original mask | |
160 | ||
161 | The bit mask allows some control over which hot keys generate ACPI | |
162 | events. Not all bits in the mask can be modified. Not all bits that | |
163 | can be modified do anything. Not all hot keys can be individually | |
164 | controlled by the mask. Most recent ThinkPad models honor the | |
165 | following bits (assuming the hot keys feature has been enabled): | |
166 | ||
167 | key bit behavior when set behavior when unset | |
168 | ||
169 | Fn-F3 always generates ACPI event | |
170 | Fn-F4 always generates ACPI event | |
171 | Fn-F5 0010 generate ACPI event enable/disable Bluetooth | |
172 | Fn-F7 0040 generate ACPI event switch LCD and external display | |
173 | Fn-F8 0080 generate ACPI event expand screen or none | |
174 | Fn-F9 0100 generate ACPI event none | |
175 | Fn-F12 always generates ACPI event | |
176 | ||
177 | Some models do not support all of the above. For example, the T30 does | |
178 | not support Fn-F5 and Fn-F9. Other models do not support the mask at | |
179 | all. On those models, hot keys cannot be controlled individually. | |
180 | ||
181 | Note that enabling ACPI events for some keys prevents their default | |
182 | behavior. For example, if events for Fn-F5 are enabled, that key will | |
183 | no longer enable/disable Bluetooth by itself. This can still be done | |
184 | from an acpid handler for the ibm/hotkey event. | |
185 | ||
186 | Note also that not all Fn key combinations are supported through | |
187 | ACPI. For example, on the X40, the brightness, volume and "Access IBM" | |
188 | buttons do not generate ACPI events even with this driver. They *can* | |
189 | be used through the "ThinkPad Buttons" utility, see | |
190 | http://www.nongnu.org/tpb/ | |
191 | ||
192 | Bluetooth -- /proc/acpi/ibm/bluetooth | |
193 | ------------------------------------- | |
194 | ||
195 | This feature shows the presence and current state of a Bluetooth | |
196 | device. If Bluetooth is installed, the following commands can be used: | |
197 | ||
198 | echo enable > /proc/acpi/ibm/bluetooth | |
199 | echo disable > /proc/acpi/ibm/bluetooth | |
200 | ||
201 | Video output control -- /proc/acpi/ibm/video | |
202 | -------------------------------------------- | |
203 | ||
204 | This feature allows control over the devices used for video output - | |
205 | LCD, CRT or DVI (if available). The following commands are available: | |
206 | ||
207 | echo lcd_enable > /proc/acpi/ibm/video | |
208 | echo lcd_disable > /proc/acpi/ibm/video | |
209 | echo crt_enable > /proc/acpi/ibm/video | |
210 | echo crt_disable > /proc/acpi/ibm/video | |
211 | echo dvi_enable > /proc/acpi/ibm/video | |
212 | echo dvi_disable > /proc/acpi/ibm/video | |
213 | echo auto_enable > /proc/acpi/ibm/video | |
214 | echo auto_disable > /proc/acpi/ibm/video | |
215 | echo expand_toggle > /proc/acpi/ibm/video | |
216 | echo video_switch > /proc/acpi/ibm/video | |
217 | ||
218 | Each video output device can be enabled or disabled individually. | |
219 | Reading /proc/acpi/ibm/video shows the status of each device. | |
220 | ||
221 | Automatic video switching can be enabled or disabled. When automatic | |
222 | video switching is enabled, certain events (e.g. opening the lid, | |
223 | docking or undocking) cause the video output device to change | |
224 | automatically. While this can be useful, it also causes flickering | |
225 | and, on the X40, video corruption. By disabling automatic switching, | |
226 | the flickering or video corruption can be avoided. | |
227 | ||
228 | The video_switch command cycles through the available video outputs | |
78f81cc4 | 229 | (it simulates the behavior of Fn-F7). |
1da177e4 LT |
230 | |
231 | Video expansion can be toggled through this feature. This controls | |
232 | whether the display is expanded to fill the entire LCD screen when a | |
233 | mode with less than full resolution is used. Note that the current | |
234 | video expansion status cannot be determined through this feature. | |
235 | ||
236 | Note that on many models (particularly those using Radeon graphics | |
237 | chips) the X driver configures the video card in a way which prevents | |
238 | Fn-F7 from working. This also disables the video output switching | |
239 | features of this driver, as it uses the same ACPI methods as | |
240 | Fn-F7. Video switching on the console should still work. | |
241 | ||
78f81cc4 BD |
242 | UPDATE: There's now a patch for the X.org Radeon driver which |
243 | addresses this issue. Some people are reporting success with the patch | |
244 | while others are still having problems. For more information: | |
245 | ||
246 | https://bugs.freedesktop.org/show_bug.cgi?id=2000 | |
247 | ||
1da177e4 LT |
248 | ThinkLight control -- /proc/acpi/ibm/light |
249 | ------------------------------------------ | |
250 | ||
251 | The current status of the ThinkLight can be found in this file. A few | |
252 | models which do not make the status available will show it as | |
253 | "unknown". The available commands are: | |
254 | ||
255 | echo on > /proc/acpi/ibm/light | |
256 | echo off > /proc/acpi/ibm/light | |
257 | ||
78f81cc4 | 258 | Docking / undocking -- /proc/acpi/ibm/dock |
1da177e4 LT |
259 | ------------------------------------------ |
260 | ||
261 | Docking and undocking (e.g. with the X4 UltraBase) requires some | |
262 | actions to be taken by the operating system to safely make or break | |
263 | the electrical connections with the dock. | |
264 | ||
265 | The docking feature of this driver generates the following ACPI events: | |
266 | ||
267 | ibm/dock GDCK 00000003 00000001 -- eject request | |
268 | ibm/dock GDCK 00000003 00000002 -- undocked | |
269 | ibm/dock GDCK 00000000 00000003 -- docked | |
270 | ||
271 | NOTE: These events will only be generated if the laptop was docked | |
272 | when originally booted. This is due to the current lack of support for | |
273 | hot plugging of devices in the Linux ACPI framework. If the laptop was | |
274 | booted while not in the dock, the following message is shown in the | |
78f81cc4 BD |
275 | logs: |
276 | ||
643f12db | 277 | Mar 17 01:42:34 aero kernel: thinkpad_acpi: dock device not present |
78f81cc4 BD |
278 | |
279 | In this case, no dock-related events are generated but the dock and | |
280 | undock commands described below still work. They can be executed | |
281 | manually or triggered by Fn key combinations (see the example acpid | |
282 | configuration files included in the driver tarball package available | |
283 | on the web site). | |
1da177e4 LT |
284 | |
285 | When the eject request button on the dock is pressed, the first event | |
286 | above is generated. The handler for this event should issue the | |
287 | following command: | |
288 | ||
289 | echo undock > /proc/acpi/ibm/dock | |
290 | ||
291 | After the LED on the dock goes off, it is safe to eject the laptop. | |
292 | Note: if you pressed this key by mistake, go ahead and eject the | |
293 | laptop, then dock it back in. Otherwise, the dock may not function as | |
294 | expected. | |
295 | ||
296 | When the laptop is docked, the third event above is generated. The | |
297 | handler for this event should issue the following command to fully | |
298 | enable the dock: | |
299 | ||
300 | echo dock > /proc/acpi/ibm/dock | |
301 | ||
302 | The contents of the /proc/acpi/ibm/dock file shows the current status | |
303 | of the dock, as provided by the ACPI framework. | |
304 | ||
305 | The docking support in this driver does not take care of enabling or | |
306 | disabling any other devices you may have attached to the dock. For | |
307 | example, a CD drive plugged into the UltraBase needs to be disabled or | |
308 | enabled separately. See the provided example acpid configuration files | |
309 | for how this can be accomplished. | |
310 | ||
311 | There is no support yet for PCI devices that may be attached to a | |
312 | docking station, e.g. in the ThinkPad Dock II. The driver currently | |
313 | does not recognize, enable or disable such devices. This means that | |
314 | the only docking stations currently supported are the X-series | |
315 | UltraBase docks and "dumb" port replicators like the Mini Dock (the | |
316 | latter don't need any ACPI support, actually). | |
317 | ||
78f81cc4 | 318 | UltraBay eject -- /proc/acpi/ibm/bay |
1da177e4 LT |
319 | ------------------------------------ |
320 | ||
321 | Inserting or ejecting an UltraBay device requires some actions to be | |
322 | taken by the operating system to safely make or break the electrical | |
323 | connections with the device. | |
324 | ||
325 | This feature generates the following ACPI events: | |
326 | ||
327 | ibm/bay MSTR 00000003 00000000 -- eject request | |
328 | ibm/bay MSTR 00000001 00000000 -- eject lever inserted | |
329 | ||
330 | NOTE: These events will only be generated if the UltraBay was present | |
331 | when the laptop was originally booted (on the X series, the UltraBay | |
332 | is in the dock, so it may not be present if the laptop was undocked). | |
333 | This is due to the current lack of support for hot plugging of devices | |
334 | in the Linux ACPI framework. If the laptop was booted without the | |
78f81cc4 BD |
335 | UltraBay, the following message is shown in the logs: |
336 | ||
643f12db | 337 | Mar 17 01:42:34 aero kernel: thinkpad_acpi: bay device not present |
78f81cc4 BD |
338 | |
339 | In this case, no bay-related events are generated but the eject | |
1da177e4 LT |
340 | command described below still works. It can be executed manually or |
341 | triggered by a hot key combination. | |
342 | ||
343 | Sliding the eject lever generates the first event shown above. The | |
344 | handler for this event should take whatever actions are necessary to | |
345 | shut down the device in the UltraBay (e.g. call idectl), then issue | |
346 | the following command: | |
347 | ||
348 | echo eject > /proc/acpi/ibm/bay | |
349 | ||
350 | After the LED on the UltraBay goes off, it is safe to pull out the | |
351 | device. | |
352 | ||
353 | When the eject lever is inserted, the second event above is | |
354 | generated. The handler for this event should take whatever actions are | |
355 | necessary to enable the UltraBay device (e.g. call idectl). | |
356 | ||
357 | The contents of the /proc/acpi/ibm/bay file shows the current status | |
358 | of the UltraBay, as provided by the ACPI framework. | |
359 | ||
78f81cc4 BD |
360 | EXPERIMENTAL warm eject support on the 600e/x, A22p and A3x (To use |
361 | this feature, you need to supply the experimental=1 parameter when | |
362 | loading the module): | |
363 | ||
364 | These models do not have a button near the UltraBay device to request | |
365 | a hot eject but rather require the laptop to be put to sleep | |
366 | (suspend-to-ram) before the bay device is ejected or inserted). | |
367 | The sequence of steps to eject the device is as follows: | |
368 | ||
369 | echo eject > /proc/acpi/ibm/bay | |
370 | put the ThinkPad to sleep | |
371 | remove the drive | |
372 | resume from sleep | |
373 | cat /proc/acpi/ibm/bay should show that the drive was removed | |
374 | ||
375 | On the A3x, both the UltraBay 2000 and UltraBay Plus devices are | |
376 | supported. Use "eject2" instead of "eject" for the second bay. | |
1da177e4 | 377 | |
78f81cc4 BD |
378 | Note: the UltraBay eject support on the 600e/x, A22p and A3x is |
379 | EXPERIMENTAL and may not work as expected. USE WITH CAUTION! | |
1da177e4 | 380 | |
b616004c HMH |
381 | CMOS control |
382 | ------------ | |
383 | ||
384 | procfs: /proc/acpi/ibm/cmos | |
385 | sysfs device attribute: cmos_command | |
1da177e4 LT |
386 | |
387 | This feature is used internally by the ACPI firmware to control the | |
78f81cc4 BD |
388 | ThinkLight on most newer ThinkPad models. It may also control LCD |
389 | brightness, sounds volume and more, but only on some models. | |
1da177e4 | 390 | |
b616004c HMH |
391 | The range of valid cmos command numbers is 0 to 21, but not all have an |
392 | effect and the behavior varies from model to model. Here is the behavior | |
393 | on the X40 (tpb is the ThinkPad Buttons utility): | |
1da177e4 LT |
394 | |
395 | 0 - no effect but tpb reports "Volume down" | |
396 | 1 - no effect but tpb reports "Volume up" | |
397 | 2 - no effect but tpb reports "Mute on" | |
398 | 3 - simulate pressing the "Access IBM" button | |
399 | 4 - LCD brightness up | |
400 | 5 - LCD brightness down | |
401 | 11 - toggle screen expansion | |
402 | 12 - ThinkLight on | |
403 | 13 - ThinkLight off | |
404 | 14 - no effect but tpb reports ThinkLight status change | |
405 | ||
b616004c HMH |
406 | The cmos command interface is prone to firmware split-brain problems, as |
407 | in newer ThinkPads it is just a compatibility layer. | |
408 | ||
78f81cc4 BD |
409 | LED control -- /proc/acpi/ibm/led |
410 | --------------------------------- | |
1da177e4 LT |
411 | |
412 | Some of the LED indicators can be controlled through this feature. The | |
413 | available commands are: | |
414 | ||
78f81cc4 BD |
415 | echo '<led number> on' >/proc/acpi/ibm/led |
416 | echo '<led number> off' >/proc/acpi/ibm/led | |
417 | echo '<led number> blink' >/proc/acpi/ibm/led | |
1da177e4 | 418 | |
78f81cc4 BD |
419 | The <led number> range is 0 to 7. The set of LEDs that can be |
420 | controlled varies from model to model. Here is the mapping on the X40: | |
1da177e4 LT |
421 | |
422 | 0 - power | |
423 | 1 - battery (orange) | |
424 | 2 - battery (green) | |
425 | 3 - UltraBase | |
426 | 4 - UltraBay | |
427 | 7 - standby | |
428 | ||
429 | All of the above can be turned on and off and can be made to blink. | |
430 | ||
78f81cc4 BD |
431 | ACPI sounds -- /proc/acpi/ibm/beep |
432 | ---------------------------------- | |
1da177e4 LT |
433 | |
434 | The BEEP method is used internally by the ACPI firmware to provide | |
78f81cc4 | 435 | audible alerts in various situations. This feature allows the same |
1da177e4 LT |
436 | sounds to be triggered manually. |
437 | ||
438 | The commands are non-negative integer numbers: | |
439 | ||
78f81cc4 | 440 | echo <number> >/proc/acpi/ibm/beep |
1da177e4 | 441 | |
78f81cc4 BD |
442 | The valid <number> range is 0 to 17. Not all numbers trigger sounds |
443 | and the sounds vary from model to model. Here is the behavior on the | |
444 | X40: | |
1da177e4 | 445 | |
78f81cc4 BD |
446 | 0 - stop a sound in progress (but use 17 to stop 16) |
447 | 2 - two beeps, pause, third beep ("low battery") | |
1da177e4 | 448 | 3 - single beep |
78f81cc4 | 449 | 4 - high, followed by low-pitched beep ("unable") |
1da177e4 | 450 | 5 - single beep |
78f81cc4 | 451 | 6 - very high, followed by high-pitched beep ("AC/DC") |
1da177e4 LT |
452 | 7 - high-pitched beep |
453 | 9 - three short beeps | |
454 | 10 - very long beep | |
455 | 12 - low-pitched beep | |
78f81cc4 BD |
456 | 15 - three high-pitched beeps repeating constantly, stop with 0 |
457 | 16 - one medium-pitched beep repeating constantly, stop with 17 | |
458 | 17 - stop 16 | |
459 | ||
2c37aa4e HMH |
460 | Temperature sensors |
461 | ------------------- | |
462 | ||
463 | procfs: /proc/acpi/ibm/thermal | |
464 | sysfs device attributes: (hwmon) temp*_input | |
78f81cc4 BD |
465 | |
466 | Most ThinkPads include six or more separate temperature sensors but | |
467 | only expose the CPU temperature through the standard ACPI methods. | |
60eb0b35 HMH |
468 | This feature shows readings from up to eight different sensors on older |
469 | ThinkPads, and it has experimental support for up to sixteen different | |
2c37aa4e | 470 | sensors on newer ThinkPads. |
60eb0b35 HMH |
471 | |
472 | EXPERIMENTAL: The 16-sensors feature is marked EXPERIMENTAL because the | |
473 | implementation directly accesses hardware registers and may not work as | |
474 | expected. USE WITH CAUTION! To use this feature, you need to supply the | |
475 | experimental=1 parameter when loading the module. When EXPERIMENTAL | |
476 | mode is enabled, reading the first 8 sensors on newer ThinkPads will | |
477 | also use an new experimental thermal sensor access mode. | |
478 | ||
479 | For example, on the X40, a typical output may be: | |
78f81cc4 BD |
480 | temperatures: 42 42 45 41 36 -128 33 -128 |
481 | ||
60eb0b35 HMH |
482 | EXPERIMENTAL: On the T43/p, a typical output may be: |
483 | temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128 | |
484 | ||
485 | The mapping of thermal sensors to physical locations varies depending on | |
486 | system-board model (and thus, on ThinkPad model). | |
487 | ||
488 | http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that | |
489 | tries to track down these locations for various models. | |
490 | ||
491 | Most (newer?) models seem to follow this pattern: | |
78f81cc4 BD |
492 | |
493 | 1: CPU | |
60eb0b35 HMH |
494 | 2: (depends on model) |
495 | 3: (depends on model) | |
78f81cc4 | 496 | 4: GPU |
60eb0b35 HMH |
497 | 5: Main battery: main sensor |
498 | 6: Bay battery: main sensor | |
499 | 7: Main battery: secondary sensor | |
500 | 8: Bay battery: secondary sensor | |
501 | 9-15: (depends on model) | |
502 | ||
503 | For the R51 (source: Thomas Gruber): | |
504 | 2: Mini-PCI | |
505 | 3: Internal HDD | |
506 | ||
507 | For the T43, T43/p (source: Shmidoax/Thinkwiki.org) | |
508 | http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p | |
509 | 2: System board, left side (near PCMCIA slot), reported as HDAPS temp | |
510 | 3: PCMCIA slot | |
511 | 9: MCH (northbridge) to DRAM Bus | |
512 | 10: ICH (southbridge), under Mini-PCI card, under touchpad | |
513 | 11: Power regulator, underside of system board, below F2 key | |
78f81cc4 | 514 | |
88679a15 HMH |
515 | The A31 has a very atypical layout for the thermal sensors |
516 | (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31) | |
517 | 1: CPU | |
518 | 2: Main Battery: main sensor | |
519 | 3: Power Converter | |
520 | 4: Bay Battery: main sensor | |
521 | 5: MCH (northbridge) | |
522 | 6: PCMCIA/ambient | |
523 | 7: Main Battery: secondary sensor | |
524 | 8: Bay Battery: secondary sensor | |
525 | ||
78f81cc4 | 526 | |
2c37aa4e HMH |
527 | Procfs notes: |
528 | Readings from sensors that are not available return -128. | |
529 | No commands can be written to this file. | |
530 | ||
531 | Sysfs notes: | |
532 | Sensors that are not available return the ENXIO error. This | |
533 | status may change at runtime, as there are hotplug thermal | |
534 | sensors, like those inside the batteries and docks. | |
535 | ||
536 | thinkpad-acpi thermal sensors are reported through the hwmon | |
537 | subsystem, and follow all of the hwmon guidelines at | |
538 | Documentation/hwmon. | |
539 | ||
540 | ||
d6bc8ac9 | 541 | EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump |
78f81cc4 BD |
542 | ------------------------------------------------------------------------ |
543 | ||
544 | This feature is marked EXPERIMENTAL because the implementation | |
545 | directly accesses hardware registers and may not work as expected. USE | |
546 | WITH CAUTION! To use this feature, you need to supply the | |
547 | experimental=1 parameter when loading the module. | |
548 | ||
549 | This feature dumps the values of 256 embedded controller | |
550 | registers. Values which have changed since the last time the registers | |
551 | were dumped are marked with a star: | |
552 | ||
837ca6dd | 553 | [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump |
78f81cc4 BD |
554 | EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f |
555 | EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00 | |
556 | EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00 | |
557 | EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80 | |
558 | EC 0x30: 01 07 1a 00 30 04 00 00 *85 00 00 10 00 50 00 00 | |
559 | EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00 | |
560 | EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 *bc *02 *bc | |
561 | EC 0x60: *02 *bc *02 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
562 | EC 0x70: 00 00 00 00 00 12 30 40 *24 *26 *2c *27 *20 80 *1f 80 | |
563 | EC 0x80: 00 00 00 06 *37 *0e 03 00 00 00 0e 07 00 00 00 00 | |
564 | EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
565 | EC 0xa0: *ff 09 ff 09 ff ff *64 00 *00 *00 *a2 41 *ff *ff *e0 00 | |
566 | EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
567 | EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
568 | EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
569 | EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03 | |
570 | EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a | |
571 | ||
572 | This feature can be used to determine the register holding the fan | |
573 | speed on some models. To do that, do the following: | |
574 | ||
575 | - make sure the battery is fully charged | |
576 | - make sure the fan is running | |
577 | - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so | |
578 | ||
579 | The first step makes sure various charging-related values don't | |
580 | vary. The second ensures that the fan-related values do vary, since | |
581 | the fan speed fluctuates a bit. The third will (hopefully) mark the | |
582 | fan register with a star: | |
583 | ||
837ca6dd | 584 | [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump |
78f81cc4 BD |
585 | EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f |
586 | EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00 | |
587 | EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00 | |
588 | EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80 | |
589 | EC 0x30: 01 07 1a 00 30 04 00 00 85 00 00 10 00 50 00 00 | |
590 | EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00 | |
591 | EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 bc 02 bc | |
592 | EC 0x60: 02 bc 02 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
593 | EC 0x70: 00 00 00 00 00 12 30 40 24 27 2c 27 21 80 1f 80 | |
594 | EC 0x80: 00 00 00 06 *be 0d 03 00 00 00 0e 07 00 00 00 00 | |
595 | EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
596 | EC 0xa0: ff 09 ff 09 ff ff 64 00 00 00 a2 41 ff ff e0 00 | |
597 | EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
598 | EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
599 | EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | |
600 | EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03 | |
601 | EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a | |
602 | ||
603 | Another set of values that varies often is the temperature | |
604 | readings. Since temperatures don't change vary fast, you can take | |
605 | several quick dumps to eliminate them. | |
606 | ||
607 | You can use a similar method to figure out the meaning of other | |
608 | embedded controller registers - e.g. make sure nothing else changes | |
609 | except the charging or discharging battery to determine which | |
610 | registers contain the current battery capacity, etc. If you experiment | |
611 | with this, do send me your results (including some complete dumps with | |
612 | a description of the conditions when they were taken.) | |
613 | ||
24f7ff0a SS |
614 | LCD brightness control -- /proc/acpi/ibm/brightness |
615 | --------------------------------------------------- | |
78f81cc4 BD |
616 | |
617 | This feature allows software control of the LCD brightness on ThinkPad | |
618 | models which don't have a hardware brightness slider. The available | |
619 | commands are: | |
620 | ||
621 | echo up >/proc/acpi/ibm/brightness | |
622 | echo down >/proc/acpi/ibm/brightness | |
623 | echo 'level <level>' >/proc/acpi/ibm/brightness | |
624 | ||
625 | The <level> number range is 0 to 7, although not all of them may be | |
626 | distinct. The current brightness level is shown in the file. | |
627 | ||
24f7ff0a SS |
628 | Volume control -- /proc/acpi/ibm/volume |
629 | --------------------------------------- | |
78f81cc4 BD |
630 | |
631 | This feature allows volume control on ThinkPad models which don't have | |
632 | a hardware volume knob. The available commands are: | |
633 | ||
634 | echo up >/proc/acpi/ibm/volume | |
635 | echo down >/proc/acpi/ibm/volume | |
636 | echo mute >/proc/acpi/ibm/volume | |
637 | echo 'level <level>' >/proc/acpi/ibm/volume | |
638 | ||
639 | The <level> number range is 0 to 15 although not all of them may be | |
640 | distinct. The unmute the volume after the mute command, use either the | |
641 | up or down command (the level command will not unmute the volume). | |
642 | The current volume level and mute state is shown in the file. | |
643 | ||
fe98a52c HMH |
644 | EXPERIMENTAL: fan speed, fan enable/disable |
645 | ------------------------------------------- | |
646 | ||
647 | procfs: /proc/acpi/ibm/fan | |
648 | sysfs device attributes: (hwmon) fan_input, pwm1, pwm1_enable | |
78f81cc4 BD |
649 | |
650 | This feature is marked EXPERIMENTAL because the implementation | |
651 | directly accesses hardware registers and may not work as expected. USE | |
652 | WITH CAUTION! To use this feature, you need to supply the | |
653 | experimental=1 parameter when loading the module. | |
654 | ||
a12095c2 HMH |
655 | This feature attempts to show the current fan speed, control mode and |
656 | other fan data that might be available. The speed is read directly | |
657 | from the hardware registers of the embedded controller. This is known | |
658 | to work on later R, T and X series ThinkPads but may show a bogus | |
659 | value on other models. | |
660 | ||
fe98a52c | 661 | Fan levels: |
a12095c2 | 662 | |
fe98a52c HMH |
663 | Most ThinkPad fans work in "levels" at the firmware interface. Level 0 |
664 | stops the fan. The higher the level, the higher the fan speed, although | |
665 | adjacent levels often map to the same fan speed. 7 is the highest | |
666 | level, where the fan reaches the maximum recommended speed. | |
78f81cc4 | 667 | |
fe98a52c HMH |
668 | Level "auto" means the EC changes the fan level according to some |
669 | internal algorithm, usually based on readings from the thermal sensors. | |
78f81cc4 | 670 | |
fe98a52c HMH |
671 | There is also a "full-speed" level, also known as "disengaged" level. |
672 | In this level, the EC disables the speed-locked closed-loop fan control, | |
673 | and drives the fan as fast as it can go, which might exceed hardware | |
674 | limits, so use this level with caution. | |
78f81cc4 | 675 | |
fe98a52c HMH |
676 | The fan usually ramps up or down slowly from one speed to another, and |
677 | it is normal for the EC to take several seconds to react to fan | |
678 | commands. The full-speed level may take up to two minutes to ramp up to | |
679 | maximum speed, and in some ThinkPads, the tachometer readings go stale | |
680 | while the EC is transitioning to the full-speed level. | |
a12095c2 | 681 | |
78f81cc4 | 682 | WARNING WARNING WARNING: do not leave the fan disabled unless you are |
a12095c2 HMH |
683 | monitoring all of the temperature sensor readings and you are ready to |
684 | enable it if necessary to avoid overheating. | |
685 | ||
686 | An enabled fan in level "auto" may stop spinning if the EC decides the | |
687 | ThinkPad is cool enough and doesn't need the extra airflow. This is | |
688 | normal, and the EC will spin the fan up if the varios thermal readings | |
689 | rise too much. | |
690 | ||
691 | On the X40, this seems to depend on the CPU and HDD temperatures. | |
692 | Specifically, the fan is turned on when either the CPU temperature | |
693 | climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The | |
694 | fan is turned off when the CPU temperature drops to 49 degrees and the | |
695 | HDD temperature drops to 41 degrees. These thresholds cannot | |
696 | currently be controlled. | |
697 | ||
fe98a52c HMH |
698 | The ThinkPad's ACPI DSDT code will reprogram the fan on its own when |
699 | certain conditions are met. It will override any fan programming done | |
700 | through thinkpad-acpi. | |
701 | ||
702 | The thinkpad-acpi kernel driver can be programmed to revert the fan | |
703 | level to a safe setting if userspace does not issue one of the procfs | |
704 | fan commands: "enable", "disable", "level" or "watchdog", or if there | |
705 | are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is | |
706 | set to 1, manual mode) within a configurable amount of time of up to | |
707 | 120 seconds. This functionality is called fan safety watchdog. | |
708 | ||
709 | Note that the watchdog timer stops after it enables the fan. It will be | |
710 | rearmed again automatically (using the same interval) when one of the | |
711 | above mentioned fan commands is received. The fan watchdog is, | |
712 | therefore, not suitable to protect against fan mode changes made through | |
713 | means other than the "enable", "disable", and "level" procfs fan | |
714 | commands, or the hwmon fan control sysfs interface. | |
715 | ||
716 | Procfs notes: | |
717 | ||
718 | The fan may be enabled or disabled with the following commands: | |
719 | ||
720 | echo enable >/proc/acpi/ibm/fan | |
721 | echo disable >/proc/acpi/ibm/fan | |
722 | ||
723 | Placing a fan on level 0 is the same as disabling it. Enabling a fan | |
724 | will try to place it in a safe level if it is too slow or disabled. | |
725 | ||
a12095c2 | 726 | The fan level can be controlled with the command: |
78f81cc4 | 727 | |
fe98a52c | 728 | echo 'level <level>' > /proc/acpi/ibm/fan |
a12095c2 | 729 | |
fe98a52c HMH |
730 | Where <level> is an integer from 0 to 7, or one of the words "auto" or |
731 | "full-speed" (without the quotes). Not all ThinkPads support the "auto" | |
732 | and "full-speed" levels. The driver accepts "disengaged" as an alias for | |
733 | "full-speed", and reports it as "disengaged" for backwards | |
734 | compatibility. | |
78f81cc4 BD |
735 | |
736 | On the X31 and X40 (and ONLY on those models), the fan speed can be | |
fe98a52c | 737 | controlled to a certain degree. Once the fan is running, it can be |
78f81cc4 BD |
738 | forced to run faster or slower with the following command: |
739 | ||
fe98a52c | 740 | echo 'speed <speed>' > /proc/acpi/ibm/fan |
78f81cc4 | 741 | |
fe98a52c HMH |
742 | The sustainable range of fan speeds on the X40 appears to be from about |
743 | 3700 to about 7350. Values outside this range either do not have any | |
744 | effect or the fan speed eventually settles somewhere in that range. The | |
745 | fan cannot be stopped or started with this command. This functionality | |
746 | is incomplete, and not available through the sysfs interface. | |
78f81cc4 | 747 | |
fe98a52c HMH |
748 | To program the safety watchdog, use the "watchdog" command. |
749 | ||
750 | echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan | |
751 | ||
752 | If you want to disable the watchdog, use 0 as the interval. | |
753 | ||
754 | Sysfs notes: | |
755 | ||
756 | The sysfs interface follows the hwmon subsystem guidelines for the most | |
757 | part, and the exception is the fan safety watchdog. | |
758 | ||
759 | hwmon device attribute pwm1_enable: | |
760 | 0: PWM offline (fan is set to full-speed mode) | |
761 | 1: Manual PWM control (use pwm1 to set fan level) | |
762 | 2: Hardware PWM control (EC "auto" mode) | |
763 | 3: reserved (Software PWM control, not implemented yet) | |
764 | ||
765 | Modes 0 and 2 are not supported by all ThinkPads, and the driver | |
766 | is not always able to detect this. If it does know a mode is | |
767 | unsupported, it will return -EINVAL. | |
768 | ||
769 | hwmon device attribute pwm1: | |
770 | Fan level, scaled from the firmware values of 0-7 to the hwmon | |
771 | scale of 0-255. 0 means fan stopped, 255 means highest normal | |
772 | speed (level 7). | |
773 | ||
774 | This attribute only commands the fan if pmw1_enable is set to 1 | |
775 | (manual PWM control). | |
776 | ||
777 | hwmon device attribute fan1_input: | |
778 | Fan tachometer reading, in RPM. May go stale on certain | |
779 | ThinkPads while the EC transitions the PWM to offline mode, | |
780 | which can take up to two minutes. May return rubbish on older | |
781 | ThinkPads. | |
782 | ||
783 | driver attribute fan_watchdog: | |
784 | Fan safety watchdog timer interval, in seconds. Minimum is | |
785 | 1 second, maximum is 120 seconds. 0 disables the watchdog. | |
786 | ||
787 | To stop the fan: set pwm1 to zero, and pwm1_enable to 1. | |
788 | ||
789 | To start the fan in a safe mode: set pwm1_enable to 2. If that fails | |
790 | with ENOTSUP, set it to 1 and set pwm1 to at least 128 (255 would be the | |
791 | safest choice, though). | |
1da177e4 | 792 | |
38f996ed | 793 | |
28b779d1 SS |
794 | EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan |
795 | --------------------------------------- | |
796 | ||
797 | This feature is marked EXPERIMENTAL because the implementation | |
798 | directly accesses hardware registers and may not work as expected. USE | |
799 | WITH CAUTION! To use this feature, you need to supply the | |
800 | experimental=1 parameter when loading the module. | |
801 | ||
802 | This feature shows the presence and current state of a WAN (Sierra | |
803 | Wireless EV-DO) device. If WAN is installed, the following commands can | |
804 | be used: | |
805 | ||
806 | echo enable > /proc/acpi/ibm/wan | |
807 | echo disable > /proc/acpi/ibm/wan | |
808 | ||
809 | It was tested on a Lenovo Thinkpad X60. It should probably work on other | |
810 | Thinkpad models which come with this module installed. | |
1da177e4 | 811 | |
78f81cc4 BD |
812 | Multiple Commands, Module Parameters |
813 | ------------------------------------ | |
1da177e4 LT |
814 | |
815 | Multiple commands can be written to the proc files in one shot by | |
816 | separating them with commas, for example: | |
817 | ||
818 | echo enable,0xffff > /proc/acpi/ibm/hotkey | |
819 | echo lcd_disable,crt_enable > /proc/acpi/ibm/video | |
820 | ||
643f12db HMH |
821 | Commands can also be specified when loading the thinkpad-acpi module, |
822 | for example: | |
1da177e4 | 823 | |
643f12db | 824 | modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable |
1da177e4 | 825 | |
132ce091 HMH |
826 | Enabling debugging output |
827 | ------------------------- | |
828 | ||
829 | The module takes a debug paramater which can be used to selectively | |
830 | enable various classes of debugging output, for example: | |
831 | ||
832 | modprobe ibm_acpi debug=0xffff | |
833 | ||
834 | will enable all debugging output classes. It takes a bitmask, so | |
835 | to enable more than one output class, just add their values. | |
836 | ||
fe08bc4b HMH |
837 | Debug bitmask Description |
838 | 0x0001 Initialization and probing | |
839 | 0x0002 Removal | |
840 | ||
132ce091 HMH |
841 | There is also a kernel build option to enable more debugging |
842 | information, which may be necessary to debug driver problems. | |
0dcef77c | 843 | |
176750d6 HMH |
844 | The level of debugging information output by the driver can be changed |
845 | at runtime through sysfs, using the driver attribute debug_level. The | |
846 | attribute takes the same bitmask as the debug module parameter above. | |
847 | ||
0dcef77c HMH |
848 | Force loading of module |
849 | ----------------------- | |
850 | ||
851 | If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify | |
852 | the module parameter force_load=1. Regardless of whether this works or | |
853 | not, please contact ibm-acpi-devel@lists.sourceforge.net with a report. | |
176750d6 HMH |
854 | |
855 | ||
856 | Sysfs interface changelog: | |
857 | ||
858 | 0x000100: Initial sysfs support, as a single platform driver and | |
859 | device. |