~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/admin-guide/laptops/thinkpad-acpi.rst

Version: ~ [ linux-6.11.5 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.58 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.114 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.169 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.228 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.284 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.322 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.9 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /Documentation/admin-guide/laptops/thinkpad-acpi.rst (Version linux-6.11.5) and /Documentation/admin-guide/laptops/thinkpad-acpi.rst (Version linux-4.17.19)


  1 ===========================                       
  2 ThinkPad ACPI Extras Driver                       
  3 ===========================                       
  4                                                   
  5 Version 0.25                                      
  6                                                   
  7 October 16th,  2013                               
  8                                                   
  9 - Borislav Deianov <borislav@users.sf.net>         
 10 - Henrique de Moraes Holschuh <hmh@hmh.eng.br>     
 11                                                   
 12 http://ibm-acpi.sf.net/                           
 13                                                   
 14 This is a Linux driver for the IBM and Lenovo     
 15 supports various features of these laptops whi    
 16 through the ACPI and ACPI EC framework, but no    
 17 supported by the generic Linux ACPI drivers.      
 18                                                   
 19 This driver used to be named ibm-acpi until ke    
 20 0.13-20070314.  It used to be in the drivers/a    
 21 moved to the drivers/misc tree and renamed to     
 22 2.6.22, and release 0.14.  It was moved to dri    
 23 kernel 2.6.29 and release 0.22.                   
 24                                                   
 25 The driver is named "thinkpad-acpi".  In some     
 26 names and log messages, "thinkpad_acpi" is use    
 27 issues.                                           
 28                                                   
 29 "tpacpi" is used as a shorthand where "thinkpa    
 30 long due to length limitations on some Linux k    
 31                                                   
 32 Status                                            
 33 ------                                            
 34                                                   
 35 The features currently supported are the follo    
 36 detailed description):                            
 37                                                   
 38         - Fn key combinations                     
 39         - Bluetooth enable and disable            
 40         - video output switching, expansion co    
 41         - ThinkLight on and off                   
 42         - CMOS/UCMS control                       
 43         - LED control                             
 44         - ACPI sounds                             
 45         - temperature sensors                     
 46         - Experimental: embedded controller re    
 47         - LCD brightness control                  
 48         - Volume control                          
 49         - Fan control and monitoring: fan spee    
 50         - WAN enable and disable                  
 51         - UWB enable and disable                  
 52         - LCD Shadow (PrivacyGuard) enable and    
 53         - Lap mode sensor                         
 54         - Setting keyboard language               
 55         - WWAN Antenna type                       
 56         - Auxmac                                  
 57                                                   
 58 A compatibility table by model and feature is     
 59 site, http://ibm-acpi.sf.net/. I appreciate an    
 60 reports, especially if they add to or correct     
 61 Please include the following information in yo    
 62                                                   
 63         - ThinkPad model name                     
 64         - a copy of your ACPI tables, using th    
 65         - a copy of the output of dmidecode, w    
 66           and UUIDs masked off                    
 67         - which driver features work and which    
 68         - the observed behavior of non-working    
 69                                                   
 70 Any other comments or patches are also more th    
 71                                                   
 72                                                   
 73 Installation                                      
 74 ------------                                      
 75                                                   
 76 If you are compiling this driver as included i    
 77 sources, look for the CONFIG_THINKPAD_ACPI Kco    
 78 It is located on the menu path: "Device Driver    
 79 Specific Device Drivers" -> "ThinkPad ACPI Lap    
 80                                                   
 81                                                   
 82 Features                                          
 83 --------                                          
 84                                                   
 85 The driver exports two different interfaces to    
 86 used to access the features it provides.  One     
 87 interface, which will be removed at some time     
 88 is a new sysfs-based interface which is not co    
 89                                                   
 90 The procfs interface creates the /proc/acpi/ib    
 91 file under that directory for each feature it     
 92 interface is mostly frozen, and will change ve    
 93 will not be extended to add any new functional    
 94 all new functionality will be implemented on t    
 95                                                   
 96 The sysfs interface tries to blend in the gene    
 97 and classes as much as possible.  Since some o    
 98 yet ready or stabilized, it is expected that t    
 99 and any and all userspace programs must deal w    
100                                                   
101                                                   
102 Notes about the sysfs interface                   
103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^                   
104                                                   
105 Unlike what was done with the procfs interface    
106 to the sysfs interfaces will be enforced, as w    
107 thinkpad-acpi's implementation of sysfs interf    
108                                                   
109 Also, any bugs in the thinkpad-acpi sysfs driv    
110 thinkpad-acpi's implementation of the sysfs in    
111 maximum correctness, even if that means changi    
112 non-compatible ways.  As these interfaces matu    
113 in thinkpad-acpi, such changes should become q    
114                                                   
115 Applications interfacing to the thinkpad-acpi     
116 follow all sysfs guidelines and correctly proc    
117 interface makes extensive use of errors).  Fil    
118 close operations to the sysfs inodes must also    
119                                                   
120 The version of thinkpad-acpi's sysfs interface    
121 as a driver attribute (see below).                
122                                                   
123 Sysfs driver attributes are on the driver's sy    
124 for 2.6.23+ this is /sys/bus/platform/drivers/    
125 /sys/bus/platform/drivers/thinkpad_hwmon/         
126                                                   
127 Sysfs device attributes are on the thinkpad_ac    
128 space, for 2.6.23+ this is /sys/devices/platfo    
129                                                   
130 Sysfs device attributes for the sensors and fa    
131 thinkpad_hwmon device's sysfs attribute space,    
132 looking for a hwmon device with the name attri    
133 better yet, through libsensors. For 4.14+ sysf    
134 hwmon device (/sys/bus/platform/devices/thinkp    
135 /sys/class/hwmon/hwmon?).                         
136                                                   
137 Driver version                                    
138 --------------                                    
139                                                   
140 procfs: /proc/acpi/ibm/driver                     
141                                                   
142 sysfs driver attribute: version                   
143                                                   
144 The driver name and version. No commands can b    
145                                                   
146                                                   
147 Sysfs interface version                           
148 -----------------------                           
149                                                   
150 sysfs driver attribute: interface_version         
151                                                   
152 Version of the thinkpad-acpi sysfs interface,     
153 (output in hex format: 0xAAAABBCC), where:        
154                                                   
155         AAAA                                      
156           - major revision                        
157         BB                                        
158           - minor revision                        
159         CC                                        
160           - bugfix revision                       
161                                                   
162 The sysfs interface version changelog for the     
163 end of this document.  Changes to the sysfs in    
164 subsystems are not documented here, nor are th    
165 attribute.                                        
166                                                   
167 Changes to the thinkpad-acpi sysfs interface a    
168 non-experimental when they are submitted to Li    
169 point the changes in this interface are docume    
170 may be updated.  If you are using any thinkpad    
171 sent to mainline for merging, you do so on you    
172 may disappear, or be implemented in a differen    
173 the time they are merged in Linux mainline.       
174                                                   
175 Changes that are backwards-compatible by natur    
176 attributes that do not change the way the othe    
177 always warrant an update of interface_version.    
178 expect that an attribute might not be there, a    
179 (an attribute not being there *is* a valid way    
180 feature is not available in sysfs).               
181                                                   
182                                                   
183 Hot keys                                          
184 --------                                          
185                                                   
186 procfs: /proc/acpi/ibm/hotkey                     
187                                                   
188 sysfs device attribute: hotkey_*                  
189                                                   
190 In a ThinkPad, the ACPI HKEY handler is respon    
191 some important events and also keyboard hot ke    
192 system.  Enabling the hotkey functionality of     
193 firmware that such a driver is present, and mo    
194 firmware will behave in many situations.          
195                                                   
196 The driver enables the HKEY ("hot key") event     
197 when loaded, and disables it when it is remove    
198                                                   
199 The driver will report HKEY events in the foll    
200                                                   
201         ibm/hotkey HKEY 00000080 0000xxxx         
202                                                   
203 Some of these events refer to hot key presses,    
204                                                   
205 The driver will generate events over the input    
206 radio switches, and over the ACPI netlink laye    
207 input layer support accepts the standard IOCTL    
208 assigned to each hot key.                         
209                                                   
210 The hot key bit mask allows some control over     
211 events.  If a key is "masked" (bit set to 0 in    
212 will handle it.  If it is "unmasked", it signa    
213 thinkpad-acpi would prefer to handle it, if th    
214 kind to allow it (and it often doesn't!).         
215                                                   
216 Not all bits in the mask can be modified.  Not    
217 modified do anything.  Not all hot keys can be    
218 by the mask.  Some models do not support the m    
219 of the mask is, therefore, highly dependent on    
220                                                   
221 The driver will filter out any unmasked hotkey    
222 doesn't allow disabling an specific hotkey, th    
223 events for unmasked hotkeys.                      
224                                                   
225 Note that unmasking some keys prevents their d    
226 example, if Fn+F5 is unmasked, that key will n    
227 Bluetooth by itself in firmware.                  
228                                                   
229 Note also that not all Fn key combinations are    
230 depending on the ThinkPad model and firmware v    
231 ThinkPads, it is still possible to support som    
232 polling the "CMOS NVRAM" at least 10 times per    
233 attempts to enables this functionality automat    
234                                                   
235 procfs notes                                      
236 ^^^^^^^^^^^^                                      
237                                                   
238 The following commands can be written to the /    
239                                                   
240         echo 0xffffffff > /proc/acpi/ibm/hotke    
241         echo 0 > /proc/acpi/ibm/hotkey -- disa    
242         ... any other 8-hex-digit mask ...        
243         echo reset > /proc/acpi/ibm/hotkey --     
244                                                   
245 The following commands have been deprecated an    
246 to log a warning::                                
247                                                   
248         echo enable > /proc/acpi/ibm/hotkey --    
249         echo disable > /proc/acpi/ibm/hotkey -    
250                                                   
251 The procfs interface does not support NVRAM po    
252 maintain maximum bug-to-bug compatibility, it     
253 nor does it allow one to manipulate the hot ke    
254 does not support masks at all, even if NVRAM p    
255                                                   
256 sysfs notes                                       
257 ^^^^^^^^^^^                                       
258                                                   
259         hotkey_bios_enabled:                      
260                 DEPRECATED, WILL BE REMOVED SO    
261                                                   
262                 Returns 0.                        
263                                                   
264         hotkey_bios_mask:                         
265                 DEPRECATED, DON'T USE, WILL BE    
266                                                   
267                 Returns the hot keys mask when    
268                 Upon module unload, the hot ke    
269                 to this value.   This is alway    
270                 the hotkeys that were supporte    
271                 without mask support.             
272                                                   
273         hotkey_enable:                            
274                 DEPRECATED, WILL BE REMOVED SO    
275                                                   
276                 0: returns -EPERM                 
277                 1: does nothing                   
278                                                   
279         hotkey_mask:                              
280                 bit mask to enable reporting (    
281                 the firmware, ACPI event gener    
282                 (see above).  Returns the curr    
283                 mask, and allows one to modify    
284                                                   
285         hotkey_all_mask:                          
286                 bit mask that should enable ev    
287                 supported hot keys, when echoe    
288                 Unless you know which events n    
289                 passively (because the firmwar    
290                 anyway), do *not* use hotkey_a    
291                 hotkey_recommended_mask, inste    
292                                                   
293         hotkey_recommended_mask:                  
294                 bit mask that should enable ev    
295                 supported hot keys, except tho    
296                 handled by the firmware anyway    
297                 hotkey_mask above, to use.  Th    
298                 used by the driver.               
299                                                   
300         hotkey_source_mask:                       
301                 bit mask that selects which ho    
302                 poll the NVRAM for.  This is a    
303                 based on the capabilities repo    
304                 but it can be overridden at ru    
305                                                   
306                 Hot keys whose bits are set in    
307                 polled for in NVRAM, and repor    
308                 enabled in hotkey_mask.  Only     
309                 available through CMOS NVRAM p    
310                                                   
311                 Warning: when in NVRAM mode, t    
312                 keys are synthesized according    
313                 which uses a single volume up     
314                 press to unmute, as per the Th    
315                 interface.  When in ACPI event    
316                 events are reported by the fir    
317                 differently (and that behaviou    
318                 version -- not just with firmw    
319                 OSI(Linux) state).                
320                                                   
321         hotkey_poll_freq:                         
322                 frequency in Hz for hot key po    
323                 0 and 25 Hz.  Polling is only     
324                 needed.                           
325                                                   
326                 Setting hotkey_poll_freq to ze    
327                 will cause hot key presses tha    
328                 to never be reported.             
329                                                   
330                 Setting hotkey_poll_freq too l    
331                 pressings of the same hot key     
332                 single key press, or to not ev    
333                 The recommended polling freque    
334                                                   
335         hotkey_radio_sw:                          
336                 If the ThinkPad has a hardware    
337                 attribute will read 0 if the s    
338                 disabled" position, and 1 if t    
339                 "radios enabled" position.        
340                                                   
341                 This attribute has poll()/sele    
342                                                   
343         hotkey_tablet_mode:                       
344                 If the ThinkPad has tablet cap    
345                 will read 0 if the ThinkPad is    
346                 1 if the ThinkPad is in tablet    
347                                                   
348                 This attribute has poll()/sele    
349                                                   
350         wakeup_reason:                            
351                 Set to 1 if the system is waki    
352                 requested a bay ejection.  Set    
353                 waking up because the user req    
354                 undock.  Set to zero for norma    
355                 due to unknown reasons.           
356                                                   
357                 This attribute has poll()/sele    
358                                                   
359         wakeup_hotunplug_complete:                
360                 Set to 1 if the system was wak    
361                 undock or bay ejection request    
362                 was successfully completed.  A    
363                 be useful to send the system b    
364                 user's choice.  Refer to HKEY     
365                 0x3003, below.                    
366                                                   
367                 This attribute has poll()/sele    
368                                                   
369 input layer notes                                 
370 ^^^^^^^^^^^^^^^^^                                 
371                                                   
372 A Hot key is mapped to a single input layer EV    
373 followed by an EV_MSC MSC_SCAN event that shal    
374 code.  An EV_SYN event will always be generate    
375 event block.                                      
376                                                   
377 Do not use the EV_MSC MSC_SCAN events to proce    
378 used as a helper to remap keys, only.  They ar    
379 remapping KEY_UNKNOWN keys.                       
380                                                   
381 The events are available in an input device, w    
382                                                   
383         ==============  ======================    
384         Bus             BUS_HOST                  
385         vendor          0x1014 (PCI_VENDOR_ID_    
386                         0x17aa (PCI_VENDOR_ID_    
387         product         0x5054 ("TP")             
388         version         0x4101                    
389         ==============  ======================    
390                                                   
391 The version will have its LSB incremented if t    
392 backwards-compatible way.  The MSB shall alway    
393 device.  If the MSB is not 0x41, do not use th    
394 this section, as it is either something else (    
395 exported by a thinkpad driver, such as HDAPS)     
396 been changed in a non-backwards compatible way    
397                                                   
398 Adding other event types for other functionali    
399 backwards-compatible change for this input dev    
400                                                   
401 Thinkpad-acpi Hot Key event map (version 0x410    
402                                                   
403 ======= ======= ==============  ==============    
404 ACPI    Scan                                      
405 event   code    Key             Notes             
406 ======= ======= ==============  ==============    
407 0x1001  0x00    FN+F1           -                 
408                                                   
409 0x1002  0x01    FN+F2           IBM: battery (    
410                                 Lenovo: Screen    
411                                                   
412 0x1003  0x02    FN+F3           Many IBM model    
413                                 this hot key,     
414                                 disabled or wi    
415                                 off               
416                                 IBM: screen lo    
417                                 off the ThinkL    
418                                 Lenovo: batter    
419                                                   
420 0x1004  0x03    FN+F4           Sleep button (    
421                                 semantics, i.e    
422                                 It always gene    
423                                 of event, eith    
424                                 event or an AC    
425                                 event. The fir    
426                                 refuse to gene    
427                                 key presses un    
428                                 sleep cycle is    
429                                 time passes.      
430                                                   
431 0x1005  0x04    FN+F5           Radio.  Enable    
432                                 the internal B    
433                                 and W-WAN card    
434                                 of the firmwar    
435                                 the WLAN card.    
436                                 Should be used    
437                                 radios (Blueto    
438                                 really.           
439                                                   
440 0x1006  0x05    FN+F6           -                 
441                                                   
442 0x1007  0x06    FN+F7           Video output c    
443                                 Do you feel lu    
444                                                   
445 0x1008  0x07    FN+F8           IBM: toggle sc    
446                                 Lenovo: config    
447                                 or toggle scre    
448                                 On newer platf    
449                                 replaced by 0x    
450                                                   
451 0x1009  0x08    FN+F9           -                 
452                                                   
453 ...     ...     ...             ...               
454                                                   
455 0x100B  0x0A    FN+F11          -                 
456                                                   
457 0x100C  0x0B    FN+F12          Sleep to disk.    
458                                 supposed to ha    
459                                 either through    
460                                 or through a h    
461                                 The firmware m    
462                                 generate furth    
463                                 press events u    
464                                 ACPI sleep cyc    
465                                 or some time p    
466                                                   
467 0x100D  0x0C    FN+BACKSPACE    -                 
468 0x100E  0x0D    FN+INSERT       -                 
469 0x100F  0x0E    FN+DELETE       -                 
470                                                   
471 0x1010  0x0F    FN+HOME         Brightness up.    
472                                 always handled    
473                                 in IBM ThinkPa    
474                                 unmasked.  Jus    
475                                 For Lenovo Thi    
476                                 BIOS, it has t    
477                                 by the ACPI OS    
478                                 The driver doe    
479                                 never mess wit    
480 0x1011  0x10    FN+END          Brightness dow    
481                                 up for details    
482                                                   
483 0x1012  0x11    FN+PGUP         ThinkLight tog    
484                                 always handled    
485                                 even when unma    
486                                                   
487 0x1013  0x12    FN+PGDOWN       -                 
488                                                   
489 0x1014  0x13    FN+SPACE        Zoom key          
490                                                   
491 0x1015  0x14    VOLUME UP       Internal mixer    
492                                 key is always     
493                                 firmware, even    
494                                 NOTE: Lenovo s    
495                                 this.             
496 0x1016  0x15    VOLUME DOWN     Internal mixer    
497                                 key is always     
498                                 firmware, even    
499                                 NOTE: Lenovo s    
500                                 this.             
501 0x1017  0x16    MUTE            Mute internal     
502                                 key is always     
503                                 firmware, even    
504                                                   
505 0x1018  0x17    THINKPAD        ThinkPad/Acces    
506                                                   
507 0x1019  0x18    unknown                           
508                                                   
509 0x131f  ...     FN+F8           Platform Mode     
510                                 Implemented in    
511                                                   
512 ...     ...     ...                               
513                                                   
514 0x1020  0x1F    unknown                           
515 ======= ======= ==============  ==============    
516                                                   
517 The ThinkPad firmware does not allow one to di    
518 keys are pressed or released (either that, or     
519 For these keys, the driver generates a set of     
520 immediately issues the same set of events for     
521 unknown by the driver if the ThinkPad firmware    
522 hot key press or release, but the firmware wil    
523 both.                                             
524                                                   
525 If a key is mapped to KEY_RESERVED, it generat    
526 If a key is mapped to KEY_UNKNOWN, it generate    
527 includes an scan code.  If a key is mapped to     
528 generate input device EV_KEY events.              
529                                                   
530 In addition to the EV_KEY events, thinkpad-acp    
531 events for switches:                              
532                                                   
533 ==============  ==============================    
534 SW_RFKILL_ALL   T60 and later hardware rfkill     
535 SW_TABLET_MODE  Tablet ThinkPads HKEY events 0    
536 ==============  ==============================    
537                                                   
538 Non hotkey ACPI HKEY event map                    
539 ------------------------------                    
540                                                   
541 Events that are never propagated by the driver    
542                                                   
543 ======          ==============================    
544 0x2304          System is waking up from suspe    
545 0x2305          System is waking up from suspe    
546 0x2404          System is waking up from hiber    
547 0x2405          System is waking up from hiber    
548 0x5001          Lid closed                        
549 0x5002          Lid opened                        
550 0x5009          Tablet swivel: switched to tab    
551 0x500A          Tablet swivel: switched to nor    
552 0x5010          Brightness level changed/contr    
553 0x6000          KEYBOARD: Numlock key pressed     
554 0x6005          KEYBOARD: Fn key pressed (TO B    
555 0x7000          Radio Switch may have changed     
556 ======          ==============================    
557                                                   
558                                                   
559 Events that are propagated by the driver to us    
560                                                   
561 ======          ==============================    
562 0x2313          ALARM: System is waking up fro    
563                 the battery is nearly empty       
564 0x2413          ALARM: System is waking up fro    
565                 the battery is nearly empty       
566 0x3003          Bay ejection (see 0x2x05) comp    
567 0x3006          Bay hotplug request (hint to p    
568                 the optical drive tray is ejec    
569 0x4003          Undocked (see 0x2x04), can sle    
570 0x4010          Docked into hotplug port repli    
571 0x4011          Undocked from hotplug port rep    
572 0x500B          Tablet pen inserted into its s    
573 0x500C          Tablet pen removed from its st    
574 0x6011          ALARM: battery is too hot         
575 0x6012          ALARM: battery is extremely ho    
576 0x6021          ALARM: a sensor is too hot        
577 0x6022          ALARM: a sensor is extremely h    
578 0x6030          System thermal table changed      
579 0x6032          Thermal Control command set co    
580 0x6040          Nvidia Optimus/AC adapter rela    
581 0x60C0          X1 Yoga 2016, Tablet mode stat    
582 0x60F0          Thermal Transformation changed    
583 ======          ==============================    
584                                                   
585 Battery nearly empty alarms are a last resort     
586 operating system to hibernate or shutdown clea    
587 cleanly (0x2413) before power is lost.  They m    
588 wake up caused by the firmware will have negat    
589                                                   
590 When any of the "too hot" alarms happen, accor    
591 should suspend or hibernate the laptop (and in    
592 alarms, unplug the AC adapter) to let it cool     
593 signal that something is wrong, they should ne    
594 operating conditions.                             
595                                                   
596 The "extremely hot" alarms are emergencies.  A    
597 operating system is to force either an immedia    
598 cycle, or a system shutdown.  Obviously, somet    
599 happens.                                          
600                                                   
601                                                   
602 Brightness hotkey notes                           
603 ^^^^^^^^^^^^^^^^^^^^^^^                           
604                                                   
605 Don't mess with the brightness hotkeys in a Th    
606 notifications for OSD, use the sysfs backlight    
607                                                   
608 The driver will issue KEY_BRIGHTNESS_UP and KE    
609 automatically for the cases were userspace has    
610 implement brightness changes.  When you overri    
611 either fail to handle properly the ThinkPads t    
612 action to change backlight brightness, or the     
613 that no action be taken to work properly.         
614                                                   
615                                                   
616 Bluetooth                                         
617 ---------                                         
618                                                   
619 procfs: /proc/acpi/ibm/bluetooth                  
620                                                   
621 sysfs device attribute: bluetooth_enable (depr    
622                                                   
623 sysfs rfkill class: switch "tpacpi_bluetooth_s    
624                                                   
625 This feature shows the presence and current st    
626 Bluetooth device in the internal ThinkPad CDC     
627                                                   
628 If the ThinkPad supports it, the Bluetooth sta    
629 so it is kept across reboots and power-off.       
630                                                   
631 Procfs notes                                      
632 ^^^^^^^^^^^^                                      
633                                                   
634 If Bluetooth is installed, the following comma    
635                                                   
636         echo enable > /proc/acpi/ibm/bluetooth    
637         echo disable > /proc/acpi/ibm/bluetoot    
638                                                   
639 Sysfs notes                                       
640 ^^^^^^^^^^^                                       
641                                                   
642         If the Bluetooth CDC card is installed    
643         disabled through the "bluetooth_enable    
644         attribute, and its current status can     
645                                                   
646         enable:                                   
647                                                   
648                 - 0: disables Bluetooth / Blue    
649                 - 1: enables Bluetooth / Bluet    
650                                                   
651         Note: this interface has been supersed    
652         class.  It has been deprecated, and it    
653         2010.                                     
654                                                   
655         rfkill controller switch "tpacpi_bluet    
656         Documentation/driver-api/rfkill.rst fo    
657                                                   
658                                                   
659 Video output control -- /proc/acpi/ibm/video      
660 --------------------------------------------      
661                                                   
662 This feature allows control over the devices u    
663 LCD, CRT or DVI (if available). The following     
664                                                   
665         echo lcd_enable > /proc/acpi/ibm/video    
666         echo lcd_disable > /proc/acpi/ibm/vide    
667         echo crt_enable > /proc/acpi/ibm/video    
668         echo crt_disable > /proc/acpi/ibm/vide    
669         echo dvi_enable > /proc/acpi/ibm/video    
670         echo dvi_disable > /proc/acpi/ibm/vide    
671         echo auto_enable > /proc/acpi/ibm/vide    
672         echo auto_disable > /proc/acpi/ibm/vid    
673         echo expand_toggle > /proc/acpi/ibm/vi    
674         echo video_switch > /proc/acpi/ibm/vid    
675                                                   
676 NOTE:                                             
677   Access to this feature is restricted to proc    
678   CAP_SYS_ADMIN capability for safety reasons,    
679   enough with some versions of X.org to crash     
680                                                   
681 Each video output device can be enabled or dis    
682 Reading /proc/acpi/ibm/video shows the status     
683                                                   
684 Automatic video switching can be enabled or di    
685 video switching is enabled, certain events (e.    
686 docking or undocking) cause the video output d    
687 automatically. While this can be useful, it al    
688 and, on the X40, video corruption. By disablin    
689 the flickering or video corruption can be avoi    
690                                                   
691 The video_switch command cycles through the av    
692 (it simulates the behavior of Fn-F7).             
693                                                   
694 Video expansion can be toggled through this fe    
695 whether the display is expanded to fill the en    
696 mode with less than full resolution is used. N    
697 video expansion status cannot be determined th    
698                                                   
699 Note that on many models (particularly those u    
700 chips) the X driver configures the video card     
701 Fn-F7 from working. This also disables the vid    
702 features of this driver, as it uses the same A    
703 Fn-F7. Video switching on the console should s    
704                                                   
705 UPDATE: refer to https://bugs.freedesktop.org/    
706                                                   
707                                                   
708 ThinkLight control                                
709 ------------------                                
710                                                   
711 procfs: /proc/acpi/ibm/light                      
712                                                   
713 sysfs attributes: as per LED class, for the "t    
714                                                   
715 procfs notes                                      
716 ^^^^^^^^^^^^                                      
717                                                   
718 The ThinkLight status can be read and set thro    
719 few models which do not make the status availa    
720 status as "unknown". The available commands ar    
721                                                   
722         echo on  > /proc/acpi/ibm/light           
723         echo off > /proc/acpi/ibm/light           
724                                                   
725 sysfs notes                                       
726 ^^^^^^^^^^^                                       
727                                                   
728 The ThinkLight sysfs interface is documented b    
729 documentation, in Documentation/leds/leds-clas    
730 is "tpacpi::thinklight".                          
731                                                   
732 Due to limitations in the sysfs LED class, if     
733 cannot be read or if it is unknown, thinkpad-a    
734 It is impossible to know if the status returne    
735                                                   
736                                                   
737 CMOS/UCMS control                                 
738 -----------------                                 
739                                                   
740 procfs: /proc/acpi/ibm/cmos                       
741                                                   
742 sysfs device attribute: cmos_command              
743                                                   
744 This feature is mostly used internally by the     
745 CMOS NVRAM bits in sync with the current machi    
746 state so that the ThinkPad will retain such se    
747                                                   
748 Some of these commands actually perform action    
749 this is expected to disappear more and more in    
750 a T43 and in a X40, commands 12 and 13 still c    
751 real, but commands 0 to 2 don't control the mi    
752 phased out) and just update the NVRAM.            
753                                                   
754 The range of valid cmos command numbers is 0 t    
755 effect and the behavior varies from model to m    
756 on the X40 (tpb is the ThinkPad Buttons utilit    
757                                                   
758         - 0 - Related to "Volume down" key pre    
759         - 1 - Related to "Volume up" key press    
760         - 2 - Related to "Mute on" key press      
761         - 3 - Related to "Access IBM" key pres    
762         - 4 - Related to "LCD brightness up" k    
763         - 5 - Related to "LCD brightness down"    
764         - 11 - Related to "toggle screen expan    
765         - 12 - Related to "ThinkLight on"         
766         - 13 - Related to "ThinkLight off"        
767         - 14 - Related to "ThinkLight" key pre    
768                                                   
769 The cmos command interface is prone to firmwar    
770 in newer ThinkPads it is just a compatibility     
771 exported just as a debug tool.                    
772                                                   
773                                                   
774 LED control                                       
775 -----------                                       
776                                                   
777 procfs: /proc/acpi/ibm/led                        
778 sysfs attributes: as per LED class, see below     
779                                                   
780 Some of the LED indicators can be controlled t    
781 some older ThinkPad models, it is possible to     
782 LED indicators as well.  Newer ThinkPads canno    
783 of the LED indicators.                            
784                                                   
785 Because misuse of the LEDs could induce an una    
786 dangerous actions (like undocking or ejecting     
787 buses are still active), or mask an important     
788 empty battery, or a broken battery), access to    
789 restricted.                                       
790                                                   
791 Unrestricted access to all LEDs requires that     
792 compiled with the CONFIG_THINKPAD_ACPI_UNSAFE_    
793 Distributions must never enable this option.      
794 are aware of the consequences are welcome to e    
795                                                   
796 Audio mute and microphone mute LEDs are suppor    
797 visible to userspace. They are used by the snd    
798                                                   
799 procfs notes                                      
800 ^^^^^^^^^^^^                                      
801                                                   
802 The available commands are::                      
803                                                   
804         echo '<LED number> on' >/proc/acpi/ibm    
805         echo '<LED number> off' >/proc/acpi/ib    
806         echo '<LED number> blink' >/proc/acpi/    
807                                                   
808 The <LED number> range is 0 to 15. The set of     
809 controlled varies from model to model. Here is    
810 mapping:                                          
811                                                   
812         - 0 - power                               
813         - 1 - battery (orange)                    
814         - 2 - battery (green)                     
815         - 3 - UltraBase/dock                      
816         - 4 - UltraBay                            
817         - 5 - UltraBase battery slot              
818         - 6 - (unknown)                           
819         - 7 - standby                             
820         - 8 - dock status 1                       
821         - 9 - dock status 2                       
822         - 10, 11 - (unknown)                      
823         - 12 - thinkvantage                       
824         - 13, 14, 15 - (unknown)                  
825                                                   
826 All of the above can be turned on and off and     
827                                                   
828 sysfs notes                                       
829 ^^^^^^^^^^^                                       
830                                                   
831 The ThinkPad LED sysfs interface is described     
832 documentation, in Documentation/leds/leds-clas    
833                                                   
834 The LEDs are named (in LED ID order, from 0 to    
835 "tpacpi::power", "tpacpi:orange:batt", "tpacpi    
836 "tpacpi::dock_active", "tpacpi::bay_active", "    
837 "tpacpi::unknown_led", "tpacpi::standby", "tpa    
838 "tpacpi::dock_status2", "tpacpi::unknown_led2"    
839 "tpacpi::thinkvantage".                           
840                                                   
841 Due to limitations in the sysfs LED class, if     
842 indicators cannot be read due to an error, thi    
843 a brightness of zero (same as LED off).           
844                                                   
845 If the thinkpad firmware doesn't support readi    
846 trying to read the current LED brightness will    
847 brightness was last written to that attribute.    
848                                                   
849 These LEDs can blink using hardware accelerati    
850 ThinkPad indicator LED should blink in hardwar    
851 "timer" trigger, and leave the delay_on and de    
852 zero (to request hardware acceleration autodet    
853                                                   
854 LEDs that are known not to exist in a given Th    
855 made available through the sysfs interface.  I    
856 notice there are LEDs listed for your ThinkPad    
857 are not in the dock), or if you notice that th    
858 a report to ibm-acpi-devel@lists.sourceforge.n    
859                                                   
860                                                   
861 ACPI sounds -- /proc/acpi/ibm/beep                
862 ----------------------------------                
863                                                   
864 The BEEP method is used internally by the ACPI    
865 audible alerts in various situations. This fea    
866 sounds to be triggered manually.                  
867                                                   
868 The commands are non-negative integer numbers:    
869                                                   
870         echo <number> >/proc/acpi/ibm/beep        
871                                                   
872 The valid <number> range is 0 to 17. Not all n    
873 and the sounds vary from model to model. Here     
874 X40:                                              
875                                                   
876         - 0 - stop a sound in progress (but us    
877         - 2 - two beeps, pause, third beep ("l    
878         - 3 - single beep                         
879         - 4 - high, followed by low-pitched be    
880         - 5 - single beep                         
881         - 6 - very high, followed by high-pitc    
882         - 7 - high-pitched beep                   
883         - 9 - three short beeps                   
884         - 10 - very long beep                     
885         - 12 - low-pitched beep                   
886         - 15 - three high-pitched beeps repeat    
887         - 16 - one medium-pitched beep repeati    
888         - 17 - stop 16                            
889                                                   
890                                                   
891 Temperature sensors                               
892 -------------------                               
893                                                   
894 procfs: /proc/acpi/ibm/thermal                    
895                                                   
896 sysfs device attributes: (hwmon "thinkpad") te    
897                                                   
898 Most ThinkPads include six or more separate te    
899 expose the CPU temperature through the standar    
900 feature shows readings from up to eight differ    
901 ThinkPads, and up to sixteen different sensors    
902                                                   
903 For example, on the X40, a typical output may     
904                                                   
905 temperatures:                                     
906         42 42 45 41 36 -128 33 -128               
907                                                   
908 On the T43/p, a typical output may be:            
909                                                   
910 temperatures:                                     
911         48 48 36 52 38 -128 31 -128 48 52 48 -    
912                                                   
913 The mapping of thermal sensors to physical loc    
914 system-board model (and thus, on ThinkPad mode    
915                                                   
916 https://thinkwiki.org/wiki/Thermal_Sensors is     
917 tries to track down these locations for variou    
918                                                   
919 Most (newer?) models seem to follow this patte    
920                                                   
921 - 1:  CPU                                         
922 - 2:  (depends on model)                          
923 - 3:  (depends on model)                          
924 - 4:  GPU                                         
925 - 5:  Main battery: main sensor                   
926 - 6:  Bay battery: main sensor                    
927 - 7:  Main battery: secondary sensor              
928 - 8:  Bay battery: secondary sensor               
929 - 9-15: (depends on model)                        
930                                                   
931 For the R51 (source: Thomas Gruber):              
932                                                   
933 - 2:  Mini-PCI                                    
934 - 3:  Internal HDD                                
935                                                   
936 For the T43, T43/p (source: Shmidoax/Thinkwiki    
937 https://thinkwiki.org/wiki/Thermal_Sensors#Thi    
938                                                   
939 - 2:  System board, left side (near PCMCIA slo    
940 - 3:  PCMCIA slot                                 
941 - 9:  MCH (northbridge) to DRAM Bus               
942 - 10: Clock-generator, mini-pci card and ICH (    
943       card, under touchpad                        
944 - 11: Power regulator, underside of system boa    
945                                                   
946 The A31 has a very atypical layout for the the    
947 (source: Milos Popovic, https://thinkwiki.org/    
948                                                   
949 - 1:  CPU                                         
950 - 2:  Main Battery: main sensor                   
951 - 3:  Power Converter                             
952 - 4:  Bay Battery: main sensor                    
953 - 5:  MCH (northbridge)                           
954 - 6:  PCMCIA/ambient                              
955 - 7:  Main Battery: secondary sensor              
956 - 8:  Bay Battery: secondary sensor               
957                                                   
958                                                   
959 Procfs notes                                      
960 ^^^^^^^^^^^^                                      
961                                                   
962         Readings from sensors that are not ava    
963         No commands can be written to this fil    
964                                                   
965 Sysfs notes                                       
966 ^^^^^^^^^^^                                       
967                                                   
968         Sensors that are not available return     
969         status may change at runtime, as there    
970         sensors, like those inside the batteri    
971                                                   
972         thinkpad-acpi thermal sensors are repo    
973         subsystem, and follow all of the hwmon    
974         Documentation/hwmon.                      
975                                                   
976 EXPERIMENTAL: Embedded controller register dum    
977 ----------------------------------------------    
978                                                   
979 This feature is not included in the thinkpad d    
980 Instead the EC can be accessed through /sys/ke    
981 a userspace tool which can be found here:         
982 ftp://ftp.suse.com/pub/people/trenn/sources/ec    
983                                                   
984 Use it to determine the register holding the f    
985 speed on some models. To do that, do the follo    
986                                                   
987         - make sure the battery is fully charg    
988         - make sure the fan is running            
989         - use above mentioned tool to read out    
990                                                   
991 Often fan and temperature values vary between     
992 readings. Since temperatures don't change vary    
993 several quick dumps to eliminate them.            
994                                                   
995 You can use a similar method to figure out the    
996 embedded controller registers - e.g. make sure    
997 except the charging or discharging battery to     
998 registers contain the current battery capacity    
999 with this, do send me your results (including     
1000 a description of the conditions when they wer    
1001                                                  
1002                                                  
1003 LCD brightness control                           
1004 ----------------------                           
1005                                                  
1006 procfs: /proc/acpi/ibm/brightness                
1007                                                  
1008 sysfs backlight device "thinkpad_screen"         
1009                                                  
1010 This feature allows software control of the L    
1011 models which don't have a hardware brightness    
1012                                                  
1013 It has some limitations: the LCD backlight ca    
1014 on or off by this interface, it just controls    
1015 level.                                           
1016                                                  
1017 On IBM (and some of the earlier Lenovo) Think    
1018 has eight brightness levels, ranging from 0 t    
1019 may not be distinct.  Later Lenovo models tha    
1020 display backlight brightness control methods     
1021 from 0 to 15.                                    
1022                                                  
1023 For IBM ThinkPads, there are two interfaces t    
1024 brightness control, EC and UCMS (or CMOS).  T    
1025 used, use the brightness_mode module paramete    
1026 EC mode, brightness_mode=2 selects UCMS mode,    
1027 mode with NVRAM backing (so that brightness c    
1028 shutdown/reboot).                                
1029                                                  
1030 The driver tries to select which interface to    
1031 defaults for each ThinkPad model.  If it make    
1032 report this as a bug, so that we can fix it.     
1033                                                  
1034 Lenovo ThinkPads only support brightness_mode    
1035                                                  
1036 When display backlight brightness controls ar    
1037 standard ACPI interface, it is best to use it    
1038 ThinkPad-specific interface.  The driver will    
1039 backlight brightness control interface if it     
1040 ACPI interface is available in the ThinkPad.     
1041                                                  
1042 If you want to use the thinkpad-acpi backligh    
1043 instead of the generic ACPI video backlight b    
1044 reason, you should use the acpi_backlight=ven    
1045                                                  
1046 The brightness_enable module parameter can be    
1047 the LCD brightness control feature will be en    
1048 brightness_enable=0 forces it to be disabled.    
1049 forces it to be enabled when available, even     
1050 interface is also available.                     
1051                                                  
1052 Procfs notes                                     
1053 ^^^^^^^^^^^^                                     
1054                                                  
1055 The available commands are::                     
1056                                                  
1057         echo up   >/proc/acpi/ibm/brightness     
1058         echo down >/proc/acpi/ibm/brightness     
1059         echo 'level <level>' >/proc/acpi/ibm/    
1060                                                  
1061 Sysfs notes                                      
1062 ^^^^^^^^^^^                                      
1063                                                  
1064 The interface is implemented through the back    
1065 poorly documented at this time.                  
1066                                                  
1067 Locate the thinkpad_screen device under /sys/    
1068 it there will be the following attributes:       
1069                                                  
1070         max_brightness:                          
1071                 Reads the maximum brightness     
1072                 The minimum is always zero.      
1073                                                  
1074         actual_brightness:                       
1075                 Reads what brightness the scr    
1076                                                  
1077         brightness:                              
1078                 Writes request the driver to     
1079                 given value.  Reads will tell    
1080                 driver is trying to set the d    
1081                 to zero and the display has n    
1082                 power management event.          
1083                                                  
1084         power:                                   
1085                 power management mode, where     
1086                 will dim the display backligh    
1087                 because thinkpad-acpi cannot     
1088                 off.  Kernel power management    
1089                 increase the current power ma    
1090                 dim the display.                 
1091                                                  
1092                                                  
1093 WARNING:                                         
1094                                                  
1095     Whatever you do, do NOT ever call thinkpa    
1096     interface and the ACPI-based backlight le    
1097     (available on newer BIOSes, and driven by    
1098     at the same time.  The two will interact     
1099     and maybe reduce the life of the backligh    
1100     its level up and down at every change.       
1101                                                  
1102                                                  
1103 Volume control (Console Audio control)           
1104 --------------------------------------           
1105                                                  
1106 procfs: /proc/acpi/ibm/volume                    
1107                                                  
1108 ALSA: "ThinkPad Console Audio Control", defau    
1109                                                  
1110 NOTE: by default, the volume control interfac    
1111 mode, as it is supposed to be used for on-scr    
1112 The read/write mode can be enabled through th    
1113 "volume_control=1" module parameter.             
1114                                                  
1115 NOTE: distros are urged to not enable volume_    
1116 should be done by the local admin only.  The     
1117 console audio control to be done through the     
1118 the desktop environment to just provide on-sc    
1119 Software volume control should be done only i    
1120 mixer.                                           
1121                                                  
1122                                                  
1123 About the ThinkPad Console Audio control         
1124 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^         
1125                                                  
1126 ThinkPads have a built-in amplifier and mutin    
1127 console headphone and speakers.  This circuit    
1128 or HDA mixer in the audio path, and under exc    
1129 firmware.                                        
1130                                                  
1131 ThinkPads have three special hotkeys to inter    
1132 audio control: volume up, volume down and mut    
1133                                                  
1134 It is worth noting that the normal way the mu    
1135 ThinkPads that do not have a "mute LED") is:     
1136                                                  
1137 1. Press mute to mute.  It will *always* mute    
1138    many times as you want, and the sound will    
1139                                                  
1140 2. Press either volume key to unmute the Thin    
1141    change the volume, it will just unmute).      
1142                                                  
1143 This is a very superior design when compared     
1144 mute-toggle solution found on normal consumer    
1145 absolutely sure the ThinkPad will not make no    
1146 button, no matter the previous state.            
1147                                                  
1148 The IBM ThinkPads, and the earlier Lenovo Thi    
1149 amplifiers driving the speakers and headphone    
1150 also handles volume control for the headphone    
1151 ThinkPads without any help from the operating    
1152 control stage exists after the main AC97 or H    
1153 path).                                           
1154                                                  
1155 The newer Lenovo models only have firmware mu    
1156 the main HDA mixer to do volume control (whic    
1157 system).  In this case, the volume keys are f    
1158 key press (there are some firmware bugs in th    
1159 normal key presses to the operating system (t    
1160 involved).                                       
1161                                                  
1162                                                  
1163 The ThinkPad-ACPI volume control                 
1164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^                 
1165                                                  
1166 The preferred way to interact with the Consol    
1167 ALSA interface.                                  
1168                                                  
1169 The legacy procfs interface allows one to rea    
1170 and if volume control is enabled, accepts the    
1171                                                  
1172         echo up   >/proc/acpi/ibm/volume         
1173         echo down >/proc/acpi/ibm/volume         
1174         echo mute >/proc/acpi/ibm/volume         
1175         echo unmute >/proc/acpi/ibm/volume       
1176         echo 'level <level>' >/proc/acpi/ibm/    
1177                                                  
1178 The <level> number range is 0 to 14 although     
1179 distinct. To unmute the volume after the mute    
1180 up or down command (the level command will no    
1181 the unmute command.                              
1182                                                  
1183 You can use the volume_capabilities parameter    
1184 whether your thinkpad has volume control or m    
1185 volume_capabilities=1 for mixers with mute an    
1186 volume_capabilities=2 for mixers with only mu    
1187                                                  
1188 If the driver misdetects the capabilities for    
1189 please report this to ibm-acpi-devel@lists.so    
1190 can update the driver.                           
1191                                                  
1192 There are two strategies for volume control.     
1193 should be used, use the volume_mode module pa    
1194 selects EC mode, and volume_mode=3 selects EC    
1195 (so that volume/mute changes are remembered a    
1196                                                  
1197 The driver will operate in volume_mode=3 by d    
1198 work well on your ThinkPad model, please repo    
1199 ibm-acpi-devel@lists.sourceforge.net.            
1200                                                  
1201 The driver supports the standard ALSA module     
1202 mixer is disabled, the driver will disable al    
1203                                                  
1204                                                  
1205 Fan control and monitoring: fan speed, fan en    
1206 ---------------------------------------------    
1207                                                  
1208 procfs: /proc/acpi/ibm/fan                       
1209                                                  
1210 sysfs device attributes: (hwmon "thinkpad") f    
1211                                                  
1212 sysfs hwmon driver attributes: fan_watchdog      
1213                                                  
1214 NOTE NOTE NOTE:                                  
1215    fan control operations are disabled by def    
1216    safety reasons.  To enable them, the modul    
1217    must be given to thinkpad-acpi.               
1218                                                  
1219 This feature attempts to show the current fan    
1220 other fan data that might be available.  The     
1221 from the hardware registers of the embedded c    
1222 to work on later R, T, X and Z series ThinkPa    
1223 value on other models.                           
1224                                                  
1225 Some Lenovo ThinkPads support a secondary fan    
1226 controlled separately, it shares the main fan    
1227                                                  
1228 Fan levels                                       
1229 ^^^^^^^^^^                                       
1230                                                  
1231 Most ThinkPad fans work in "levels" at the fi    
1232 stops the fan.  The higher the level, the hig    
1233 adjacent levels often map to the same fan spe    
1234 level, where the fan reaches the maximum reco    
1235                                                  
1236 Level "auto" means the EC changes the fan lev    
1237 internal algorithm, usually based on readings    
1238                                                  
1239 There is also a "full-speed" level, also know    
1240 In this level, the EC disables the speed-lock    
1241 and drives the fan as fast as it can go, whic    
1242 limits, so use this level with caution.          
1243                                                  
1244 The fan usually ramps up or down slowly from     
1245 it is normal for the EC to take several secon    
1246 commands.  The full-speed level may take up t    
1247 maximum speed, and in some ThinkPads, the tac    
1248 while the EC is transitioning to the full-spe    
1249                                                  
1250 WARNING WARNING WARNING: do not leave the fan    
1251 monitoring all of the temperature sensor read    
1252 enable it if necessary to avoid overheating.     
1253                                                  
1254 An enabled fan in level "auto" may stop spinn    
1255 ThinkPad is cool enough and doesn't need the     
1256 normal, and the EC will spin the fan up if th    
1257 rise too much.                                   
1258                                                  
1259 On the X40, this seems to depend on the CPU a    
1260 Specifically, the fan is turned on when eithe    
1261 climbs to 56 degrees or the HDD temperature c    
1262 fan is turned off when the CPU temperature dr    
1263 HDD temperature drops to 41 degrees.  These t    
1264 currently be controlled.                         
1265                                                  
1266 The ThinkPad's ACPI DSDT code will reprogram     
1267 certain conditions are met.  It will override    
1268 through thinkpad-acpi.                           
1269                                                  
1270 The thinkpad-acpi kernel driver can be progra    
1271 level to a safe setting if userspace does not    
1272 fan commands: "enable", "disable", "level" or    
1273 are no writes to pwm1_enable (or to pwm1 *if     
1274 set to 1, manual mode) within a configurable     
1275 120 seconds.  This functionality is called fa    
1276                                                  
1277 Note that the watchdog timer stops after it e    
1278 rearmed again automatically (using the same i    
1279 above mentioned fan commands is received.  Th    
1280 therefore, not suitable to protect against fa    
1281 means other than the "enable", "disable", and    
1282 commands, or the hwmon fan control sysfs inte    
1283                                                  
1284 Procfs notes                                     
1285 ^^^^^^^^^^^^                                     
1286                                                  
1287 The fan may be enabled or disabled with the f    
1288                                                  
1289         echo enable  >/proc/acpi/ibm/fan         
1290         echo disable >/proc/acpi/ibm/fan         
1291                                                  
1292 Placing a fan on level 0 is the same as disab    
1293 will try to place it in a safe level if it is    
1294                                                  
1295 The fan level can be controlled with the comm    
1296                                                  
1297         echo 'level <level>' > /proc/acpi/ibm    
1298                                                  
1299 Where <level> is an integer from 0 to 7, or o    
1300 "full-speed" (without the quotes).  Not all T    
1301 and "full-speed" levels.  The driver accepts     
1302 "full-speed", and reports it as "disengaged"     
1303 compatibility.                                   
1304                                                  
1305 On the X31 and X40 (and ONLY on those models)    
1306 controlled to a certain degree.  Once the fan    
1307 forced to run faster or slower with the follo    
1308                                                  
1309         echo 'speed <speed>' > /proc/acpi/ibm    
1310                                                  
1311 The sustainable range of fan speeds on the X4    
1312 3700 to about 7350. Values outside this range    
1313 effect or the fan speed eventually settles so    
1314 fan cannot be stopped or started with this co    
1315 is incomplete, and not available through the     
1316                                                  
1317 To program the safety watchdog, use the "watc    
1318                                                  
1319         echo 'watchdog <interval in seconds>'    
1320                                                  
1321 If you want to disable the watchdog, use 0 as    
1322                                                  
1323 Sysfs notes                                      
1324 ^^^^^^^^^^^                                      
1325                                                  
1326 The sysfs interface follows the hwmon subsyst    
1327 part, and the exception is the fan safety wat    
1328                                                  
1329 Writes to any of the sysfs attributes may ret    
1330 that operation is not supported in a given Th    
1331 is out-of-bounds, and EPERM if it is forbidde    
1332 EINTR (interrupted system call), and EIO (I/O    
1333 to the firmware).                                
1334                                                  
1335 Features not yet implemented by the driver re    
1336                                                  
1337 hwmon device attribute pwm1_enable:              
1338         - 0: PWM offline (fan is set to full-    
1339         - 1: Manual PWM control (use pwm1 to     
1340         - 2: Hardware PWM control (EC "auto"     
1341         - 3: reserved (Software PWM control,     
1342                                                  
1343         Modes 0 and 2 are not supported by al    
1344         driver is not always able to detect t    
1345         mode is unsupported, it will return -    
1346                                                  
1347 hwmon device attribute pwm1:                     
1348         Fan level, scaled from the firmware v    
1349         scale of 0-255.  0 means fan stopped,    
1350         speed (level 7).                         
1351                                                  
1352         This attribute only commands the fan     
1353         (manual PWM control).                    
1354                                                  
1355 hwmon device attribute fan1_input:               
1356         Fan tachometer reading, in RPM.  May     
1357         ThinkPads while the EC transitions th    
1358         which can take up to two minutes.  Ma    
1359         ThinkPads.                               
1360                                                  
1361 hwmon device attribute fan2_input:               
1362         Fan tachometer reading, in RPM, for t    
1363         Available only on some ThinkPads.  If    
1364         not installed, will always read 0.       
1365                                                  
1366 hwmon driver attribute fan_watchdog:             
1367         Fan safety watchdog timer interval, i    
1368         1 second, maximum is 120 seconds.  0     
1369                                                  
1370 To stop the fan: set pwm1 to zero, and pwm1_e    
1371                                                  
1372 To start the fan in a safe mode: set pwm1_ena    
1373 with EINVAL, try to set pwm1_enable to 1 and     
1374 would be the safest choice, though).             
1375                                                  
1376                                                  
1377 WAN                                              
1378 ---                                              
1379                                                  
1380 procfs: /proc/acpi/ibm/wan                       
1381                                                  
1382 sysfs device attribute: wwan_enable (deprecat    
1383                                                  
1384 sysfs rfkill class: switch "tpacpi_wwan_sw"      
1385                                                  
1386 This feature shows the presence and current s    
1387 Wireless WAN device.                             
1388                                                  
1389 If the ThinkPad supports it, the WWAN state i    
1390 so it is kept across reboots and power-off.      
1391                                                  
1392 It was tested on a Lenovo ThinkPad X60. It sh    
1393 ThinkPad models which come with this module i    
1394                                                  
1395 Procfs notes                                     
1396 ^^^^^^^^^^^^                                     
1397                                                  
1398 If the W-WAN card is installed, the following    
1399                                                  
1400         echo enable > /proc/acpi/ibm/wan         
1401         echo disable > /proc/acpi/ibm/wan        
1402                                                  
1403 Sysfs notes                                      
1404 ^^^^^^^^^^^                                      
1405                                                  
1406         If the W-WAN card is installed, it ca    
1407         disabled through the "wwan_enable" th    
1408         attribute, and its current status can    
1409                                                  
1410         enable:                                  
1411                 - 0: disables WWAN card / WWA    
1412                 - 1: enables WWAN card / WWAN    
1413                                                  
1414         Note: this interface has been superse    
1415         class.  It has been deprecated, and i    
1416         2010.                                    
1417                                                  
1418         rfkill controller switch "tpacpi_wwan    
1419         Documentation/driver-api/rfkill.rst f    
1420                                                  
1421                                                  
1422 LCD Shadow control                               
1423 ------------------                               
1424                                                  
1425 procfs: /proc/acpi/ibm/lcdshadow                 
1426                                                  
1427 Some newer T480s and T490s ThinkPads provide     
1428 PrivacyGuard. By turning this feature on, the    
1429 horizontal viewing angles of the LCD can be l    
1430 screen was applied manually in front of the d    
1431                                                  
1432 procfs notes                                     
1433 ^^^^^^^^^^^^                                     
1434                                                  
1435 The available commands are::                     
1436                                                  
1437         echo '0' >/proc/acpi/ibm/lcdshadow       
1438         echo '1' >/proc/acpi/ibm/lcdshadow       
1439                                                  
1440 The first command ensures the best viewing an    
1441 on the feature, restricting the viewing angle    
1442                                                  
1443                                                  
1444 DYTC Lapmode sensor                              
1445 -------------------                              
1446                                                  
1447 sysfs: dytc_lapmode                              
1448                                                  
1449 Newer thinkpads and mobile workstations have     
1450 the device is in deskmode or lapmode. This fe    
1451 to decide if WWAN transmission can be increas    
1452 also useful for understanding the different t    
1453 they differ between desk and lap mode.           
1454                                                  
1455 The property is read-only. If the platform do    
1456 class is not created.                            
1457                                                  
1458 EXPERIMENTAL: UWB                                
1459 -----------------                                
1460                                                  
1461 This feature is considered EXPERIMENTAL becau    
1462 tested and validated in various ThinkPad mode    
1463 work as expected. USE WITH CAUTION! To use th    
1464 the experimental=1 parameter when loading the    
1465                                                  
1466 sysfs rfkill class: switch "tpacpi_uwb_sw"       
1467                                                  
1468 This feature exports an rfkill controller for    
1469 present and enabled in the BIOS.                 
1470                                                  
1471 Sysfs notes                                      
1472 ^^^^^^^^^^^                                      
1473                                                  
1474         rfkill controller switch "tpacpi_uwb_    
1475         Documentation/driver-api/rfkill.rst f    
1476                                                  
1477                                                  
1478 Setting keyboard language                        
1479 -------------------------                        
1480                                                  
1481 sysfs: keyboard_lang                             
1482                                                  
1483 This feature is used to set keyboard language    
1484 Fewer thinkpads models like T580 , T590 , T15    
1485 ")" numeric keys, which are not displaying co    
1486 is other than "english". This is because the     
1487 is set as "english". Hence using this sysfs,     
1488 language to ECFW and then these key's will wo    
1489                                                  
1490 Example of command to set keyboard language i    
1491                                                  
1492         echo jp > /sys/devices/platform/think    
1493                                                  
1494 Text corresponding to keyboard layout to be s    
1495 cz(Czech), da(Danish), de(German), en(English    
1496 fr(French), fr-ch(French(Switzerland)), hu(Hu    
1497 nl(Dutch), nn(Norway), pl(Polish), pt(portugu    
1498 tr(Turkey)                                       
1499                                                  
1500 WWAN Antenna type                                
1501 -----------------                                
1502                                                  
1503 sysfs: wwan_antenna_type                         
1504                                                  
1505 On some newer Thinkpads we need to set SAR va    
1506 type. This interface will be used by userspac    
1507 and set the corresponding SAR value, as is re    
1508                                                  
1509 The available commands are::                     
1510                                                  
1511         cat /sys/devices/platform/thinkpad_ac    
1512                                                  
1513 Currently 2 antenna types are supported as me    
1514 - type a                                         
1515 - type b                                         
1516                                                  
1517 The property is read-only. If the platform do    
1518 class is not created.                            
1519                                                  
1520 Auxmac                                           
1521 ------                                           
1522                                                  
1523 sysfs: auxmac                                    
1524                                                  
1525 Some newer Thinkpads have a feature called MA    
1526 feature is implemented by the system firmware    
1527 that can override a dock or USB ethernet dong    
1528 network. This property enables user-space to     
1529 if the feature is enabled.                       
1530                                                  
1531 The values of this auxiliary MAC are:            
1532                                                  
1533         cat /sys/devices/platform/thinkpad_ac    
1534                                                  
1535 If the feature is disabled, the value will be    
1536                                                  
1537 This property is read-only.                      
1538                                                  
1539 Adaptive keyboard                                
1540 -----------------                                
1541                                                  
1542 sysfs device attribute: adaptive_kbd_mode        
1543                                                  
1544 This sysfs attribute controls the keyboard "f    
1545 Lenovo X1 Carbon 2nd gen (2014)'s adaptive ke    
1546 and set.                                         
1547                                                  
1548 - 0 = Home mode                                  
1549 - 1 = Web-browser mode                           
1550 - 2 = Web-conference mode                        
1551 - 3 = Function mode                              
1552 - 4 = Layflat mode                               
1553                                                  
1554 For more details about which buttons will app    
1555 review the laptop's user guide:                  
1556 https://download.lenovo.com/ibmdl/pub/pc/pccb    
1557                                                  
1558 Battery charge control                           
1559 ----------------------                           
1560                                                  
1561 sysfs attributes:                                
1562 /sys/class/power_supply/BAT*/charge_control_{    
1563                                                  
1564 These two attributes are created for those ba    
1565 driver. They enable the user to control the b    
1566 given battery. Both values may be read and se    
1567 accepts an integer between 0 and 99 (inclusiv    
1568 percentage level, below which charging will b    
1569 accepts an integer between 1 and 100 (inclusi    
1570 percentage level, above which charging will s    
1571                                                  
1572 The exact semantics of the attributes may be     
1573 Documentation/ABI/testing/sysfs-class-power.     
1574                                                  
1575 Multiple Commands, Module Parameters             
1576 ------------------------------------             
1577                                                  
1578 Multiple commands can be written to the proc     
1579 separating them with commas, for example::       
1580                                                  
1581         echo enable,0xffff > /proc/acpi/ibm/h    
1582         echo lcd_disable,crt_enable > /proc/a    
1583                                                  
1584 Commands can also be specified when loading t    
1585 for example::                                    
1586                                                  
1587         modprobe thinkpad_acpi hotkey=enable,    
1588                                                  
1589                                                  
1590 Enabling debugging output                        
1591 -------------------------                        
1592                                                  
1593 The module takes a debug parameter which can     
1594 enable various classes of debugging output, f    
1595                                                  
1596          modprobe thinkpad_acpi debug=0xffff     
1597                                                  
1598 will enable all debugging output classes.  It    
1599 to enable more than one output class, just ad    
1600                                                  
1601         =============           =============    
1602         Debug bitmask           Description      
1603         =============           =============    
1604         0x8000                  Disclose PID     
1605                                 accessing som    
1606         0x0001                  Initializatio    
1607         0x0002                  Removal          
1608         0x0004                  RF Transmitte    
1609                                 (bluetooth, W    
1610         0x0008                  HKEY event in    
1611         0x0010                  Fan control      
1612         0x0020                  Backlight bri    
1613         0x0040                  Audio mixer/v    
1614         =============           =============    
1615                                                  
1616 There is also a kernel build option to enable    
1617 information, which may be necessary to debug     
1618                                                  
1619 The level of debugging information output by     
1620 at runtime through sysfs, using the driver at    
1621 attribute takes the same bitmask as the debug    
1622                                                  
1623                                                  
1624 Force loading of module                          
1625 -----------------------                          
1626                                                  
1627 If thinkpad-acpi refuses to detect your Think    
1628 the module parameter force_load=1.  Regardles    
1629 not, please contact ibm-acpi-devel@lists.sour    
1630                                                  
1631                                                  
1632 Sysfs interface changelog                        
1633 ^^^^^^^^^^^^^^^^^^^^^^^^^                        
1634                                                  
1635 =========       =============================    
1636 0x000100:       Initial sysfs support, as a s    
1637                 device.                          
1638 0x000200:       Hot key support for 32 hot ke    
1639                 support.                         
1640 0x010000:       Hot keys are now handled by d    
1641                 layer, the radio switch gener    
1642                 and the driver enables hot ke    
1643                 the firmware.                    
1644                                                  
1645 0x020000:       ABI fix: added a separate hwm    
1646                 driver, which must be located    
1647                 and the hwmon class for libse    
1648                 compatibility.  Moved all hwm    
1649                 new platform device.             
1650                                                  
1651 0x020100:       Marker for thinkpad-acpi with    
1652                 support.  If you must, use it    
1653                 start a userspace NVRAM polle    
1654                 NVRAM is compiled out by the     
1655                 unneeded/undesired in the fir    
1656 0x020101:       Marker for thinkpad-acpi with    
1657                 and proper hotkey_mask semant    
1658                 NVRAM polling patch).  Some d    
1659                 0.18 had an earlier version t    
1660                 to hotkey_mask.                  
1661                                                  
1662 0x020200:       Add poll()/select() support t    
1663                 hotkey_radio_sw, wakeup_hotun    
1664                                                  
1665 0x020300:       hotkey enable/disable support    
1666                 hotkey_bios_enabled and hotke    
1667                 marked for removal.              
1668                                                  
1669 0x020400:       Marker for 16 LEDs support.      
1670                 to not exist in a given model    
1671                 the LED sysfs class anymore.     
1672                                                  
1673 0x020500:       Updated hotkey driver, hotkey    
1674                 and it is always able to disa    
1675                 thinkpads are properly suppor    
1676                 is deprecated and marked for     
1677                                                  
1678 0x020600:       Marker for backlight change e    
1679                                                  
1680 0x020700:       Support for mute-only mixers.    
1681                 Volume control in read-only m    
1682                 Marker for ALSA mixer support    
1683                                                  
1684 0x030000:       Thermal and fan sysfs attribu    
1685                 device instead of being attac    
1686                 device.                          
1687 =========       =============================    
                                                      

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php