Lines Matching +full:keep +full:- +full:power +full:- +full:in +full:- +full:suspend
9 - Borislav Deianov <borislav@users.sf.net>
10 - Henrique de Moraes Holschuh <hmh@hmh.eng.br>
12 http://ibm-acpi.sf.net/
19 This driver used to be named ibm-acpi until kernel 2.6.21 and release
20 0.13-20070314. It used to be in the drivers/acpi tree, but it was
21 moved to the drivers/misc tree and renamed to thinkpad-acpi for kernel
25 The driver is named "thinkpad-acpi". In some places, like module
29 "tpacpi" is used as a shorthand where "thinkpad-acpi" would be too
33 ------
38 - Fn key combinations
39 - Bluetooth enable and disable
40 - video output switching, expansion control
41 - ThinkLight on and off
42 - CMOS/UCMS control
43 - LED control
44 - ACPI sounds
45 - temperature sensors
46 - Experimental: embedded controller register dump
47 - LCD brightness control
48 - Volume control
49 - Fan control and monitoring: fan speed, fan enable/disable
50 - WAN enable and disable
51 - UWB enable and disable
52 - LCD Shadow (PrivacyGuard) enable and disable
53 - Lap mode sensor
54 - Setting keyboard language
55 - WWAN Antenna type
56 - Auxmac
59 site, http://ibm-acpi.sf.net/. I appreciate any success or failure
61 Please include the following information in your report:
63 - ThinkPad model name
64 - a copy of your ACPI tables, using the "acpidump" utility
65 - a copy of the output of dmidecode, with serial numbers
67 - which driver features work and which don't
68 - the observed behavior of non-working features
74 ------------
76 If you are compiling this driver as included in the Linux kernel
78 It is located on the menu path: "Device Drivers" -> "X86 Platform
79 Specific Device Drivers" -> "ThinkPad ACPI Laptop Extras".
83 --------
86 used to access the features it provides. One is a legacy procfs-based
87 interface, which will be removed at some time in the future. The other
88 is a new sysfs-based interface which is not complete yet.
93 will not be extended to add any new functionality in the driver, instead
96 The sysfs interface tries to blend in the generic Linux sysfs subsystems
106 to the sysfs interfaces will be enforced, as will correctness in the
107 thinkpad-acpi's implementation of sysfs interfaces.
109 Also, any bugs in the thinkpad-acpi sysfs driver code or in the
110 thinkpad-acpi's implementation of the sysfs interfaces will be fixed for
111 maximum correctness, even if that means changing an interface in
112 non-compatible ways. As these interfaces mature both in the kernel and
113 in thinkpad-acpi, such changes should become quite rare.
115 Applications interfacing to the thinkpad-acpi sysfs interfaces must
120 The version of thinkpad-acpi's sysfs interface is exported by the driver
138 --------------
148 -----------------------
152 Version of the thinkpad-acpi sysfs interface, as an unsigned long
153 (output in hex format: 0xAAAABBCC), where:
156 - major revision
158 - minor revision
160 - bugfix revision
167 Changes to the thinkpad-acpi sysfs interface are only considered
168 non-experimental when they are submitted to Linux mainline, at which
169 point the changes in this interface are documented and interface_version
170 may be updated. If you are using any thinkpad-acpi features not yet
172 may disappear, or be implemented in a different and incompatible way by
173 the time they are merged in Linux mainline.
175 Changes that are backwards-compatible by nature (e.g. the addition of
180 feature is not available in sysfs).
184 --------
190 In a ThinkPad, the ACPI HKEY handler is responsible for communicating
192 system. Enabling the hotkey functionality of thinkpad-acpi signals the
194 firmware will behave in many situations.
199 The driver will report HKEY events in the following format::
211 events. If a key is "masked" (bit set to 0 in the mask), the firmware
213 thinkpad-acpi would prefer to handle it, if the firmware would be so
216 Not all bits in the mask can be modified. Not all bits that can be
227 Bluetooth by itself in firmware.
240 echo 0xffffffff > /proc/acpi/ibm/hotkey -- enable all hot keys
241 echo 0 > /proc/acpi/ibm/hotkey -- disable all possible hot keys
242 ... any other 8-hex-digit mask ...
243 echo reset > /proc/acpi/ibm/hotkey -- restore the recommended mask
248 echo enable > /proc/acpi/ibm/hotkey -- does nothing
249 echo disable > /proc/acpi/ibm/hotkey -- returns an error
252 maintain maximum bug-to-bug compatibility, it does not report any masks,
254 does not support masks at all, even if NVRAM polling is in use.
265 DEPRECATED, DON'T USE, WILL BE REMOVED IN THE FUTURE.
267 Returns the hot keys mask when thinkpad-acpi was loaded.
276 0: returns -EPERM
302 poll the NVRAM for. This is auto-detected by the driver
306 Hot keys whose bits are set in hotkey_source_mask are
307 polled for in NVRAM, and reported as hotkey events if
308 enabled in hotkey_mask. Only a few hot keys are
311 Warning: when in NVRAM mode, the volume up/down/mute
312 keys are synthesized according to changes in the mixer,
315 interface. When in ACPI event mode, volume up/down/mute
318 version -- not just with firmware models -- as well as
322 frequency in Hz for hot key polling. It must be between
337 attribute will read 0 if the switch is in the "radios
338 disabled" position, and 1 if the switch is in the
345 will read 0 if the ThinkPad is in normal mode, and
346 1 if the ThinkPad is in tablet mode.
354 undock. Set to zero for normal wake-ups or wake-ups
381 The events are available in an input device, with the following id:
391 The version will have its LSB incremented if the keymap changes in a
392 backwards-compatible way. The MSB shall always be 0x41 for this input
393 device. If the MSB is not 0x41, do not use the device as described in
396 been changed in a non-backwards compatible way.
399 backwards-compatible change for this input device.
401 Thinkpad-acpi Hot Key event map (version 0x4101):
407 0x1001 0x00 FN+F1 -
417 off the ThinkLight as side-effect
421 semantics, i.e. sleep-to-RAM).
433 and W-WAN card if left in control
437 radios (Bluetooth+W-WAN+WLAN),
440 0x1006 0x05 FN+F6 -
453 0x1009 0x08 FN+F9 -
457 0x100B 0x0A FN+F11 -
469 0x100D 0x0C FN+BACKSPACE -
470 0x100E 0x0D FN+INSERT -
471 0x100F 0x0E FN+DELETE -
475 in IBM ThinkPads, even when
489 0x1013 0x12 FN+PGDOWN -
512 Implemented in driver.
515 Implemented in driver.
534 In addition to the EV_KEY events, thinkpad-acpi may also issue EV_SW
543 ------------------------------
548 0x2304 System is waking up from suspend to undock
549 0x2305 System is waking up from suspend to eject bay
566 0x2313 ALARM: System is waking up from suspend because
571 0x3006 Bay hotplug request (hint to power up SATA link when
574 0x4010 Docked into hotplug port replicator (non-ACPI dock)
575 0x4011 Undocked from hotplug port replicator (non-ACPI dock)
591 cleanly (0x2413) before power is lost. They must be acted upon, as the
595 should suspend or hibernate the laptop (and in the case of battery
601 operating system is to force either an immediate suspend or hibernate
609 Don't mess with the brightness hotkeys in a Thinkpad. If you want
621 ---------
630 Bluetooth device in the internal ThinkPad CDC slot.
632 If the ThinkPad supports it, the Bluetooth state is stored in NVRAM,
633 so it is kept across reboots and power-off.
647 disabled through the "bluetooth_enable" thinkpad-acpi device
652 - 0: disables Bluetooth / Bluetooth is disabled
653 - 1: enables Bluetooth / Bluetooth is enabled.
656 class. It has been deprecated, and it will be removed in year
660 Documentation/driver-api/rfkill.rst for details.
663 Video output control -- /proc/acpi/ibm/video
664 --------------------------------------------
666 This feature allows control over the devices used for video output -
696 (it simulates the behavior of Fn-F7).
704 chips) the X driver configures the video card in a way which prevents
705 Fn-F7 from working. This also disables the video output switching
707 Fn-F7. Video switching on the console should still work.
713 ------------------
733 documentation, in Documentation/leds/leds-class.rst. The ThinkLight LED name
736 Due to limitations in the sysfs LED class, if the status of the ThinkLight
737 cannot be read or if it is unknown, thinkpad-acpi will report it as "off".
742 -----------------
748 This feature is mostly used internally by the ACPI firmware to keep the legacy
749 CMOS NVRAM bits in sync with the current machine state, and to record this
752 Some of these commands actually perform actions in some ThinkPad models, but
753 this is expected to disappear more and more in newer models. As an example, in
754 a T43 and in a X40, commands 12 and 13 still control the ThinkLight state for
762 - 0 - Related to "Volume down" key press
763 - 1 - Related to "Volume up" key press
764 - 2 - Related to "Mute on" key press
765 - 3 - Related to "Access IBM" key press
766 - 4 - Related to "LCD brightness up" key press
767 - 5 - Related to "LCD brightness down" key press
768 - 11 - Related to "toggle screen expansion" key press/function
769 - 12 - Related to "ThinkLight on"
770 - 13 - Related to "ThinkLight off"
771 - 14 - Related to "ThinkLight" key press (toggle ThinkLight)
773 The cmos command interface is prone to firmware split-brain problems, as
774 in newer ThinkPads it is just a compatibility layer. Do not use it, it is
779 -----------
795 Unrestricted access to all LEDs requires that thinkpad-acpi be
801 visible to userspace. They are used by the snd-hda-intel audio driver.
816 - 0 - power
817 - 1 - battery (orange)
818 - 2 - battery (green)
819 - 3 - UltraBase/dock
820 - 4 - UltraBay
821 - 5 - UltraBase battery slot
822 - 6 - (unknown)
823 - 7 - standby
824 - 8 - dock status 1
825 - 9 - dock status 2
826 - 10, 11 - (unknown)
827 - 12 - thinkvantage
828 - 13, 14, 15 - (unknown)
835 The ThinkPad LED sysfs interface is described in detail by the LED class
836 documentation, in Documentation/leds/leds-class.rst.
838 The LEDs are named (in LED ID order, from 0 to 12):
839 "tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt",
845 Due to limitations in the sysfs LED class, if the status of the LED
846 indicators cannot be read due to an error, thinkpad-acpi will report it as
854 ThinkPad indicator LED should blink in hardware accelerated mode, use the
858 LEDs that are known not to exist in a given ThinkPad model are not
861 are not in the dock), or if you notice that there are missing LEDs,
862 a report to ibm-acpi-devel@lists.sourceforge.net is appreciated.
865 ACPI sounds -- /proc/acpi/ibm/beep
866 ----------------------------------
869 audible alerts in various situations. This feature allows the same
872 The commands are non-negative integer numbers::
880 - 0 - stop a sound in progress (but use 17 to stop 16)
881 - 2 - two beeps, pause, third beep ("low battery")
882 - 3 - single beep
883 - 4 - high, followed by low-pitched beep ("unable")
884 - 5 - single beep
885 - 6 - very high, followed by high-pitched beep ("AC/DC")
886 - 7 - high-pitched beep
887 - 9 - three short beeps
888 - 10 - very long beep
889 - 12 - low-pitched beep
890 - 15 - three high-pitched beeps repeating constantly, stop with 0
891 - 16 - one medium-pitched beep repeating constantly, stop with 17
892 - 17 - stop 16
896 -------------------
910 42 42 45 41 36 -128 33 -128
915 48 48 36 52 38 -128 31 -128 48 52 48 -128 -128 -128 -128 -128
918 system-board model (and thus, on ThinkPad model).
925 - 1: CPU
926 - 2: (depends on model)
927 - 3: (depends on model)
928 - 4: GPU
929 - 5: Main battery: main sensor
930 - 6: Bay battery: main sensor
931 - 7: Main battery: secondary sensor
932 - 8: Bay battery: secondary sensor
933 - 9-15: (depends on model)
937 - 2: Mini-PCI
938 - 3: Internal HDD
943 - 2: System board, left side (near PCMCIA slot), reported as HDAPS temp
944 - 3: PCMCIA slot
945 - 9: MCH (northbridge) to DRAM Bus
946 - 10: Clock-generator, mini-pci card and ICH (southbridge), under Mini-PCI
948 - 11: Power regulator, underside of system board, below F2 key
953 - 1: CPU
954 - 2: Main Battery: main sensor
955 - 3: Power Converter
956 - 4: Bay Battery: main sensor
957 - 5: MCH (northbridge)
958 - 6: PCMCIA/ambient
959 - 7: Main Battery: secondary sensor
960 - 8: Bay Battery: secondary sensor
966 Readings from sensors that are not available return -128.
976 thinkpad-acpi thermal sensors are reported through the hwmon
981 -----------------------------------------------
983 This feature is not included in the thinkpad driver anymore.
991 - make sure the battery is fully charged
992 - make sure the fan is running
993 - use above mentioned tool to read out the EC
1000 embedded controller registers - e.g. make sure nothing else changes
1008 ----------------------
1042 ThinkPad-specific interface. The driver will disable its native
1044 ACPI interface is available in the ThinkPad.
1046 If you want to use the thinkpad-acpi backlight brightness control
1084 driver is trying to set the display to when "power" is set
1086 power management event.
1088 power:
1089 power management mode, where 0 is "display on", and 1 to 3
1091 because thinkpad-acpi cannot really turn the backlight
1092 off. Kernel power management events can temporarily
1093 increase the current power management level, i.e. they can
1099 Whatever you do, do NOT ever call thinkpad-acpi backlight-level change
1100 interface and the ACPI-based backlight level change interface
1102 at the same time. The two will interact in bad ways, do funny things,
1108 --------------------------------------
1114 NOTE: by default, the volume control interface operates in read-only
1115 mode, as it is supposed to be used for on-screen-display purposes.
1122 the desktop environment to just provide on-screen-display feedback.
1123 Software volume control should be done only in the main AC97/HDA
1130 ThinkPads have a built-in amplifier and muting circuit that drives the
1132 or HDA mixer in the audio path, and under exclusive control of the
1147 This is a very superior design when compared to the cheap software-only
1148 mute-toggle solution found on normal consumer laptops: you can be
1152 The IBM ThinkPads, and the earlier Lenovo ThinkPads have variable-gain
1156 control stage exists after the main AC97 or HDA mixer in the audio
1161 system). In this case, the volume keys are filtered out for unmute
1162 key press (there are some firmware bugs in this area) and delivered as
1163 normal key presses to the operating system (thinkpad-acpi is not
1167 The ThinkPad-ACPI volume control
1188 whether your thinkpad has volume control or mute-only control:
1193 please report this to ibm-acpi-devel@lists.sourceforge.net, so that we
1201 The driver will operate in volume_mode=3 by default. If that does not
1203 ibm-acpi-devel@lists.sourceforge.net.
1210 ---------------------------------------------------------
1221 must be given to thinkpad-acpi.
1235 Most ThinkPad fans work in "levels" at the firmware interface. Level 0
1243 There is also a "full-speed" level, also known as "disengaged" level.
1244 In this level, the EC disables the speed-locked closed-loop fan control,
1250 commands. The full-speed level may take up to two minutes to ramp up to
1251 maximum speed, and in some ThinkPads, the tachometer readings go stale
1252 while the EC is transitioning to the full-speed level.
1258 An enabled fan in level "auto" may stop spinning if the EC decides the
1272 through thinkpad-acpi.
1274 The thinkpad-acpi kernel driver can be programmed to revert the fan
1297 will try to place it in a safe level if it is too slow or disabled.
1304 "full-speed" (without the quotes). Not all ThinkPads support the "auto"
1305 and "full-speed" levels. The driver accepts "disengaged" as an alias for
1306 "full-speed", and reports it as "disengaged" for backwards
1317 effect or the fan speed eventually settles somewhere in that range. The
1323 echo 'watchdog <interval in seconds>' > /proc/acpi/ibm/fan
1334 that operation is not supported in a given ThinkPad or if the parameter
1335 is out-of-bounds, and EPERM if it is forbidden. They may also return
1342 - 0: PWM offline (fan is set to full-speed mode)
1343 - 1: Manual PWM control (use pwm1 to set fan level)
1344 - 2: Hardware PWM control (EC "auto" mode)
1345 - 3: reserved (Software PWM control, not implemented yet)
1349 mode is unsupported, it will return -EINVAL.
1352 Fan level, scaled from the firmware values of 0-7 to the hwmon
1353 scale of 0-255. 0 means fan stopped, 255 means highest normal
1360 Fan tachometer reading, in RPM. May go stale on certain
1366 Fan tachometer reading, in RPM, for the secondary fan.
1371 Fan safety watchdog timer interval, in seconds. Minimum is
1376 To start the fan in a safe mode: set pwm1_enable to 2. If that fails
1382 ---
1390 This feature shows the presence and current state of the built-in
1393 If the ThinkPad supports it, the WWAN state is stored in NVRAM,
1394 so it is kept across reboots and power-off.
1402 If the W-WAN card is installed, the following commands can be used::
1410 If the W-WAN card is installed, it can be enabled /
1411 disabled through the "wwan_enable" thinkpad-acpi device
1415 - 0: disables WWAN card / WWAN card is disabled
1416 - 1: enables WWAN card / WWAN card is enabled.
1419 class. It has been deprecated, and it will be removed in year
1423 Documentation/driver-api/rfkill.rst for details.
1427 ------------------
1434 screen was applied manually in front of the display).
1449 -------------------
1454 the device is in deskmode or lapmode. This feature is used by user space
1455 to decide if WWAN transmission can be increased to maximum power and is
1459 The property is read-only. If the platform doesn't have support the sysfs
1463 -----------------
1466 tested and validated in various ThinkPad models yet. The feature may not
1473 present and enabled in the BIOS.
1479 Documentation/driver-api/rfkill.rst for details.
1483 -------------------------
1490 is other than "english". This is because the default keyboard language in ECFW
1498 Text corresponding to keyboard layout to be set in sysfs are: be(Belgian),
1500 fr(French), fr-ch(French(Switzerland)), hu(Hungarian), it(Italy), jp (Japan),
1505 -----------------
1518 - type a
1519 - type b
1521 The property is read-only. If the platform doesn't have support the sysfs
1525 ------
1529 Some newer Thinkpads have a feature called MAC Address Pass-through. This
1532 network. This property enables user-space to easily determine the MAC address
1541 This property is read-only.
1544 -----------------
1552 - 0 = Home mode
1553 - 1 = Web-browser mode
1554 - 2 = Web-conference mode
1555 - 3 = Function mode
1556 - 4 = Layflat mode
1563 ----------------------
1576 The exact semantics of the attributes may be found in
1577 Documentation/ABI/testing/sysfs-class-power.
1580 ------------------------------------
1582 Multiple commands can be written to the proc files in one shot by
1588 Commands can also be specified when loading the thinkpad-acpi module,
1595 -------------------------
1629 -----------------------
1631 If thinkpad-acpi refuses to detect your ThinkPad, you can try to specify
1633 not, please contact ibm-acpi-devel@lists.sourceforge.net with a report.
1646 and the driver enables hot key handling by default in
1651 and the hwmon class for libsensors4 (lm-sensors 3)
1655 0x020100: Marker for thinkpad-acpi with hot key NVRAM polling
1659 unneeded/undesired in the first place).
1660 0x020101: Marker for thinkpad-acpi with hot key NVRAM polling
1674 to not exist in a given model are not registered with
1684 0x020700: Support for mute-only mixers.
1685 Volume control in read-only mode by default.