thinkpad-acpi.txt 54 KB

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