Difference between revisions of "How to protect the harddisk through APS"

From ThinkWiki
Jump to: navigation, search
m (Troubleshooting)
m (Verifying hdapsd is working)
 
(39 intermediate revisions by 25 users not shown)
Line 3: Line 3:
 
|style="vertical-align:top" |
 
|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.
 
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 ==
 
== How APS works in Linux ==
 
APS in Linux consists of four components on the software side:
 
APS in Linux consists of four components on the software side:
* The [[HDAPS]] driver (included in recent kernels). (As a modul if you want to use tp_smapi (Gentoo-Linux))
+
* 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 (available [http://www.dresco.co.uk/hdaps/hdaps_protect.20060118.patch for kernel 2.6.15] and [http://www.dresco.co.uk/hdaps/hdaps_protect.20060409.patch for kernel 2.6.16]; see [[HDAPS#Disk_head_parking|here]] for other versions)
+
* 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/hdapsd-20060409.c <tt>hdapsd</tt>] disk protection userspace daemon
+
** '''NOTE''': Starting with kernel 2.6.28 a generic disc protection feature is built into the libata driver
* Optional: the [http://www.oakcourt.dyndns.org/projects/khdapsmon/ <tt>khdapsmon</tt> KDE System Tray applet] or the [http://www.dresco.co.uk/hdaps/gnome-hdaps-applet-20060120.tar.gz <tt>gnome-hdaps-applet</tt>].
+
* The [http://sourceforge.net/projects/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/projects/khdaps/wiki <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>.
The [[HDAPS|HDAPS driver]] exports a sysfs interface providing the acceleration values.
+
|}
 
+
The <tt>hdaps_protect</tt> kernel patch exports a sysfs interface that enables an ide or sata disk to be protected by a userspace process.
+
 
+
The <tt>hdapsd</tt> userspace daemon 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.
+
 
+
The optional KDE/GNOME applets provide a visual indication of the disk protection status and also a graphical interface for adjusting configuration options for <tt>hdapsd</tt>.
+
  
 
==Installation==
 
==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.  
 
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.  
{{NOTE|1=If you use [[tp_smapi]], remember to include the option <tt>HDAPS=1</tt> when [[Tp_smapi#Installation|installing tp_smapi]].}}
+
 
 
In order to use this information to protect the disk, some additional steps are required.
 
In order to use this information to protect the disk, some additional steps are required.
  
Line 34: Line 31:
 
! Latest Sources
 
! Latest Sources
 
|
 
|
*<tt>hdaps_protect</tt>, <tt>hdapsd</tt> and the <tt>gnome-hdaps-applet</tt>: http://www.dresco.co.uk/hdaps
+
See [[HDAPS#Disk_head_parking|HDAPS - Disk head parking]]
*<tt>khdapsmon</tt>: http://www.oakcourt.dyndns.org/projects/khdapsmon/
+
|-
 +
! {{Slackware}}
 +
|
 +
*<tt>hdapsd</tt> SlackBuild: http://slackbuilds.org/repository/12.2/system/hdapsd/
 
|-
 
|-
 
! {{Debian}}
 
! {{Debian}}
 
|
 
|
*<tt>hdapsd</tt>, <tt>hdaps_protect</tt>, <tt>khdapsmon</tt>, <tt>gnome-hdaps-applet</tt>:
+
*<tt>hdapsd</tt> package: http://packages.debian.org/unstable/misc/hdapsd
:{{cmdroot|deb http://www.oakcourt.dyndns.org/debian/ ./}}
+
:{{cmdroot|deb-src http://www.oakcourt.dyndns.org/debian/ ./}}
+
 
|-
 
|-
 
! {{Fedora}}
 
! {{Fedora}}
Line 50: Line 48:
 
! {{Gentoo}}
 
! {{Gentoo}}
 
|
 
|
*<tt>hdapsd</tt> ebuild: http://bugs.gentoo.org/show_bug.cgi?id=119845
+
*<tt>hdapsd</tt>: [http://sources.gentoo.org/viewcvs.py/gentoo-x86/app-laptop/hdapsd available]
*<tt>khdapsmon</tt> ebuild: http://bugs.gentoo.org/show_bug.cgi?id=124175
+
*<tt>khdapsmonitor</tt>: [http://sources.gentoo.org/viewcvs.py/gentoo-x86/app-laptop/khdapsmonitor available]
 
|}
 
|}
  
Line 64: Line 62:
 
:{{cmdroot|make}}
 
:{{cmdroot|make}}
 
:{{cmdroot|make modules_install}}
 
:{{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 ===
 
=== Installing hdapsd ===
 
==== Manual compilation from source ====
 
==== 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)
 
* Download the <tt>hdapsd</tt> sources (see above)
 
* Compile using {{cmdroot|gcc -o hdapsd hdapsd-*.c}}
 
* 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)
 
* Run {{cmdroot|./hdapsd -d sda -s 12 -a}} (replace <tt>sda</tt> with your hard disk device; run {{cmdroot|./hdapsd}} without arguments for help)
 
==== Fedora Core ====
 
{{Fedora}} users can try the instructions [[Installing_Fedora_Core_5_on_a_ThinkPad_X41_Tablet#Harddrive_Active_Protection_System_.28HDAPS.29|here]]
 
  
 
==== Gentoo ====
 
==== Gentoo ====
{{Gentoo}} users can try the ebuild attached to [http://bugs.gentoo.org/show_bug.cgi?id=119845 gentoo bug 119845].
+
{{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 modul if you want to use tp_smapi and hdaps, see tp_smapi topic)
+
*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.
 
*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}}:
 
*Make known the portage an extern ebuild path and add the following line to {{path|/etc/make.conf}}:
Line 89: Line 104:
 
*Accept the x86 keyword for this package: {{cmdroot|echo "app-laptop/hdapsd ~x86" >> /etc/portage/package.keywords}}
 
*Accept the x86 keyword for this package: {{cmdroot|echo "app-laptop/hdapsd ~x86" >> /etc/portage/package.keywords}}
 
*Install hdapsd with: {{cmdroot|emerge hdapsd}}.
 
*Install hdapsd with: {{cmdroot|emerge hdapsd}}.
*Edit {{path|/etc/conf.d/hdapsd}} (change your harddrive if neccessary: my is sda, and change the value from 5, 5 is to sensitive, 12 is a good value in my opinion).
+
*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}}
 
*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}}
 
*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.
 
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 (9.04) and newer versions.
  
 
=== Building an applet ===
 
=== Building an applet ===
 
====hdaps-gl====
 
====hdaps-gl====
 
*Make sure you have installed hdaps [and loaded] and ?opengl?
 
*Make sure you have installed hdaps [and loaded] and ?opengl?
*Download <tt>hdaps-gl-0.0.5</tt> from the web.
+
*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}}.
 
*Extract files to {{path|/opt/hdaps-gl}}.
 
*{{cmdroot|make}}
 
*{{cmdroot|make}}
 
*Start the applet: {{cmdroot|./hdaps-gl}}
 
*Start the applet: {{cmdroot|./hdaps-gl}}
  
=====Fedora Core=====
+
==Verifying hdapsd is working==
{{Fedora}} users can try the instructions [[Installing_Fedora_Core_5_on_a_ThinkPad_X41_Tablet#Harddrive_Active_Protection_System_.28HDAPS.29|here]]
+
According to instructions from the [http://sourceforge.net/mailarchive/message.php?msg_name=h5r1f4%246s8%241%40ger.gmane.org hdaps-devel mailing list]:
 
+
====khdapsmon====
+
  
This application uses GNU autotools, so building it is the same as any other autotooled program: extract the source somewhere, run ./configure, make, and make install (as root). See above for Debian packages and a Gentoo ebuild.
+
Start {{cmdroot|find /}} in a terminal and move your laptop.  The output should stop while moving (while the heads are parked). When you do this, make sure you do not have any external usb drives. If so it could look like it is not parking the drive while you do this (i.e. it wont park the external and since find is run over the external too, it can continue the find command there).
  
====gnome-hdaps-applet====
+
Alternatively, run {{cmdroot|while true; do cat /sys/block/sda/device/unload_heads; done}} (replacing <tt>sda</tt> with your device) and move the laptop.  When the value is greater than zero the heads are parked.
=====Fedora Core=====
+
{{Fedora}} users can try the instructions [[Installing_Fedora_Core_5_on_a_ThinkPad_X41_Tablet#Harddrive_Active_Protection_System_.28HDAPS.29|here]]
+
=====Debian/Ubuntu=====
+
Packages available at site listed above (with source packages that can do the building for you)
+
  
 
==Troubleshooting==
 
==Troubleshooting==
See the [[Problem_with_APS_harddisk_parking]] for troubleshooting APS issues.
+
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==
 
==Further Information==
Line 122: Line 135:
  
  
[[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:Z60m]] [[Category:Z60t]]
+
[[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]]

Latest revision as of 18:56, 1 May 2011

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 here.

For Debian (Etch) have a look at 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 hdaps_protect 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 gmane.linux.drivers.hdaps.devel.
    • NOTE: Starting with kernel 2.6.28 a generic disc protection feature is built into the libata driver
  • The hdapsd 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 khdapsmonitor KDE System Tray applet or the gnome-hdaps-applet. These applets provide a visual indication of the disk protection status and also a graphical interface for adjusting configuration options for hdapsd.

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

Latest Sources

See HDAPS - Disk head parking

Slackware
Debian
Fedora see instructions here
Gentoo

Adding kernel support

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

Manually patching and compiling a kernel

As root, do:

# cd /usr/src/linux
# patch -p1 < ~/hdaps_protect.20060409.patch
# make clean
# make
# 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

# tar jxf zen-sources-2.6-version-zen0.tar.bz2

Installation is similar to previous one.

As root, do:

# make oldconfig
# make clean
# make
# 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!
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 hdapsd sources (see above)
  • Compile using # gcc -o hdapsd hdapsd-*.c
  • Run # ./hdapsd -d sda -s 12 -a (replace sda with your hard disk device; run # ./hdapsd without arguments for help)

Gentoo

NOTE!
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 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 /etc/make.conf:
PORTDIR_OVERLAY="/usr/local/portage/" (or any other location)
  • Create directory /usr/local/portage and /usr/local/portage/app-laptop/
  • Copy the downloaded ebuild to /usr/local/portage/app-laptop (/usr/local/portage/app-laptop/hdapsd should now exists)
  • Make portage known the new ebuild and creat digist with:
# ebuild /usr/local/portage/app-laptop/hdapsd/hdapsd-20060326.ebuild digest
  • Optional: Copy source file to portage distfiles (if no internet connection is available):
# cp hdapsd-20060326.c /usr/portage/distfiles
  • Accept the x86 keyword for this package: # echo "app-laptop/hdapsd ~x86" >> /etc/portage/package.keywords
  • Install hdapsd with: # emerge hdapsd.
  • Edit /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: # /etc/init.d/hdapsd start
  • Optional: add to default runlevel: # 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 (9.04) and newer versions.

Building an applet

hdaps-gl

  • Make sure you have installed hdaps [and loaded] and ?opengl?
  • Download hdaps-gl-0.0.5 from the web.
  • Extract files to /opt/hdaps-gl.
  • # make
  • Start the applet: # ./hdaps-gl

Verifying hdapsd is working

According to instructions from the hdaps-devel mailing list:

Start # find / in a terminal and move your laptop. The output should stop while moving (while the heads are parked). When you do this, make sure you do not have any external usb drives. If so it could look like it is not parking the drive while you do this (i.e. it wont park the external and since find is run over the external too, it can continue the find command there).

Alternatively, run # while true; do cat /sys/block/sda/device/unload_heads; done (replacing sda with your device) and move the laptop. When the value is greater than zero the heads are parked.

Troubleshooting

See the Problem with APS harddisk parking page for troubleshooting APS issues.

NOTE!
If you use tp_smapi, remember to include the option HDAPS=1 when installing tp_smapi. Also, you might need to build the hdaps driver as module.

Further Information

  • Additonal information and support is available through the hdaps-devel mailinglist and its archive.