Tp smapi

2007-01-29T05:27:39Z

Meister Eder: /* Installation from source */

{| 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 underlfying hardware interfaces are [[SMAPI support for Linux|SMAPI]] and direct access to the embedded controller.

For older ThinkPad models, see also [[tpctl]].

{{WARN|This driver uses undocumented features and direct hardware access. It thus cannot be guaranteed to work and could conceivably damage your computer (though so far no incidents have been reported).}}

|}

===Features===
*Battery charge/discharge control
*Battery status information
*PCI bus power saving control

===Project Homepage / Availability===
* Project page: http://tpctl.sourceforge.net/
* You need to [http://sourceforge.net/project/showfiles.php?group_id=1212&package_id=171579 download] only the <tt>tp_smapi</tt> package. Versions containing <tt>-test</tt> are experimental, others are stable.

===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)}} .

For testing, you can simply compile and load the driver within the current
working directory:
:{{cmdroot|tar xzvf tp_smapi-0.30.tgz}}
:{{cmdroot|cd tp_smapi-0.30}}
:{{cmdroot|make load}}

To 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):
:{{cmdroot|1=make load HDAPS=1}}
or, to compile and 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}}.

''Comment: I had to install the complete kernel source tree to make it work (Edgy, T43)''

====Installation in Gentoo====
The {{Gentoo}} portage system carries a [http://packages.gentoo.org/packages/?category=app-laptop;name=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:

* Configure <tt>hdaps</tt> as module in your 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}}

===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 unconditionally inhibit charging for 17 minutes:
:{{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 a 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 charge inhibiting:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}

To force battery discharging even if connected to AC, use one of these:
:{{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 [[#Conflict_with_hdaps|Conflict with hdaps]] 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]].

===Other features===

This controls the "PCI bus power saving" option in the BIOS, and takes effect at the next boot. On a ThinkPad {{T43}} turning this off increases idle power consumption by about 350mW. Out-of-the-box default is 1.
# cat /sys/devices/platform/smapi/enable_pci_power_saving_on_boot
# echo 1 > /sys/devices/platform/smapi/enable_pci_power_saving_on_boot # on
# echo 0 > /sys/devices/platform/smapi/enable_pci_power_saving_on_boot # off

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 charge stop threshold.

===Conflict with <tt>hdaps</tt>===
The extended battery status function conflicts with the [[HDAPS|hdaps]] kernel module (they use the same IO ports). The <tt>tp_smapi</tt> package includes a patch against <tt>hdaps</tt> to make it compatible with <tt>tp_smapi</tt>, and also to fix many problems in the original driver.

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

If you don't do that, you will not be able tp load <tt>tp_smapi</tt> (and its support module <tt>tp_base</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>.

===Model-specific status===

<div style="font-size: 92%">
{| border="1" cellspacing="0" cellpadding="2"
|+<tt>tp_smapi</tt> feature support matrix
|-
! ×
! <tt>start_charge_<br />thresh</tt>
! <tt>stop_charge_<br />thresh</tt>
! <tt>inhbit_charge_<br />minutes</tt>
! <tt>force_discharge</tt>
! battery status files
! <tt>cd_speed</tt><br \><span style="font-size: 90%">(removed)</span>
! Notes
|-
! colspan=8 style="text-align:center;background:#efefef;" |
=====A series=====
|-
! {{A22p}} 2629-USG
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} ||
|-
! {{A30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} ||
|-
! colspan=8 style="text-align:center;background:#efefef;" |
=====G series=====
|-
! {{G41}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||
|-
! colspan=8 style="text-align:center;background:#efefef;" |
=====R series=====
|-
! [[:Category:R31|R31]]
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || No SMAPI BIOS
|-
! {{R40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} ||
|-
! {{R50}}
| {{Cunk}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{R50e}} 1834-JAG
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} ||
|-
! {{R51}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||
|-
! {{R60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} ||
|-

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

=====T series=====
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T23}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} ||
|-
! {{T30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} ||
|-
! {{T40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cyes}} ||
|-
! {{T40p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} ||
|-
! {{T41}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} ||
|-
! {{T41p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} ||
|-
! {{T42}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||
|-
! {{T42p}} 2373-KUU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{T43}} 2686-DGU
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||
|-
! {{T43p}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} ||
|-
! colspan=8 style="text-align:center;background:#efefef;" |

=====X series=====
|-
! {{X20}} 2662-31G
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || tp_smapi 0.20
|-
! {{X24}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{X31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{X32}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} ||
|-
! {{X40}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || BIOS v2.03, EC v1.60
|-
! {{X41}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} ||
|-
! {{X60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! colspan=8 style="text-align:center;background:#efefef;" |

=====Z series=====
|-
! {{Z60m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} ||
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{Z61m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||
|-
! {{Z61t}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||
|}
</div>

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>" 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]].

[[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

ThinkWiki - User contributions [en]

Tp smapi