Difference between revisions of "Tp smapi"
(→Installation on Ubuntu Kamic) |
(clean up debian and ubuntu documentation, only mention dkms now) |
||
(64 intermediate revisions by 35 users not shown) | |||
Line 5: | Line 5: | ||
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. | 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. | ||
+ | |||
+ | If you are installing on a recent Thinkpad that has an [[Ivy Bridge]] or newer processor ({{X230}}, {{T430}}, {{T530}}, etc.), tp_smapi will not work. You will be mostly limited to [[thinkpad-acpi]] capabilities. You can however set battery charge thresholds with [[tpacpi-bat]]. | ||
|} | |} | ||
Line 18: | Line 20: | ||
===Project Homepage / Availability=== | ===Project Homepage / Availability=== | ||
* Project page: http://tpctl.sourceforge.net/ | * Project page: http://tpctl.sourceforge.net/ | ||
− | * Download page: http://sourceforge.net/projects/tpctl/files/tp_smapi | + | * Download page: http://sourceforge.net/projects/tpctl/files/tp_smapi, a newer version 0.41 is available in a fork at https://github.com/evgeni/tp_smapi which is also available in Debian |
* You need to download only the <i>tp_smapi</i> package. | * You need to download only the <i>tp_smapi</i> package. | ||
Line 68: | Line 70: | ||
* {{cmdroot|modprobe hdaps}} | * {{cmdroot|modprobe hdaps}} | ||
− | + | '''NOTE:''' If {{cmdroot|modprobe}} fails and dmesg says something about <tt>__stack_chk_fail()</tt>, you probably just compiled your modules with <tt>-fstack-protector</tt> and/or <tt>-fstack-protector-all</tt> without having a kernel that supports it. You can either configure your kernel to have <tt>CC_STACKPROTECTOR</tt> enabled (in ''Processor type and features'' if you use {{cmdroot|make menuconfig}}) or edit your <tt>make.conf</tt> (or, if you're using paludis, your <tt>/etc/paludis/bashrc</tt>) and remove <tt>-fstack-protector</tt> and <tt>-fstack-protector-all</tt> from your <tt>CFLAGS</tt>. If you choose to enable it in the kernel, be aware that you need a patched GCC for it (and I do not know if the gcc in stage3 is patched). | |
− | |||
− | |||
− | |||
− | |||
− | If you | + | ====Installation on Debian and Ubuntu==== |
− | * {{cmdroot| | + | Since Debian 7 Wheezy and Ubuntu 12.04 Precise you can use 'dkms'. (Note: If installation seems ineffective, confirm you have the linux-headers of your kernel installed, purge tp-smapi-dkms and reinstall.) |
− | * {{cmdroot| | + | * {{cmdroot|apt-get install linux-headers tp-smapi-dkms}} |
+ | * {{cmdroot|modprobe tp_smapi}} | ||
+ | |||
+ | {{HINT|This appears to be the ideal solution. A description of DKMS, from [http://linux.dell.com/projects.shtml#dkms Dell]: "DKMS stands for Dynamic Kernel Module Support. It is designed to create a framework where kernel dependent module source can reside so that it is very easy to rebuild modules as you upgrade kernels."}} | ||
====Installation on openSUSE==== | ====Installation on openSUSE==== | ||
Line 87: | Line 88: | ||
<pre><nowiki>cp /usr/include/linux/aio_abi.h /lib/modules/`uname -r`/build/include/linux/</nowiki></pre> | <pre><nowiki>cp /usr/include/linux/aio_abi.h /lib/modules/`uname -r`/build/include/linux/</nowiki></pre> | ||
− | ==== | + | ===Battery charge control features=== |
− | + | {{NOTE|Not all Thinkpad ECs support these charge control features. If you get the message "Operation not supported" when trying to cat for the status of a given parameter, it means your controller does not support that feature.}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
To set the thresholds for starting and stopping battery charging (in percent of current full charge capacity): | 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 40 > /sys/devices/platform/smapi/BAT0/start_charge_thresh}} | ||
Line 164: | Line 109: | ||
To cancel forced discharge: | To cancel forced discharge: | ||
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}} | :{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}} | ||
+ | |||
+ | {{HINT|TPBattStat-Applet is a gnome applet for integrating battery balancing with a graphics and/or text display of both batteries in a panel. Battery balancing improves battery life by not leaving one battery empty while the other discharges. For the latest alpha release, see https://github.com/teleshoes/tpbattstat-applet}} | ||
====Making the settings permanent on reboot==== | ====Making the settings permanent on reboot==== | ||
Line 270: | Line 217: | ||
Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16). | Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16). | ||
− | Models which need this option include: | + | Models which need this option include: {{T400}}, {{T500}}, {{X60s}}, {{X61}}, {{X301}} |
− | |||
− | |||
− | |||
More information: | More information: | ||
Line 284: | Line 228: | ||
==== <tt>T60p writing to start_charge_thresh/stop_charge_thresh does not work!</tt> ==== | ==== <tt>T60p writing to start_charge_thresh/stop_charge_thresh does not work!</tt> ==== | ||
Writing to /sys/devices/platform/smapi/BAT0/start_charge_thresh succeeds, but the older value does not change. Solution: unknown. If you know a solution please update here. | Writing to /sys/devices/platform/smapi/BAT0/start_charge_thresh succeeds, but the older value does not change. Solution: unknown. If you know a solution please update here. | ||
+ | |||
+ | UPDATE: Failure to effectively change sysfs values sometimes happens at boot time (through sysfs.conf OR etc/local.start for instance) when the values have never previously been changed manually (ie using echo from a shell). Try initializing the values manually before including them in boot-time scripting. | ||
===Model-specific status=== | ===Model-specific status=== | ||
+ | Tip: The <tt>thinkpad-acpi</tt> module reports both the BIOS and EC firmware versions when it loads. | ||
<div style="font-size: 92%"> | <div style="font-size: 92%"> | ||
Line 292: | Line 239: | ||
|+<tt>tp_smapi</tt> feature support matrix | |+<tt>tp_smapi</tt> feature support matrix | ||
|- | |- | ||
− | ! colspan=12 style="text-align:center;background:#efefef;" | | + | ! colspan=12 style="text-align:center;background:#efefef;" | |
+ | |||
=====A series===== | =====A series===== | ||
|- | |- | ||
Line 304: | Line 252: | ||
|- | |- | ||
! colspan=12 style="text-align:center;background:#efefef;" | | ! colspan=12 style="text-align:center;background:#efefef;" | | ||
+ | |||
=====G series===== | =====G series===== | ||
|- | |- | ||
Line 351: | Line 300: | ||
|- | |- | ||
! {{R61i}} | ! {{R61i}} | ||
− | | {{Cyes}} || {{Cyes}} || {{ | + | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.41 || || || Machine types 7732, 8250 |
|- | |- | ||
! {{R400}} | ! {{R400}} | ||
Line 379: | Line 328: | ||
! {{T40}} | ! {{T40}} | ||
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || || | | {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || || || || | ||
+ | |- | ||
+ | ! {{T40}} 2373-72U | ||
+ | | {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || 0.40 || 3.23 || 1RHT71WW-3.04 || | ||
|- | |- | ||
! {{T40p}} | ! {{T40p}} | ||
Line 385: | Line 337: | ||
! {{T41}} | ! {{T41}} | ||
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 3.23 || 3.04 || | | {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 3.23 || 3.04 || | ||
+ | |- | ||
+ | ! {{T41}} | ||
+ | | {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.40 || 3.20 || 3.04 || | ||
+ | |- | ||
+ | ! {{T41}} | ||
+ | | {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.40 || 3.23 || 3.04 || | ||
|- | |- | ||
! {{T41p}} 2373-AM9 | ! {{T41p}} 2373-AM9 | ||
Line 428: | Line 386: | ||
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref] | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref] | ||
|- | |- | ||
− | ! {{T400}} | + | ! {{T400}} |
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt> | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt> | ||
|- | |- | ||
− | ! {{T400s}} | + | ! {{T400s}} |
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 2 || 0.40 || 1.06 || || Requires <tt>invert=2</tt> paramteter to <tt>hdaps</tt> | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 2 || 0.40 || 1.06 || || Requires <tt>invert=2</tt> paramteter to <tt>hdaps</tt> | ||
+ | |- | ||
+ | ! {{T410s}} | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 4 || 0.40 || 1.14 || || Requires <tt>invert=4</tt> accoding to <tt>hdaps-gl</tt> | ||
+ | |- | ||
+ | ! {{T410}} | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.40 || 1.25 || || | ||
|- | |- | ||
! {{T500}} | ! {{T500}} | ||
Line 438: | Line 402: | ||
|- | |- | ||
! {{T510}} | ! {{T510}} | ||
− | | {{ | + | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 1.12 || 1.08 || || |
+ | |- | ||
+ | ! {{T510}} | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 1.35 || 1.17 || || | ||
|- | |- | ||
! colspan=12 style="text-align:center;background:#efefef;" | | ! colspan=12 style="text-align:center;background:#efefef;" | | ||
Line 448: | Line 415: | ||
! {{W700}} 2757-CTO | ! {{W700}} 2757-CTO | ||
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.40 || 2.08 || 1.05 || | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.40 || 2.08 || 1.05 || | ||
+ | |- | ||
+ | ! {{W500}} 4062-4EG | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || 0.40 || {{Cunk}} || {{Cunk}} || | ||
|- | |- | ||
Line 466: | Line 436: | ||
|- | |- | ||
! {{X31}} | ! {{X31}} | ||
− | | {{Cno}} || {{Cno}} || {{Cno}} || {{ | + | | {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || N/A || N/A || 0.40 || 3.02 || || |
|- | |- | ||
! {{X32}} | ! {{X32}} | ||
Line 478: | Line 448: | ||
|- | |- | ||
! {{X41_Tablet}} | ! {{X41_Tablet}} | ||
− | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} | + | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.40 || 75ET60WW (2.06 ) || 75HT20WW (1.02) || |
|- | |- | ||
! {{X60}} | ! {{X60}} | ||
Line 490: | Line 460: | ||
|- | |- | ||
! {{X60s}} 1704-56G | ! {{X60s}} 1704-56G | ||
− | | {{Cyes}} || {{Cyes}} || {{ | + | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cno|text=}} 3 || 0.40 || 7BETD5WW 2.16 || 7BHT40WW 1.13 || |
|- | |- | ||
! {{X61}} 7673-CTO | ! {{X61}} 7673-CTO | ||
− | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{ | + | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 6 || 0.40 || 7NETB9WW (2.19) || 7MHT25WW-1.03 || |
− | |||
− | |||
− | |||
|- | |- | ||
! {{X61}} 7675-4KU | ! {{X61}} 7675-4KU | ||
Line 506: | Line 473: | ||
! {{X61s}} | ! {{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 | | {{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 | ||
+ | |- | ||
+ | ! {{X100e}} | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.40 || 6XET36WW (1.20a) || 6XHT36WW (1.176000) || x100e NTS4UTX, dual-core L625 also works (NTT27MH) | ||
+ | |- | ||
+ | ! {{X120e}} | ||
+ | | {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.41 || 8FET32WW (1.16 ) || {{Cunk}} || model 0596CTO | ||
|- | |- | ||
! {{X200}} | ! {{X200}} | ||
− | | {{Cyes}} || {{Cyes}} || {{ | + | | {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 6DET40WW (2.04 ) || 7XHT22WW 1.04 || |
+ | |- | ||
+ | ! {{X200s}} 7470-X01 | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 5 || 0.40 || 6DET63WW (3.13) || 7XHT24WW 1.06 || | ||
+ | |- | ||
+ | ! {{X201}} | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 / 5 || 0.40 || || ECP: || It said 6 here, but see [http://www.thinkwiki.org/wiki/Talk:Tp_smapi#Wrong_HDAPS_axis_orientation_for_x201 discussion page] | ||
+ | |- | ||
+ | ! {{X201s}} | ||
+ | | {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 5 || 0.40 || 6QET44WW (1.14 ) || ECP: 1.09/1.09 || | ||
+ | |- | ||
+ | ! {{X220}} 4290-2GW | ||
+ | | {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || 0.40 || 8DET46WW (1.16 ) || "unknown" || | ||
+ | |- | ||
+ | ! {{X220}} 4286-CTO | ||
+ | | {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.41 || 8DET54WW (1.24 ) || {{Cunk}} || HDAPS works fine, don't know wich axis orientation thougth || | ||
|- | |- | ||
! {{X300}} | ! {{X300}} | ||
Line 573: | Line 561: | ||
* [[gkrellm-ThinkBat]] - battery status plugin for Gkrellm2 | * [[gkrellm-ThinkBat]] - battery status plugin for Gkrellm2 | ||
* {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module. | * {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module. | ||
+ | |||
+ | ===See also=== | ||
+ | * https://wiki.archlinux.org/index.php/Tp_smapi#Workaround_for_Partially_Supported_Laptops | ||
== Headline text == | == Headline text == |
Latest revision as of 09:29, 1 May 2016
The tp_smapi kernel module exposes some features of the ThinkPad hardware/firmware via a sysfs 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 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. If you are installing on a recent Thinkpad that has an Ivy Bridge or newer processor (X230, T430, T530, etc.), tp_smapi will not work. You will be mostly limited to thinkpad-acpi capabilities. You can however set battery charge thresholds with tpacpi-bat. |
Features
- tp_smapi driver
- Battery charge/discharge control
- Battery status information
- hdaps driver (compared with the standard hdaps driver)
- Improved stability
- Improved model support
- Improved functionality
Project Homepage / Availability
- Project page: http://tpctl.sourceforge.net/
- Download page: http://sourceforge.net/projects/tpctl/files/tp_smapi, a newer version 0.41 is available in a fork at https://github.com/evgeni/tp_smapi which is also available in Debian
- You need to download only the tp_smapi package.
Installation
Installation from source
You will need the kernel headers and makefiles corresponding to your current kernel version. On Fedora, this means # yum install kernel-devel-$(uname -r)
.
# tar xzvf tp_smapi-0.40.tgz
# cd tp_smapi-0.40
Then, either compile and load the driver within the current working directory (for testing):
# make load
OR compile and install into the kernel's module path:
# make install
If you use the HDAPS driver, add HDAPS=1 to also patch the hdaps for compatibility with tp_smapi (this requires a kernel source tree matching the current kernel). Again, either load the driver within the current working directory:
# make load HDAPS=1
OR install into the kernel's module path:
# make install HDAPS=1
To prepare a stand-alone patch against the current kernel tree (including a patch against hdaps and new Kconfig entries):
# make patch
To delete all autogenerated files:
# make clean
The original kernel tree is never modified by any these commands.
The /lib/modules directory is modified only by # make install
.
Installation in Gentoo
The Gentoo portage system carries a 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 hdaps module in your kernel configuration (Device Drivers → Hardware Monitoring Support → IBM Hard Drive Active Protection System)
- Rebuild and install the kernel
- Add the hdaps use flag in /etc/make.conf
# rmmod hdaps
Then:
# emerge tp_smapi
(or install tp_smapi with hdaps support manually, as above)# echo "tp_smapi" >> /etc/modules.autoload.d/kernel-2.6
# echo "hdaps" >> /etc/modules.autoload.d/kernel-2.6
Then reboot, or run:
# modprobe tp_smapi
# modprobe hdaps
NOTE: If # modprobe
fails and dmesg says something about __stack_chk_fail(), you probably just compiled your modules with -fstack-protector and/or -fstack-protector-all without having a kernel that supports it. You can either configure your kernel to have CC_STACKPROTECTOR enabled (in Processor type and features if you use # make menuconfig
) or edit your make.conf (or, if you're using paludis, your /etc/paludis/bashrc) and remove -fstack-protector and -fstack-protector-all from your CFLAGS. If you choose to enable it in the kernel, be aware that you need a patched GCC for it (and I do not know if the gcc in stage3 is patched).
Installation on Debian and Ubuntu
Since Debian 7 Wheezy and Ubuntu 12.04 Precise you can use 'dkms'. (Note: If installation seems ineffective, confirm you have the linux-headers of your kernel installed, purge tp-smapi-dkms and reinstall.)
# apt-get install linux-headers tp-smapi-dkms
# modprobe tp_smapi
Installation on openSUSE
openSUSE provides rpm packages. Look for them at the package search: [1], 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 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:
cp /usr/include/linux/aio_abi.h /lib/modules/`uname -r`/build/include/linux/
Battery charge control features
To set the thresholds for starting and stopping battery charging (in percent of current full charge capacity):
# echo 40 > /sys/devices/platform/smapi/BAT0/start_charge_thresh
# echo 70 > /sys/devices/platform/smapi/BAT0/stop_charge_thresh
# cat /sys/devices/platform/smapi/BAT0/*_charge_thresh
To prevent charging for 17 minutes (regardless of thresholds):
# echo 17 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes
To cancel charging preventation:
# echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes
To force battery discharging (even if connected to AC):
# echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge
To cancel forced discharge:
# echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge
Making the settings permanent on reboot
If you always use the same type of battery, then you may want the same settings to be configured each time you boot the machine.
If you use various types of battery, then you may want to consider writing some scripts to detect the battery type and apply the appropriate settings.
Debian
It is not necessary to create your own init.d script or modify /etc/rc.local - you just need the package sysfsutils:
# apt-get install sysfsutils
Now, put your desired settings in /etc/sysfs.conf:
# cat >> /etc/sysfs.conf << EOF # For a LiIon battery in a Thinkpad devices/platform/smapi/BAT0/start_charge_thresh = 50 devices/platform/smapi/BAT0/stop_charge_thresh = 80 EOF
The init script supplied by sysfsutils will load these settings on each boot.
Battery status features
To view extended battery status such as charging state, voltage, current, capacity, cycle count and model information:
# 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
The raw status data is also available, including some fields not listed above (in case you can figure them out):
# cat /sys/devices/platform/smapi/BAT0/dump
In all of the above, replace BAT0 with BAT1 to address the 2nd battery.
Note that the battery status readout conflicts with the stock hdaps driver, so if you use hdaps you will need to load tp_smapi using # make load HDAPS=1
(see Bundled hdaps driver below).
On ACPI-enabled systems, most of above information is also available through the files under /proc/acpi/battery. However, the ACPI interface does not include the instantaneous power and cycle count readouts, and does not work well when hotswapping UltraBay batteries.
Scripts
Some scripts can make it easier to grep the information you need from tp_smapi
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 hdaps driver
The tp_smapi package includes a modified version of the hdaps Linux kernel driver used by the HDAPS system. It has remained outside the mainline kernel for a few years for several reasons, [2] 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.) [3] [4] [5]
To use tp_smapi and hdaps concurrently, you must use the modified version.
To build the modified version, simply append the HDAPS=1 parameter to the make command (see Installation above):
# make load HDAPS=1
or
# make install HDAPS=1
If you don't do that, you will not be able to load tp_smapi (and its support module thinkpad_ec) when hdaps is loaded, and vice versa. You can use rmmod to switch between these modules.
Note that some of the battery status is also visible through ACPI (/proc/acpi/battery/*), independently of tp_smapi.
The modified hdaps has several changes:
- The hdaps driver in mainline kernels conflicts with the extended battery status (they use the same IO ports). The modified hdaps coordinates this access through the bundled thinkpad_ec driver.
- The modified hdaps 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
thinkpad_ec: cannot claim io ports 0x1600-0x161f
The "thinkpad_ec: cannot claim io ports 0x1600-0x161f!" error message is printed when loading the thinkpad_ec 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 force_io=1 module parameter to thinkpad_ec in /etc/modprobe.conf (or your distribution's equivalent). Add the line:
- options thinkpad_ec force_io=1
For transient testing, load the modules as follows:
# 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: T400, T500, X60s, X61, 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
thinkpad_ec: no ThinkPad embedded controller!
If you get "thinkpad_ec: no ThinkPad embedded controller!" when trying to load the module on a supported model listed below, you should upgrade your BIOS. Some early BIOS (like 1.x on the X31) don't handle the embedded controller.
T60p writing to start_charge_thresh/stop_charge_thresh does not work!
Writing to /sys/devices/platform/smapi/BAT0/start_charge_thresh succeeds, but the older value does not change. Solution: unknown. If you know a solution please update here.
UPDATE: Failure to effectively change sysfs values sometimes happens at boot time (through sysfs.conf OR etc/local.start for instance) when the values have never previously been changed manually (ie using echo from a shell). Try initializing the values manually before including them in boot-time scripting.
Model-specific status
Tip: The thinkpad-acpi module reports both the BIOS and EC firmware versions when it loads.
A series | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Model and machine type | start_ charge_ thresh |
stop_ charge_ thresh |
inhbit_ charge_ minutes |
force_ discharge |
battery status files | Bundled HDAPS | HDAPS axis orientation1 | tp_smapi version | BIOS version | EC firmware version |
Notes | |
A22p 2629-USG | no | no | no | no | no | N/A | N/A | |||||
A30 | no | no | no | no | yes | N/A | N/A | |||||
G series | ||||||||||||
Model and machine type | start_ charge_ thresh |
stop_ charge_ thresh |
inhbit_ charge_ minutes |
force_ discharge |
battery status files | Bundled HDAPS | HDAPS axis orientation1 | tp_smapi version | BIOS version | EC firmware version |
Notes | |
G41 | yes | no | yes | unknown | unknown | N/A | N/A | |||||
R series | ||||||||||||
Model and machine type | start_ charge_ thresh |
stop_ charge_ thresh |
inhbit_ charge_ minutes |
force_ discharge |
battery status files | Bundled HDAPS | HDAPS axis orientation1 | tp_smapi version | BIOS version | EC firmware version |
Notes | |
R31 | no | no | no | no | no | N/A | N/A | No SMAPI BIOS | ||||
R40 | no | no | no | no | unknown | N/A | N/A | |||||
R50 | unknown | no | unknown | unknown | yes | unknown | unknown | |||||
R50e 1834-JAG | yes | no | yes | yes | yes | N/A | N/A | |||||
R50e 1834-5US | yes | no | yes | yes | yes | N/A | N/A | |||||
R50p | no | no | no | no | yes | unknown | unknown | |||||
R51 18* | yes | no | yes | yes | yes | yes | 0 | 0.32 | 3.22 | Machine types 1829, 1830, 1831 and 1836 | ||
R51 28* | yes | no | yes | unknown | yes | unknown | unknown | 1.29 | Machine types 2883, 2887, 2888, 2889, 2894 and 2495 | |||
R52 | yes | yes | yes | yes | yes | yes | 0 | 0.33 | 1.29 | 1.06 | ||
R60 | yes | yes | yes | yes | yes | yes | 1 | 0.33 | ||||
R61 | yes | yes | unknown | unknown | yes | yes | 1 | 0.35-test1 | 7KETA7WW 2.07 | 7KHT24WW 1.08 | Machine type 8918 | |
R61i | yes | yes | yes | yes | yes | yes | 1 | 0.41 | Machine types 7732, 8250 | |||
R400 | yes | yes | yes | yes | yes | yes | 1 | 0.40-1 | Machine type 7443 | |||
R500 | yes | yes | unknown | unknown | yes | unknown | 1 | 0.40-1 | ||||
T series | ||||||||||||
Model and machine type | start_ charge_ thresh |
stop_ charge_ thresh |
inhbit_ charge_ minutes |
force_ discharge |
battery status files | Bundled HDAPS | HDAPS axis orientation1 | tp_smapi version | BIOS version | EC firmware version |
Notes | |
T20 | no | no | no | no | no | N/A | N/A | Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails. | ||||
T22 | no | no | no | no | no | N/A | N/A | Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails. | ||||
T23 | no | no | no | no | yes | N/A | N/A | |||||
T30 | no | no | no | no | yes | N/A | N/A | |||||
T40 | no | no | no | no | yes | N/A | N/A | |||||
T40 2373-72U | no | no | no | no | yes | N/A | N/A | 0.40 | 3.23 | 1RHT71WW-3.04 | ||
T40p | no | no | no | no | yes | N/A | N/A | |||||
T41 | no | no | no | no | yes | unknown | unknown | 0.37 | 3.23 | 3.04 | ||
T41 | no | no | no | no | yes | unknown | unknown | 0.40 | 3.20 | 3.04 | ||
T41 | no | no | no | no | yes | unknown | unknown | 0.40 | 3.23 | 3.04 | ||
T41p 2373-AM9 | no | no | no | no | yes | yes | 1 | 0.32 | 3.20 | v3.04 | ||
T42 | yes | no | yes | yes | yes | unknown | unknown | |||||
T42p 2373-KXU | yes | no | yes | yes | yes | yes | 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 | yes | no | yes | unknown | yes | unknown | unknown | |||||
T43 2686 | yes | yes | yes | yes | yes | yes | 0 | 0.33 | 1.27 | |||
T43p | yes | yes | yes | yes | yes | unknown | 0 | |||||
T60 | yes | yes | unknown | yes | yes | yes | 7 | 0.32 | ||||
T60 | yes | yes | unknown | yes | yes | yes | 1 | 0.34 | ||||
T60 1951-24G | yes | yes | unknown | yes | yes | yes | unknown | 0.36 | 1.09a | |||
T60 2007-FSG | yes | yes | yes | yes | yes | unknown | unknown | 0.39 | 1.10 | 1.05b | ||
T60 1951-CZ1 | yes | yes | yes | yes | yes | yes | 1 | 0.40 | 2.23 | 1.07 | ||
T60p 8743-CTO | yes | yes | yes | yes | yes | yes | 1 | 0.32 | ||||
T61 | yes | yes | yes | yes | yes | yes | 1 | 0.32 | ref | |||
T61p 6457-7XG | yes | yes | yes | yes | yes | yes | 1 | 0.32 | ref | |||
T400 | yes | yes | yes | yes | yes | yes | 1 | 0.40 | 1.19 | Requires force_io=1 parameter to thinkpad_ec | ||
T400s | yes | yes | yes | yes | yes | yes | 2 | 0.40 | 1.06 | Requires invert=2 paramteter to hdaps | ||
T410s | yes | yes | yes | unknown | yes | yes | 4 | 0.40 | 1.14 | Requires invert=4 accoding to hdaps-gl | ||
T410 | yes | yes | yes | yes | yes | yes | 1 | 0.40 | 1.25 | |||
T500 | yes | yes | yes | yes | yes | yes | 1 | 0.40 | 2.07 | Requires force_io=1 parameter to thinkpad_ec | ||
T510 | yes | yes | yes | yes | yes | yes | 7 | 0.40 | 1.12 | 1.08 | ||
T510 | yes | yes | yes | yes | yes | yes | 7 | 0.40 | 1.35 | 1.17 | ||
W series | ||||||||||||
Model and machine type | start_ charge_ thresh |
stop_ charge_ thresh |
inhbit_ charge_ minutes |
force_ discharge |
battery status files | Bundled HDAPS | HDAPS axis orientation1 | tp_smapi version | BIOS version | EC firmware version |
Notes | |
W700 2757-CTO | yes | yes | yes | yes | yes | unknown | unknown | 0.40 | 2.08 | 1.05 | ||
W500 4062-4EG | yes | yes | unknown | unknown | unknown | unknown | unknown | 0.40 | unknown | unknown | ||
X series | ||||||||||||
Model and machine type | start_ charge_ thresh |
stop_ charge_ thresh |
inhbit_ charge_ minutes |
force_ discharge |
battery status files | Bundled HDAPS | HDAPS axis orientation1 | tp_smapi version | BIOS version | EC firmware version |
Notes | |
X22 | no | no | no | no | no | N/A | N/A | no EC controller found | ||||
X24 | no | no | no | unknown | yes | N/A | N/A | |||||
X30 | no | no | no | no | yes | N/A | N/A | 0.34 | 1.09 | |||
X31 | no | no | no | no | yes | N/A | N/A | 0.40 | 3.02 | |||
X32 | no | no | no | no | yes | N/A | N/A | |||||
X40 | yes | yes | yes | yes | yes | yes | 3 | 0.32 | 2.08 | 1.62 | ||
X41 | yes | yes | yes | yes | yes | yes | 3 | 0.32 | ||||
X41 Tablet | yes | yes | yes | yes | yes | yes | 3 | 0.40 | 75ET60WW (2.06 ) | 75HT20WW (1.02) | ||
X60 | yes | yes | yes | yes | yes | yes | 6 | 2.07 | 1.10 | 2.6.20 issue (see discussion) | ||
X60 Tablet | yes | yes | yes | yes | yes | yes | 3 | 0.34 | 7JET25WW (1.10 ) | 7JHT13WW 1.04 | ref ref | |
X60s 1704-5UG | yes | yes | unknown | unknown | unknown | unknown | 3 | 0.34 | 7BETD2WW 2.13 | 7BHT40WW 1.13 | ||
X60s 1704-56G | yes | yes | yes | unknown | yes | unknown | 3 | 0.40 | 7BETD5WW 2.16 | 7BHT40WW 1.13 | ||
X61 7673-CTO | yes | yes | yes | yes | yes | yes | 6 | 0.40 | 7NETB9WW (2.19) | 7MHT25WW-1.03 | ||
X61 7675-4KU | yes | yes | yes | yes | yes | yes | 6 | 0.34 | 7NET30WW (1.11 ) | 7MHT24WW 1.02 | ||
X61 Tablet | yes | yes | unknown | unknown | yes | yes | 6 | 0.32 | ||||
X61s | yes | yes | yes | yes | yes | yes | 6 / 3 | 0.32 | ref says 3 but conflicting report received | |||
X100e | yes | yes | yes | yes | yes | unknown | unknown | 0.40 | 6XET36WW (1.20a) | 6XHT36WW (1.176000) | x100e NTS4UTX, dual-core L625 also works (NTT27MH) | |
X120e | no | yes | yes | no | yes | unknown | unknown | 0.41 | 8FET32WW (1.16 ) | unknown | model 0596CTO | |
X200 | yes | yes | yes | yes | yes | yes | 7 | 0.40 | 6DET40WW (2.04 ) | 7XHT22WW 1.04 | ||
X200s 7470-X01 | yes | yes | unknown | unknown | yes | yes | 5 | 0.40 | 6DET63WW (3.13) | 7XHT24WW 1.06 | ||
X201 | yes | yes | unknown | unknown | yes | yes | 6 / 5 | 0.40 | ECP: | It said 6 here, but see discussion page | ||
X201s | yes | yes | unknown | unknown | yes | yes | 5 | 0.40 | 6QET44WW (1.14 ) | ECP: 1.09/1.09 | ||
X220 4290-2GW | no | no | no | no | no | no | no | 0.40 | 8DET46WW (1.16 ) | "unknown" | ||
X220 4286-CTO | no | yes | yes | no | yes | yes | unknown | 0.41 | 8DET54WW (1.24 ) | unknown | HDAPS works fine, don't know wich axis orientation thougth | |
X300 | yes | yes | yes | unknown | yes | yes | unknown | 0.37 | 7TET25WW (1.02 ) | 7THT15WW 1.00c | ||
Z series | ||||||||||||
Model and machine type | start_ charge_ thresh |
stop_ charge_ thresh |
inhbit_ charge_ minutes |
force_ discharge |
battery status files | Bundled HDAPS | HDAPS axis orientation1 | tp_smapi version | BIOS version | EC firmware version |
Notes | |
Z60m | yes | yes | yes | yes | yes | unknown | unknown | |||||
Z60t | yes | yes | unknown | unknown | yes | unknown | unknown | |||||
Z61m | yes | yes | yes | yes | yes | yes | 0 | 0.32 | ||||
Z61t | yes | yes | yes | yes | yes | yes | unknown | ref | ||||
Z61p | yes | yes | unknown | yes | yes | yes | unknown | |||||
SL series and IdeaPad | ||||||||||||
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. |
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 discussion page. If the module loads but gives a "not supported" or "not implementeded" error when you try to use some specific file in /sys/devices/platform/smapi/, please report the dmesg 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
1 The HDAPS axis orientation is set using the invert module parameter (at load time) or sysfs attribute (at runtime). The hdaps driver of tp_smapi supports all 8 possible sensor orientations (inversion and swapping). You can use hdaps visualisation to check if the settings is correct.
The invert 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 X and Y denote the hardware readouts. Let R denote the laptop's roll (tilt left/right), and let P 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)
Tools using this driver
The driver's interface can be accessed directly through the files under /sys/devices/platform/smapi, or via the following tools:
- KThinkBat - display battery status on the KDE kicker panel.
- gkrellm-ThinkBat - battery status plugin for Gkrellm2
- thinkpad-smapi.sh (download) - script to display various SMAPI information using tp_smapi module.
See also
Headline text
- X230
- T430
- T530
- Fedora
- Gentoo
- T400
- T500
- X60s
- X61
- X301
- A22p
- A30
- G41
- R31
- R40
- R50
- R50e
- R50p
- R51
- R52
- R60
- R61
- R61i
- R400
- R500
- T20
- T22
- T23
- T30
- T40
- T40p
- T41
- T41p
- T42
- T42p
- T43
- T43p
- T60
- T60p
- T61
- T61p
- T400s
- T410s
- T410
- T510
- W700
- W500
- X22
- X24
- X30
- X31
- X32
- X40
- X41
- X41 Tablet
- X60
- X60 Tablet
- X61 Tablet
- X61s
- X100e
- X120e
- X200
- X200s
- X201
- X201s
- X220
- X300
- Z60m
- Z60t
- Z61m
- Z61t
- Z61p
- Drivers
- Patches