ThinkWiki - User contributions [en]

How to protect the harddisk through APS

2008-12-24T21:27:26Z

Alkos333: /* Getting the files */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
This page tells you how to make the [[Active Protection System]] work under Linux to protect your harddrive from damage in case of a notebook drop or other kind of impact while it is running.

Specific instructions for {{Fedora}} can be found [[Installing_Fedora_Core_5_on_a_ThinkPad_X41_Tablet#Harddrive_Active_Protection_System_.28HDAPS.29|here]].

For {{Debian}} (Etch) have a look at [[Installing_Debian_Etch_on_a_ThinkPad_Z60m#Active_Protection_System|this]].

== How APS works in Linux ==
APS in Linux consists of four components on the software side:
* The [[HDAPS]] driver (included in recent kernels). It exports a sysfs interface providing the acceleration values.
* The <tt>hdaps_protect</tt> disk protection kernel patch, which exports a sysfs interface that enables an ide or sata disk to be protected by a userspace process. You should get the patch appropriate to your kernel version from [http://news.gmane.org/group/gmane.linux.drivers.hdaps.devel/last=/force_load=t gmane.linux.drivers.hdaps.devel].
* The [http://www.dresco.co.uk/hdaps/ <tt>hdapsd</tt>] disk protection userspace daemon. It monitors the acceleration values through the HDAPS interface and automatically initiates disk protection through the hdaps_protect interface - given that the movement exceeds a user specified threshold.
* Optional: the [http://roy.marples.name/node/269 <tt>khdapsmonitor KDE System Tray applet</tt>] or the [http://www.dresco.co.uk/hdaps/ <tt>gnome-hdaps-applet</tt>]. These applets provide a visual indication of the disk protection status and also a graphical interface for adjusting configuration options for <tt>hdapsd</tt>.
* For Kernel 2.6.28 it's planned to put a general disc protection directly into the libata driver
|}

==Installation==
As mentioned above, the hdaps kernel driver found in recent kernels is only responsible for reading the accelerometer data and exporting it through the sysfs interface.

In order to use this information to protect the disk, some additional steps are required.

* Download and build the latest hdaps_protect disk protection kernel patches.
* Enable the drivers in the kernel (requires kernel rebuild).
* Download, build and configure the hdapsd userspace daemon.
* Download and build one of the applets to get a real-time representation of the disk protection status.

===Getting the files===
{| border="1" cellspacing="0" cellpadding="2"
! Latest Sources
|
See [[HDAPS#Disk_head_parking|HDAPS - Disk head parking]]
|-
! {{Slackware}}
|
*<tt>hdapsd</tt> SlackBuild: http://slackbuilds.org/repository/12.2/system/hdapsd/
|-
! {{Debian}}
|
*<tt>hdapsd</tt> package: http://packages.debian.org/unstable/misc/hdapsd
|-
! {{Fedora}}
| see instructions [[Installing_Fedora_Core_5_on_a_ThinkPad_X41_Tablet#Harddrive_Active_Protection_System_.28HDAPS.29|here]]
*kernel RPM packages including <tt>hdaps_protect</tt>: http://www.dresco.co.uk/hdaps/
*kernel RPM packages including <tt>hdaps_protect</tt> and [[Software Suspend 2]]: http://mhensler.de/swsusp/download/yum/development/fc5/ (build 2084_2 and up)
|-
! {{Gentoo}}
|
*<tt>hdapsd</tt>: [http://sources.gentoo.org/viewcvs.py/gentoo-x86/app-laptop/hdapsd available]
*<tt>khdapsmonitor</tt>: [http://sources.gentoo.org/viewcvs.py/gentoo-x86/app-laptop/khdapsmonitor available]
|}

=== Adding kernel support ===
A kernel patch is required for disk head parking and queue freezing.

==== Manually patching and compiling a kernel ====
As root, do:
:{{cmdroot|cd /usr/src/linux}}
:{{cmdroot|patch -p1 < ~/hdaps_protect.20060409.patch}}
:{{cmdroot|make clean}}
:{{cmdroot|make}}
:{{cmdroot|make modules_install}}

==== Zen-Sources patched kernel ====
Another way to achieve this is using zen-sources kernel.
It has hdaps patches applied. Additional it supports many other IBM futures like tp_smapi and newest thinkpad_acpi.

Download page for this kind of kernel is http://zen-sources.org/

After downloading a kernel image unpack it to ''/usr/src/linux'' with
:{{cmdroot|tar jxf zen-sources-2.6-version-zen0.tar.bz2 }}

Installation is similar to previous one.

As root, do:
:{{cmdroot|make oldconfig}}
:{{cmdroot|make clean}}
:{{cmdroot|make}}
:{{cmdroot|make modules_install}}

'''make oldconfig''' command will ask you for some information. It's required to tap '''m''' or '''y''' on "HDAPS" functionality, and on some other things connected with Thinkpad.

=== Installing hdapsd ===
==== Manual compilation from source ====
{{NOTE|1=There has been a new release of hdapsd which doesn't use sysfs anymore and therefore reduces timer interrupts. You need tp_smapi 0.32 for this. See also: http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1040 .}}
* Download the <tt>hdapsd</tt> sources (see above)
* Compile using {{cmdroot|gcc -o hdapsd hdapsd-*.c}}
* Run {{cmdroot|./hdapsd -d sda -s 12 -a}} (replace <tt>sda</tt> with your hard disk device; run {{cmdroot|./hdapsd}} without arguments for help)

==== Gentoo ====
{{NOTE|1=hdapsd was added to the official portage tree on the 26th June 2006. However the version in portage is to be considered outdated. (20060409)}}
{{Gentoo}} users can try the ebuild attached to [http://bugs.gentoo.org/show_bug.cgi?id=166166 gentoo bug 166166].
*Add hdapsd support in your kernel: device drivers -> hardware monitoring -> ... (you need it as a module if you want to use tp_smapi and hdaps, see [[Tp_smapi]])
*Download the ebuild, use same ebuild date as the kernel-patch.
*Make known the portage an extern ebuild path and add the following line to {{path|/etc/make.conf}}:
PORTDIR_OVERLAY="/usr/local/portage/" (or any other location)
*Create directory {{path|/usr/local/portage}} and {{path|/usr/local/portage/app-laptop/}}
*Copy the downloaded ebuild to {{path|/usr/local/portage/app-laptop}} ({{path|/usr/local/portage/app-laptop/hdapsd}} should now exists)
*Make portage known the new ebuild and creat digist with:
:{{cmdroot|ebuild /usr/local/portage/app-laptop/hdapsd/hdapsd-20060326.ebuild digest}}
*Optional: Copy source file to portage distfiles (if no internet connection is available):
:{{cmdroot|cp hdapsd-20060326.c /usr/portage/distfiles}}
*Accept the x86 keyword for this package: {{cmdroot|echo "app-laptop/hdapsd ~x86" >> /etc/portage/package.keywords}}
*Install hdapsd with: {{cmdroot|emerge hdapsd}}.
*Edit {{path|/etc/conf.d/hdapsd}} (change your harddrive if neccessary: mine is sda, and change the value from 5, 5 is to sensitive, 12 is a good value in my opinion).
*start deamon with: {{cmdroot|/etc/init.d/hdapsd start}}
*Optional: add to default runlevel: {{cmdroot|rc-update add hdapsd default, rc-update add hdapsd battery}}
Write an eMail to abartel[Ã¤d]htwm.de, if you want to get my hdapsd-20060326.ebuild and please upload it.

==== Ubuntu ====
hdapsd is available via synaptic for Hardy Heron.

=== Building an applet ===
====hdaps-gl====
*Make sure you have installed hdaps [and loaded] and ?opengl?
*Download [https://sourceforge.net/project/showfiles.php?group_id=138242 hdaps-gl-0.0.5] from the web.
*Extract files to {{path|/opt/hdaps-gl}}.
*{{cmdroot|make}}
*Start the applet: {{cmdroot|./hdaps-gl}}

==Troubleshooting==
See the [[Problem with APS harddisk parking]] page for troubleshooting APS issues.
{{NOTE|1=If you use [[tp_smapi]], remember to include the option <tt>HDAPS=1</tt> when [[Tp_smapi#Installation|installing tp_smapi]]. Also, you might need to build the hdaps driver as module.}}

==Further Information==
*Additonal information and support is available through the [[Mailinglists#HDAPS Developers Mailinglist|hdaps-devel]] mailinglist and its archive.

[[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Z61m]] [[Category:Z61e]] [[Category:Z61m]]

Swsusp

2007-03-16T00:37:59Z

Alkos333: /* Model-specific Status */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
===Software Suspend - swsusp===
Software Suspend (<tt>swsusp</tt>) is a suspend-to-disk implementation included in the 2.6 kernel series. See [[Software Suspend 2]] for an alternative implementation, which has some advantages.

Note that swsusp is not needed for suspend-to-RAM functionality.
|}

==Kernel configuration==
To enable software suspend change your kernel config as follows:
:{{kernelconf|CONFIG_PM|<*>|Power management support|Power management options|||}}
:{{kernelconf|CONFIG_SOFTWARE_SUSPEND|<*>|Software Suspend|Power management options|||}}
:{{kernelconf|CONFIG_PM_STD_PARTITION|[/dev/resume_partition]|Default resume partition|Power management options|||}}
<tt>/dev/resume_partition</tt> needs to be replaced by the swap partition you want to use for suspending. (Use {{cmdroot|fdisk -l /dev/hda}} if unsure.)

You can override the default resume partition anytime by giving {{bootparm|resume|/dev/resume_partition}} as kernel boot parameter.
Also, in case you suspended, but want to boot up normally (without resuming from the saved image - losing all data that was unsaved at suspend time), you can give the {{bootparm|noresume|}} kernel boot parameter.

{{NOTE|For some people suspending did not work if <tt>resume_partition</tt> was specified in the kernel config. In such case specify the resume partition as a kernel parameter instead.}}

{{NOTE|When using Debian Etch or Sid, you need to use <tt>initramfs-tools</tt> as yaird is currently (2006-05-18) not supporting swsusp. See [http://wiki.debian.org/InitrdReplacementOptions the Debian Wiki] for more details.}}

==Suspending==
To suspend you can either do a simple {{cmdroot|echo disk > /sys/power/state}} (recommended) or use the [http://softwaresuspend.berlios.de/old-site/swsusp/sysvinit-2.76-v2-for_swsusp-v5.tar.gz patched SysVInit] and call {{cmdroot|swsusp}} or {{cmdroot|shutdown -z now}}. As the {{path|/proc/acpi/sleep}} interface becomes deprecated in newer kernels you should NOT use the old {{cmdroot|echo -n 4 > /proc/acpi/sleep}} anymore.

Ideally, you would do this from a script like {{path|/etc/acpi/actions/hibernate.sh}}. It has proven to be a good idea to shutdown the following processes/drivers within the script before you do the actual suspend:
*any running mysql server
*the linuxant driver may require to be stopped as well ({{cmdroot|dldrstop}} does the trick).

Afterwards you might want to enable them again, as well as run a script that does necessary configurations according to the ac power state.
Furthermore, the system clock is not readjusted automatically, so you will probably also want the do that from that script (i.e. by restarting your systemclock bootup script).

If the sound output is silent after resume, the following commands might help to get sound to work again without reloading any modules:
amixer set Master mute >/dev/null 2>&1
amixer set PCM mute >/dev/null 2>&1
amixer set Master unmute >/dev/null 2>&1
amixer set PCM unmute >/dev/null 2>&1

==S5 vs. S4 state==
Finally you should take note that swsusp does not set the ACPI S4 state. Instead it goes to S5. This means that the machine itself doesn't know that it was suspend rather than shutdown. Hence you can i.e. boot a parallel installed other operating system and resume your linux session later, as long as you don't touch the swap partition the image was saved to.

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| swsusp works
! style="background:#efefef;"| Note
|- style="background: white;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.20
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.18 with [[User:Profilek | Forest Zhao's AHCI patches]]
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.19.2
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X31}}
| 2672-BCO
| [[:Category:Debian|Debian Etch]]
| 2.6.20.1
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|{{R52}}
| 18299MG
| [[:Category:Debian|Debian Sarge]]
| 2.6.17.9
! style ="color:green;"| yes
|

|- style="background: white; color:black;"
|{{T43}}
| 2668-74G
| [[:Category:Fedora|Fedora Core 6]]
| 2.6.19
! style ="color:green;"| yes
|

|- style="background: white; color:black;"
|{{T60}}
| 1953-E7U
| [[:Category:Slackware|Slackware 11]]
| 2.6.20
! style="color:green;" | yes
|
|- style="background: white; color:black;"

Swsusp

2007-03-16T00:37:42Z

Alkos333: /* Model-specific Status */

Swsusp

2007-03-16T00:36:32Z

Alkos333: /* Model-specific Status */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
===Software Suspend - swsusp===
Software Suspend (<tt>swsusp</tt>) is a suspend-to-disk implementation included in the 2.6 kernel series. See [[Software Suspend 2]] for an alternative implementation, which has some advantages.

Note that swsusp is not needed for suspend-to-RAM functionality.
|}

==Kernel configuration==
To enable software suspend change your kernel config as follows:
:{{kernelconf|CONFIG_PM|<*>|Power management support|Power management options|||}}
:{{kernelconf|CONFIG_SOFTWARE_SUSPEND|<*>|Software Suspend|Power management options|||}}
:{{kernelconf|CONFIG_PM_STD_PARTITION|[/dev/resume_partition]|Default resume partition|Power management options|||}}
<tt>/dev/resume_partition</tt> needs to be replaced by the swap partition you want to use for suspending. (Use {{cmdroot|fdisk -l /dev/hda}} if unsure.)

You can override the default resume partition anytime by giving {{bootparm|resume|/dev/resume_partition}} as kernel boot parameter.
Also, in case you suspended, but want to boot up normally (without resuming from the saved image - losing all data that was unsaved at suspend time), you can give the {{bootparm|noresume|}} kernel boot parameter.

{{NOTE|For some people suspending did not work if <tt>resume_partition</tt> was specified in the kernel config. In such case specify the resume partition as a kernel parameter instead.}}

{{NOTE|When using Debian Etch or Sid, you need to use <tt>initramfs-tools</tt> as yaird is currently (2006-05-18) not supporting swsusp. See [http://wiki.debian.org/InitrdReplacementOptions the Debian Wiki] for more details.}}

==Suspending==
To suspend you can either do a simple {{cmdroot|echo disk > /sys/power/state}} (recommended) or use the [http://softwaresuspend.berlios.de/old-site/swsusp/sysvinit-2.76-v2-for_swsusp-v5.tar.gz patched SysVInit] and call {{cmdroot|swsusp}} or {{cmdroot|shutdown -z now}}. As the {{path|/proc/acpi/sleep}} interface becomes deprecated in newer kernels you should NOT use the old {{cmdroot|echo -n 4 > /proc/acpi/sleep}} anymore.

Ideally, you would do this from a script like {{path|/etc/acpi/actions/hibernate.sh}}. It has proven to be a good idea to shutdown the following processes/drivers within the script before you do the actual suspend:
*any running mysql server
*the linuxant driver may require to be stopped as well ({{cmdroot|dldrstop}} does the trick).

Afterwards you might want to enable them again, as well as run a script that does necessary configurations according to the ac power state.
Furthermore, the system clock is not readjusted automatically, so you will probably also want the do that from that script (i.e. by restarting your systemclock bootup script).

If the sound output is silent after resume, the following commands might help to get sound to work again without reloading any modules:
amixer set Master mute >/dev/null 2>&1
amixer set PCM mute >/dev/null 2>&1
amixer set Master unmute >/dev/null 2>&1
amixer set PCM unmute >/dev/null 2>&1

==S5 vs. S4 state==
Finally you should take note that swsusp does not set the ACPI S4 state. Instead it goes to S5. This means that the machine itself doesn't know that it was suspend rather than shutdown. Hence you can i.e. boot a parallel installed other operating system and resume your linux session later, as long as you don't touch the swap partition the image was saved to.

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| swsusp works
! style="background:#efefef;"| Note
|- style="background: white;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.20
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.18 with [[User:Profilek | Forest Zhao's AHCI patches]]
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.19.2
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X31}}
| 2672-BCO
| [[:Category:Debian|Debian Etch]]
| 2.6.20.1
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|{{R52}}
| 18299MG
| [[:Category:Debian|Debian Sarge]]
| 2.6.17.9
! style ="color:green;"| yes
|

|- style="background: white; color:black;"
|{{T43}}
| 2668-74G
| [[:Category:Fedora|Fedora Core 6]]
| 2.6.19
! style ="color:green;"| yes
|
|

|- style="background: white; color:black;"
|{{T60}}
| 1953-E7U
| [[:Category:Slackware|Slackware 11]]
| 2.6.20
! style="color:green;" | yes
|
|- style="background: white; color:black;"
}

Swsusp

2007-03-16T00:35:39Z

Alkos333: /* Model-specific Status */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
===Software Suspend - swsusp===
Software Suspend (<tt>swsusp</tt>) is a suspend-to-disk implementation included in the 2.6 kernel series. See [[Software Suspend 2]] for an alternative implementation, which has some advantages.

Note that swsusp is not needed for suspend-to-RAM functionality.
|}

==Kernel configuration==
To enable software suspend change your kernel config as follows:
:{{kernelconf|CONFIG_PM|<*>|Power management support|Power management options|||}}
:{{kernelconf|CONFIG_SOFTWARE_SUSPEND|<*>|Software Suspend|Power management options|||}}
:{{kernelconf|CONFIG_PM_STD_PARTITION|[/dev/resume_partition]|Default resume partition|Power management options|||}}
<tt>/dev/resume_partition</tt> needs to be replaced by the swap partition you want to use for suspending. (Use {{cmdroot|fdisk -l /dev/hda}} if unsure.)

You can override the default resume partition anytime by giving {{bootparm|resume|/dev/resume_partition}} as kernel boot parameter.
Also, in case you suspended, but want to boot up normally (without resuming from the saved image - losing all data that was unsaved at suspend time), you can give the {{bootparm|noresume|}} kernel boot parameter.

{{NOTE|For some people suspending did not work if <tt>resume_partition</tt> was specified in the kernel config. In such case specify the resume partition as a kernel parameter instead.}}

{{NOTE|When using Debian Etch or Sid, you need to use <tt>initramfs-tools</tt> as yaird is currently (2006-05-18) not supporting swsusp. See [http://wiki.debian.org/InitrdReplacementOptions the Debian Wiki] for more details.}}

==Suspending==
To suspend you can either do a simple {{cmdroot|echo disk > /sys/power/state}} (recommended) or use the [http://softwaresuspend.berlios.de/old-site/swsusp/sysvinit-2.76-v2-for_swsusp-v5.tar.gz patched SysVInit] and call {{cmdroot|swsusp}} or {{cmdroot|shutdown -z now}}. As the {{path|/proc/acpi/sleep}} interface becomes deprecated in newer kernels you should NOT use the old {{cmdroot|echo -n 4 > /proc/acpi/sleep}} anymore.

Ideally, you would do this from a script like {{path|/etc/acpi/actions/hibernate.sh}}. It has proven to be a good idea to shutdown the following processes/drivers within the script before you do the actual suspend:
*any running mysql server
*the linuxant driver may require to be stopped as well ({{cmdroot|dldrstop}} does the trick).

Afterwards you might want to enable them again, as well as run a script that does necessary configurations according to the ac power state.
Furthermore, the system clock is not readjusted automatically, so you will probably also want the do that from that script (i.e. by restarting your systemclock bootup script).

If the sound output is silent after resume, the following commands might help to get sound to work again without reloading any modules:
amixer set Master mute >/dev/null 2>&1
amixer set PCM mute >/dev/null 2>&1
amixer set Master unmute >/dev/null 2>&1
amixer set PCM unmute >/dev/null 2>&1

==S5 vs. S4 state==
Finally you should take note that swsusp does not set the ACPI S4 state. Instead it goes to S5. This means that the machine itself doesn't know that it was suspend rather than shutdown. Hence you can i.e. boot a parallel installed other operating system and resume your linux session later, as long as you don't touch the swap partition the image was saved to.

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| swsusp works
! style="background:#efefef;"| Note
|- style="background: white;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.20
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.18 with [[User:Profilek | Forest Zhao's AHCI patches]]
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.19.2
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X31}}
| 2672-BCO
| [[:Category:Debian|Debian Etch]]
| 2.6.20.1
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|{{R52}}
| 18299MG
| [[:Category:Debian|Debian Sarge]]
| 2.6.17.9
! style ="color:green;"| yes
|

|- style="background: white; color:black;"
|{{T43}}
| 2668-74G
| [[:Category:Fedora|Fedora Core 6]]
| 2.6.19
! style ="color:green;"| yes
|
|

|{{T60}}
| 1953-E7U
| [[:Category:Slackware|Slackware 11]]
| 2.6.20
! style="color:green;" | yes
|
}

How to control fan speed

2007-03-14T18:09:06Z

Alkos333: /* Automated control scripts */

This page discusses methods for controlling the system fan.

==For Linux==
===Using a patched kernel===
{{WARN|This patch is superceded by the patches in [[ibm-acpi]] [[Git]] repository or [http://ibm-acpi.sourceforge.net ibm-acpi.sf.net] releases}}
{{NOTE|Advanced fan control through ibm-acpi has been merged in Linux 2.6.20-rc2 mainline, so users of 2.6.20 won't need to patch their kernels to get the '''fan level''' functionality anymore}}

The [[Patch for controlling fan speed]] provides a convenient interface via {{path|/proc/acpi/ibm/fan}}.

Manual speed control can be done through the [[patch for controlling fan speed]]:

'''#cat /proc/acpi/ibm/fan'''
status: enabled
level: auto
speed: 4219
commands: enable, disable, level <level>
(<level> is 0-7, auto or disengaged)

'''#echo level 2 > /proc/acpi/ibm/fan'''

'''#cat /proc/acpi/ibm/fan'''
status: enabled
level: 2
speed: 3142
commands: enable, disable, level <level>
(<level> is 0-7, auto or disengaged)

===Using a stock kernel===

If you have the [[ibm-acpi]] module loaded with <tt>experimental=1</tt>, you can control the fan without patching the kernel by directly writing to the relevant embedded controller register using {{path|/proc/acpi/ibm/ecdump}}.

For example:

{{cmdroot|echo 0x2F 0x00 > /proc/acpi/ibm/ecdump}} (fan off)

{{cmdroot|echo 0x2F 0x02 > /proc/acpi/ibm/ecdump}} (low speed)

{{cmdroot|echo 0x2F 0x04 > /proc/acpi/ibm/ecdump}} (medium speed)

{{cmdroot|echo 0x2F 0x07 > /proc/acpi/ibm/ecdump}} (maximum speed)

{{cmdroot|echo 0x2F 0x80 > /proc/acpi/ibm/ecdump}} (automatic - default)

{{cmdroot|echo 0x2F 0x40 > /proc/acpi/ibm/ecdump}} (disengaged)

See the specifications below for the meaning of these modes.

===On/off control using stock kernel===

If you only wish to turn the fan on and off (with automatic control when it's on), you can use the following.

When loading [[ibm-acpi]] v0.11 with experimental switch ({{cmdroot|1=modprobe ibm_acpi experimental=1}}), it is possible to read and write the status of fan:

'''#cat /proc/acpi/ibm/fan'''
status: enabled
speed: 3580
commands: enable, disable

'''#echo disable > /proc/acpi/ibm/fan'''

'''cat /proc/acpi/ibm/fan'''
status: disabled
speed: 0
commands: enable, disable

When off, the fan will then '''never''' wake up. It is advised to use an automated control script to reduce the chance of hardware damage.

===Automated control scripts===

An [[ACPI fan control script#Variable speed control scripts|ACPI fan control script]] can be used to override the firmware's fan algorithm with gentler, quieter version. It monitors the laptop's [[thermal sensors]] and sets the fan speed accordingly, according to customizable thresholds. For the default behavior, simply save the [[ACPI fan control script#Variable speed control scripts|script]] as {{path|tp-fancontrol}} and run; note that this script requires you to modprobe the ibm_acpi module as "modprobe ibm_acpi experimental=1"<br />
{{cmdroot|./tp-fancontrol}}

==For Windows==

Shimodax's ThinkPad fan control tool offers similar functionality (see [http://forum.thinkpads.com/viewtopic.php?t=17715 forum discussion] at thinkpads.com). Source and binaries are available through the [http://sourceforge.net/projects/tp4xfancontrol "Tp4xFanControl"] project on SourceForge.

==Hardware specs==

The following hardware behavior was discovered experimentally by [[User:Thinker|Thinker]] and neither provided by nor confirmed by IBM/Lenovo. The following description may be inaccurate and may vary by model (see list of models above). The terminology probably does not match the one used by IBM/Lenovo engineers.

{{NOTE|Information on other models is included in the [[ibm-acpi]] [[Git]] version.}}

ACPI DSDT register _SB.PCI0.LPC.EC.HFSP (8 bits, offset 0x2F in the <tt>EmbeddedController</tt> address space, accessed through the standard EC interface at IO ports 0x62 and 0x66) is read/writable and has the following meaning:

Bits 7 6 5 4 3 2 1 0
---------------
Value 1 0 * * * * * * - automatic
* 1 * * * * * * - disengaged
0 0 N N N N N N - manual (0..63; 0=disable fan, 1=min, ..., 7=max)

In ''automatic'' mode, the embedded controller sets the fan speed automatically according to system temperatures and some unknown algorithm.

In ''manual'' mode, the fan level is forced to the given value and the EC will auto-regulate the fan to maintain at a (roughly) constant RPM, which is model-dependent. Manual speed levels 8-63 yield the same behavior as level 7, and the the ACPI DSDT uses level 7 for the emergency mode it enters upon critical CPU/GPU temperature, so apparently 7 is the real maximum level.

In ''disengaged'' mode, the embedded controller does not read the fan RPM (hence <tt>EmbeddedController</tt> offset 0x84 is not updated), and does not maintain a stable fan speed. When disengaged mode is entered the fan speed is not immediately changed (except if the fan was disabed, in which case it is turned on at a low level). However, once in disengaged mode, fan speed will slowly increase to ''beyond'' the maximum manual level (this may cause hardware damage!).

{{NOTE|The "disengaged" mode has a different behaviour on ThinkPad {{A31}} than that described above. As above, the fan speed increases beyond the levels of the regular 0-7 speed settings. However, the speed increase is fairly instantaneous (the change being as fast as the transition between any other two speed levels, except 0 (off) which seems faster, i.e. immediate); and the fan speed reading is ''continuously'' available while in "disengaged" mode. In the {{A31}}, the speed reaches about 4000 RPM as listed in the table below.}}

After boot, the HFSP register may not reflect the true state of the EC (on some models it reads 0x07 even though the EC is actually in automatic mode).

{{HINT|Apparently the [[Problem with fan noise|pulsing fan noise]] experienced by some users can be cured by repeatedly running 2-4 seconds of manual control followed by 0.5-1 seconds of disengaged mode. The pulse occurs when the the embedded controller computes the fan speed and adjusts the fan voltage adaptively every few seconds (~4.8sec for the ThinkPad T43); the aforementioned mode switching doesn't give it a chance to do so. One of the [[ACPI fan control script#Variable speed control scripts|ACPI fan control scripts]] implements this solution.}}

==Supported models==

The above was successfully tested on the following models:

* ThinkPad {{T60}} (fan levels RPM: 1-2 = 3000-3100, 3-5 = ~3600, 6-7 = ~4500)
* ThinkPad {{T43}}, {{T43p}} (fan levels RPM: 1-2 = ~3300, 3-5 = ~4100, 6-7 = ~4700; disengaged mode works)
* ThinkPad {{T42}}, {{T42p}} (fan levels RPM: 1-2 = ~2900, 3-5 = ~3700, 6-7 = ~4700; disengaged mode works at ~5200)
* ThinkPad {{T41}}, {{T41p}} (fan levels RPM: 1-2 = ~2980, 3-5 = ~3500, 6-7 = ~4050; disengaged mode works at ~5100)
* ThinkPad {{T40}} (fan levels RPM: 1-2 = ~2950, 3-5 = ~3600, 6-7 = ~4050)
* ThinkPad {{T30}}
* ThinkPad {{T22}}
* ThinkPad {{T23}} (low speed = ~2200, medium and maximum speed = ~4800; disengaged mode works at ~5800)
* ThinkPad {{R52}}
* ThinkPad {{R50}} (highest manual level is 3; disengage mode works and reaches much higher RPM)
* ThinkPad {{R50p}} (disengaged mode works at ~5100)
* ThinkPad {{R51}} (level 0 = off, level 1-2 = ~3150, level 3-5 = ~3350, level 6 = ~3750, disengaged = ~5100)
* ThinkPad {{R51e}} (level 0 = off, level 1-2 = ~3300, level 3-5 = ~3800, level 6 = ~4150, disengaged = ~5100)
* ThinkPad {{X30}} (level 0 = off, low = ~3900, medium = ~4200, maximum = ~4650, disengaged = ~5900)
* ThinkPad {{X31}}
* ThinkPad {{X40}}
* ThinkPad {{X41T}}
* ThinkPad {{Z60t}} (fan levels RPM: 1-2 = ~1700, 3-5 = ~2800, 6-7 = ~3500)
* ThinkPad {{Z60m}} (fan levels like Z60t)
* ThinkPad {{Z61m}}
* Thinkpad {{Z61p}} (fan levels 0-7, auto, disengaged; enable, disable; watchdog (untested))
* ThinkPad {{X60}}
* ThinkPad {{A31}} (fan levels RPM: 0 = off, 1-2 = ~3280-3380 (!), 3-5 = ~3200, 6-7 = ~3380, "disengaged" = ~4000 (see NOTE above))
Probably other models are supported too (please update this page if you confirm this).

==Models using a different interface==

The following models also work, use a different access method which supported (only) via the {{path|/proc/acpi/ibm/fan}} of [[ibm-acpi]]. No need for patching.

* ThinkPad {{600E}}, {{600X}}, {{770E}}, {{770X}} (these use a different fan control interface)

==Unsupported models==

* ThinkPad {{560}} (these models don't have a fan)