aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/ibm-acpi.txt
diff options
context:
space:
mode:
authorHenrique de Moraes Holschuh <hmh@hmh.eng.br>2007-03-23 16:33:59 -0400
committerLen Brown <len.brown@intel.com>2007-03-25 23:37:54 -0400
commit38f996ed21089fa4ae40526a5f428e3c792ea561 (patch)
tree909a92433e662af4cf868f015bec2586085e9867 /Documentation/ibm-acpi.txt
parenta62bc916cf48caaf9efa2fed20440fd617647c6c (diff)
ACPI: ibm-acpi: update documentation
Update documentation header, and relocate a hunk of text that was missplaced. Signed-off-by: Henrique de Moraes Holschuh <hmh@hmh.eng.br> Signed-off-by: Len Brown <len.brown@intel.com>
Diffstat (limited to 'Documentation/ibm-acpi.txt')
-rw-r--r--Documentation/ibm-acpi.txt85
1 files changed, 25 insertions, 60 deletions
diff --git a/Documentation/ibm-acpi.txt b/Documentation/ibm-acpi.txt
index cdcef016907a..f409f4bbdc47 100644
--- a/Documentation/ibm-acpi.txt
+++ b/Documentation/ibm-acpi.txt
@@ -1,16 +1,17 @@
1 IBM ThinkPad ACPI Extras Driver 1 IBM ThinkPad ACPI Extras Driver
2 2
3 Version 0.12 3 Version 0.13
4 17 August 2005 4 31 December 2006
5 5
6 Borislav Deianov <borislav@users.sf.net> 6 Borislav Deianov <borislav@users.sf.net>
7 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
7 http://ibm-acpi.sf.net/ 8 http://ibm-acpi.sf.net/
8 9
9 10
10This is a Linux ACPI driver for the IBM ThinkPad laptops. It supports 11This is a Linux ACPI driver for the IBM ThinkPad laptops. It supports
11various features of these laptops which are accessible through the 12various features of these laptops which are accessible through the
12ACPI framework but not otherwise supported by the generic Linux ACPI 13ACPI framework but not otherwise fully supported by the generic Linux
13drivers. 14ACPI drivers.
14 15
15 16
16Status 17Status
@@ -638,6 +639,26 @@ The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
638certain conditions are met. It will override any fan programming done 639certain conditions are met. It will override any fan programming done
639through ibm-acpi. 640through ibm-acpi.
640 641
642The ibm-acpi kernel driver can be programmed to revert the fan level
643to a safe setting if userspace does not issue one of the fan commands:
644"enable", "disable", "level" or "watchdog" within a configurable
645ammount of time. To do this, use the "watchdog" command.
646
647 echo 'watchdog <interval>' > /proc/acpi/ibm/fan
648
649Interval is the ammount of time in seconds to wait for one of the
650above mentioned fan commands before reseting the fan level to a safe
651one. If set to zero, the watchdog is disabled (default). When the
652watchdog timer runs out, it does the exact equivalent of the "enable"
653fan command.
654
655Note that the watchdog timer stops after it enables the fan. It will
656be rearmed again automatically (using the same interval) when one of
657the above mentioned fan commands is received. The fan watchdog is,
658therefore, not suitable to protect against fan mode changes made
659through means other than the "enable", "disable", and "level" fan
660commands.
661
641EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan 662EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan
642--------------------------------------- 663---------------------------------------
643 664
@@ -670,59 +691,3 @@ example:
670 691
671 modprobe ibm_acpi hotkey=enable,0xffff video=auto_disable 692 modprobe ibm_acpi hotkey=enable,0xffff video=auto_disable
672 693
673The ibm-acpi kernel driver can be programmed to revert the fan level
674to a safe setting if userspace does not issue one of the fan commands:
675"enable", "disable", "level" or "watchdog" within a configurable
676ammount of time. To do this, use the "watchdog" command.
677
678 echo 'watchdog <interval>' > /proc/acpi/ibm/fan
679
680Interval is the ammount of time in seconds to wait for one of the
681above mentioned fan commands before reseting the fan level to a safe
682one. If set to zero, the watchdog is disabled (default). When the
683watchdog timer runs out, it does the exact equivalent of the "enable"
684fan command.
685
686Note that the watchdog timer stops after it enables the fan. It will
687be rearmed again automatically (using the same interval) when one of
688the above mentioned fan commands is received. The fan watchdog is,
689therefore, not suitable to protect against fan mode changes made
690through means other than the "enable", "disable", and "level" fan
691commands.
692
693
694Example Configuration
695---------------------
696
697The ACPI support in the kernel is intended to be used in conjunction
698with a user-space daemon, acpid. The configuration files for this
699daemon control what actions are taken in response to various ACPI
700events. An example set of configuration files are included in the
701config/ directory of the tarball package available on the web
702site. Note that these are provided for illustration purposes only and
703may need to be adapted to your particular setup.
704
705The following utility scripts are used by the example action
706scripts (included with ibm-acpi for completeness):
707
708 /usr/local/sbin/idectl -- from the hdparm source distribution,
709 see http://www.ibiblio.org/pub/Linux/system/hardware
710 /usr/local/sbin/laptop_mode -- from the Linux kernel source
711 distribution, see Documentation/laptop-mode.txt
712 /sbin/service -- comes with Redhat/Fedora distributions
713 /usr/sbin/hibernate -- from the Software Suspend 2 distribution,
714 see http://softwaresuspend.berlios.de/
715
716Toan T Nguyen <ntt@physics.ucla.edu> notes that Suse uses the
717powersave program to suspend ('powersave --suspend-to-ram') or
718hibernate ('powersave --suspend-to-disk'). This means that the
719hibernate script is not needed on that distribution.
720
721Henrik Brix Andersen <brix@gentoo.org> has written a Gentoo ACPI event
722handler script for the X31. You can get the latest version from
723http://dev.gentoo.org/~brix/files/x31.sh
724
725David Schweikert <dws@ee.eth.ch> has written an alternative blank.sh
726script which works on Debian systems. This scripts has now been
727extended to also work on Fedora systems and included as the default
728blank.sh in the distribution.