thinkpad-acpi.txt 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378
  1. ThinkPad ACPI Extras Driver
  2. Version 0.19
  3. January 06th, 2008
  4. Borislav Deianov <borislav@users.sf.net>
  5. Henrique de Moraes Holschuh <hmh@hmh.eng.br>
  6. http://ibm-acpi.sf.net/
  7. This is a Linux driver for the IBM and Lenovo ThinkPad laptops. It
  8. supports various features of these laptops which are accessible
  9. through the ACPI and ACPI EC framework, but not otherwise fully
  10. supported by the generic Linux ACPI drivers.
  11. This driver used to be named ibm-acpi until kernel 2.6.21 and release
  12. 0.13-20070314. It used to be in the drivers/acpi tree, but it was
  13. moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel
  14. 2.6.22, and release 0.14.
  15. Status
  16. ------
  17. The features currently supported are the following (see below for
  18. detailed description):
  19. - Fn key combinations
  20. - Bluetooth enable and disable
  21. - video output switching, expansion control
  22. - ThinkLight on and off
  23. - limited docking and undocking
  24. - UltraBay eject
  25. - CMOS control
  26. - LED control
  27. - ACPI sounds
  28. - temperature sensors
  29. - Experimental: embedded controller register dump
  30. - LCD brightness control
  31. - Volume control
  32. - Fan control and monitoring: fan speed, fan enable/disable
  33. - Experimental: WAN enable and disable
  34. A compatibility table by model and feature is maintained on the web
  35. site, http://ibm-acpi.sf.net/. I appreciate any success or failure
  36. reports, especially if they add to or correct the compatibility table.
  37. Please include the following information in your report:
  38. - ThinkPad model name
  39. - a copy of your DSDT, from /proc/acpi/dsdt
  40. - a copy of the output of dmidecode, with serial numbers
  41. and UUIDs masked off
  42. - which driver features work and which don't
  43. - the observed behavior of non-working features
  44. Any other comments or patches are also more than welcome.
  45. Installation
  46. ------------
  47. If you are compiling this driver as included in the Linux kernel
  48. sources, simply enable the CONFIG_THINKPAD_ACPI option, and optionally
  49. enable the CONFIG_THINKPAD_ACPI_BAY option if you want the
  50. thinkpad-specific bay functionality.
  51. Features
  52. --------
  53. The driver exports two different interfaces to userspace, which can be
  54. used to access the features it provides. One is a legacy procfs-based
  55. interface, which will be removed at some time in the distant future.
  56. The other is a new sysfs-based interface which is not complete yet.
  57. The procfs interface creates the /proc/acpi/ibm directory. There is a
  58. file under that directory for each feature it supports. The procfs
  59. interface is mostly frozen, and will change very little if at all: it
  60. will not be extended to add any new functionality in the driver, instead
  61. all new functionality will be implemented on the sysfs interface.
  62. The sysfs interface tries to blend in the generic Linux sysfs subsystems
  63. and classes as much as possible. Since some of these subsystems are not
  64. yet ready or stabilized, it is expected that this interface will change,
  65. and any and all userspace programs must deal with it.
  66. Notes about the sysfs interface:
  67. Unlike what was done with the procfs interface, correctness when talking
  68. to the sysfs interfaces will be enforced, as will correctness in the
  69. thinkpad-acpi's implementation of sysfs interfaces.
  70. Also, any bugs in the thinkpad-acpi sysfs driver code or in the
  71. thinkpad-acpi's implementation of the sysfs interfaces will be fixed for
  72. maximum correctness, even if that means changing an interface in
  73. non-compatible ways. As these interfaces mature both in the kernel and
  74. in thinkpad-acpi, such changes should become quite rare.
  75. Applications interfacing to the thinkpad-acpi sysfs interfaces must
  76. follow all sysfs guidelines and correctly process all errors (the sysfs
  77. interface makes extensive use of errors). File descriptors and open /
  78. close operations to the sysfs inodes must also be properly implemented.
  79. The version of thinkpad-acpi's sysfs interface is exported by the driver
  80. as a driver attribute (see below).
  81. Sysfs driver attributes are on the driver's sysfs attribute space,
  82. for 2.6.23 this is /sys/bus/platform/drivers/thinkpad_acpi/ and
  83. /sys/bus/platform/drivers/thinkpad_hwmon/
  84. Sysfs device attributes are on the thinkpad_acpi device sysfs attribute
  85. space, for 2.6.23 this is /sys/devices/platform/thinkpad_acpi/.
  86. Sysfs device attributes for the sensors and fan are on the
  87. thinkpad_hwmon device's sysfs attribute space, but you should locate it
  88. looking for a hwmon device with the name attribute of "thinkpad".
  89. Driver version
  90. --------------
  91. procfs: /proc/acpi/ibm/driver
  92. sysfs driver attribute: version
  93. The driver name and version. No commands can be written to this file.
  94. Sysfs interface version
  95. -----------------------
  96. sysfs driver attribute: interface_version
  97. Version of the thinkpad-acpi sysfs interface, as an unsigned long
  98. (output in hex format: 0xAAAABBCC), where:
  99. AAAA - major revision
  100. BB - minor revision
  101. CC - bugfix revision
  102. The sysfs interface version changelog for the driver can be found at the
  103. end of this document. Changes to the sysfs interface done by the kernel
  104. subsystems are not documented here, nor are they tracked by this
  105. attribute.
  106. Changes to the thinkpad-acpi sysfs interface are only considered
  107. non-experimental when they are submitted to Linux mainline, at which
  108. point the changes in this interface are documented and interface_version
  109. may be updated. If you are using any thinkpad-acpi features not yet
  110. sent to mainline for merging, you do so on your own risk: these features
  111. may disappear, or be implemented in a different and incompatible way by
  112. the time they are merged in Linux mainline.
  113. Changes that are backwards-compatible by nature (e.g. the addition of
  114. attributes that do not change the way the other attributes work) do not
  115. always warrant an update of interface_version. Therefore, one must
  116. expect that an attribute might not be there, and deal with it properly
  117. (an attribute not being there *is* a valid way to make it clear that a
  118. feature is not available in sysfs).
  119. Hot keys
  120. --------
  121. procfs: /proc/acpi/ibm/hotkey
  122. sysfs device attribute: hotkey_*
  123. In a ThinkPad, the ACPI HKEY handler is responsible for communicating
  124. some important events and also keyboard hot key presses to the operating
  125. system. Enabling the hotkey functionality of thinkpad-acpi signals the
  126. firmware that such a driver is present, and modifies how the ThinkPad
  127. firmware will behave in many situations.
  128. The driver enables the hot key feature automatically when loaded. The
  129. feature can later be disabled and enabled back at runtime. The driver
  130. will also restore the hot key feature to its previous state and mask
  131. when it is unloaded.
  132. When the hotkey feature is enabled and the hot key mask is set (see
  133. below), the driver will report HKEY events in the following format:
  134. ibm/hotkey HKEY 00000080 0000xxxx
  135. Some of these events refer to hot key presses, but not all.
  136. The driver will generate events over the input layer for hot keys and
  137. radio switches, and over the ACPI netlink layer for other events. The
  138. input layer support accepts the standard IOCTLs to remap the keycodes
  139. assigned to each hot key.
  140. The hot key bit mask allows some control over which hot keys generate
  141. events. If a key is "masked" (bit set to 0 in the mask), the firmware
  142. will handle it. If it is "unmasked", it signals the firmware that
  143. thinkpad-acpi would prefer to handle it, if the firmware would be so
  144. kind to allow it (and it often doesn't!).
  145. Not all bits in the mask can be modified. Not all bits that can be
  146. modified do anything. Not all hot keys can be individually controlled
  147. by the mask. Some models do not support the mask at all, and in those
  148. models, hot keys cannot be controlled individually. The behaviour of
  149. the mask is, therefore, highly dependent on the ThinkPad model.
  150. Note that unmasking some keys prevents their default behavior. For
  151. example, if Fn+F5 is unmasked, that key will no longer enable/disable
  152. Bluetooth by itself.
  153. Note also that not all Fn key combinations are supported through ACPI.
  154. For example, on the X40, the brightness, volume and "Access IBM" buttons
  155. do not generate ACPI events even with this driver. They *can* be used
  156. through the "ThinkPad Buttons" utility, see http://www.nongnu.org/tpb/
  157. procfs notes:
  158. The following commands can be written to the /proc/acpi/ibm/hotkey file:
  159. echo enable > /proc/acpi/ibm/hotkey -- enable the hot keys feature
  160. echo disable > /proc/acpi/ibm/hotkey -- disable the hot keys feature
  161. echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
  162. echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
  163. ... any other 8-hex-digit mask ...
  164. echo reset > /proc/acpi/ibm/hotkey -- restore the original mask
  165. The procfs interface does not support NVRAM polling control. So as to
  166. maintain maximum bug-to-bug compatibility, it does not report any masks,
  167. nor does it allow one to manipulate the hot key mask when the firmware
  168. does not support masks at all, even if NVRAM polling is in use.
  169. sysfs notes:
  170. hotkey_bios_enabled:
  171. Returns the status of the hot keys feature when
  172. thinkpad-acpi was loaded. Upon module unload, the hot
  173. key feature status will be restored to this value.
  174. 0: hot keys were disabled
  175. 1: hot keys were enabled (unusual)
  176. hotkey_bios_mask:
  177. Returns the hot keys mask when thinkpad-acpi was loaded.
  178. Upon module unload, the hot keys mask will be restored
  179. to this value.
  180. hotkey_enable:
  181. Enables/disables the hot keys feature in the ACPI
  182. firmware, and reports current status of the hot keys
  183. feature. Has no effect on the NVRAM hot key polling
  184. functionality.
  185. 0: disables the hot keys feature / feature disabled
  186. 1: enables the hot keys feature / feature enabled
  187. hotkey_mask:
  188. bit mask to enable driver-handling (and depending on
  189. the firmware, ACPI event generation) for each hot key
  190. (see above). Returns the current status of the hot keys
  191. mask, and allows one to modify it.
  192. Note: when NVRAM polling is active, the firmware mask
  193. will be different from the value returned by
  194. hotkey_mask. The driver will retain enabled bits for
  195. hotkeys that are under NVRAM polling even if the
  196. firmware refuses them, and will not set these bits on
  197. the firmware hot key mask.
  198. hotkey_all_mask:
  199. bit mask that should enable event reporting for all
  200. supported hot keys, when echoed to hotkey_mask above.
  201. Unless you know which events need to be handled
  202. passively (because the firmware *will* handle them
  203. anyway), do *not* use hotkey_all_mask. Use
  204. hotkey_recommended_mask, instead. You have been warned.
  205. hotkey_recommended_mask:
  206. bit mask that should enable event reporting for all
  207. supported hot keys, except those which are always
  208. handled by the firmware anyway. Echo it to
  209. hotkey_mask above, to use.
  210. hotkey_source_mask:
  211. bit mask that selects which hot keys will the driver
  212. poll the NVRAM for. This is auto-detected by the driver
  213. based on the capabilities reported by the ACPI firmware,
  214. but it can be overridden at runtime.
  215. Hot keys whose bits are set in both hotkey_source_mask
  216. and also on hotkey_mask are polled for in NVRAM. Only a
  217. few hot keys are available through CMOS NVRAM polling.
  218. Warning: when in NVRAM mode, the volume up/down/mute
  219. keys are synthesized according to changes in the mixer,
  220. so you have to use volume up or volume down to unmute,
  221. as per the ThinkPad volume mixer user interface. When
  222. in ACPI event mode, volume up/down/mute are reported as
  223. separate events, but this behaviour may be corrected in
  224. future releases of this driver, in which case the
  225. ThinkPad volume mixer user interface semantics will be
  226. enforced.
  227. hotkey_poll_freq:
  228. frequency in Hz for hot key polling. It must be between
  229. 0 and 25 Hz. Polling is only carried out when strictly
  230. needed.
  231. Setting hotkey_poll_freq to zero disables polling, and
  232. will cause hot key presses that require NVRAM polling
  233. to never be reported.
  234. Setting hotkey_poll_freq too low will cause repeated
  235. pressings of the same hot key to be misreported as a
  236. single key press, or to not even be detected at all.
  237. The recommended polling frequency is 10Hz.
  238. hotkey_radio_sw:
  239. If the ThinkPad has a hardware radio switch, this
  240. attribute will read 0 if the switch is in the "radios
  241. disabled" position, and 1 if the switch is in the
  242. "radios enabled" position.
  243. This attribute has poll()/select() support.
  244. hotkey_tablet_mode:
  245. If the ThinkPad has tablet capabilities, this attribute
  246. will read 0 if the ThinkPad is in normal mode, and
  247. 1 if the ThinkPad is in tablet mode.
  248. This attribute has poll()/select() support.
  249. hotkey_report_mode:
  250. Returns the state of the procfs ACPI event report mode
  251. filter for hot keys. If it is set to 1 (the default),
  252. all hot key presses are reported both through the input
  253. layer and also as ACPI events through procfs (but not
  254. through netlink). If it is set to 2, hot key presses
  255. are reported only through the input layer.
  256. This attribute is read-only in kernels 2.6.23 or later,
  257. and read-write on earlier kernels.
  258. May return -EPERM (write access locked out by module
  259. parameter) or -EACCES (read-only).
  260. wakeup_reason:
  261. Set to 1 if the system is waking up because the user
  262. requested a bay ejection. Set to 2 if the system is
  263. waking up because the user requested the system to
  264. undock. Set to zero for normal wake-ups or wake-ups
  265. due to unknown reasons.
  266. This attribute has poll()/select() support.
  267. wakeup_hotunplug_complete:
  268. Set to 1 if the system was waken up because of an
  269. undock or bay ejection request, and that request
  270. was successfully completed. At this point, it might
  271. be useful to send the system back to sleep, at the
  272. user's choice. Refer to HKEY events 0x4003 and
  273. 0x3003, below.
  274. This attribute has poll()/select() support.
  275. input layer notes:
  276. A Hot key is mapped to a single input layer EV_KEY event, possibly
  277. followed by an EV_MSC MSC_SCAN event that shall contain that key's scan
  278. code. An EV_SYN event will always be generated to mark the end of the
  279. event block.
  280. Do not use the EV_MSC MSC_SCAN events to process keys. They are to be
  281. used as a helper to remap keys, only. They are particularly useful when
  282. remapping KEY_UNKNOWN keys.
  283. The events are available in an input device, with the following id:
  284. Bus: BUS_HOST
  285. vendor: 0x1014 (PCI_VENDOR_ID_IBM) or
  286. 0x17aa (PCI_VENDOR_ID_LENOVO)
  287. product: 0x5054 ("TP")
  288. version: 0x4101
  289. The version will have its LSB incremented if the keymap changes in a
  290. backwards-compatible way. The MSB shall always be 0x41 for this input
  291. device. If the MSB is not 0x41, do not use the device as described in
  292. this section, as it is either something else (e.g. another input device
  293. exported by a thinkpad driver, such as HDAPS) or its functionality has
  294. been changed in a non-backwards compatible way.
  295. Adding other event types for other functionalities shall be considered a
  296. backwards-compatible change for this input device.
  297. Thinkpad-acpi Hot Key event map (version 0x4101):
  298. ACPI Scan
  299. event code Key Notes
  300. 0x1001 0x00 FN+F1 -
  301. 0x1002 0x01 FN+F2 IBM: battery (rare)
  302. Lenovo: Screen lock
  303. 0x1003 0x02 FN+F3 Many IBM models always report
  304. this hot key, even with hot keys
  305. disabled or with Fn+F3 masked
  306. off
  307. IBM: screen lock
  308. Lenovo: battery
  309. 0x1004 0x03 FN+F4 Sleep button (ACPI sleep button
  310. semantics, i.e. sleep-to-RAM).
  311. It is always generate some kind
  312. of event, either the hot key
  313. event or a ACPI sleep button
  314. event. The firmware may
  315. refuse to generate further FN+F4
  316. key presses until a S3 or S4 ACPI
  317. sleep cycle is performed or some
  318. time passes.
  319. 0x1005 0x04 FN+F5 Radio. Enables/disables
  320. the internal Bluetooth hardware
  321. and W-WAN card if left in control
  322. of the firmware. Does not affect
  323. the WLAN card.
  324. Should be used to turn on/off all
  325. radios (Bluetooth+W-WAN+WLAN),
  326. really.
  327. 0x1006 0x05 FN+F6 -
  328. 0x1007 0x06 FN+F7 Video output cycle.
  329. Do you feel lucky today?
  330. 0x1008 0x07 FN+F8 IBM: toggle screen expand
  331. Lenovo: configure UltraNav
  332. 0x1009 0x08 FN+F9 -
  333. .. .. ..
  334. 0x100B 0x0A FN+F11 -
  335. 0x100C 0x0B FN+F12 Sleep to disk. You are always
  336. supposed to handle it yourself,
  337. either through the ACPI event,
  338. or through a hotkey event.
  339. The firmware may refuse to
  340. generate further FN+F4 key
  341. press events until a S3 or S4
  342. ACPI sleep cycle is performed,
  343. or some time passes.
  344. 0x100D 0x0C FN+BACKSPACE -
  345. 0x100E 0x0D FN+INSERT -
  346. 0x100F 0x0E FN+DELETE -
  347. 0x1010 0x0F FN+HOME Brightness up. This key is
  348. always handled by the firmware
  349. in IBM ThinkPads, even when
  350. unmasked. Just leave it alone.
  351. For Lenovo ThinkPads with a new
  352. BIOS, it has to be handled either
  353. by the ACPI OSI, or by userspace.
  354. 0x1011 0x10 FN+END Brightness down. See brightness
  355. up for details.
  356. 0x1012 0x11 FN+PGUP ThinkLight toggle. This key is
  357. always handled by the firmware,
  358. even when unmasked.
  359. 0x1013 0x12 FN+PGDOWN -
  360. 0x1014 0x13 FN+SPACE Zoom key
  361. 0x1015 0x14 VOLUME UP Internal mixer volume up. This
  362. key is always handled by the
  363. firmware, even when unmasked.
  364. NOTE: Lenovo seems to be changing
  365. this.
  366. 0x1016 0x15 VOLUME DOWN Internal mixer volume up. This
  367. key is always handled by the
  368. firmware, even when unmasked.
  369. NOTE: Lenovo seems to be changing
  370. this.
  371. 0x1017 0x16 MUTE Mute internal mixer. This
  372. key is always handled by the
  373. firmware, even when unmasked.
  374. 0x1018 0x17 THINKPAD ThinkPad/Access IBM/Lenovo key
  375. 0x1019 0x18 unknown
  376. .. .. ..
  377. 0x1020 0x1F unknown
  378. The ThinkPad firmware does not allow one to differentiate when most hot
  379. keys are pressed or released (either that, or we don't know how to, yet).
  380. For these keys, the driver generates a set of events for a key press and
  381. immediately issues the same set of events for a key release. It is
  382. unknown by the driver if the ThinkPad firmware triggered these events on
  383. hot key press or release, but the firmware will do it for either one, not
  384. both.
  385. If a key is mapped to KEY_RESERVED, it generates no input events at all.
  386. If a key is mapped to KEY_UNKNOWN, it generates an input event that
  387. includes an scan code. If a key is mapped to anything else, it will
  388. generate input device EV_KEY events.
  389. In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
  390. events for switches:
  391. SW_RADIO T60 and later hardare rfkill rocker switch
  392. SW_TABLET_MODE Tablet ThinkPads HKEY events 0x5009 and 0x500A
  393. Non hot-key ACPI HKEY event map:
  394. 0x5001 Lid closed
  395. 0x5002 Lid opened
  396. 0x5009 Tablet swivel: switched to tablet mode
  397. 0x500A Tablet swivel: switched to normal mode
  398. 0x7000 Radio Switch may have changed state
  399. The above events are not propagated by the driver, except for legacy
  400. compatibility purposes when hotkey_report_mode is set to 1.
  401. 0x2304 System is waking up from suspend to undock
  402. 0x2305 System is waking up from suspend to eject bay
  403. 0x2404 System is waking up from hibernation to undock
  404. 0x2405 System is waking up from hibernation to eject bay
  405. The above events are never propagated by the driver.
  406. 0x3003 Bay ejection (see 0x2x05) complete, can sleep again
  407. 0x4003 Undocked (see 0x2x04), can sleep again
  408. 0x500B Tablet pen inserted into its storage bay
  409. 0x500C Tablet pen removed from its storage bay
  410. 0x5010 Brightness level changed (newer Lenovo BIOSes)
  411. The above events are propagated by the driver.
  412. Compatibility notes:
  413. ibm-acpi and thinkpad-acpi 0.15 (mainline kernels before 2.6.23) never
  414. supported the input layer, and sent events over the procfs ACPI event
  415. interface.
  416. To avoid sending duplicate events over the input layer and the ACPI
  417. event interface, thinkpad-acpi 0.16 implements a module parameter
  418. (hotkey_report_mode), and also a sysfs device attribute with the same
  419. name.
  420. Make no mistake here: userspace is expected to switch to using the input
  421. layer interface of thinkpad-acpi, together with the ACPI netlink event
  422. interface in kernels 2.6.23 and later, or with the ACPI procfs event
  423. interface in kernels 2.6.22 and earlier.
  424. If no hotkey_report_mode module parameter is specified (or it is set to
  425. zero), the driver defaults to mode 1 (see below), and on kernels 2.6.22
  426. and earlier, also allows one to change the hotkey_report_mode through
  427. sysfs. In kernels 2.6.23 and later, where the netlink ACPI event
  428. interface is available, hotkey_report_mode cannot be changed through
  429. sysfs (it is read-only).
  430. If the hotkey_report_mode module parameter is set to 1 or 2, it cannot
  431. be changed later through sysfs (any writes will return -EPERM to signal
  432. that hotkey_report_mode was locked. On 2.6.23 and later, where
  433. hotkey_report_mode cannot be changed at all, writes will return -EACCES).
  434. hotkey_report_mode set to 1 makes the driver export through the procfs
  435. ACPI event interface all hot key presses (which are *also* sent to the
  436. input layer). This is a legacy compatibility behaviour, and it is also
  437. the default mode of operation for the driver.
  438. hotkey_report_mode set to 2 makes the driver filter out the hot key
  439. presses from the procfs ACPI event interface, so these events will only
  440. be sent through the input layer. Userspace that has been updated to use
  441. the thinkpad-acpi input layer interface should set hotkey_report_mode to
  442. 2.
  443. Hot key press events are never sent to the ACPI netlink event interface.
  444. Really up-to-date userspace under kernel 2.6.23 and later is to use the
  445. netlink interface and the input layer interface, and don't bother at all
  446. with hotkey_report_mode.
  447. Bluetooth
  448. ---------
  449. procfs: /proc/acpi/ibm/bluetooth
  450. sysfs device attribute: bluetooth_enable
  451. This feature shows the presence and current state of a ThinkPad
  452. Bluetooth device in the internal ThinkPad CDC slot.
  453. Procfs notes:
  454. If Bluetooth is installed, the following commands can be used:
  455. echo enable > /proc/acpi/ibm/bluetooth
  456. echo disable > /proc/acpi/ibm/bluetooth
  457. Sysfs notes:
  458. If the Bluetooth CDC card is installed, it can be enabled /
  459. disabled through the "bluetooth_enable" thinkpad-acpi device
  460. attribute, and its current status can also be queried.
  461. enable:
  462. 0: disables Bluetooth / Bluetooth is disabled
  463. 1: enables Bluetooth / Bluetooth is enabled.
  464. Note: this interface will be probably be superseded by the
  465. generic rfkill class, so it is NOT to be considered stable yet.
  466. Video output control -- /proc/acpi/ibm/video
  467. --------------------------------------------
  468. This feature allows control over the devices used for video output -
  469. LCD, CRT or DVI (if available). The following commands are available:
  470. echo lcd_enable > /proc/acpi/ibm/video
  471. echo lcd_disable > /proc/acpi/ibm/video
  472. echo crt_enable > /proc/acpi/ibm/video
  473. echo crt_disable > /proc/acpi/ibm/video
  474. echo dvi_enable > /proc/acpi/ibm/video
  475. echo dvi_disable > /proc/acpi/ibm/video
  476. echo auto_enable > /proc/acpi/ibm/video
  477. echo auto_disable > /proc/acpi/ibm/video
  478. echo expand_toggle > /proc/acpi/ibm/video
  479. echo video_switch > /proc/acpi/ibm/video
  480. Each video output device can be enabled or disabled individually.
  481. Reading /proc/acpi/ibm/video shows the status of each device.
  482. Automatic video switching can be enabled or disabled. When automatic
  483. video switching is enabled, certain events (e.g. opening the lid,
  484. docking or undocking) cause the video output device to change
  485. automatically. While this can be useful, it also causes flickering
  486. and, on the X40, video corruption. By disabling automatic switching,
  487. the flickering or video corruption can be avoided.
  488. The video_switch command cycles through the available video outputs
  489. (it simulates the behavior of Fn-F7).
  490. Video expansion can be toggled through this feature. This controls
  491. whether the display is expanded to fill the entire LCD screen when a
  492. mode with less than full resolution is used. Note that the current
  493. video expansion status cannot be determined through this feature.
  494. Note that on many models (particularly those using Radeon graphics
  495. chips) the X driver configures the video card in a way which prevents
  496. Fn-F7 from working. This also disables the video output switching
  497. features of this driver, as it uses the same ACPI methods as
  498. Fn-F7. Video switching on the console should still work.
  499. UPDATE: There's now a patch for the X.org Radeon driver which
  500. addresses this issue. Some people are reporting success with the patch
  501. while others are still having problems. For more information:
  502. https://bugs.freedesktop.org/show_bug.cgi?id=2000
  503. ThinkLight control -- /proc/acpi/ibm/light
  504. ------------------------------------------
  505. The current status of the ThinkLight can be found in this file. A few
  506. models which do not make the status available will show it as
  507. "unknown". The available commands are:
  508. echo on > /proc/acpi/ibm/light
  509. echo off > /proc/acpi/ibm/light
  510. Docking / undocking -- /proc/acpi/ibm/dock
  511. ------------------------------------------
  512. Docking and undocking (e.g. with the X4 UltraBase) requires some
  513. actions to be taken by the operating system to safely make or break
  514. the electrical connections with the dock.
  515. The docking feature of this driver generates the following ACPI events:
  516. ibm/dock GDCK 00000003 00000001 -- eject request
  517. ibm/dock GDCK 00000003 00000002 -- undocked
  518. ibm/dock GDCK 00000000 00000003 -- docked
  519. NOTE: These events will only be generated if the laptop was docked
  520. when originally booted. This is due to the current lack of support for
  521. hot plugging of devices in the Linux ACPI framework. If the laptop was
  522. booted while not in the dock, the following message is shown in the
  523. logs:
  524. Mar 17 01:42:34 aero kernel: thinkpad_acpi: dock device not present
  525. In this case, no dock-related events are generated but the dock and
  526. undock commands described below still work. They can be executed
  527. manually or triggered by Fn key combinations (see the example acpid
  528. configuration files included in the driver tarball package available
  529. on the web site).
  530. When the eject request button on the dock is pressed, the first event
  531. above is generated. The handler for this event should issue the
  532. following command:
  533. echo undock > /proc/acpi/ibm/dock
  534. After the LED on the dock goes off, it is safe to eject the laptop.
  535. Note: if you pressed this key by mistake, go ahead and eject the
  536. laptop, then dock it back in. Otherwise, the dock may not function as
  537. expected.
  538. When the laptop is docked, the third event above is generated. The
  539. handler for this event should issue the following command to fully
  540. enable the dock:
  541. echo dock > /proc/acpi/ibm/dock
  542. The contents of the /proc/acpi/ibm/dock file shows the current status
  543. of the dock, as provided by the ACPI framework.
  544. The docking support in this driver does not take care of enabling or
  545. disabling any other devices you may have attached to the dock. For
  546. example, a CD drive plugged into the UltraBase needs to be disabled or
  547. enabled separately. See the provided example acpid configuration files
  548. for how this can be accomplished.
  549. There is no support yet for PCI devices that may be attached to a
  550. docking station, e.g. in the ThinkPad Dock II. The driver currently
  551. does not recognize, enable or disable such devices. This means that
  552. the only docking stations currently supported are the X-series
  553. UltraBase docks and "dumb" port replicators like the Mini Dock (the
  554. latter don't need any ACPI support, actually).
  555. UltraBay eject -- /proc/acpi/ibm/bay
  556. ------------------------------------
  557. Inserting or ejecting an UltraBay device requires some actions to be
  558. taken by the operating system to safely make or break the electrical
  559. connections with the device.
  560. This feature generates the following ACPI events:
  561. ibm/bay MSTR 00000003 00000000 -- eject request
  562. ibm/bay MSTR 00000001 00000000 -- eject lever inserted
  563. NOTE: These events will only be generated if the UltraBay was present
  564. when the laptop was originally booted (on the X series, the UltraBay
  565. is in the dock, so it may not be present if the laptop was undocked).
  566. This is due to the current lack of support for hot plugging of devices
  567. in the Linux ACPI framework. If the laptop was booted without the
  568. UltraBay, the following message is shown in the logs:
  569. Mar 17 01:42:34 aero kernel: thinkpad_acpi: bay device not present
  570. In this case, no bay-related events are generated but the eject
  571. command described below still works. It can be executed manually or
  572. triggered by a hot key combination.
  573. Sliding the eject lever generates the first event shown above. The
  574. handler for this event should take whatever actions are necessary to
  575. shut down the device in the UltraBay (e.g. call idectl), then issue
  576. the following command:
  577. echo eject > /proc/acpi/ibm/bay
  578. After the LED on the UltraBay goes off, it is safe to pull out the
  579. device.
  580. When the eject lever is inserted, the second event above is
  581. generated. The handler for this event should take whatever actions are
  582. necessary to enable the UltraBay device (e.g. call idectl).
  583. The contents of the /proc/acpi/ibm/bay file shows the current status
  584. of the UltraBay, as provided by the ACPI framework.
  585. EXPERIMENTAL warm eject support on the 600e/x, A22p and A3x (To use
  586. this feature, you need to supply the experimental=1 parameter when
  587. loading the module):
  588. These models do not have a button near the UltraBay device to request
  589. a hot eject but rather require the laptop to be put to sleep
  590. (suspend-to-ram) before the bay device is ejected or inserted).
  591. The sequence of steps to eject the device is as follows:
  592. echo eject > /proc/acpi/ibm/bay
  593. put the ThinkPad to sleep
  594. remove the drive
  595. resume from sleep
  596. cat /proc/acpi/ibm/bay should show that the drive was removed
  597. On the A3x, both the UltraBay 2000 and UltraBay Plus devices are
  598. supported. Use "eject2" instead of "eject" for the second bay.
  599. Note: the UltraBay eject support on the 600e/x, A22p and A3x is
  600. EXPERIMENTAL and may not work as expected. USE WITH CAUTION!
  601. CMOS control
  602. ------------
  603. procfs: /proc/acpi/ibm/cmos
  604. sysfs device attribute: cmos_command
  605. This feature is mostly used internally by the ACPI firmware to keep the legacy
  606. CMOS NVRAM bits in sync with the current machine state, and to record this
  607. state so that the ThinkPad will retain such settings across reboots.
  608. Some of these commands actually perform actions in some ThinkPad models, but
  609. this is expected to disappear more and more in newer models. As an example, in
  610. a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
  611. real, but commands 0 to 2 don't control the mixer anymore (they have been
  612. phased out) and just update the NVRAM.
  613. The range of valid cmos command numbers is 0 to 21, but not all have an
  614. effect and the behavior varies from model to model. Here is the behavior
  615. on the X40 (tpb is the ThinkPad Buttons utility):
  616. 0 - Related to "Volume down" key press
  617. 1 - Related to "Volume up" key press
  618. 2 - Related to "Mute on" key press
  619. 3 - Related to "Access IBM" key press
  620. 4 - Related to "LCD brightness up" key press
  621. 5 - Related to "LCD brightness down" key press
  622. 11 - Related to "toggle screen expansion" key press/function
  623. 12 - Related to "ThinkLight on"
  624. 13 - Related to "ThinkLight off"
  625. 14 - Related to "ThinkLight" key press (toggle ThinkLight)
  626. The cmos command interface is prone to firmware split-brain problems, as
  627. in newer ThinkPads it is just a compatibility layer. Do not use it, it is
  628. exported just as a debug tool.
  629. LED control -- /proc/acpi/ibm/led
  630. ---------------------------------
  631. Some of the LED indicators can be controlled through this feature. The
  632. available commands are:
  633. echo '<led number> on' >/proc/acpi/ibm/led
  634. echo '<led number> off' >/proc/acpi/ibm/led
  635. echo '<led number> blink' >/proc/acpi/ibm/led
  636. The <led number> range is 0 to 7. The set of LEDs that can be
  637. controlled varies from model to model. Here is the mapping on the X40:
  638. 0 - power
  639. 1 - battery (orange)
  640. 2 - battery (green)
  641. 3 - UltraBase
  642. 4 - UltraBay
  643. 7 - standby
  644. All of the above can be turned on and off and can be made to blink.
  645. ACPI sounds -- /proc/acpi/ibm/beep
  646. ----------------------------------
  647. The BEEP method is used internally by the ACPI firmware to provide
  648. audible alerts in various situations. This feature allows the same
  649. sounds to be triggered manually.
  650. The commands are non-negative integer numbers:
  651. echo <number> >/proc/acpi/ibm/beep
  652. The valid <number> range is 0 to 17. Not all numbers trigger sounds
  653. and the sounds vary from model to model. Here is the behavior on the
  654. X40:
  655. 0 - stop a sound in progress (but use 17 to stop 16)
  656. 2 - two beeps, pause, third beep ("low battery")
  657. 3 - single beep
  658. 4 - high, followed by low-pitched beep ("unable")
  659. 5 - single beep
  660. 6 - very high, followed by high-pitched beep ("AC/DC")
  661. 7 - high-pitched beep
  662. 9 - three short beeps
  663. 10 - very long beep
  664. 12 - low-pitched beep
  665. 15 - three high-pitched beeps repeating constantly, stop with 0
  666. 16 - one medium-pitched beep repeating constantly, stop with 17
  667. 17 - stop 16
  668. Temperature sensors
  669. -------------------
  670. procfs: /proc/acpi/ibm/thermal
  671. sysfs device attributes: (hwmon "thinkpad") temp*_input
  672. Most ThinkPads include six or more separate temperature sensors but only
  673. expose the CPU temperature through the standard ACPI methods. This
  674. feature shows readings from up to eight different sensors on older
  675. ThinkPads, and up to sixteen different sensors on newer ThinkPads.
  676. For example, on the X40, a typical output may be:
  677. temperatures: 42 42 45 41 36 -128 33 -128
  678. On the T43/p, a typical output may be:
  679. temperatures: 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
  680. The mapping of thermal sensors to physical locations varies depending on
  681. system-board model (and thus, on ThinkPad model).
  682. http://thinkwiki.org/wiki/Thermal_Sensors is a public wiki page that
  683. tries to track down these locations for various models.
  684. Most (newer?) models seem to follow this pattern:
  685. 1: CPU
  686. 2: (depends on model)
  687. 3: (depends on model)
  688. 4: GPU
  689. 5: Main battery: main sensor
  690. 6: Bay battery: main sensor
  691. 7: Main battery: secondary sensor
  692. 8: Bay battery: secondary sensor
  693. 9-15: (depends on model)
  694. For the R51 (source: Thomas Gruber):
  695. 2: Mini-PCI
  696. 3: Internal HDD
  697. For the T43, T43/p (source: Shmidoax/Thinkwiki.org)
  698. http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_T43.2C_T43p
  699. 2: System board, left side (near PCMCIA slot), reported as HDAPS temp
  700. 3: PCMCIA slot
  701. 9: MCH (northbridge) to DRAM Bus
  702. 10: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
  703. card, under touchpad
  704. 11: Power regulator, underside of system board, below F2 key
  705. The A31 has a very atypical layout for the thermal sensors
  706. (source: Milos Popovic, http://thinkwiki.org/wiki/Thermal_Sensors#ThinkPad_A31)
  707. 1: CPU
  708. 2: Main Battery: main sensor
  709. 3: Power Converter
  710. 4: Bay Battery: main sensor
  711. 5: MCH (northbridge)
  712. 6: PCMCIA/ambient
  713. 7: Main Battery: secondary sensor
  714. 8: Bay Battery: secondary sensor
  715. Procfs notes:
  716. Readings from sensors that are not available return -128.
  717. No commands can be written to this file.
  718. Sysfs notes:
  719. Sensors that are not available return the ENXIO error. This
  720. status may change at runtime, as there are hotplug thermal
  721. sensors, like those inside the batteries and docks.
  722. thinkpad-acpi thermal sensors are reported through the hwmon
  723. subsystem, and follow all of the hwmon guidelines at
  724. Documentation/hwmon.
  725. EXPERIMENTAL: Embedded controller register dump -- /proc/acpi/ibm/ecdump
  726. ------------------------------------------------------------------------
  727. This feature is marked EXPERIMENTAL because the implementation
  728. directly accesses hardware registers and may not work as expected. USE
  729. WITH CAUTION! To use this feature, you need to supply the
  730. experimental=1 parameter when loading the module.
  731. This feature dumps the values of 256 embedded controller
  732. registers. Values which have changed since the last time the registers
  733. were dumped are marked with a star:
  734. [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
  735. EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
  736. EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
  737. EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
  738. EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
  739. EC 0x30: 01 07 1a 00 30 04 00 00 *85 00 00 10 00 50 00 00
  740. EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
  741. EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 *bc *02 *bc
  742. EC 0x60: *02 *bc *02 00 00 00 00 00 00 00 00 00 00 00 00 00
  743. EC 0x70: 00 00 00 00 00 12 30 40 *24 *26 *2c *27 *20 80 *1f 80
  744. EC 0x80: 00 00 00 06 *37 *0e 03 00 00 00 0e 07 00 00 00 00
  745. EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  746. EC 0xa0: *ff 09 ff 09 ff ff *64 00 *00 *00 *a2 41 *ff *ff *e0 00
  747. EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  748. EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  749. EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  750. EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
  751. EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
  752. This feature can be used to determine the register holding the fan
  753. speed on some models. To do that, do the following:
  754. - make sure the battery is fully charged
  755. - make sure the fan is running
  756. - run 'cat /proc/acpi/ibm/ecdump' several times, once per second or so
  757. The first step makes sure various charging-related values don't
  758. vary. The second ensures that the fan-related values do vary, since
  759. the fan speed fluctuates a bit. The third will (hopefully) mark the
  760. fan register with a star:
  761. [root@x40 ibm-acpi]# cat /proc/acpi/ibm/ecdump
  762. EC +00 +01 +02 +03 +04 +05 +06 +07 +08 +09 +0a +0b +0c +0d +0e +0f
  763. EC 0x00: a7 47 87 01 fe 96 00 08 01 00 cb 00 00 00 40 00
  764. EC 0x10: 00 00 ff ff f4 3c 87 09 01 ff 42 01 ff ff 0d 00
  765. EC 0x20: 00 00 00 00 00 00 00 00 00 00 00 03 43 00 00 80
  766. EC 0x30: 01 07 1a 00 30 04 00 00 85 00 00 10 00 50 00 00
  767. EC 0x40: 00 00 00 00 00 00 14 01 00 04 00 00 00 00 00 00
  768. EC 0x50: 00 c0 02 0d 00 01 01 02 02 03 03 03 03 bc 02 bc
  769. EC 0x60: 02 bc 02 00 00 00 00 00 00 00 00 00 00 00 00 00
  770. EC 0x70: 00 00 00 00 00 12 30 40 24 27 2c 27 21 80 1f 80
  771. EC 0x80: 00 00 00 06 *be 0d 03 00 00 00 0e 07 00 00 00 00
  772. EC 0x90: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  773. EC 0xa0: ff 09 ff 09 ff ff 64 00 00 00 a2 41 ff ff e0 00
  774. EC 0xb0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  775. EC 0xc0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  776. EC 0xd0: 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  777. EC 0xe0: 00 00 00 00 00 00 00 00 11 20 49 04 24 06 55 03
  778. EC 0xf0: 31 55 48 54 35 38 57 57 08 2f 45 73 07 65 6c 1a
  779. Another set of values that varies often is the temperature
  780. readings. Since temperatures don't change vary fast, you can take
  781. several quick dumps to eliminate them.
  782. You can use a similar method to figure out the meaning of other
  783. embedded controller registers - e.g. make sure nothing else changes
  784. except the charging or discharging battery to determine which
  785. registers contain the current battery capacity, etc. If you experiment
  786. with this, do send me your results (including some complete dumps with
  787. a description of the conditions when they were taken.)
  788. LCD brightness control
  789. ----------------------
  790. procfs: /proc/acpi/ibm/brightness
  791. sysfs backlight device "thinkpad_screen"
  792. This feature allows software control of the LCD brightness on ThinkPad
  793. models which don't have a hardware brightness slider.
  794. It has some limitations: the LCD backlight cannot be actually turned on or
  795. off by this interface, and in many ThinkPad models, the "dim while on
  796. battery" functionality will be enabled by the BIOS when this interface is
  797. used, and cannot be controlled.
  798. On IBM (and some of the earlier Lenovo) ThinkPads, the backlight control
  799. has eight brightness levels, ranging from 0 to 7. Some of the levels
  800. may not be distinct. Later Lenovo models that implement the ACPI
  801. display backlight brightness control methods have 16 levels, ranging
  802. from 0 to 15.
  803. There are two interfaces to the firmware for direct brightness control,
  804. EC and CMOS. To select which one should be used, use the
  805. brightness_mode module parameter: brightness_mode=1 selects EC mode,
  806. brightness_mode=2 selects CMOS mode, brightness_mode=3 selects both EC
  807. and CMOS. The driver tries to auto-detect which interface to use.
  808. When display backlight brightness controls are available through the
  809. standard ACPI interface, it is best to use it instead of this direct
  810. ThinkPad-specific interface. The driver will disable its native
  811. backlight brightness control interface if it detects that the standard
  812. ACPI interface is available in the ThinkPad.
  813. The brightness_enable module parameter can be used to control whether
  814. the LCD brightness control feature will be enabled when available.
  815. brightness_enable=0 forces it to be disabled. brightness_enable=1
  816. forces it to be enabled when available, even if the standard ACPI
  817. interface is also available.
  818. Procfs notes:
  819. The available commands are:
  820. echo up >/proc/acpi/ibm/brightness
  821. echo down >/proc/acpi/ibm/brightness
  822. echo 'level <level>' >/proc/acpi/ibm/brightness
  823. Sysfs notes:
  824. The interface is implemented through the backlight sysfs class, which is
  825. poorly documented at this time.
  826. Locate the thinkpad_screen device under /sys/class/backlight, and inside
  827. it there will be the following attributes:
  828. max_brightness:
  829. Reads the maximum brightness the hardware can be set to.
  830. The minimum is always zero.
  831. actual_brightness:
  832. Reads what brightness the screen is set to at this instant.
  833. brightness:
  834. Writes request the driver to change brightness to the
  835. given value. Reads will tell you what brightness the
  836. driver is trying to set the display to when "power" is set
  837. to zero and the display has not been dimmed by a kernel
  838. power management event.
  839. power:
  840. power management mode, where 0 is "display on", and 1 to 3
  841. will dim the display backlight to brightness level 0
  842. because thinkpad-acpi cannot really turn the backlight
  843. off. Kernel power management events can temporarily
  844. increase the current power management level, i.e. they can
  845. dim the display.
  846. Volume control -- /proc/acpi/ibm/volume
  847. ---------------------------------------
  848. This feature allows volume control on ThinkPad models which don't have
  849. a hardware volume knob. The available commands are:
  850. echo up >/proc/acpi/ibm/volume
  851. echo down >/proc/acpi/ibm/volume
  852. echo mute >/proc/acpi/ibm/volume
  853. echo 'level <level>' >/proc/acpi/ibm/volume
  854. The <level> number range is 0 to 15 although not all of them may be
  855. distinct. The unmute the volume after the mute command, use either the
  856. up or down command (the level command will not unmute the volume).
  857. The current volume level and mute state is shown in the file.
  858. Fan control and monitoring: fan speed, fan enable/disable
  859. ---------------------------------------------------------
  860. procfs: /proc/acpi/ibm/fan
  861. sysfs device attributes: (hwmon "thinkpad") fan1_input, pwm1,
  862. pwm1_enable
  863. sysfs hwmon driver attributes: fan_watchdog
  864. NOTE NOTE NOTE: fan control operations are disabled by default for
  865. safety reasons. To enable them, the module parameter "fan_control=1"
  866. must be given to thinkpad-acpi.
  867. This feature attempts to show the current fan speed, control mode and
  868. other fan data that might be available. The speed is read directly
  869. from the hardware registers of the embedded controller. This is known
  870. to work on later R, T, X and Z series ThinkPads but may show a bogus
  871. value on other models.
  872. Fan levels:
  873. Most ThinkPad fans work in "levels" at the firmware interface. Level 0
  874. stops the fan. The higher the level, the higher the fan speed, although
  875. adjacent levels often map to the same fan speed. 7 is the highest
  876. level, where the fan reaches the maximum recommended speed.
  877. Level "auto" means the EC changes the fan level according to some
  878. internal algorithm, usually based on readings from the thermal sensors.
  879. There is also a "full-speed" level, also known as "disengaged" level.
  880. In this level, the EC disables the speed-locked closed-loop fan control,
  881. and drives the fan as fast as it can go, which might exceed hardware
  882. limits, so use this level with caution.
  883. The fan usually ramps up or down slowly from one speed to another, and
  884. it is normal for the EC to take several seconds to react to fan
  885. commands. The full-speed level may take up to two minutes to ramp up to
  886. maximum speed, and in some ThinkPads, the tachometer readings go stale
  887. while the EC is transitioning to the full-speed level.
  888. WARNING WARNING WARNING: do not leave the fan disabled unless you are
  889. monitoring all of the temperature sensor readings and you are ready to
  890. enable it if necessary to avoid overheating.
  891. An enabled fan in level "auto" may stop spinning if the EC decides the
  892. ThinkPad is cool enough and doesn't need the extra airflow. This is
  893. normal, and the EC will spin the fan up if the various thermal readings
  894. rise too much.
  895. On the X40, this seems to depend on the CPU and HDD temperatures.
  896. Specifically, the fan is turned on when either the CPU temperature
  897. climbs to 56 degrees or the HDD temperature climbs to 46 degrees. The
  898. fan is turned off when the CPU temperature drops to 49 degrees and the
  899. HDD temperature drops to 41 degrees. These thresholds cannot
  900. currently be controlled.
  901. The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
  902. certain conditions are met. It will override any fan programming done
  903. through thinkpad-acpi.
  904. The thinkpad-acpi kernel driver can be programmed to revert the fan
  905. level to a safe setting if userspace does not issue one of the procfs
  906. fan commands: "enable", "disable", "level" or "watchdog", or if there
  907. are no writes to pwm1_enable (or to pwm1 *if and only if* pwm1_enable is
  908. set to 1, manual mode) within a configurable amount of time of up to
  909. 120 seconds. This functionality is called fan safety watchdog.
  910. Note that the watchdog timer stops after it enables the fan. It will be
  911. rearmed again automatically (using the same interval) when one of the
  912. above mentioned fan commands is received. The fan watchdog is,
  913. therefore, not suitable to protect against fan mode changes made through
  914. means other than the "enable", "disable", and "level" procfs fan
  915. commands, or the hwmon fan control sysfs interface.
  916. Procfs notes:
  917. The fan may be enabled or disabled with the following commands:
  918. echo enable >/proc/acpi/ibm/fan
  919. echo disable >/proc/acpi/ibm/fan
  920. Placing a fan on level 0 is the same as disabling it. Enabling a fan
  921. will try to place it in a safe level if it is too slow or disabled.
  922. The fan level can be controlled with the command:
  923. echo 'level <level>' > /proc/acpi/ibm/fan
  924. Where <level> is an integer from 0 to 7, or one of the words "auto" or
  925. "full-speed" (without the quotes). Not all ThinkPads support the "auto"
  926. and "full-speed" levels. The driver accepts "disengaged" as an alias for
  927. "full-speed", and reports it as "disengaged" for backwards
  928. compatibility.
  929. On the X31 and X40 (and ONLY on those models), the fan speed can be
  930. controlled to a certain degree. Once the fan is running, it can be
  931. forced to run faster or slower with the following command:
  932. echo 'speed <speed>' > /proc/acpi/ibm/fan
  933. The sustainable range of fan speeds on the X40 appears to be from about
  934. 3700 to about 7350. Values outside this range either do not have any
  935. effect or the fan speed eventually settles somewhere in that range. The
  936. fan cannot be stopped or started with this command. This functionality
  937. is incomplete, and not available through the sysfs interface.
  938. To program the safety watchdog, use the "watchdog" command.
  939. echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
  940. If you want to disable the watchdog, use 0 as the interval.
  941. Sysfs notes:
  942. The sysfs interface follows the hwmon subsystem guidelines for the most
  943. part, and the exception is the fan safety watchdog.
  944. Writes to any of the sysfs attributes may return the EINVAL error if
  945. that operation is not supported in a given ThinkPad or if the parameter
  946. is out-of-bounds, and EPERM if it is forbidden. They may also return
  947. EINTR (interrupted system call), and EIO (I/O error while trying to talk
  948. to the firmware).
  949. Features not yet implemented by the driver return ENOSYS.
  950. hwmon device attribute pwm1_enable:
  951. 0: PWM offline (fan is set to full-speed mode)
  952. 1: Manual PWM control (use pwm1 to set fan level)
  953. 2: Hardware PWM control (EC "auto" mode)
  954. 3: reserved (Software PWM control, not implemented yet)
  955. Modes 0 and 2 are not supported by all ThinkPads, and the
  956. driver is not always able to detect this. If it does know a
  957. mode is unsupported, it will return -EINVAL.
  958. hwmon device attribute pwm1:
  959. Fan level, scaled from the firmware values of 0-7 to the hwmon
  960. scale of 0-255. 0 means fan stopped, 255 means highest normal
  961. speed (level 7).
  962. This attribute only commands the fan if pmw1_enable is set to 1
  963. (manual PWM control).
  964. hwmon device attribute fan1_input:
  965. Fan tachometer reading, in RPM. May go stale on certain
  966. ThinkPads while the EC transitions the PWM to offline mode,
  967. which can take up to two minutes. May return rubbish on older
  968. ThinkPads.
  969. hwmon driver attribute fan_watchdog:
  970. Fan safety watchdog timer interval, in seconds. Minimum is
  971. 1 second, maximum is 120 seconds. 0 disables the watchdog.
  972. To stop the fan: set pwm1 to zero, and pwm1_enable to 1.
  973. To start the fan in a safe mode: set pwm1_enable to 2. If that fails
  974. with EINVAL, try to set pwm1_enable to 1 and pwm1 to at least 128 (255
  975. would be the safest choice, though).
  976. EXPERIMENTAL: WAN
  977. -----------------
  978. procfs: /proc/acpi/ibm/wan
  979. sysfs device attribute: wwan_enable
  980. This feature is marked EXPERIMENTAL because the implementation
  981. directly accesses hardware registers and may not work as expected. USE
  982. WITH CAUTION! To use this feature, you need to supply the
  983. experimental=1 parameter when loading the module.
  984. This feature shows the presence and current state of a W-WAN (Sierra
  985. Wireless EV-DO) device.
  986. It was tested on a Lenovo ThinkPad X60. It should probably work on other
  987. ThinkPad models which come with this module installed.
  988. Procfs notes:
  989. If the W-WAN card is installed, the following commands can be used:
  990. echo enable > /proc/acpi/ibm/wan
  991. echo disable > /proc/acpi/ibm/wan
  992. Sysfs notes:
  993. If the W-WAN card is installed, it can be enabled /
  994. disabled through the "wwan_enable" thinkpad-acpi device
  995. attribute, and its current status can also be queried.
  996. enable:
  997. 0: disables WWAN card / WWAN card is disabled
  998. 1: enables WWAN card / WWAN card is enabled.
  999. Note: this interface will be probably be superseded by the
  1000. generic rfkill class, so it is NOT to be considered stable yet.
  1001. Multiple Commands, Module Parameters
  1002. ------------------------------------
  1003. Multiple commands can be written to the proc files in one shot by
  1004. separating them with commas, for example:
  1005. echo enable,0xffff > /proc/acpi/ibm/hotkey
  1006. echo lcd_disable,crt_enable > /proc/acpi/ibm/video
  1007. Commands can also be specified when loading the thinkpad-acpi module,
  1008. for example:
  1009. modprobe thinkpad_acpi hotkey=enable,0xffff video=auto_disable
  1010. Enabling debugging output
  1011. -------------------------
  1012. The module takes a debug parameter which can be used to selectively
  1013. enable various classes of debugging output, for example:
  1014. modprobe thinkpad_acpi debug=0xffff
  1015. will enable all debugging output classes. It takes a bitmask, so
  1016. to enable more than one output class, just add their values.
  1017. Debug bitmask Description
  1018. 0x0001 Initialization and probing
  1019. 0x0002 Removal
  1020. There is also a kernel build option to enable more debugging
  1021. information, which may be necessary to debug driver problems.
  1022. The level of debugging information output by the driver can be changed
  1023. at runtime through sysfs, using the driver attribute debug_level. The
  1024. attribute takes the same bitmask as the debug module parameter above.
  1025. Force loading of module
  1026. -----------------------
  1027. If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
  1028. the module parameter force_load=1. Regardless of whether this works or
  1029. not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
  1030. Sysfs interface changelog:
  1031. 0x000100: Initial sysfs support, as a single platform driver and
  1032. device.
  1033. 0x000200: Hot key support for 32 hot keys, and radio slider switch
  1034. support.
  1035. 0x010000: Hot keys are now handled by default over the input
  1036. layer, the radio switch generates input event EV_RADIO,
  1037. and the driver enables hot key handling by default in
  1038. the firmware.
  1039. 0x020000: ABI fix: added a separate hwmon platform device and
  1040. driver, which must be located by name (thinkpad)
  1041. and the hwmon class for libsensors4 (lm-sensors 3)
  1042. compatibility. Moved all hwmon attributes to this
  1043. new platform device.
  1044. 0x020100: Marker for thinkpad-acpi with hot key NVRAM polling
  1045. support. If you must, use it to know you should not
  1046. start an userspace NVRAM poller (allows to detect when
  1047. NVRAM is compiled out by the user because it is
  1048. unneeded/undesired in the first place).
  1049. 0x020101: Marker for thinkpad-acpi with hot key NVRAM polling
  1050. and proper hotkey_mask semantics (version 8 of the
  1051. NVRAM polling patch). Some development snapshots of
  1052. 0.18 had an earlier version that did strange things
  1053. to hotkey_mask.
  1054. 0x020200: Add poll()/select() support to the following attributes:
  1055. hotkey_radio_sw, wakeup_hotunplug_complete, wakeup_reason