ThinkWiki - User contributions [en]

Tp smapi

2009-07-01T15:08:39Z

Sfr3: /* Bundled hdaps driver */ upstream thing

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
The <tt>tp_smapi</tt> kernel module exposes some features of the ThinkPad hardware/firmware via a <tt>sysfs</tt> interface. Currently, the main implemented functionality is control of battery charging and extended battery status. The tp_smapi software package also includes an improved version of the [[HDAPS]] driver. The underlying hardware interfaces are [[SMAPI support for Linux|SMAPI]] and direct access to the embedded controller.

This driver uses undocumented features and direct hardware access, so it may work unreliably or even damage your hardware; but so far no such damage has been reported.
|}

===Features===
*<tt>tp_smapi</tt> driver
**Battery charge/discharge control
**Battery status information
*<tt>hdaps</tt> driver (compared with the standard <tt>hdaps</tt> driver)
**Improved stability
**Improved model support
**Improved functionality

===Project Homepage / Availability===
* Project page: http://tpctl.sourceforge.net/
* You need to download only the <i>tp_smapi</i> package.

===Installation===
====Installation from source====
You will need the kernel headers and makefiles corresponding to your current kernel version. On {{Fedora}}, this means {{cmdroot|yum install kernel-devel-$(uname -r)}} .

:{{cmdroot|tar xzvf tp_smapi-0.40.tgz}}
:{{cmdroot|cd tp_smapi-0.40}}

Then, either compile and load the driver within the current working directory (for testing):
:{{cmdroot|make load}}
OR compile and install into the kernel's module path:
:{{cmdroot|make install}}

If you use the [[HDAPS]] driver, add <tt>HDAPS=1</tt> to also patch the <tt>hdaps</tt> for compatibility with <tt>tp_smapi</tt> (this requires a kernel source tree matching the current kernel).
Again, either load the driver within the current working directory:
:{{cmdroot|1=make load HDAPS=1}}
OR install into the kernel's module path:
:{{cmdroot|1=make install HDAPS=1}}

To prepare a stand-alone patch against the current kernel tree (including
a patch against <tt>hdaps</tt> and new <tt>Kconfig</tt> entries):
:{{cmdroot|make patch}}

To delete all autogenerated files:
:{{cmdroot|make clean}}

The original kernel tree is never modified by any these commands.
The {{path|/lib/modules}} directory is modified only by {{cmdroot|make install}}.

====Installation in Gentoo====
The {{Gentoo}} portage system carries a [http://packages.gentoo.org/package/app-laptop/tp_smapi tp_smapi package], which follows the latest version pretty closely. On a Gentoo system, you can install and load as follows.

If you use the [[HDAPS]] driver, do this first:

* Disable the <tt>hdaps</tt> module in your kernel configuration (Device Drivers → Hardware Monitoring Support → IBM Hard Drive Active Protection System)
* Rebuild and install the kernel
* Add the <tt>hdaps</tt> use flag in {{path|/etc/make.conf}}
* {{cmdroot|rmmod hdaps}}

Then:
* {{cmdroot|emerge tp_smapi}} (or install tp_smapi with hdaps support manually, as above)
* {{cmdroot|echo "tp_smapi" >> /etc/modules.autoload.d/kernel-2.6}}
* {{cmdroot|echo "hdaps" >> /etc/modules.autoload.d/kernel-2.6}}

Then reboot, or run:
* {{cmdroot|modprobe tp_smapi}}
* {{cmdroot|modprobe hdaps}}

====Installation on Debian unstable (sid), testing (squeeze) or stable (lenny)====
Debian now contains the [http://packages.debian.org/tp-smapi packaged module source] and prebuilt modules for Debian kernels.

If you use a stock Debian kernel, you can install the tp_smapi modules with:
* {{cmdroot|apt-get install tp-smapi-modules-`uname -r`}}
* in order to make sure the modules package is kept in sync with the kernel one, you may also want to install the <code>tm-smapi-modules-2.6-686</code> or <code>tm-smapi-modules-2.6-amd64</code> package, depending on your architecture

If you use a custom kernel, you can build tp_smapi with module-assistant:
* {{cmdroot|aptitude install tp-smapi-source}}
* {{cmdroot|m-a -t a-i tp-smapi}}

====Installation on openSUSE====
openSUSE provides rpm packages. Look for them at the package search: [http://software.opensuse.org/search/], search for the package named "tp_smapi".

A step-by-step guide on how a relative linux newbie installed tp_smapi on a Thinkpad W500 running openSuse 11.1 using YAST Software Manager is available [http://forums.opensuse.org/hardware/laptop/417254-tp_smapi-lenovo-thinkpad-t400-t500-w500-step-step.html#post2005932 here]

In case you are taking the hard way around, while compiling on 11.0, make complained about not being able to locate the kernel sources. It worked for me after I did this:
<pre><nowiki>cp /usr/include/linux/aio_abi.h /lib/modules/`uname -r`/build/include/linux/</nowiki></pre>

====Installation on Ubuntu====
Ubuntu ships tp_smapi in their <tt>linux-ubuntu-modules-*</tt> package for Hardy, so you don't have to build it yourself. Please note that they have renamed tp_smapi's modified <tt>hdaps</tt> module to <tt>hdaps_ec</tt> so that the two can coexist. You should load <tt>hdaps_ec</tt>, not <tt>hdaps</tt>.

Ubuntu Intrepid and Jaunty, however, lack the <tt>hdaps_ec</tt> module, as reported [https://bugs.launchpad.net/ubuntu/+source/linux/+bug/297213 here]. It will not be included again until said [[#Bundled hdaps driver|bundled hdaps driver]] is merged into mainline.

=====Installation on Ubuntu Jaunty=====
I have posted my experiences [http://meandmyubuntu.blogspot.com/2009/05/getting-hdasp-to-work-on-jaunty.html here]

====Installation on older Ubuntu/Debian====
Installation on Ubuntu or Debian is quite easy, but there are a few things to look after:

To get your system ready for compiling code, install the build-essentials (as root, of course, as all of the following comands; Ubuntu users have to prepend 'sudo' to every line and enter their own password when prompted):
<pre><nowiki>apt-get install build-essential</nowiki></pre>

To get tp_smapi to work, obtain the latest source as mentioned above and unpack it. If you want to use HDAPS, you need to install the kernel source matching te kernel you are running. To do so, issue this:
<pre><nowiki>uname -r</nowiki></pre>
This will give you the version of your current kernel.
Debian users execute the following:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users execute the following using the kernel-version only (exclude -XX-generic; e.g. 'linux-source-2.6.20'):
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>

Be sure to unpack the source file. The easiest way is to open Nautilus as root:
<pre><nowiki>sudo nautilus</nowiki></pre>
Then browse to /usr/src/ and extract the source file to that directory.

Now change to the tp_smapi dir:
<pre><nowiki>cd tp_smapi-X.YY</nowiki></pre> (X.YY being the version-number of [[tp_smapi]])
and make and install tp_smapi as instructed above.

If you get an error that the kernel version isn't matching (or that you need to set KSRC/KBUILD), please check that there is a symlink from the modules dir to the kernel source:
<pre><nowiki>root@localhost:~#ls -l /lib/modules/2.6.20-16-generic
lrwxrwxrwx 1 root root 28 2007-02-02 08:39 build -> /usr/src/linux-source-2.6.20</nowiki></pre>
Create the link if the line above is not existent:
<pre><nowiki>root@localhost:~#ln -s /usr/src/linux-source-2.6.20 /lib/modules/2.6.20-16-generic/build</nowiki></pre>

Now the following will build and install the correct modules to their locations:
<pre><nowiki>make install HDAPS=1</nowiki></pre>
To make sure your system loads the modules at boot time, do this:
<pre><nowiki>echo "tp_smapi" >> /etc/modules
echo "hdaps" >> /etc/modules</nowiki></pre>
and update your initramfs:
<pre><nowiki>update-initramfs -u</nowiki></pre>

To get tp_smapi running now, just load the modules:
<pre><nowiki>modprobe -a tp_smapi hdaps</nowiki></pre>

This description was tested on Kubuntu 'Feisty Fawn' and should work on all Debian-based distros with minor tweaks.

'''EDIT:''' Works on Kubuntu 7.10 ("Gutsy Gibbon"), too

===Battery charge control features===
To set the thresholds for starting and stopping battery charging (in percent of current full charge capacity):
:{{cmdroot|echo 40 > /sys/devices/platform/smapi/BAT0/start_charge_thresh}}
:{{cmdroot|echo 70 > /sys/devices/platform/smapi/BAT0/stop_charge_thresh}}
:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/*_charge_thresh}}
{{HINT|Battery charging thresholds can be used to keep Li-Ion ad Li-Polymer batteries partially charged, in order to [[Maintenance#Battery_treatment|increase their lifetime]].}}
To prevent charging for 17 minutes (regardless of thresholds):
:{{cmdroot|echo 17 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}
{{HINT|Charge inhibiting can be used to reduce the power draw of the laptop, in order to use an under-spec power supply that can't handle the combined power draw of running and charging. It can also be used to control which battery is charged when [[How to use UltraBay batteries|using an Ultrabay battery]].}}

To cancel charging preventation:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}

To force battery discharging (even if connected to AC):
:{{cmdroot|echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge}}
{{HINT|This can be used to choose which battery is discharged when [[How to use UltraBay batteries|using an UltraBay battery]].}}

To cancel forced discharge:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}}

===Battery status features===
To view extended battery status such as charging state, voltage, current, capacity, cycle count and model information:

<pre>
# cat /sys/devices/platform/smapi/BAT0/installed
# cat /sys/devices/platform/smapi/BAT0/state # idle/charging/discharging
# cat /sys/devices/platform/smapi/BAT0/cycle_count
# cat /sys/devices/platform/smapi/BAT0/current_now # instantaneous current
# cat /sys/devices/platform/smapi/BAT0/current_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/power_now # instantaneous power
# cat /sys/devices/platform/smapi/BAT0/power_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/last_full_capacity
# cat /sys/devices/platform/smapi/BAT0/remaining_percent
# cat /sys/devices/platform/smapi/BAT0/remaining_running_time
# cat /sys/devices/platform/smapi/BAT0/remaining_charging_time
# cat /sys/devices/platform/smapi/BAT0/remaining_capacity
# cat /sys/devices/platform/smapi/BAT0/design_capacity
# cat /sys/devices/platform/smapi/BAT0/voltage
# cat /sys/devices/platform/smapi/BAT0/design_voltage
# cat /sys/devices/platform/smapi/BAT0/manufacturer
# cat /sys/devices/platform/smapi/BAT0/model
# cat /sys/devices/platform/smapi/BAT0/barcoding
# cat /sys/devices/platform/smapi/BAT0/chemistry
# cat /sys/devices/platform/smapi/BAT0/serial
# cat /sys/devices/platform/smapi/BAT0/manufacture_date
# cat /sys/devices/platform/smapi/BAT0/first_use_date
# cat /sys/devices/platform/smapi/BAT0/temperature # in milli-Celsius
# cat /sys/devices/platform/smapi/ac_connected
</pre>

The raw status data is also available, including some fields not listed above (in case you can figure them out):

:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/dump}}

In all of the above, replace <tt>BAT0</tt> with <tt>BAT1</tt> to address the 2nd battery.

Note that the battery status readout conflicts with the stock [[HDAPS|hdaps]] driver, so if you use <tt>hdaps</tt> you will need to load <tt>tp_smapi</tt> using {{cmdroot|1=make load HDAPS=1}} (see [[#Bundled hdaps driver|Bundled hdaps driver]] below).

On [[ACPI]]-enabled systems, most of above information is also available through the files under {{path|/proc/acpi/battery}}. However, the ACPI interface does not include the instantaneous power and cycle count readouts, and does not work well when [[How to use UltraBay batteries|hotswapping UltraBay batteries]].

====Scripts====
Some scripts can make it easier to grep the information you need from tp_smapi
* [[battery.rb]]

===Other features===

There is also [[sysfs]] attribute for making direct SMAPI requests to the SM BIOS firmware. Don't touch it unless you really know what you're doing. Example:
# echo '211a 100 0 0' > /sys/devices/platform/smapi/smapi_request; cat /sys/devices/platform/smapi/smapi_request
211a 34b b2 0 0 0 'OK'
The "4b" in the 2nd value, converted to decimal, is 75: the current charging stop threshold (stop_charge_thresh).

===Bundled <tt>hdaps</tt> driver===

The tp_smapi package includes a modified version of the <tt>hdaps</tt> Linux kernel driver used by the [[HDAPS]] system. It has remained outside the mainline kernel for a few years for several reasons, [https://lists.ubuntu.com/archives/kernel-team/2009-April/005565.html] including the upstream maintainer's assertion that the new code's anonymous author was under a NDA. (Although this would not normally expose the kernel team to litigation.) [http://lkml.org/lkml/2008/9/15/126] [http://lkml.org/lkml/2008/10/7/403] [http://lkml.org/lkml/2008/10/7/428]

To use <tt>tp_smapi</tt> and <tt>hdaps</tt> concurrently, you '''must''' use the modified version.

To build the modified version, simply append the <tt>HDAPS=1</tt> parameter to the <tt>make</tt> command (see [[#Installation|Installation]] above):
:{{cmdroot|1=make load HDAPS=1}}
or
:{{cmdroot|1=make install HDAPS=1}}

If you don't do that, you will not be able to load <tt>tp_smapi</tt> (and its support module <tt>thinkpad_ec</tt>) when <tt>hdaps</tt> is loaded, and vice versa. You can use <tt>rmmod</tt> to switch between these modules.

Note that some of the battery status is also visible through ACPI ({{path|/proc/acpi/battery/*}}), independently of <tt>tp_smapi</tt>.

The modified <tt>hdaps</tt> has several changes:
* The <tt>hdaps</tt> driver in mainline kernels conflicts with the extended battery status (they use the same IO ports). The modified <tt>hdaps</tt> coordinates this access through the bundled <tt>thinkpad_ec</tt> driver.
* The modified <tt>hdaps</tt> driver fixes reliability and improves support for recent ThinkPad models (*60 and newer), since unlike the mainline driver, it correctly follows the Embedded Controller communication protocol.
* Several other improvements, such as the ability to control the polling rate.

===Troubleshooting===
==== <tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f</tt> ====
The "<tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f!</tt>" error message is printed when loading the <tt>thinkpad_ec</tt> module on some recent ThinkPad models. This occurs because the ACPI BIOS DSDT is reserving ports used by tp_smapi.

As a workaround, add the <tt>force_io=1</tt> module parameter to <tt>thinkpad_ec</tt> in {{path|/etc/modprobe.conf}} (or your distribution's equivalent). For transient testing, load the modules as follows:

: {{cmdroot|1=make load HDAPS=1 FORCE_IO=1}}

Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16).

Models which need this option include:
* ThinkPad {{T400}}
* ThinkPad {{T500}}
* ThinkPad {{X301}}

More information:
* http://bugzilla.kernel.org/show_bug.cgi?id=12221
* http://www.nabble.com/thinkpad_ec-fails-to-load-on-Thinkpad-T500-td19932985.html

==== <tt>thinkpad_ec: no ThinkPad embedded controller!</tt> ====
If you get "<tt>thinkpad_ec: no ThinkPad embedded controller!</tt>" when trying to load the module on a supported model listed below, you should [[BIOS_Upgrade|upgrade your BIOS]]. Some early BIOS (like 1.x on the X31) don't handle the embedded controller.

===Model-specific status===

<div style="font-size: 92%">
{| border="1" cellspacing="0" cellpadding="2"
|+<tt>tp_smapi</tt> feature support matrix
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====A series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{A22p}} 2629-USG
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || ||
|-
! {{A30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====G series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{G41}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || N/A || N/A || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====R series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{R31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || No SMAPI BIOS
|-
! {{R40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || N/A || N/A || || || ||
|-
! {{R50}}
| {{Cunk}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R50e}} 1834-JAG
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{R50e}} 1834-5US
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R51}} 18*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || 3.22 || || Machine types 1829, 1830, 1831 and 1836
|-
! {{R51}} 28*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || 1.29 || || Machine types 2883, 2887, 2888, 2889, 2894 and 2495
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.29 || 1.06 ||
|-
! {{R60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cno|text=}} 1 || 0.33 || || ||
|-
! {{R61}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.35-test1 || 7KETA7WW 2.07 || 7KHT24WW 1.08 || Machine type 8918
|-
! {{R61i}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || || || || Machine type 8250
|-
! {{R400}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.40-1 || || || Machine type 7443
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====T series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T23}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T40p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T41}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 3.23 || 3.04 ||
|-
! {{T41p}} 2373-AM9
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.20 || v3.04 ||
|-
! {{T42}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T42p}} 2373-KXU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.21 || || Stop charge threshold works in Windows, but dmesg says "__get_real_thresh: cannot get stop_thresh of bat=0: Function is not supported by SMAPI BIOS".
|-
! {{T42p}} 2373-KUU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T43}} 2686
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.27 || ||
|-
! {{T43p}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes|text=}} 0 || || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.32 || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.34 || || ||
|-
! {{T60}} 1951-24G
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.36 || 1.09a || ||
|-
! {{T60}} 2007-FSG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.39 || 1.10 || 1.05b ||
|-
! {{T60}} 1951-CZ1
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.40 || 2.23 || 1.07 ||
|-
! {{T60p}} 8743-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || || ||
|-
! {{T61}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T61p}} 6457-7XG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T400}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! {{T500}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} 1 || 0.40 || 2.07 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-

! colspan=12 style="text-align:center;background:#efefef;" |

=====X series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{X20}} 2662-31G
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || ||
|-
! {{X22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || no EC controller found
|-
! {{X24}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || 0.34 || 1.09 || ||
|-
! {{X31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X32}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X40}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || 2.08 || 1.62 ||
|-
! {{X41}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || || ||
|-
! {{X41_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} (see ref) || 0.32 || || [http://sourceforge.net/mailarchive/message.php?msg_name=4757BD30.8080808%40ugcs.caltech.edu ref] ||
|-
! {{X60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || || 2.07 || 1.10 || 2.6.20 issue (see discussion)
|-
! {{X60_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.34 || 7JET25WW (1.10 ) || 7JHT13WW 1.04 || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X60s}} 1704-5UG
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cno|text=}} 3 || 0.34 || 7BETD2WW 2.13 || 7BHT40WW 1.13 ||
|-
! {{X61}} 7673-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 7NETB9WW (2.19) || {{Cunk}} ||
|-
! {{X61}} 7675-CTO
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} 6 || 0.35-test1 || || ||
|-
! {{X61}} 7675-4KU
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.34 || 7NET30WW (1.11 ) || 7MHT24WW-1.02 ||
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.32 || || ||
|-
! {{X61s}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 / 3 || 0.32 || || || [http://www.slackwiki.org/ThinkPad_X61s ref] says 3 but conflicting report received
|-
! {{X200}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 6DET40WW (2.04 ) || 7XHT22WW-1.04 ||
|-
! {{X300}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.37 || 7TET25WW (1.02 ) || 7THT15WW-1.00c ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====Z series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{Z60m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z61m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || || ||
|-
! {{Z61t}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || || [https://bugs.launchpad.net/ubuntu/+source/linux-source-2.6.20/+bug/45014 ref]
|-
! {{Z61p}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====SL series and IdeaPad=====
|-
! colspan=12 style="text-align:left" |
The ThinkPad SL series and IdeaPad series have firmware that is completely different from other ThinkPad models. Neither [[tp_smapi]] nor [[thinkpad-acpi]] support these models.
|}
</div>

SMAPI capabilities may depend on the BIOS version as well, so upgrading to the latest version of the BIOS might provide more SMAPI functions (especially true for long-lived BIOS with lots of releases, like the TP-1R).

Please update the above and report your experience on the [[Talk:tp_smapi|discussion]] page. If the module loads but gives a "<tt>not supported</tt>" or "<tt>not implementeded</tt>" error when you try to use some specific file in {{path|/sys/devices/platform/smapi/}}, please report the <tt>dmesg</tt> output and whether the corresponding functionality is available under Windows - maybe your ThinkPad just can't do that.

While at it, you may also want to add your laptop to the [[list of DMI IDs]].

=====HDAPS axis orientation=====
<sup>1</sup> The HDAPS axis orientation is set using the <tt>invert</tt> module parameter (at load time) or sysfs attribute (at runtime). The <tt>hdaps</tt> driver of tp_smapi supports all 8 possible sensor orientations (inversion and swapping). You can use [[HDAPS#Visualisation_of_ThinkPad_orientation|hdaps visualisation]] to check if the settings is correct.

The <tt>invert</tt> parameter is an integer between 0 and 7, whose meaning is defined below. (This is confusing. Most people will find it easier to just try all 8 possibilities.)

Let <tt>X</tt> and <tt>Y</tt> denote the hardware readouts. Let <tt>R</tt> denote the laptop's roll (tilt left/right), and let <tt>P</tt> denote the laptop's pitch (tilt forward/backward). The possible values are as follows:
invert=0: R= X P= Y (same as mainline)
invert=1: R=-X P=-Y (same as mainline)
invert=2: R=-X P= Y (new)
invert=3: R= X P=-Y (new)
invert=4: R= Y P= X (new)
invert=5: R=-Y P=-X (new)
invert=6: R=-Y P= X (new)
invert=7: R= Y P=-X (new)

[[Category:Drivers]] [[Category:Patches]]

===Tools using this driver===

The driver's interface can be accessed directly through the files under {{path|/sys/devices/platform/smapi}}, or via the following tools:
* [[KThinkBat]] - display battery status on the KDE <tt>kicker</tt> panel.
* [[gkrellm-ThinkBat]] - battery status plugin for Gkrellm2
* {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module.

== Headline text ==

Tp smapi

2009-07-01T14:54:37Z

Sfr3: /* Installation on Ubuntu */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
The <tt>tp_smapi</tt> kernel module exposes some features of the ThinkPad hardware/firmware via a <tt>sysfs</tt> interface. Currently, the main implemented functionality is control of battery charging and extended battery status. The tp_smapi software package also includes an improved version of the [[HDAPS]] driver. The underlying hardware interfaces are [[SMAPI support for Linux|SMAPI]] and direct access to the embedded controller.

This driver uses undocumented features and direct hardware access, so it may work unreliably or even damage your hardware; but so far no such damage has been reported.
|}

===Features===
*<tt>tp_smapi</tt> driver
**Battery charge/discharge control
**Battery status information
*<tt>hdaps</tt> driver (compared with the standard <tt>hdaps</tt> driver)
**Improved stability
**Improved model support
**Improved functionality

===Project Homepage / Availability===
* Project page: http://tpctl.sourceforge.net/
* You need to download only the <i>tp_smapi</i> package.

===Installation===
====Installation from source====
You will need the kernel headers and makefiles corresponding to your current kernel version. On {{Fedora}}, this means {{cmdroot|yum install kernel-devel-$(uname -r)}} .

:{{cmdroot|tar xzvf tp_smapi-0.40.tgz}}
:{{cmdroot|cd tp_smapi-0.40}}

Then, either compile and load the driver within the current working directory (for testing):
:{{cmdroot|make load}}
OR compile and install into the kernel's module path:
:{{cmdroot|make install}}

If you use the [[HDAPS]] driver, add <tt>HDAPS=1</tt> to also patch the <tt>hdaps</tt> for compatibility with <tt>tp_smapi</tt> (this requires a kernel source tree matching the current kernel).
Again, either load the driver within the current working directory:
:{{cmdroot|1=make load HDAPS=1}}
OR install into the kernel's module path:
:{{cmdroot|1=make install HDAPS=1}}

To prepare a stand-alone patch against the current kernel tree (including
a patch against <tt>hdaps</tt> and new <tt>Kconfig</tt> entries):
:{{cmdroot|make patch}}

To delete all autogenerated files:
:{{cmdroot|make clean}}

The original kernel tree is never modified by any these commands.
The {{path|/lib/modules}} directory is modified only by {{cmdroot|make install}}.

====Installation in Gentoo====
The {{Gentoo}} portage system carries a [http://packages.gentoo.org/package/app-laptop/tp_smapi tp_smapi package], which follows the latest version pretty closely. On a Gentoo system, you can install and load as follows.

If you use the [[HDAPS]] driver, do this first:

* Disable the <tt>hdaps</tt> module in your kernel configuration (Device Drivers → Hardware Monitoring Support → IBM Hard Drive Active Protection System)
* Rebuild and install the kernel
* Add the <tt>hdaps</tt> use flag in {{path|/etc/make.conf}}
* {{cmdroot|rmmod hdaps}}

Then:
* {{cmdroot|emerge tp_smapi}} (or install tp_smapi with hdaps support manually, as above)
* {{cmdroot|echo "tp_smapi" >> /etc/modules.autoload.d/kernel-2.6}}
* {{cmdroot|echo "hdaps" >> /etc/modules.autoload.d/kernel-2.6}}

Then reboot, or run:
* {{cmdroot|modprobe tp_smapi}}
* {{cmdroot|modprobe hdaps}}

====Installation on Debian unstable (sid), testing (squeeze) or stable (lenny)====
Debian now contains the [http://packages.debian.org/tp-smapi packaged module source] and prebuilt modules for Debian kernels.

If you use a stock Debian kernel, you can install the tp_smapi modules with:
* {{cmdroot|apt-get install tp-smapi-modules-`uname -r`}}
* in order to make sure the modules package is kept in sync with the kernel one, you may also want to install the <code>tm-smapi-modules-2.6-686</code> or <code>tm-smapi-modules-2.6-amd64</code> package, depending on your architecture

If you use a custom kernel, you can build tp_smapi with module-assistant:
* {{cmdroot|aptitude install tp-smapi-source}}
* {{cmdroot|m-a -t a-i tp-smapi}}

====Installation on openSUSE====
openSUSE provides rpm packages. Look for them at the package search: [http://software.opensuse.org/search/], search for the package named "tp_smapi".

A step-by-step guide on how a relative linux newbie installed tp_smapi on a Thinkpad W500 running openSuse 11.1 using YAST Software Manager is available [http://forums.opensuse.org/hardware/laptop/417254-tp_smapi-lenovo-thinkpad-t400-t500-w500-step-step.html#post2005932 here]

In case you are taking the hard way around, while compiling on 11.0, make complained about not being able to locate the kernel sources. It worked for me after I did this:
<pre><nowiki>cp /usr/include/linux/aio_abi.h /lib/modules/`uname -r`/build/include/linux/</nowiki></pre>

====Installation on Ubuntu====
Ubuntu ships tp_smapi in their <tt>linux-ubuntu-modules-*</tt> package for Hardy, so you don't have to build it yourself. Please note that they have renamed tp_smapi's modified <tt>hdaps</tt> module to <tt>hdaps_ec</tt> so that the two can coexist. You should load <tt>hdaps_ec</tt>, not <tt>hdaps</tt>.

Ubuntu Intrepid and Jaunty, however, lack the <tt>hdaps_ec</tt> module, as reported [https://bugs.launchpad.net/ubuntu/+source/linux/+bug/297213 here]. It will not be included again until said [[#Bundled hdaps driver|bundled hdaps driver]] is merged into mainline.

=====Installation on Ubuntu Jaunty=====
I have posted my experiences [http://meandmyubuntu.blogspot.com/2009/05/getting-hdasp-to-work-on-jaunty.html here]

====Installation on older Ubuntu/Debian====
Installation on Ubuntu or Debian is quite easy, but there are a few things to look after:

To get your system ready for compiling code, install the build-essentials (as root, of course, as all of the following comands; Ubuntu users have to prepend 'sudo' to every line and enter their own password when prompted):
<pre><nowiki>apt-get install build-essential</nowiki></pre>

To get tp_smapi to work, obtain the latest source as mentioned above and unpack it. If you want to use HDAPS, you need to install the kernel source matching te kernel you are running. To do so, issue this:
<pre><nowiki>uname -r</nowiki></pre>
This will give you the version of your current kernel.
Debian users execute the following:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users execute the following using the kernel-version only (exclude -XX-generic; e.g. 'linux-source-2.6.20'):
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>

Be sure to unpack the source file. The easiest way is to open Nautilus as root:
<pre><nowiki>sudo nautilus</nowiki></pre>
Then browse to /usr/src/ and extract the source file to that directory.

Now change to the tp_smapi dir:
<pre><nowiki>cd tp_smapi-X.YY</nowiki></pre> (X.YY being the version-number of [[tp_smapi]])
and make and install tp_smapi as instructed above.

If you get an error that the kernel version isn't matching (or that you need to set KSRC/KBUILD), please check that there is a symlink from the modules dir to the kernel source:
<pre><nowiki>root@localhost:~#ls -l /lib/modules/2.6.20-16-generic
lrwxrwxrwx 1 root root 28 2007-02-02 08:39 build -> /usr/src/linux-source-2.6.20</nowiki></pre>
Create the link if the line above is not existent:
<pre><nowiki>root@localhost:~#ln -s /usr/src/linux-source-2.6.20 /lib/modules/2.6.20-16-generic/build</nowiki></pre>

Now the following will build and install the correct modules to their locations:
<pre><nowiki>make install HDAPS=1</nowiki></pre>
To make sure your system loads the modules at boot time, do this:
<pre><nowiki>echo "tp_smapi" >> /etc/modules
echo "hdaps" >> /etc/modules</nowiki></pre>
and update your initramfs:
<pre><nowiki>update-initramfs -u</nowiki></pre>

To get tp_smapi running now, just load the modules:
<pre><nowiki>modprobe -a tp_smapi hdaps</nowiki></pre>

This description was tested on Kubuntu 'Feisty Fawn' and should work on all Debian-based distros with minor tweaks.

'''EDIT:''' Works on Kubuntu 7.10 ("Gutsy Gibbon"), too

===Battery charge control features===
To set the thresholds for starting and stopping battery charging (in percent of current full charge capacity):
:{{cmdroot|echo 40 > /sys/devices/platform/smapi/BAT0/start_charge_thresh}}
:{{cmdroot|echo 70 > /sys/devices/platform/smapi/BAT0/stop_charge_thresh}}
:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/*_charge_thresh}}
{{HINT|Battery charging thresholds can be used to keep Li-Ion ad Li-Polymer batteries partially charged, in order to [[Maintenance#Battery_treatment|increase their lifetime]].}}
To prevent charging for 17 minutes (regardless of thresholds):
:{{cmdroot|echo 17 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}
{{HINT|Charge inhibiting can be used to reduce the power draw of the laptop, in order to use an under-spec power supply that can't handle the combined power draw of running and charging. It can also be used to control which battery is charged when [[How to use UltraBay batteries|using an Ultrabay battery]].}}

To cancel charging preventation:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}

To force battery discharging (even if connected to AC):
:{{cmdroot|echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge}}
{{HINT|This can be used to choose which battery is discharged when [[How to use UltraBay batteries|using an UltraBay battery]].}}

To cancel forced discharge:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}}

===Battery status features===
To view extended battery status such as charging state, voltage, current, capacity, cycle count and model information:

<pre>
# cat /sys/devices/platform/smapi/BAT0/installed
# cat /sys/devices/platform/smapi/BAT0/state # idle/charging/discharging
# cat /sys/devices/platform/smapi/BAT0/cycle_count
# cat /sys/devices/platform/smapi/BAT0/current_now # instantaneous current
# cat /sys/devices/platform/smapi/BAT0/current_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/power_now # instantaneous power
# cat /sys/devices/platform/smapi/BAT0/power_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/last_full_capacity
# cat /sys/devices/platform/smapi/BAT0/remaining_percent
# cat /sys/devices/platform/smapi/BAT0/remaining_running_time
# cat /sys/devices/platform/smapi/BAT0/remaining_charging_time
# cat /sys/devices/platform/smapi/BAT0/remaining_capacity
# cat /sys/devices/platform/smapi/BAT0/design_capacity
# cat /sys/devices/platform/smapi/BAT0/voltage
# cat /sys/devices/platform/smapi/BAT0/design_voltage
# cat /sys/devices/platform/smapi/BAT0/manufacturer
# cat /sys/devices/platform/smapi/BAT0/model
# cat /sys/devices/platform/smapi/BAT0/barcoding
# cat /sys/devices/platform/smapi/BAT0/chemistry
# cat /sys/devices/platform/smapi/BAT0/serial
# cat /sys/devices/platform/smapi/BAT0/manufacture_date
# cat /sys/devices/platform/smapi/BAT0/first_use_date
# cat /sys/devices/platform/smapi/BAT0/temperature # in milli-Celsius
# cat /sys/devices/platform/smapi/ac_connected
</pre>

The raw status data is also available, including some fields not listed above (in case you can figure them out):

:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/dump}}

In all of the above, replace <tt>BAT0</tt> with <tt>BAT1</tt> to address the 2nd battery.

Note that the battery status readout conflicts with the stock [[HDAPS|hdaps]] driver, so if you use <tt>hdaps</tt> you will need to load <tt>tp_smapi</tt> using {{cmdroot|1=make load HDAPS=1}} (see [[#Bundled hdaps driver|Bundled hdaps driver]] below).

On [[ACPI]]-enabled systems, most of above information is also available through the files under {{path|/proc/acpi/battery}}. However, the ACPI interface does not include the instantaneous power and cycle count readouts, and does not work well when [[How to use UltraBay batteries|hotswapping UltraBay batteries]].

====Scripts====
Some scripts can make it easier to grep the information you need from tp_smapi
* [[battery.rb]]

===Other features===

There is also [[sysfs]] attribute for making direct SMAPI requests to the SM BIOS firmware. Don't touch it unless you really know what you're doing. Example:
# echo '211a 100 0 0' > /sys/devices/platform/smapi/smapi_request; cat /sys/devices/platform/smapi/smapi_request
211a 34b b2 0 0 0 'OK'
The "4b" in the 2nd value, converted to decimal, is 75: the current charging stop threshold (stop_charge_thresh).

===Bundled <tt>hdaps</tt> driver===

The tp_smapi package includes a modified version of the <tt>hdaps</tt> Linux kernel driver used by the [[HDAPS]] system. To use <tt>tp_smapi</tt> and <tt>hdaps</tt> concurrently, you '''must''' use the modified version.

To build the modified version, simply append the <tt>HDAPS=1</tt> parameter to the <tt>make</tt> command (see [[#Installation|Installation]] above):
:{{cmdroot|1=make load HDAPS=1}}
or
:{{cmdroot|1=make install HDAPS=1}}

If you don't do that, you will not be able to load <tt>tp_smapi</tt> (and its support module <tt>thinkpad_ec</tt>) when <tt>hdaps</tt> is loaded, and vice versa. You can use <tt>rmmod</tt> to switch between these modules.

Note that some of the battery status is also visible through ACPI ({{path|/proc/acpi/battery/*}}), independently of <tt>tp_smapi</tt>.

The modified <tt>hdaps</tt> has several changes:
* The <tt>hdaps</tt> driver in mainline kernels conflicts with the extended battery status (they use the same IO ports). The modified <tt>hdaps</tt> coordinates this access through the bundled <tt>thinkpad_ec</tt> driver.
* The modified <tt>hdaps</tt> driver fixes reliability and improves support for recent ThinkPad models (*60 and newer), since unlike the mainline driver, it correctly follows the Embedded Controller communication protocol.
* Several other improvements, such as the ability to control the polling rate.

===Troubleshooting===
==== <tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f</tt> ====
The "<tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f!</tt>" error message is printed when loading the <tt>thinkpad_ec</tt> module on some recent ThinkPad models. This occurs because the ACPI BIOS DSDT is reserving ports used by tp_smapi.

As a workaround, add the <tt>force_io=1</tt> module parameter to <tt>thinkpad_ec</tt> in {{path|/etc/modprobe.conf}} (or your distribution's equivalent). For transient testing, load the modules as follows:

: {{cmdroot|1=make load HDAPS=1 FORCE_IO=1}}

Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16).

Models which need this option include:
* ThinkPad {{T400}}
* ThinkPad {{T500}}
* ThinkPad {{X301}}

More information:
* http://bugzilla.kernel.org/show_bug.cgi?id=12221
* http://www.nabble.com/thinkpad_ec-fails-to-load-on-Thinkpad-T500-td19932985.html

==== <tt>thinkpad_ec: no ThinkPad embedded controller!</tt> ====
If you get "<tt>thinkpad_ec: no ThinkPad embedded controller!</tt>" when trying to load the module on a supported model listed below, you should [[BIOS_Upgrade|upgrade your BIOS]]. Some early BIOS (like 1.x on the X31) don't handle the embedded controller.

===Model-specific status===

<div style="font-size: 92%">
{| border="1" cellspacing="0" cellpadding="2"
|+<tt>tp_smapi</tt> feature support matrix
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====A series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{A22p}} 2629-USG
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || ||
|-
! {{A30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====G series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{G41}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || N/A || N/A || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====R series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{R31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || No SMAPI BIOS
|-
! {{R40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || N/A || N/A || || || ||
|-
! {{R50}}
| {{Cunk}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R50e}} 1834-JAG
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{R50e}} 1834-5US
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R51}} 18*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || 3.22 || || Machine types 1829, 1830, 1831 and 1836
|-
! {{R51}} 28*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || 1.29 || || Machine types 2883, 2887, 2888, 2889, 2894 and 2495
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.29 || 1.06 ||
|-
! {{R60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cno|text=}} 1 || 0.33 || || ||
|-
! {{R61}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.35-test1 || 7KETA7WW 2.07 || 7KHT24WW 1.08 || Machine type 8918
|-
! {{R61i}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || || || || Machine type 8250
|-
! {{R400}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.40-1 || || || Machine type 7443
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====T series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T23}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T40p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T41}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 3.23 || 3.04 ||
|-
! {{T41p}} 2373-AM9
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.20 || v3.04 ||
|-
! {{T42}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T42p}} 2373-KXU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.21 || || Stop charge threshold works in Windows, but dmesg says "__get_real_thresh: cannot get stop_thresh of bat=0: Function is not supported by SMAPI BIOS".
|-
! {{T42p}} 2373-KUU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T43}} 2686
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.27 || ||
|-
! {{T43p}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes|text=}} 0 || || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.32 || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.34 || || ||
|-
! {{T60}} 1951-24G
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.36 || 1.09a || ||
|-
! {{T60}} 2007-FSG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.39 || 1.10 || 1.05b ||
|-
! {{T60}} 1951-CZ1
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.40 || 2.23 || 1.07 ||
|-
! {{T60p}} 8743-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || || ||
|-
! {{T61}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T61p}} 6457-7XG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T400}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! {{T500}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} 1 || 0.40 || 2.07 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-

! colspan=12 style="text-align:center;background:#efefef;" |

=====X series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{X20}} 2662-31G
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || ||
|-
! {{X22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || no EC controller found
|-
! {{X24}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || 0.34 || 1.09 || ||
|-
! {{X31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X32}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X40}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || 2.08 || 1.62 ||
|-
! {{X41}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || || ||
|-
! {{X41_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} (see ref) || 0.32 || || [http://sourceforge.net/mailarchive/message.php?msg_name=4757BD30.8080808%40ugcs.caltech.edu ref] ||
|-
! {{X60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || || 2.07 || 1.10 || 2.6.20 issue (see discussion)
|-
! {{X60_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.34 || 7JET25WW (1.10 ) || 7JHT13WW 1.04 || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X60s}} 1704-5UG
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cno|text=}} 3 || 0.34 || 7BETD2WW 2.13 || 7BHT40WW 1.13 ||
|-
! {{X61}} 7673-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 7NETB9WW (2.19) || {{Cunk}} ||
|-
! {{X61}} 7675-CTO
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} 6 || 0.35-test1 || || ||
|-
! {{X61}} 7675-4KU
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.34 || 7NET30WW (1.11 ) || 7MHT24WW-1.02 ||
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.32 || || ||
|-
! {{X61s}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 / 3 || 0.32 || || || [http://www.slackwiki.org/ThinkPad_X61s ref] says 3 but conflicting report received
|-
! {{X200}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 6DET40WW (2.04 ) || 7XHT22WW-1.04 ||
|-
! {{X300}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.37 || 7TET25WW (1.02 ) || 7THT15WW-1.00c ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====Z series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{Z60m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z61m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || || ||
|-
! {{Z61t}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || || [https://bugs.launchpad.net/ubuntu/+source/linux-source-2.6.20/+bug/45014 ref]
|-
! {{Z61p}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====SL series and IdeaPad=====
|-
! colspan=12 style="text-align:left" |
The ThinkPad SL series and IdeaPad series have firmware that is completely different from other ThinkPad models. Neither [[tp_smapi]] nor [[thinkpad-acpi]] support these models.
|}
</div>

SMAPI capabilities may depend on the BIOS version as well, so upgrading to the latest version of the BIOS might provide more SMAPI functions (especially true for long-lived BIOS with lots of releases, like the TP-1R).

Please update the above and report your experience on the [[Talk:tp_smapi|discussion]] page. If the module loads but gives a "<tt>not supported</tt>" or "<tt>not implementeded</tt>" error when you try to use some specific file in {{path|/sys/devices/platform/smapi/}}, please report the <tt>dmesg</tt> output and whether the corresponding functionality is available under Windows - maybe your ThinkPad just can't do that.

While at it, you may also want to add your laptop to the [[list of DMI IDs]].

=====HDAPS axis orientation=====
<sup>1</sup> The HDAPS axis orientation is set using the <tt>invert</tt> module parameter (at load time) or sysfs attribute (at runtime). The <tt>hdaps</tt> driver of tp_smapi supports all 8 possible sensor orientations (inversion and swapping). You can use [[HDAPS#Visualisation_of_ThinkPad_orientation|hdaps visualisation]] to check if the settings is correct.

The <tt>invert</tt> parameter is an integer between 0 and 7, whose meaning is defined below. (This is confusing. Most people will find it easier to just try all 8 possibilities.)

Let <tt>X</tt> and <tt>Y</tt> denote the hardware readouts. Let <tt>R</tt> denote the laptop's roll (tilt left/right), and let <tt>P</tt> denote the laptop's pitch (tilt forward/backward). The possible values are as follows:
invert=0: R= X P= Y (same as mainline)
invert=1: R=-X P=-Y (same as mainline)
invert=2: R=-X P= Y (new)
invert=3: R= X P=-Y (new)
invert=4: R= Y P= X (new)
invert=5: R=-Y P=-X (new)
invert=6: R=-Y P= X (new)
invert=7: R= Y P=-X (new)

[[Category:Drivers]] [[Category:Patches]]

===Tools using this driver===

The driver's interface can be accessed directly through the files under {{path|/sys/devices/platform/smapi}}, or via the following tools:
* [[KThinkBat]] - display battery status on the KDE <tt>kicker</tt> panel.
* [[gkrellm-ThinkBat]] - battery status plugin for Gkrellm2
* {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module.

== Headline text ==

Tp smapi

2009-07-01T14:46:58Z

Sfr3: /* Installation */ ubuntu hdaps_ec dispute

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
The <tt>tp_smapi</tt> kernel module exposes some features of the ThinkPad hardware/firmware via a <tt>sysfs</tt> interface. Currently, the main implemented functionality is control of battery charging and extended battery status. The tp_smapi software package also includes an improved version of the [[HDAPS]] driver. The underlying hardware interfaces are [[SMAPI support for Linux|SMAPI]] and direct access to the embedded controller.

This driver uses undocumented features and direct hardware access, so it may work unreliably or even damage your hardware; but so far no such damage has been reported.
|}

===Features===
*<tt>tp_smapi</tt> driver
**Battery charge/discharge control
**Battery status information
*<tt>hdaps</tt> driver (compared with the standard <tt>hdaps</tt> driver)
**Improved stability
**Improved model support
**Improved functionality

===Project Homepage / Availability===
* Project page: http://tpctl.sourceforge.net/
* You need to download only the <i>tp_smapi</i> package.

===Installation===
====Installation from source====
You will need the kernel headers and makefiles corresponding to your current kernel version. On {{Fedora}}, this means {{cmdroot|yum install kernel-devel-$(uname -r)}} .

:{{cmdroot|tar xzvf tp_smapi-0.40.tgz}}
:{{cmdroot|cd tp_smapi-0.40}}

Then, either compile and load the driver within the current working directory (for testing):
:{{cmdroot|make load}}
OR compile and install into the kernel's module path:
:{{cmdroot|make install}}

If you use the [[HDAPS]] driver, add <tt>HDAPS=1</tt> to also patch the <tt>hdaps</tt> for compatibility with <tt>tp_smapi</tt> (this requires a kernel source tree matching the current kernel).
Again, either load the driver within the current working directory:
:{{cmdroot|1=make load HDAPS=1}}
OR install into the kernel's module path:
:{{cmdroot|1=make install HDAPS=1}}

To prepare a stand-alone patch against the current kernel tree (including
a patch against <tt>hdaps</tt> and new <tt>Kconfig</tt> entries):
:{{cmdroot|make patch}}

To delete all autogenerated files:
:{{cmdroot|make clean}}

The original kernel tree is never modified by any these commands.
The {{path|/lib/modules}} directory is modified only by {{cmdroot|make install}}.

====Installation in Gentoo====
The {{Gentoo}} portage system carries a [http://packages.gentoo.org/package/app-laptop/tp_smapi tp_smapi package], which follows the latest version pretty closely. On a Gentoo system, you can install and load as follows.

If you use the [[HDAPS]] driver, do this first:

* Disable the <tt>hdaps</tt> module in your kernel configuration (Device Drivers → Hardware Monitoring Support → IBM Hard Drive Active Protection System)
* Rebuild and install the kernel
* Add the <tt>hdaps</tt> use flag in {{path|/etc/make.conf}}
* {{cmdroot|rmmod hdaps}}

Then:
* {{cmdroot|emerge tp_smapi}} (or install tp_smapi with hdaps support manually, as above)
* {{cmdroot|echo "tp_smapi" >> /etc/modules.autoload.d/kernel-2.6}}
* {{cmdroot|echo "hdaps" >> /etc/modules.autoload.d/kernel-2.6}}

Then reboot, or run:
* {{cmdroot|modprobe tp_smapi}}
* {{cmdroot|modprobe hdaps}}

====Installation on Debian unstable (sid), testing (squeeze) or stable (lenny)====
Debian now contains the [http://packages.debian.org/tp-smapi packaged module source] and prebuilt modules for Debian kernels.

If you use a stock Debian kernel, you can install the tp_smapi modules with:
* {{cmdroot|apt-get install tp-smapi-modules-`uname -r`}}
* in order to make sure the modules package is kept in sync with the kernel one, you may also want to install the <code>tm-smapi-modules-2.6-686</code> or <code>tm-smapi-modules-2.6-amd64</code> package, depending on your architecture

If you use a custom kernel, you can build tp_smapi with module-assistant:
* {{cmdroot|aptitude install tp-smapi-source}}
* {{cmdroot|m-a -t a-i tp-smapi}}

====Installation on openSUSE====
openSUSE provides rpm packages. Look for them at the package search: [http://software.opensuse.org/search/], search for the package named "tp_smapi".

A step-by-step guide on how a relative linux newbie installed tp_smapi on a Thinkpad W500 running openSuse 11.1 using YAST Software Manager is available [http://forums.opensuse.org/hardware/laptop/417254-tp_smapi-lenovo-thinkpad-t400-t500-w500-step-step.html#post2005932 here]

In case you are taking the hard way around, while compiling on 11.0, make complained about not being able to locate the kernel sources. It worked for me after I did this:
<pre><nowiki>cp /usr/include/linux/aio_abi.h /lib/modules/`uname -r`/build/include/linux/</nowiki></pre>

====Installation on Ubuntu====
Ubuntu ships tp_smapi in their linux-ubuntu-modules Package since Hardy, so you don't have to build it yourself. Please note that they have renamed tp_smapi's modified <tt>hdaps</tt> module to <tt>hdaps_ec</tt>. You should load <tt>hdaps_ec</tt>, not <tt>hdaps</tt>.

Ubuntu Intrepid and Jaunty, however, lack the <tt>hdaps_ec</tt> module, as reported [https://bugs.launchpad.net/ubuntu/+source/linux/+bug/297213 here]. It will not be included again until the [[#Bundled hdaps driver|bundled hdaps driver]] is merged into mainline.

=====Installation on Ubuntu Jaunty=====
I have posted my experiences [http://meandmyubuntu.blogspot.com/2009/05/getting-hdasp-to-work-on-jaunty.html here]

====Installation on older Ubuntu/Debian====
Installation on Ubuntu or Debian is quite easy, but there are a few things to look after:

To get your system ready for compiling code, install the build-essentials (as root, of course, as all of the following comands; Ubuntu users have to prepend 'sudo' to every line and enter their own password when prompted):
<pre><nowiki>apt-get install build-essential</nowiki></pre>

To get tp_smapi to work, obtain the latest source as mentioned above and unpack it. If you want to use HDAPS, you need to install the kernel source matching te kernel you are running. To do so, issue this:
<pre><nowiki>uname -r</nowiki></pre>
This will give you the version of your current kernel.
Debian users execute the following:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users execute the following using the kernel-version only (exclude -XX-generic; e.g. 'linux-source-2.6.20'):
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>

Be sure to unpack the source file. The easiest way is to open Nautilus as root:
<pre><nowiki>sudo nautilus</nowiki></pre>
Then browse to /usr/src/ and extract the source file to that directory.

Now change to the tp_smapi dir:
<pre><nowiki>cd tp_smapi-X.YY</nowiki></pre> (X.YY being the version-number of [[tp_smapi]])
and make and install tp_smapi as instructed above.

If you get an error that the kernel version isn't matching (or that you need to set KSRC/KBUILD), please check that there is a symlink from the modules dir to the kernel source:
<pre><nowiki>root@localhost:~#ls -l /lib/modules/2.6.20-16-generic
lrwxrwxrwx 1 root root 28 2007-02-02 08:39 build -> /usr/src/linux-source-2.6.20</nowiki></pre>
Create the link if the line above is not existent:
<pre><nowiki>root@localhost:~#ln -s /usr/src/linux-source-2.6.20 /lib/modules/2.6.20-16-generic/build</nowiki></pre>

Now the following will build and install the correct modules to their locations:
<pre><nowiki>make install HDAPS=1</nowiki></pre>
To make sure your system loads the modules at boot time, do this:
<pre><nowiki>echo "tp_smapi" >> /etc/modules
echo "hdaps" >> /etc/modules</nowiki></pre>
and update your initramfs:
<pre><nowiki>update-initramfs -u</nowiki></pre>

To get tp_smapi running now, just load the modules:
<pre><nowiki>modprobe -a tp_smapi hdaps</nowiki></pre>

This description was tested on Kubuntu 'Feisty Fawn' and should work on all Debian-based distros with minor tweaks.

'''EDIT:''' Works on Kubuntu 7.10 ("Gutsy Gibbon"), too

===Battery charge control features===
To set the thresholds for starting and stopping battery charging (in percent of current full charge capacity):
:{{cmdroot|echo 40 > /sys/devices/platform/smapi/BAT0/start_charge_thresh}}
:{{cmdroot|echo 70 > /sys/devices/platform/smapi/BAT0/stop_charge_thresh}}
:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/*_charge_thresh}}
{{HINT|Battery charging thresholds can be used to keep Li-Ion ad Li-Polymer batteries partially charged, in order to [[Maintenance#Battery_treatment|increase their lifetime]].}}
To prevent charging for 17 minutes (regardless of thresholds):
:{{cmdroot|echo 17 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}
{{HINT|Charge inhibiting can be used to reduce the power draw of the laptop, in order to use an under-spec power supply that can't handle the combined power draw of running and charging. It can also be used to control which battery is charged when [[How to use UltraBay batteries|using an Ultrabay battery]].}}

To cancel charging preventation:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}

To force battery discharging (even if connected to AC):
:{{cmdroot|echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge}}
{{HINT|This can be used to choose which battery is discharged when [[How to use UltraBay batteries|using an UltraBay battery]].}}

To cancel forced discharge:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}}

===Battery status features===
To view extended battery status such as charging state, voltage, current, capacity, cycle count and model information:

<pre>
# cat /sys/devices/platform/smapi/BAT0/installed
# cat /sys/devices/platform/smapi/BAT0/state # idle/charging/discharging
# cat /sys/devices/platform/smapi/BAT0/cycle_count
# cat /sys/devices/platform/smapi/BAT0/current_now # instantaneous current
# cat /sys/devices/platform/smapi/BAT0/current_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/power_now # instantaneous power
# cat /sys/devices/platform/smapi/BAT0/power_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/last_full_capacity
# cat /sys/devices/platform/smapi/BAT0/remaining_percent
# cat /sys/devices/platform/smapi/BAT0/remaining_running_time
# cat /sys/devices/platform/smapi/BAT0/remaining_charging_time
# cat /sys/devices/platform/smapi/BAT0/remaining_capacity
# cat /sys/devices/platform/smapi/BAT0/design_capacity
# cat /sys/devices/platform/smapi/BAT0/voltage
# cat /sys/devices/platform/smapi/BAT0/design_voltage
# cat /sys/devices/platform/smapi/BAT0/manufacturer
# cat /sys/devices/platform/smapi/BAT0/model
# cat /sys/devices/platform/smapi/BAT0/barcoding
# cat /sys/devices/platform/smapi/BAT0/chemistry
# cat /sys/devices/platform/smapi/BAT0/serial
# cat /sys/devices/platform/smapi/BAT0/manufacture_date
# cat /sys/devices/platform/smapi/BAT0/first_use_date
# cat /sys/devices/platform/smapi/BAT0/temperature # in milli-Celsius
# cat /sys/devices/platform/smapi/ac_connected
</pre>

The raw status data is also available, including some fields not listed above (in case you can figure them out):

:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/dump}}

In all of the above, replace <tt>BAT0</tt> with <tt>BAT1</tt> to address the 2nd battery.

Note that the battery status readout conflicts with the stock [[HDAPS|hdaps]] driver, so if you use <tt>hdaps</tt> you will need to load <tt>tp_smapi</tt> using {{cmdroot|1=make load HDAPS=1}} (see [[#Bundled hdaps driver|Bundled hdaps driver]] below).

On [[ACPI]]-enabled systems, most of above information is also available through the files under {{path|/proc/acpi/battery}}. However, the ACPI interface does not include the instantaneous power and cycle count readouts, and does not work well when [[How to use UltraBay batteries|hotswapping UltraBay batteries]].

====Scripts====
Some scripts can make it easier to grep the information you need from tp_smapi
* [[battery.rb]]

===Other features===

There is also [[sysfs]] attribute for making direct SMAPI requests to the SM BIOS firmware. Don't touch it unless you really know what you're doing. Example:
# echo '211a 100 0 0' > /sys/devices/platform/smapi/smapi_request; cat /sys/devices/platform/smapi/smapi_request
211a 34b b2 0 0 0 'OK'
The "4b" in the 2nd value, converted to decimal, is 75: the current charging stop threshold (stop_charge_thresh).

===Bundled <tt>hdaps</tt> driver===

The tp_smapi package includes a modified version of the <tt>hdaps</tt> Linux kernel driver used by the [[HDAPS]] system. To use <tt>tp_smapi</tt> and <tt>hdaps</tt> concurrently, you '''must''' use the modified version.

To build the modified version, simply append the <tt>HDAPS=1</tt> parameter to the <tt>make</tt> command (see [[#Installation|Installation]] above):
:{{cmdroot|1=make load HDAPS=1}}
or
:{{cmdroot|1=make install HDAPS=1}}

If you don't do that, you will not be able to load <tt>tp_smapi</tt> (and its support module <tt>thinkpad_ec</tt>) when <tt>hdaps</tt> is loaded, and vice versa. You can use <tt>rmmod</tt> to switch between these modules.

Note that some of the battery status is also visible through ACPI ({{path|/proc/acpi/battery/*}}), independently of <tt>tp_smapi</tt>.

The modified <tt>hdaps</tt> has several changes:
* The <tt>hdaps</tt> driver in mainline kernels conflicts with the extended battery status (they use the same IO ports). The modified <tt>hdaps</tt> coordinates this access through the bundled <tt>thinkpad_ec</tt> driver.
* The modified <tt>hdaps</tt> driver fixes reliability and improves support for recent ThinkPad models (*60 and newer), since unlike the mainline driver, it correctly follows the Embedded Controller communication protocol.
* Several other improvements, such as the ability to control the polling rate.

===Troubleshooting===
==== <tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f</tt> ====
The "<tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f!</tt>" error message is printed when loading the <tt>thinkpad_ec</tt> module on some recent ThinkPad models. This occurs because the ACPI BIOS DSDT is reserving ports used by tp_smapi.

As a workaround, add the <tt>force_io=1</tt> module parameter to <tt>thinkpad_ec</tt> in {{path|/etc/modprobe.conf}} (or your distribution's equivalent). For transient testing, load the modules as follows:

: {{cmdroot|1=make load HDAPS=1 FORCE_IO=1}}

Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16).

Models which need this option include:
* ThinkPad {{T400}}
* ThinkPad {{T500}}
* ThinkPad {{X301}}

More information:
* http://bugzilla.kernel.org/show_bug.cgi?id=12221
* http://www.nabble.com/thinkpad_ec-fails-to-load-on-Thinkpad-T500-td19932985.html

==== <tt>thinkpad_ec: no ThinkPad embedded controller!</tt> ====
If you get "<tt>thinkpad_ec: no ThinkPad embedded controller!</tt>" when trying to load the module on a supported model listed below, you should [[BIOS_Upgrade|upgrade your BIOS]]. Some early BIOS (like 1.x on the X31) don't handle the embedded controller.

===Model-specific status===

<div style="font-size: 92%">
{| border="1" cellspacing="0" cellpadding="2"
|+<tt>tp_smapi</tt> feature support matrix
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====A series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{A22p}} 2629-USG
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || ||
|-
! {{A30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====G series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{G41}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || N/A || N/A || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====R series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{R31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || No SMAPI BIOS
|-
! {{R40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || N/A || N/A || || || ||
|-
! {{R50}}
| {{Cunk}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R50e}} 1834-JAG
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{R50e}} 1834-5US
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R51}} 18*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || 3.22 || || Machine types 1829, 1830, 1831 and 1836
|-
! {{R51}} 28*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || 1.29 || || Machine types 2883, 2887, 2888, 2889, 2894 and 2495
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.29 || 1.06 ||
|-
! {{R60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cno|text=}} 1 || 0.33 || || ||
|-
! {{R61}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.35-test1 || 7KETA7WW 2.07 || 7KHT24WW 1.08 || Machine type 8918
|-
! {{R61i}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || || || || Machine type 8250
|-
! {{R400}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.40-1 || || || Machine type 7443
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====T series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T23}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T40p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{T41}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 3.23 || 3.04 ||
|-
! {{T41p}} 2373-AM9
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.20 || v3.04 ||
|-
! {{T42}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T42p}} 2373-KXU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.21 || || Stop charge threshold works in Windows, but dmesg says "__get_real_thresh: cannot get stop_thresh of bat=0: Function is not supported by SMAPI BIOS".
|-
! {{T42p}} 2373-KUU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T43}} 2686
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.27 || ||
|-
! {{T43p}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes|text=}} 0 || || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.32 || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.34 || || ||
|-
! {{T60}} 1951-24G
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.36 || 1.09a || ||
|-
! {{T60}} 2007-FSG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.39 || 1.10 || 1.05b ||
|-
! {{T60}} 1951-CZ1
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.40 || 2.23 || 1.07 ||
|-
! {{T60p}} 8743-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || || ||
|-
! {{T61}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T61p}} 6457-7XG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T400}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! {{T500}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} 1 || 0.40 || 2.07 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-

! colspan=12 style="text-align:center;background:#efefef;" |

=====X series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{X20}} 2662-31G
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || ||
|-
! {{X22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || N/A || N/A || || || || no EC controller found
|-
! {{X24}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || 0.34 || 1.09 || ||
|-
! {{X31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X32}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || ||
|-
! {{X40}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || 2.08 || 1.62 ||
|-
! {{X41}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || || ||
|-
! {{X41_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} (see ref) || 0.32 || || [http://sourceforge.net/mailarchive/message.php?msg_name=4757BD30.8080808%40ugcs.caltech.edu ref] ||
|-
! {{X60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || || 2.07 || 1.10 || 2.6.20 issue (see discussion)
|-
! {{X60_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.34 || 7JET25WW (1.10 ) || 7JHT13WW 1.04 || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X60s}} 1704-5UG
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cno|text=}} 3 || 0.34 || 7BETD2WW 2.13 || 7BHT40WW 1.13 ||
|-
! {{X61}} 7673-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 7NETB9WW (2.19) || {{Cunk}} ||
|-
! {{X61}} 7675-CTO
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} 6 || 0.35-test1 || || ||
|-
! {{X61}} 7675-4KU
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.34 || 7NET30WW (1.11 ) || 7MHT24WW-1.02 ||
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.32 || || ||
|-
! {{X61s}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 / 3 || 0.32 || || || [http://www.slackwiki.org/ThinkPad_X61s ref] says 3 but conflicting report received
|-
! {{X200}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 6DET40WW (2.04 ) || 7XHT22WW-1.04 ||
|-
! {{X300}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.37 || 7TET25WW (1.02 ) || 7THT15WW-1.00c ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====Z series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{Z60m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z61m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || || ||
|-
! {{Z61t}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || || [https://bugs.launchpad.net/ubuntu/+source/linux-source-2.6.20/+bug/45014 ref]
|-
! {{Z61p}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====SL series and IdeaPad=====
|-
! colspan=12 style="text-align:left" |
The ThinkPad SL series and IdeaPad series have firmware that is completely different from other ThinkPad models. Neither [[tp_smapi]] nor [[thinkpad-acpi]] support these models.
|}
</div>

SMAPI capabilities may depend on the BIOS version as well, so upgrading to the latest version of the BIOS might provide more SMAPI functions (especially true for long-lived BIOS with lots of releases, like the TP-1R).

Please update the above and report your experience on the [[Talk:tp_smapi|discussion]] page. If the module loads but gives a "<tt>not supported</tt>" or "<tt>not implementeded</tt>" error when you try to use some specific file in {{path|/sys/devices/platform/smapi/}}, please report the <tt>dmesg</tt> output and whether the corresponding functionality is available under Windows - maybe your ThinkPad just can't do that.

While at it, you may also want to add your laptop to the [[list of DMI IDs]].

=====HDAPS axis orientation=====
<sup>1</sup> The HDAPS axis orientation is set using the <tt>invert</tt> module parameter (at load time) or sysfs attribute (at runtime). The <tt>hdaps</tt> driver of tp_smapi supports all 8 possible sensor orientations (inversion and swapping). You can use [[HDAPS#Visualisation_of_ThinkPad_orientation|hdaps visualisation]] to check if the settings is correct.

The <tt>invert</tt> parameter is an integer between 0 and 7, whose meaning is defined below. (This is confusing. Most people will find it easier to just try all 8 possibilities.)

Let <tt>X</tt> and <tt>Y</tt> denote the hardware readouts. Let <tt>R</tt> denote the laptop's roll (tilt left/right), and let <tt>P</tt> denote the laptop's pitch (tilt forward/backward). The possible values are as follows:
invert=0: R= X P= Y (same as mainline)
invert=1: R=-X P=-Y (same as mainline)
invert=2: R=-X P= Y (new)
invert=3: R= X P=-Y (new)
invert=4: R= Y P= X (new)
invert=5: R=-Y P=-X (new)
invert=6: R=-Y P= X (new)
invert=7: R= Y P=-X (new)

[[Category:Drivers]] [[Category:Patches]]

===Tools using this driver===

The driver's interface can be accessed directly through the files under {{path|/sys/devices/platform/smapi}}, or via the following tools:
* [[KThinkBat]] - display battery status on the KDE <tt>kicker</tt> panel.
* [[gkrellm-ThinkBat]] - battery status plugin for Gkrellm2
* {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module.

== Headline text ==

How to protect the harddisk through APS

2009-03-06T18:02:25Z

Sfr3: mainline support

{| 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].
** '''NOTE''': Starting with kernel 2.6.28 a generic disc protection feature is built into the libata driver
* 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>.
|}

==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]]

How to reduce power consumption

2008-10-12T05:23:45Z

Sfr3: /* SATA Link Power Management */ 2.6.27 fix; kernel bug 10817

Reducing system power consumption will extend battery life, reduce system
temperature and (on some models) reduce system fan noise.
Power consumption can be greatly improved from a stock distribution configuration
to a fine tuned system. The general rules are :
* Unload drivers for unused devices (ie. USB 1.1, Yenta/PCMCIA, Wireless, IRDA, Bluetooth, ...)
* Reduce polling on devices (drives, USB subsystem, nvram, use SATA AN, ...)
* Reduce hard drive activity
* Reduce LCD brightness to the minimum you can stand
* Reduce CPU wakeups, so it can stay longer in deep power saving c-states
* Make use of every hardware devices availables power saving features (AHCI ALPM, USB autosuspend, Alsa and Wireless powersaving modes, HPET timers, ...)

==Tools==
Arjan van de Ven's [[PowerTOP]] utility
is a gold mine to improve energy efficiency, but is almost only CPU-oriented. This tool helps to easily detect
the top power offenders, both userland and kernel modules, which prevent the use of CPU power saving mechanisms and sometime suggest
fixes accordingly.
PowerTOP users collected some [http://www.lesswatts.org/projects/powertop/known.php tips & tricks]
and an informative [http://www.lesswatts.org/projects/powertop/faq.php faq].

Alternatively (or complementary) to PowerTOP, running <code>strace -p $(pidof yourapp)</code>
for all your favorite or background running applications while they are expected to be
idle, will show the misbehaviors.

Beside CPU wakeups, disks spins are also power hungry. To detect what make your disk spinning,

<code>
sysctl vm.block_dump=1
</code>

will list all applications causing disks wakeups on the kernel's dmesg.
Other useful tools for this purpose are blktrace, iostat and lm-profiler
(from laptop-mode-tools suite).

See also [[#Misbehaving Userland]].

==BIOS settings==
Some Thinkpad BIOS (like 2.08 BIOS on {{X40}}) offer two very lame options,
with a very misleading online help (saying "Usually not needed"). That's

<code>
CPU power management: (default disabled)
PCI bus power management: (default disabled)
</code>

You should indeed ''enable'' them, else the deepest C3 and C4 ACPI C-states
are disabled.

==CPU==
Look at:
* [[How to make use of Dynamic Frequency Scaling]]
* [[Pentium M undervolting and underclocking]]

A good thing to keep in mind is that every CPU wakeup, even if it's for
a trivial light job, reduce the time the CPU stays on a deep power
saving C-state (like C3 or C4). Therefore you should ensure your applications
stay really idle when they meant to be idle (track shorts select timeouts
in loop, etc. with [[PowerTOP]]).

Also note that manually locking the CPU in the lowest P-state (frequency)
available is '''not''' an efficient way to improve battery lifetime. This will
cause the CPU to stay longer in C0 (power hungry C-state) doing hard work when
there is something to do, while it could have done this work faster by augmenting
the CPU freq, and returned back faster to a deeper, economic, C-state and to a
lower frequency (P-state).
The best is to let the kernel select the appropriates CPU frequencies by itself
with the help of in kernel CPU governors.
Have a look at [http://www.bughost.org/pipermail/power/2007-May/000166.html this explanation]
from Intel's kernel developer Arjan van de Ven.

==Kernel settings and patches==

===General settings===
The 2.6.21 kernel brought some very effective changes (like [[dynticks]]).
Later, 2.6.24-rc2 brought a lot of other power efficiency improvements.
If it's not already on your distribution and you value power efficiency,
you may think about compiling a recent kernel yourself.

Here are a few options (beside the ACPI and APM related one) that matter to
reduce power consumption or to help diagnosing consumers:

<code>
# From PowerTOP's FAQ:
CONFIG_NO_HZ
CONFIG_HIGH_RES_TIMERS
CONFIG_HPET
CONFIG_HPET_TIMER
CONFIG_CPU_FREQ_GOV_ONDEMAND
CONFIG_USB_SUSPEND
CONFIG_SND_AC97_POWER_SAVE
CONFIG_SND_HDA_POWER_SAVE
CONFIG_SND_HDA_POWER_SAVE_DEFAULT=3
CONFIG_TIMER_STATS
CONFIG_ACPI_BATTERY
CONFIG_CPU_FREQ_STAT
CONFIG_INOTIFY

# Not from the PowerTOP FAQ:
CONFIG_BLK_DEV_IO_TRACE
CONFIG_X86_ACPI_CPUFREQ
CONFIG_X86_SPEEDSTEP_CENTRINO depreciated as of kernel 2.6.24, use CONFIG_X86_ACPI_CPUFREQ
CONFIG_X86_SPEEDSTEP_ICH
CONFIG_X86_SPEEDSTEP_SMI
CONFIG_CPU_IDLE
CONFIG_CPU_IDLE_GOV_LADDER
CONFIG_CPU_IDLE_GOV_MENU
</code>

Those options are already in Fedora Core 7 and Ubuntu Gutsy (not Feisty) default i686 kernels.
PowerTOP FAQ also suggest to '''disable'''
CONFIG_IRQBALANCE and CONFIG_ACPI_DEBUG.

Also, you need to properly set APM and ACPI. Look at:
* [[Power Management]]
* [[How to make use of Power Management features]]

=== Kernel boot and module loading options ===
If you have an Intel chipset > ICH3 (cf. lspci output), as in most modern Thinpads, you should
be using the integrated HPET timer (saves about 30 CPU wake ups per second). To see if
hpet is enabled on your laptop :

<code>
grep hpet /proc/timer_list
</code>

If this does not display "Clock Event Device: hpet", then add

<code>
hpet=force
</code>

to your kernel boot options (usualy in /boot/grub/menu.lst or lilo.conf).
Note that "hpet=force" is only available by default in 2.6.24-rc2 and above
(or as a separated patch for 2.6.22 and 2.6.23, see below).

===Useful Patches===

Thomas Gleixner High Resolution Timers (hrt) patchset brings many improvements,
like the cpuidle work and Udo A. Steinberg and Venki Pallipadi "force
enable HPET" patches (non HPET timers causes about 20-40 CPU wakeups/second, but
HPET is often hidden by the BIOS due to Windows XP deficiencies). Those are
fully merged in 2.6.24-rc1 vanilla kernel.
See http://www.tglx.de/projects/hrtimers/

Kristen Carlson Accardi from Intel has a patchset to turn on "Aggressive
Link Power Management" (ALPM) for the AHCI driver (for SATA bus). Also from
Accardi, SATA Asynchronous Notification (SATA AN), alows SATA link to notify
media insertions (thus avoid hal polling the cdrom). Those patches were merged
in 2.6.24-rc2 kernel (AN needs also support in hal to be used).
See: http://www.kernel.org/pub/linux/kernel/people/kristen/patches/SATA/alpm/

As of now (2.6.24-rc8), the linux kernel doesn't support PCI Express power
management (aka PCIe ASPM, aka PCIe LPM). Shaohua Li from Intel submited a
patch on LKML (http://lkml.org/lkml/2008/1/17/544 ) though, and reported it
to reduce power consumption by 1.3 watts for a system with three PCIe links.

The [[HDAPS]] disk protection systems can reduce battery life.
Matthew Garrett provides [http://www.linuxpowertop.org/patches/hdaps.patch a patch]
that prevents hdaps kernel module to generate interrupts when
this feature isn't used.

===Useful sysctls===
The meaning of those settings is explained case by case on the relevant
sections of this document. But for convenience sake, we group them here too.

Note that the "ondemand" scaling governor is recommended by Intel developers
for energy efficiency: it's expected to be more efficient than the "powersave"
governor, or than userspace daemons (like cpufreq-utils, cpufreqd, powernowd...).
Look [http://www.bughost.org/pipermail/power/2007-May/000071.html here],
[http://www.bughost.org/pipermail/power/2007-May/000073.html here], or
[http://www.bughost.org/pipermail/power/2007-May/000166.html here] for a
kernel developer explanation about "ondemand" being better on modern Intel CPUs.

The "link_power_management_policy" tunable won't be available unless you
run a 2.6.24-rc2 or more kernel, or applied Kirsten patchset, have an Intel
AHCI compatible chipset, and use SATA drives.

<code>
echo 5 > /proc/sys/vm/laptop_mode
echo 0 > /proc/sys/kernel/nmi_watchdog
echo Y > /sys/module/snd_ac97_codec/parameters/power_save
echo 1 > /sys/devices/system/cpu/sched_mc_power_savings
echo ondemand > /sys/devices/system/cpu/cpu0/cpufreq/scaling_governor
echo 1500 > /proc/sys/vm/dirty_writeback_centisecs
for i in /sys/bus/usb/devices/*/power/autosuspend; do echo 1 > $i; done
# those sysctl's are only available if you have an AHCI compatible SATA
# controler and use kernel > 2.6.24-rc2 (or use Kristen ALPM patchset) :
echo min_power > /sys/class/scsi_host/host0/link_power_management_policy
echo min_power > /sys/class/scsi_host/host1/link_power_management_policy
</code>

If you're running a kernel older than 2.6.22 do this. Not needed for kernels 2.6.22 onward:

<code>
cd /sys/devices/system/cpu/cpu0/cpufreq
cat ondemand/sampling_rate_max > ondemand/sampling_rate
</code>

==ATA drives==
Hard drives and CDRom drives spinning is very costly. To improve battery
lifetime, you should reduce disks access (or devices polling) the more you
can.

===Hard Drives===
The files access time update, while mandated by POSIX, is causing lots of
disks access; even accessing files on disk cache may wake the ATA or USB
bus. If you don't use this feature, disable it via:

<code>
mount -o remount,noatime / # and so on for all mounted fs
</code>

Also consider merely using a larger value for
commit=nrsec
Sync all data and metadata every nrsec seconds. The default value is 5 seconds.
See man mount(8).

The laptop_mode reduce disk usage by regrouping writes. You should enable
it, at least while on battery. See [[Laptop-mode]] for more details:

<code>
echo 5 > /proc/sys/vm/laptop_mode
</code>

The default kernel dirty page writeback frequency is very conservative. On
a laptop running on battery, one might find more appropriate to reduce it:

<code>
echo 1500 > /proc/sys/vm/dirty_writeback_centisecs
</code>

Some power saving hard drives features can be activated with hdparm (beware
that "-B 1" may reduce your drive lifetime, if you have lot of intermittent
disk activity causing lots of heads load/unloads: so reduce I/O activity first,
as explained above, in order to get longer disks idling periods).
For more details look at [[How to make use of Power Management features]] :

<code>
hdparm -B 1 -S 12 /dev/sda # and/or any other disk device
</code>

====SATA Link Power Management====
On kernels 2.6.24 and new this enables SATA Link Power Management:
<code>
echo min_power > /sys/class/scsi_host/host0/link_power_management_policy
echo min_power > /sys/class/scsi_host/host1/link_power_management_policy
</code>

Disable it by replacing <code>min_power</code> with <code>max_performance</code>.

On Hardy Heron with a 2.6.24-16 kernel, a suspend/resume cycle is much quicker if you disable SATA Link Power Management before initiating the suspend. As of Intrepid Ibex and kernel 2.6.27, this should be fixed. ([https://bugs.launchpad.net/linux/+bug/234047 Launchpad bug 234047], [http://bugzilla.kernel.org/show_bug.cgi?id=10817 Kernel bug 10817])

===Optical drive===
The optical drive is reported to consume power even when not accessed. See

* [[How to hotswap UltraBay devices|Eject the UltraBay optical drive]], or just turn off its power supply (i.e., run the appropriate eject script but leave the drive inserted).
* [[How to set optical drive speed|Reduce the spinning speed of the optical drive]].

The hald daemon polling tends to maintain the ATA buses out of power saving
modes, and to wakeup CDROM drive (except if you have a kernel >= 2.6.24, hal >= 0.5.10,
and SATA AN compatible devices). If you have a recent hald version, you
can stop this polling when on battery:

<code>
hal-disable-polling --device /dev/scd0 # or whatever your CD drive is
</code>

start polling again when on ac:
<code>
hal-disable-polling --enable-polling --device /dev/scd0 # or whatever your CD drive is
</code>

If your hald is not recent enough, consider suspending it when running on battery. Some moderns SATA buses and drivers supports a notification mechanism (SATA AN - Asynchronous Events Notifications) that obsolete the need for polling on modern hardware; support for this feature had been merged in Linux 2.6.24-rc1 and HAL 0.5.10.

==LCD Backlight/Brightness==
The LCD backlight is one of the very major power drain.
Reducing brightness to the lowest readable
level will save a lot of battery lifetime. Also, don't forget to configure
your screen saver to shutdown the screen backlight (rather than displaying some
eye candy), when no activity for a few minutes.

You can also let the system [[automatically reduce brightness]] after a
period of inactivity.

If you're choosing your Thinkpad laptop model, keep in mind that the screen
size affect the battery time greatly: more power needed for larger screens.

The very recent, but xorg standard way to control backlight from CLI is
using xbacklight. ie. to set backlight at half the brightness:

<code>
xbacklight -set 50
</code>

You should configure the DPMS to shutdown the screen when idle (rather than
displaying a fancy but power consuming screensaver). ie. to turn off the
display after 5mn of idling:

<code>
xset +dpms
xset dpms 0 0 300
</code>

==Graphic controllers==
All xorg Thinkpad graphics chipsets drivers (ati, radeon, fglrx, i810) have
the same bug causing very frequent CPU wakeups when DRI is activated, even
when you don't use any 3D application.
This problem is partly fixed on xorg git tree but not released as of xorg
7.2. If you value more battery than 3D, you should disable DRI: put this on
the /etc/X11/xorg.conf "Device" of you graphic controller:

<code>
Option "NoDRI"
</code>

Also be sure that DPMS is working: <code>grep DPMS /var/log/Xorg.0.log</code>
should output "DPMS enabled". If not, put <code>Option "DPMS"</code> in your config.
See the section above about how to enable dpms driven display power saving.

On recent xrandr/xorg versions, you can disable the TV output (or any other detected
as connected but not used outputs) when you're not using it: it's known to consume power.

<code>
xrandr # see all displays listed here, but that you don't actually use and disable them.
xrandr --output TV --off # for instance (if "xrandr" above listed a connected output named "TV" that you don't use)
</code>

When you don't have an external monitor plugged, disable CRT and DVI output
(for some, this can make a difference in power usage) :
<code>
echo crt_disable > /proc/acpi/ibm/video
echo dvi_disable > /proc/acpi/ibm/video
</code>

Some drivers have specials power saving mode, and/or allows underclocking the GPU. See also:
* [[How to make use of Graphics Chips Power Management features]], or with [[Rovclock]] on ATI.
* [[Problem with high power drain in ACPI sleep]]

==USB Subsystem==
The kernel support an efficient USB 2.0 power saving feature if you enabled
CONFIG_USB_SUSPEND. This may not trigger in when you have an USB device
plugged (and beside, USB devices tends to suck power on their own), so avoid
using such devices when on battery. To enable it by default, you must add the line
<code>
options usbcore autosuspend=1
</code>
to your <tt>/etc/modprobe.conf</tt> or add it to (and create if necessary) the file <tt>/etc/modprobe.d/usbcore</tt> depending on how your distribution organises modprobe configuratoin.

If on the other hand, you have <tt>usbcore</tt> built into your kernel, you can add this in the kernel boot options (ie. in grub's menu.lst):

<code>
usbcore.autosuspend=1
</code>

or at runtime, per device, with:

<code>
for i in /sys/bus/usb/devices/%s/power/autosuspend; do echo 1 > $i; done
</code>

USB 1.1 is worst. It needs polling the bus frequently, hence can't really go
in a low power mode when you enabled it, even if you don't have any device
plugged. You'd better remove it when you don't use a 1.1 device:

<code>
rmmod uhci_hcd
</code>

If you don't intend to use any device needing USB 1.1 (unfortunately, the built-in bluetooth and fingerprint-reader are USB 1.1 devices), the USB 1.1 support can also be totally avoided. On Debian and derivatives, just do:

<code>
echo "blacklist uhci_hcd" >> /etc/modprobe.d/blacklist
</code>

==PCMCIA/CardBus==
Same for PCMCIA/CardBus. Some users experiences interrupts clouds (sometime up to
several thousands interrupts/second) causing CPU wakeups, thus totally preventing
the CPU to reach lower C-states.
If you don't use PCMCIA, you may disable it the same way (unloading seems insufficient
to restore the system properly, you have to boot without it):

<code>
echo "blacklist pcmcia" >> /etc/modprobe.d/blacklist
echo "blacklist yenta_socket" >> /etc/modprobe.d/blacklist
</code>

==Sound==
ALSA has a power saving feature that should be enabled on your kernel
(CONFIG_SND_AC97_POWER_SAVE). Note that this low power mode won't trigger in
unless you muted all sound inputs (micro, line in etc.). This feature has
to be activated with:

<code>
amixer set Line mute nocap
amixer set Mic mute nocap
echo Y > /sys/module/snd_ac97_codec/parameters/power_save
</code>

More radical: you can unload all sound related modules when you are on
battery, or mute the sound system (echo mute > /proc/acpi/ibm/volume).

See also [[How to enable audio codec power saving]].

==Wireless Interface==
===intel wireless===
Wireless network consume a lot of power.
To save power, you can kill the Wi-Fi radio when it's not in use:

<code>
echo 1 > /sys/bus/pci/devices/*/rf_kill
</code>

If you need Wi-Fi, you can also reduce power consumption (at the price of
performances) by activating the power saving modes:

<code>
iwpriv eth1 set_power 5
</code>

For drivers using the new Wi-Fi kernel framework (mac80211/cfg80211),
the canonical way to do this is now:

<code>
for i in /sys/bus/pci/devices/*/power_level ; do echo 5 > $i ; done
</code>

Most drivers, like ipw2200, that don't use the new mac80211 framework place the
interfaces in aggressive scanning mode when they are not associated with any
Access Point, even when the interface is down (more info about this on Intel's
[http://www.lesswatts.org/tips/wireless.php LessWatts] website).
This behavior consumes a lot of power, even more than when the interface
is plain active and in use. But this can disabled at module's load time :

<code>
rmmod ipw2200
modprobe ipw2200 associate=0
</code>

You can fix this setting by placing the following in /etc/modprobe.d/options
(Debian/Ubuntu) or in /etc/modprobe.conf (Red Hat/Fedora):

<code>
options ipw2200 associate=0
</code>

Reducing beacon intervals on your Access Point to 1 per second will also
reduce network card interrupts, therefore power savings. This shouldn't have
negatives side effects.

See also, to activate power saving on the wireless network card:
* For [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]] and [[Intel PRO/Wireless 2915ABG Mini-PCI Adapter]], see instructions for the [[ipw2200]] driver.
* For [[Intel PRO/Wireless 3945ABG Mini-PCI Express Adapter]], see the [http://ipw3945.sourceforge.net/README.ipw3945 ipw3945 driver README]

==Ethernet Controler==
If you don't use Wake-on-LAN, you should disable it for your network card,
because it sucks a lot of power:

<code>
ethtool -s eth0 wol d
</code>

If you can, try to reduce useless network activity on your ethernet
segment, coming to your NIC (ie. uneeded broadcasts), those cause
interrupts and CPU wakeups.

Forcing 100Mbps full-duplex speed on a gigabit ethernet NIC can also save a lot of power (~1W) on most network workloads. This also reduces components temperature (e.g., [[Thermal Sensors|thermal sensor]] 0xC0 on the {{T43}} cools down by 5 degree between 1000Mbps and 100Mbps, and another 1 degree for 10Mbps).

<code>
ethtool -s eth0 autoneg off speed 100
</code>

Note, however, that if the network device on the other side has auto-negotiation enabled (which is very common) and you turn auto-negotiation off, the other side will assume half-duplex mode and you will experience a significant loss of performance.

==Bluetooth==
When you don't need bluetooth, disable it. Because of its radio,
bluetooth is not power friendly.

<code>
hciconfig hci0 down ; rmmod hci_usb
echo disable > /proc/acpi/ibm/bluetooth
</code>

==Modem==
When was the last time you used your analog modem? If you can't remember, you probably just don't need it. If it is on a separate module in your laptop, simply remove it. Store it in a ESD safe place (like the bag in which your last addon card or hard drive was packed), in case you should need it again. This won't save you a lot of power and weight, but why carry something around you never use.

==System Fans==
Fans consumes power when running, so you may look at the [[ACPI fan control script]].

==Misbehaving Userland==
You should avoid using Beagle, Compiz, Beryl, XMMS, gnome-power-manager
and Evolution while on battery.
Look at the PowerTOP's [http://www.linuxpowertop.org/known.php known problems]
list.

Deactivate desktop animations (blinking cursor on the terms, animated wallpapers, ...): they cause regular X (therefore kernel and CPU) wakeups.

In short, while on battery, you should stop all applications that don't really stay idle when you're not using them. This means applications that:
* Wakes up the CPU too often (by polling something, because of too short select() timeouts, ...)
* Access the disks at regular intervals
* Access an hardware bus (USB, ATA, ...) at regular intervals
To find those offenders run:
* <code>strace -p $(pidof yourapp)</code> # for all your running applications
* <code>powertop</code>
* <code>sysctl vm.block_dump=1</code> # and look at dmesg
* <code>ps aux | awk '{print$10,$11}' | sort -n</code> # will list all running softs sorted by used cpu time
Please, don't forget to fill a bug when you find such a misbehaving software.
{{NOTE|Not all software is evil, buggy or badly written. Some produce regular activity because they have to, in order to provide their intented functionality. Think twice before filling bugs about this.}}

==See Also==
* [[How to measure power consumption]]
* [[Script for monitoring power consumption]]
* Battery [[maintenance]]

==External resources==
* [http://www.free-it.de/archiv/talks_2005/paper-11017/paper-11017.html ''Current trends in Linux Kernel Power Management''], Dominik Brodowski, 2005
* [http://www.linuxpowertop.org PowerTOP] website
* [http://www.gentoo.org/doc/en/power-management-guide.xml Power Management Guide] from the Gentoo Linux documentation
* [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030478.html When/where/what for low power consumption?] (thread on Linux-Thinkpad)
* Intel's [http://www.lesswatts.org/ LessWatts] "''Saving power on Linux''" website
* ''8 hours of battery life on your lap(top)'' ([http://atrey.karlin.mff.cuni.cz/~pavel/swsusp/8hours.odp ODP]/[http://atrey.karlin.mff.cuni.cz/~pavel/swsusp/8hours.pdf PDF]), a presentation by Pavel Machek

[[Category:600X]] [[Category:A20m]] [[Category:A20p]] [[Category:A21e]] [[Category:A21m]] [[Category:A21p]] [[Category:A22e]] [[Category:A22m]] [[Category:A22p]] [[Category:A30]] [[Category:A30p]] [[Category:A31]] [[Category:A31p]] [[Category:i1200]] [[Category:i1300]] [[Category:i1620]] [[Category:G40]] [[Category:G41]] [[Category:R30]] [[Category:R31]] [[Category:R32]] [[Category:R40]] [[Category:R40e]] [[Category:R50]] [[Category:R50e]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:R60]] [[Category:R60e]] [[Category:T20]] [[Category:T21]] [[Category:T22]] [[Category:T23]] [[Category:T30]] [[Category:T40]] [[Category:T40p]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X20]] [[Category:X21]] [[Category:X22]] [[Category:X23]] [[Category:X24]] [[Category:X30]] [[Category:X31]] [[Category:X32]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:X61]] [[Category:X61s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Z61t]] [[Category:Z61e]] [[Category:TransNote]]

How to reduce power consumption

2008-07-05T17:39:23Z

Sfr3: /* SATA Link Power Management */ launchpad bug #234047

Reducing system power consumption will extend battery life, reduce system
temperature and (on some models) reduce system fan noise.
Power consumption can be greatly improved from a stock distribution configuration
to a fine tuned system. The general rules are :
* Unload drivers for unused devices (ie. USB 1.1, Yenta/PCMCIA, Wireless, IRDA, Bluetooth, ...)
* Reduce polling on devices (drives, USB subsystem, nvram, use SATA AN, ...)
* Reduce hard drive activity
* Reduce LCD brightness to the minimum you can stand
* Reduce CPU wakeups, so it can stay longer in deep power saving c-states
* Make use of every hardware devices availables power saving features (AHCI ALPM, USB autosuspend, Alsa and Wireless powersaving modes, HPET timers, ...)

==Tools==
Arjan van de Ven's [[PowerTOP]] utility
is a gold mine to improve energy efficiency, but is almost only CPU-oriented. This tool helps to easily detect
the top power offenders, both userland and kernel modules, which prevent the use of CPU power saving mechanisms and sometime suggest
fixes accordingly.
PowerTOP users collected some [http://www.lesswatts.org/projects/powertop/known.php tips & tricks]
and an informative [http://www.lesswatts.org/projects/powertop/faq.php faq].

Alternatively (or complementary) to PowerTOP, running <code>strace -p $(pidof yourapp)</code>
for all your favorite or background running applications while they are expected to be
idle, will show the misbehaviors.

Beside CPU wakeups, disks spins are also power hungry. To detect what make your disk spinning,

<code>
sysctl vm.block_dump=1
</code>

will list all applications causing disks wakeups on the kernel's dmesg.
Other useful tools for this purpose are blktrace, iostat and lm-profiler
(from laptop-mode-tools suite).

See also [[#Misbehaving Userland]].

==BIOS settings==
Some Thinkpad BIOS (like 2.08 BIOS on {{X40}}) offer two very lame options,
with a very misleading online help (saying "Usually not needed"). That's

<code>
CPU power management: (default disabled)
PCI bus power management: (default disabled)
</code>

You should indeed ''enable'' them, else the deepest C3 and C4 ACPI C-states
are disabled.

==CPU==
Look at:
* [[How to make use of Dynamic Frequency Scaling]]
* [[Pentium M undervolting and underclocking]]

A good thing to keep in mind is that every CPU wakeup, even if it's for
a trivial light job, reduce the time the CPU stays on a deep power
saving C-state (like C3 or C4). Therefore you should ensure your applications
stay really idle when they meant to be idle (track shorts select timeouts
in loop, etc. with [[PowerTOP]]).

Also note that manually locking the CPU in the lowest P-state (frequency)
available is '''not''' an efficient way to improve battery lifetime. This will
cause the CPU to stay longer in C0 (power hungry C-state) doing hard work when
there is something to do, while it could have done this work faster by augmenting
the CPU freq, and returned back faster to a deeper, economic, C-state and to a
lower frequency (P-state).
The best is to let the kernel select the appropriates CPU frequencies by itself
with the help of in kernel CPU governors.
Have a look at [http://www.bughost.org/pipermail/power/2007-May/000166.html this explanation]
from Intel's kernel developer Arjan van de Ven.

==Kernel settings and patches==

===General settings===
The 2.6.21 kernel brought some very effective changes (like [[dynticks]]).
Later, 2.6.24-rc2 brought a lot of other power efficiency improvements.
If it's not already on your distribution and you value power efficiency,
you may think about compiling a recent kernel yourself.

Here are a few options (beside the ACPI and APM related one) that matter to
reduce power consumption or to help diagnosing consumers:

<code>
# From PowerTOP's FAQ:
CONFIG_NO_HZ
CONFIG_HIGH_RES_TIMERS
CONFIG_HPET
CONFIG_HPET_TIMER
CONFIG_CPU_FREQ_GOV_ONDEMAND
CONFIG_USB_SUSPEND
CONFIG_SND_AC97_POWER_SAVE
CONFIG_SND_HDA_POWER_SAVE
CONFIG_SND_HDA_POWER_SAVE_DEFAULT=3
CONFIG_TIMER_STATS
CONFIG_ACPI_BATTERY
CONFIG_CPU_FREQ_STAT
CONFIG_INOTIFY

# Not from the PowerTOP FAQ:
CONFIG_BLK_DEV_IO_TRACE
CONFIG_X86_ACPI_CPUFREQ
CONFIG_X86_SPEEDSTEP_CENTRINO depreciated as of kernel 2.6.24, use CONFIG_X86_ACPI_CPUFREQ
CONFIG_X86_SPEEDSTEP_ICH
CONFIG_X86_SPEEDSTEP_SMI
CONFIG_CPU_IDLE
CONFIG_CPU_IDLE_GOV_LADDER
CONFIG_CPU_IDLE_GOV_MENU
</code>

Those options are already in Fedora Core 7 and Ubuntu Gutsy (not Feisty) default i686 kernels.
PowerTOP FAQ also suggest to '''disable'''
CONFIG_IRQBALANCE and CONFIG_ACPI_DEBUG.

Also, you need to properly set APM and ACPI. Look at:
* [[Power Management]]
* [[How to make use of Power Management features]]

=== Kernel boot and module loading options ===
If you have an Intel chipset > ICH3 (cf. lspci output), as in most modern Thinpads, you should
be using the integrated HPET timer (saves about 30 CPU wake ups per second). To see if
hpet is enabled on your laptop :

<code>
grep hpet /proc/timer_list
</code>

If this does not display "Clock Event Device: hpet", then add

<code>
hpet=force
</code>

to your kernel boot options (usualy in /boot/grub/menu.lst or lilo.conf).
Note that "hpet=force" is only available by default in 2.6.24-rc2 and above
(or as a separated patch for 2.6.22 and 2.6.23, see below).

===Useful Patches===

Thomas Gleixner High Resolution Timers (hrt) patchset brings many improvements,
like the cpuidle work and Udo A. Steinberg and Venki Pallipadi "force
enable HPET" patches (non HPET timers causes about 20-40 CPU wakeups/second, but
HPET is often hidden by the BIOS due to Windows XP deficiencies). Those are
fully merged in 2.6.24-rc1 vanilla kernel.
See http://www.tglx.de/projects/hrtimers/

Kristen Carlson Accardi from Intel has a patchset to turn on "Aggressive
Link Power Management" (ALPM) for the AHCI driver (for SATA bus). Also from
Accardi, SATA Asynchronous Notification (SATA AN), alows SATA link to notify
media insertions (thus avoid hal polling the cdrom). Those patches were merged
in 2.6.24-rc2 kernel (AN needs also support in hal to be used).
See: http://www.kernel.org/pub/linux/kernel/people/kristen/patches/SATA/alpm/

As of now (2.6.24-rc8), the linux kernel doesn't support PCI Express power
management (aka PCIe ASPM, aka PCIe LPM). Shaohua Li from Intel submited a
patch on LKML (http://lkml.org/lkml/2008/1/17/544 ) though, and reported it
to reduce power consumption by 1.3 watts for a system with three PCIe links.

The [[HDAPS]] disk protection systems can reduce battery life.
Matthew Garrett provides [http://www.linuxpowertop.org/patches/hdaps.patch a patch]
that prevents hdaps kernel module to generate interrupts when
this feature isn't used.

===Useful sysctls===
The meaning of those settings is explained case by case on the relevant
sections of this document. But for convenience sake, we group them here too.

Note that the "ondemand" scaling governor is recommended by Intel developers
for energy efficiency: it's expected to be more efficient than the "powersave"
governor, or than userspace daemons (like cpufreq-utils, cpufreqd, powernowd...).
Look [http://www.bughost.org/pipermail/power/2007-May/000071.html here],
[http://www.bughost.org/pipermail/power/2007-May/000073.html here], or
[http://www.bughost.org/pipermail/power/2007-May/000166.html here] for a
kernel developer explanation about "ondemand" being better on modern Intel CPUs.

The "link_power_management_policy" tunable won't be available unless you
run a 2.6.24-rc2 or more kernel, or applied Kirsten patchset, have an Intel
AHCI compatible chipset, and use SATA drives.

<code>
echo 5 > /proc/sys/vm/laptop_mode
echo 0 > /proc/sys/kernel/nmi_watchdog
echo Y > /sys/module/snd_ac97_codec/parameters/power_save
echo 1 > /sys/devices/system/cpu/sched_mc_power_savings
echo ondemand > /sys/devices/system/cpu/cpu0/cpufreq/scaling_governor
echo 1500 > /proc/sys/vm/dirty_writeback_centisecs
for i in /sys/bus/usb/devices/*/power/autosuspend; do echo 1 > $i; done
# those sysctl's are only available if you have an AHCI compatible SATA
# controler and use kernel > 2.6.24-rc2 (or use Kristen ALPM patchset) :
echo min_power > /sys/class/scsi_host/host0/link_power_management_policy
echo min_power > /sys/class/scsi_host/host1/link_power_management_policy
</code>

If you're running a kernel older than 2.6.22 do this. Not needed for kernels 2.6.22 onward:

<code>
cd /sys/devices/system/cpu/cpu0/cpufreq
cat ondemand/sampling_rate_max > ondemand/sampling_rate
</code>

==ATA drives==
Hard drives and CDRom drives spinning is very costly. To improve battery
lifetime, you should reduce disks access (or devices polling) the more you
can.

===Hard Drives===
The files access time update, while mandated by POSIX, is causing lots of
disks access; even accessing files on disk cache may wake the ATA or USB
bus. If you don't use this feature, disable it via:

<code>
mount -o remount,noatime / # and so on for all mounted fs
</code>

The laptop_mode reduce disk usage by regrouping writes. You should enable
it, at least while on battery. See [[Laptop-mode]] for more details:

<code>
echo 5 > /proc/sys/vm/laptop_mode
</code>

The default kernel dirty page writeback frequency is very conservative. On
a laptop running on battery, one might find more appropriate to reduce it:

<code>
echo 1500 > /proc/sys/vm/dirty_writeback_centisecs
</code>

Some power saving hard drives features can be activated with hdparm (beware
that "-B 1" may reduce your drive lifetime, if you have lot of intermittent
disk activity causing lots of heads load/unloads: so reduce I/O activity first,
as explained above, in order to get longer disks idling periods).
For more details look at [[How to make use of Power Management features]] :

<code>
hdparm -B 1 -S 12 /dev/sda # and/or any other disk device
</code>

====SATA Link Power Management====
On kernels 2.6.24 and new this enables SATA Link Power Management:
<code>
echo min_power > /sys/class/scsi_host/host0/link_power_management_policy
echo min_power > /sys/class/scsi_host/host1/link_power_management_policy
</code>

Disable it by replacing <code>min_power</code> with <code>max_performance</code>.

On Hardy Heron with a 2.6.24-16 kernel, a suspend/resume cycle is much quicker if you disable SATA Link Power Management before initiating the suspend. [[https://bugs.launchpad.net/linux/+bug/234047 Launchpad bug 234047]]

===Optical drive===
The optical drive is reported to consume power even when not accessed. See

* [[How to hotswap UltraBay devices|Eject the UltraBay optical drive]], or just turn off its power supply (i.e., run the appropriate eject script but leave the drive inserted).
* [[How to set optical drive speed|Reduce the spinning speed of the optical drive]].

The hald daemon polling tends to maintain the ATA buses out of power saving
modes, and to wakeup CDROM drive (except if you have a kernel >= 2.6.24, hal >= 0.5.10,
and SATA AN compatible devices). If you have a recent hald version, you
can stop this polling when on battery:

<code>
hal-disable-polling --device /dev/scd0 # or whatever your CD drive is
</code>

start polling again when on ac:
<code>
hal-disable-polling --enable-polling --device /dev/scd0 # or whatever your CD drive is
</code>

If your hald is not recent enough, consider suspending it when running on battery. Some moderns SATA buses and drivers supports a notification mechanism (SATA AN - Asynchronous Events Notifications) that obsolete the need for polling on modern hardware; support for this feature had been merged in Linux 2.6.24-rc1 and HAL 0.5.10.

==LCD Backlight/Brightness==
The LCD backlight is one of the very major power drain.
Reducing brightness to the lowest readable
level will save a lot of battery lifetime. Also, don't forget to configure
your screen saver to shutdown the screen backlight (rather than displaying some
eye candy), when no activity for a few minutes.

You can also let the system [[automatically reduce brightness]] after a
period of inactivity.

If you're choosing your Thinkpad laptop model, keep in mind that the screen
size affect the battery time greatly: more power needed for larger screens.

The very recent, but xorg standard way to control backlight from CLI is
using xbacklight. ie. to set backlight at half the brightness:

<code>
xbacklight -set 50
</code>

You should configure the DPMS to shutdown the screen when idle (rather than
displaying a fancy but power consuming screensaver). ie. to turn off the
display after 5mn of idling:

<code>
xset +dpms
xset dpms 0 0 300
</code>

==Graphic controllers==
All xorg Thinkpad graphics chipsets drivers (ati, radeon, fglrx, i810) have
the same bug causing very frequent CPU wakeups when DRI is activated, even
when you don't use any 3D application.
This problem is partly fixed on xorg git tree but not released as of xorg
7.2. If you value more battery than 3D, you should disable DRI: put this on
the /etc/X11/xorg.conf "Device" of you graphic controller:

<code>
Option "NoDRI"
</code>

Also be sure that DPMS is working: <code>grep DPMS /var/log/Xorg.0.log</code>
should output "DPMS enabled". If not, put <code>Option "DPMS"</code> in your config.
See the section above about how to enable dpms driven display power saving.

On recent xrandr/xorg versions, you can disable the TV output (or any other detected
as connected but not used outputs) when you're not using it: it's known to consume power.

<code>
xrandr # see all displays listed here, but that you don't actually use and disable them.
xrandr --output TV --off # for instance (if "xrandr" above listed a connected output named "TV" that you don't use)
</code>

When you don't have an external monitor plugged, disable CRT and DVI output
(for some, this can make a difference in power usage) :
<code>
echo crt_disable > /proc/acpi/ibm/video
echo dvi_disable > /proc/acpi/ibm/video
</code>

Some drivers have specials power saving mode, and/or allows underclocking the GPU. See also:
* [[How to make use of Graphics Chips Power Management features]], or with [[Rovclock]] on ATI.
* [[Problem with high power drain in ACPI sleep]]

==USB Subsystem==
The kernel support an efficient USB 2.0 power saving feature if you enabled
CONFIG_USB_SUSPEND. This may not trigger in when you have an USB device
plugged (and beside, USB devices tends to suck power on their own), so avoid
using such devices when on battery. To enable it by default, you must add the line
<code>
options usbcore autosuspend=1
</code>
to your <tt>/etc/modprobe.conf</tt> or add it to (and create if necessary) the file <tt>/etc/modprobe.d/usbcore</tt> depending on how your distribution organises modprobe configuratoin.

If on the other hand, you have <tt>usbcore</tt> built into your kernel, you can add this in the kernel boot options (ie. in grub's menu.lst):

<code>
usbcore.autosuspend=1
</code>

or at runtime, per device, with:

<code>
for i in /sys/bus/usb/devices/%s/power/autosuspend; do echo 1 > $i; done
</code>

USB 1.1 is worst. It needs polling the bus frequently, hence can't really go
in a low power mode when you enabled it, even if you don't have any device
plugged. You'd better remove it when you don't use a 1.1 device:

<code>
rmmod uhci_hcd
</code>

If you don't intend to use any device needing USB 1.1 (unfortunately, the built-in bluetooth and fingerprint-reader are USB 1.1 devices), the USB 1.1 support can also be totally avoided. On Debian and derivatives, just do:

<code>
echo "blacklist uhci_hcd" >> /etc/modprobe.d/blacklist
</code>

==PCMCIA/CardBus==
Same for PCMCIA/CardBus. Some users experiences interrupts clouds (sometime up to
several thousands interrupts/second) causing CPU wakeups, thus totally preventing
the CPU to reach lower C-states.
If you don't use PCMCIA, you may disable it the same way (unloading seems insufficient
to restore the system properly, you have to boot without it):

<code>
echo "blacklist pcmcia" >> /etc/modprobe.d/blacklist
echo "blacklist yenta_socket" >> /etc/modprobe.d/blacklist
</code>

==Sound==
ALSA has a power saving feature that should be enabled on your kernel
(CONFIG_SND_AC97_POWER_SAVE). Note that this low power mode won't trigger in
unless you muted all sound inputs (micro, line in etc.). This feature has
to be activated with:

<code>
amixer set Line mute nocap
amixer set Mic mute nocap
echo Y > /sys/module/snd_ac97_codec/parameters/power_save
</code>

More radical: you can unload all sound related modules when you are on
battery, or mute the sound system (echo mute > /proc/acpi/ibm/volume).

See also [[How to enable audio codec power saving]].

==Wireless Interface==
===intel wireless===
Wireless network consume a lot of power.
To save power, you can kill the Wi-Fi radio when it's not in use:

<code>
echo 1 > /sys/bus/pci/devices/*/rf_kill
</code>

If you need Wi-Fi, you can also reduce power consumption (at the price of
performances) by activating the power saving modes:

<code>
iwpriv eth1 set_power 5
</code>

For drivers using the new Wi-Fi kernel framework (mac80211/cfg80211),
the canonical way to do this is now:

<code>
for i in /sys/bus/pci/devices/*/power_level ; do echo 5 > $i ; done
</code>

Most drivers, like ipw2200, that don't use the new mac80211 framework place the
interfaces in aggressive scanning mode when they are not associated with any
Access Point, even when the interface is down (more info about this on Intel's
[http://www.lesswatts.org/tips/wireless.php LessWatts] website).
This behavior consumes a lot of power, even more than when the interface
is plain active and in use. But this can disabled at module's load time :

<code>
rmmod ipw2200
modprobe ipw2200 associate=0
</code>

You can fix this setting by placing the following in /etc/modprobe.d/options
(Debian/Ubuntu) or in /etc/modprobe.conf (Red Hat/Fedora):

<code>
options ipw2200 associate=0
</code>

Reducing beacon intervals on your Access Point to 1 per second will also
reduce network card interrupts, therefore power savings. This shouldn't have
negatives side effects.

See also, to activate power saving on the wireless network card:
* For [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]] and [[Intel PRO/Wireless 2915ABG Mini-PCI Adapter]], see instructions for the [[ipw2200]] driver.
* For [[Intel PRO/Wireless 3945ABG Mini-PCI Express Adapter]], see the [http://ipw3945.sourceforge.net/README.ipw3945 ipw3945 driver README]

==Ethernet Controler==
If you don't use Wake-on-LAN, you should disable it for your network card,
because it sucks a lot of power:

<code>
ethtool -s eth0 wol d
</code>

If you can, try to reduce useless network activity on your ethernet
segment, coming to your NIC (ie. uneeded broadcasts), those cause
interrupts and CPU wakeups.

Forcing 100Mbps full-duplex speed on a gigabit ethernet NIC can also save a lot of power (~1W) on most network workloads. This also reduces components temperature (e.g., [[Thermal Sensors|thermal sensor]] 0xC0 on the {{T43}} cools down by 5 degree between 1000Mbps and 100Mbps, and another 1 degree for 10Mbps).

<code>
ethtool -s eth0 autoneg off speed 100
</code>

Note, however, that if the network device on the other side has auto-negotiation enabled (which is very common) and you turn auto-negotiation off, the other side will assume half-duplex mode and you will experience a significant loss of performance.

==Bluetooth==
When you don't need bluetooth, disable it. Because of its radio,
bluetooth is not power friendly.

<code>
hciconfig hci0 down ; rmmod hci_usb
echo disable > /proc/acpi/ibm/bluetooth
</code>

==Modem==
When was the last time you used your analog modem? If you can't remember, you probably just don't need it. If it is on a separate module in your laptop, simply remove it. Store it in a ESD safe place (like the bag in which your last addon card or hard drive was packed), in case you should need it again. This won't save you a lot of power and weight, but why carry something around you never use.

==System Fans==
Fans consumes power when running, so you may look at the [[ACPI fan control script]].

==Misbehaving Userland==
You should avoid using Beagle, Compiz, Beryl, XMMS, gnome-power-manager
and Evolution while on battery.
Look at the PowerTOP's [http://www.linuxpowertop.org/known.php known problems]
list.

Deactivate desktop animations (blinking cursor on the terms, animated wallpapers, ...): they cause regular X (therefore kernel and CPU) wakeups.

In short, while on battery, you should stop all applications that don't really stay idle when you're not using them. This means applications that:
* Wakes up the CPU too often (by polling something, because of too short select() timeouts, ...)
* Access the disks at regular intervals
* Access an hardware bus (USB, ATA, ...) at regular intervals
To find those offenders run:
* <code>strace -p $(pidof yourapp)</code> # for all your running applications
* <code>powertop</code>
* <code>sysctl vm.block_dump=1</code> # and look at dmesg
* <code>ps aux | awk '{print$10,$11}' | sort -n</code> # will list all running softs sorted by used cpu time
Please, don't forget to fill a bug when you find such a misbehaving software.
{{NOTE|Not all software is evil, buggy or badly written. Some produce regular activity because they have to, in order to provide their intented functionality. Think twice before filling bugs about this.}}

==See Also==
* [[How to measure power consumption]]
* [[Script for monitoring power consumption]]
* Battery [[maintenance]]

==External resources==
* [http://www.free-it.de/archiv/talks_2005/paper-11017/paper-11017.html ''Current trends in Linux Kernel Power Management''], Dominik Brodowski, 2005
* [http://www.linuxpowertop.org PowerTOP] website
* [http://www.gentoo.org/doc/en/power-management-guide.xml Power Management Guide] from the Gentoo Linux documentation
* [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030478.html When/where/what for low power consumption?] (thread on Linux-Thinkpad)
* Intel's [http://www.lesswatts.org/ LessWatts] "''Saving power on Linux''" website
* ''8 hours of battery life on your lap(top)'' ([http://atrey.karlin.mff.cuni.cz/~pavel/swsusp/8hours.odp ODP]/[http://atrey.karlin.mff.cuni.cz/~pavel/swsusp/8hours.pdf PDF]), a presentation by Pavel Machek

[[Category:600X]] [[Category:A20m]] [[Category:A20p]] [[Category:A21e]] [[Category:A21m]] [[Category:A21p]] [[Category:A22e]] [[Category:A22m]] [[Category:A22p]] [[Category:A30]] [[Category:A30p]] [[Category:A31]] [[Category:A31p]] [[Category:i1200]] [[Category:i1300]] [[Category:i1620]] [[Category:G40]] [[Category:G41]] [[Category:R30]] [[Category:R31]] [[Category:R32]] [[Category:R40]] [[Category:R40e]] [[Category:R50]] [[Category:R50e]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:R60]] [[Category:R60e]] [[Category:T20]] [[Category:T21]] [[Category:T22]] [[Category:T23]] [[Category:T30]] [[Category:T40]] [[Category:T40p]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X20]] [[Category:X21]] [[Category:X22]] [[Category:X23]] [[Category:X24]] [[Category:X30]] [[Category:X31]] [[Category:X32]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:X61]] [[Category:X61s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Z61t]] [[Category:Z61e]] [[Category:TransNote]]