Tp smapi

2006-07-25T13:46:20Z

Orden: /* Z series */

{| 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's [[SMAPI support for Linux|SMAPI]] functionality via a <tt>sysfs</tt> interface. Currently, the implemented functionality is control of battery charging, extended battery status and control of CD/DVD speed (disabled by default).

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

{{WARN|This driver uses undocumented features and direct hardware access. It thus cannot be guaranteed to work, and may cause arbitrary damage (though so far none was reported).}}

|}

===Features===
*Battery charge/discharge control
*Battery status information
*Optical drive speed control (disabled by default)

===Project Homepage / Availability===
* Project page: http://tpctl.sourceforge.net/
* You need to download only the [http://sourceforge.net/project/showfiles.php?group_id=1212&package_id=171579 tp_smapi kernel module].

===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.22.tgz}}
:{{cmdroot|cd tp_smapi-0.22}}
:{{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 compatibility fixes to <tt>hdaps</tt> and <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/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}}

====Installation on Debian/Ubuntu====

<pre>
deb http://www.oakcourt.dyndns.org/debian/ ./
deb-src http://www.oakcourt.dyndns.org/debian/ ./
</pre>

This repository has kernel-patch packages for tp_smapi. This will not only integrate tp_smapi into your kernel build but will patch the hdaps driver for you. It is available for kernel 2.6.15 and later. Also available is an init script to automatically set SMAPI paramaters at boot--this is in package tpsmapi-utils. Please report any bugs to [[User:Ajbarr]]

===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_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/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]].

===Optical drive control features===

To control the speed of the optical drive:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/cd_speed # slow}}
:{{cmdroot|echo 1 > /sys/devices/platform/smapi/cd_speed # medium}}
:{{cmdroot|echo 2 > /sys/devices/platform/smapi/cd_speed # fast}}
:{{cmdroot|cat /sys/devices/platform/smapi/cd_speed}}

=====Enabling this feature=====
Changing the drive speed when a disc is being accessed will hang your computer. This feature is thus '''disabled by default''', but can be enabled using by adding <tt>#define PROVIDE_CD_SPEED</tt> at the top of <tt>tp_smapi.c</tt>. The safe way to set the drive speed is using <tt>hdparm -E num</tt> or <tt>eject -x num</tt> for CD-ROM, and <tt>speedcontrol -x num</tt> (sourcecode [http://safari.iki.fi/speedcontrol.c here]) for DVD. For kernels older than 2.6.15, this may require the [[Problems_with_SATA_and_Linux#No_SMART_support libata pass-through|libata pass-through patch]].

===Features not yet implemented===
Other things that can be controlled through SMAPI, but are not supported in this version of the driver, include PCI bus power saving, CPU power saving control and fan control (the latter is available through an [[How to control fan speed|alternative method]]). See the included README file for more information.

===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>. To build the patched version, 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>.

Some new ThinkPad models are not recognized by the built-in whitelist, so you will need to add the <tt>force=1</tt> module parameter to <tt>hdaps</tt> (this option is added by the <tt>tp_smapi</tt> patch to <tt>hdaps</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_ thresh</tt>
! <tt>stop_charge_ thresh</tt>
! <tt>inhbit_charge_ minutes</tt>
! <tt>force_discharge</tt>
! battery status files
! <tt>cd_speed</tt> (see [[#Enabling_this_feature|note]] above)
! Notes
|-
! colspan=8 style="text-align:center;background:#efefef;" |
=====A series=====
|-
! {{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}} ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} ||
|-
! {{R51}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||
|-
! colspan=8 style="text-align:center;background:#efefef;" |
=====T series=====
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} ||
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} ||
|-
! {{T23}}
| {{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}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{T43}}
| {{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=====
|-
! {{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}} ||
|-
! colspan=8 style="text-align:center;background:#efefef;" |
=====Z series=====
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} ||
|-
! {{Z61m}}
| {{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

List of DMI IDs

2006-07-24T15:14:19Z

Orden: /* DMI ID database */

This page maintains a database of [http://en.wikipedia.org/wiki/Desktop_Management_Interface DMI] information which can be used to identify ThinkPad models. It is intended as an aid for driver development.

==DMI ID database==

{| border="1" cellspacing="0" cellpadding="2"
|-
! Model
! <tt>system- manufa cturer</tt>
! <tt>system- product-name</tt>
! <tt>system- version</tt>
! <tt>baseboard- manufa cturer</tt>
! <tt>baseboard- product-name</tt>
! <tt>baseboard- version</tt>
! <tt>chassis- manufa cturer</tt>
! <tt>chassis- version</tt>
! <tt>bios- vendor</tt>
! <tt>bios- version</tt>
! <tt>bios- release- date</tt>
! Embedded controller
! Notes
|-
! colspan=14 style="text-align:center;background:#efefef;" | A series
|-
| {{A22p}} 2629-USG
|| IBM || 2629USG || Not Available || IBM || 2629USG || Not Available || IBM || Not Available || IBM || KYET36WW (1.09a) || 10/17/2002
|| ''unknown'' ||
|-
! colspan=14 style="text-align:center;background:#efefef;" | R series
|-
| {{R52}} 1846-AQG
|| IBM || 1846AQG || ThinkPad H || IBM || 1846AQG || Not Available || IBM || Not Available || IBM || 76ET58WW (1.18 ) || 07/19/2005
|| <nowiki> String 1: IBM ThinkPad Embedded Controller -[76HT14WW-1.04 ]-</nowiki> || Note the weird system-version
|-
| {{R52}} 1846-AQG
|| IBM || 1846AQG || ThinkPad R52 || IBM || 1846AQG || Not Available || IBM || Not Available || IBM || 76ET65WW (1.25 ) || 05/18/2006|| <nowiki> String 1: IBM ThinkPad Embedded Controller -[76HT16WW-1.06 ]-</nowiki> ||
|-
| {{R51}} 1829-9MG
|| IBM || 18299MG || ThinkPad R51 || IBM || 18299MG || Not Available || IBM || Not Available || IBM || 1RETDOWW (3.20 ) || 02/ 27/2006
|| <nowiki> String 1: IBM ThinkPad Embedded Controller -[1RHT71WW-3.04 ]-</nowiki> ||
|-
! colspan=14 style="text-align:center;background:#efefef;" | T series
|-
| {{T40}} 2378-D2U
|| IBM || 2378D2U || ThinkPad T40 || IBM || 2378D2U || Not Available || IBM || Not Available || IBM || 1RETC2WW (3.03 ) || 04/07/2004
|| <nowiki></nowiki> ||
|-
| {{T41}} 23732FG
|| IBM || 23732FG || ThinkPad T41 || IBM || 23732FG || Not Available || IBM || Not Available || IBM || 1RET84WW (2.11 ) || 10/30/2003
|| <nowiki></nowiki> ||
|-
| {{T43}} 2686-DGU
|| IBM || 2686DGU || ThinkPad T43 || IBM || 2686DGU || Not Available || IBM || Not Available || IBM || 1YET62WW (1.27 ) || 05/18/2006
|| String 1: IBM ThinkPad Embedded Controller -[1YHT29WW-1.06 ]- ||
|-
| {{T60p}} 2007-83U
|| LENOVO || 200783U || ThinkPad T60p || LENOVO || 200783U || Not Available || LENOVO || Not Available || LENOVO || 79ET60WW (1.05a) || 04/18/2006 || <nowiki> String 1: IBM ThinkPad Embedded Controller -[79HT43WW-1.02 ]-</nowiki> ||
|-
! colspan=14 style="text-align:center;background:#efefef;" | X series
|-
| {{X60}} 1709-47U
|| LENOVO || 170947U || ThinkPad X60 || LENOVO || 170947U || Not Available || LENOVO || Not Available || LENOVO || 7BET44WW (1.04 ) || 03/13/2006
|| <nowiki> String 1: IBM ThinkPad Embedded Controller -[7BHT29WW-1.02 ]-</nowiki> ||
|-
| {{X60s}} 1702-55G
|| LENOVO || 170255G || ThinkPad X60s || LENOVO || 170255G || Not Available || LENOVO || Not Available || LENOVO || 7BET44WW (1.04 ) || 03/13/2006
|| <nowiki> String 1: IBM ThinkPad Embedded Controller -[7BHT29WW-1.02 ]-</nowiki> ||
|-
! colspan=14 style="text-align:center;background:#efefef;" | Z series
|-
| {{Z61m}} 9453-A11
|| LENOVO || 9453A11 || ThinkPad Z61m || LENOVO || 9453A11 || Not Available || LENOVO || Not Available || LENOVO || 7FET48WW (1.08 ) || 05/26/2006
|| <nowiki> String 1: IBM ThinkPad Embedded Controller -[7FHT21WW-1.03 ]-</nowiki> ||
|}

==Adding entries==

Edit the [[#DMI_ID_database|DMI ID database]] section above. Identify your series (or add a new one), and add an entry of the following form:
:<tt>!-</tt>
:<tt>| </tt>description of your model
:data line 1
:data line 2

where the two data lines are genereated by the following <tt>bash</tt> command:

<pre>
for X in system-{manufacturer,product-name,version} \
baseboard-{manufacturer,product-name,version} \
chassis-{manufacturer,version} bios-{vendor,version,release-date}; do \
echo -n "|| `sudo /usr/sbin/dmidecode -s $X` "; done; echo; \
echo "|| <nowiki><nowiki>`sudo /usr/sbin/dmidecode | grep -i 'embedded controller'`</nowiki></nowiki> ||"
</pre>

==Software using ThinkPad DMI IDs==
* [[HDAPS]] driver whitelist
* [[tp_smapi]] driver whitelist

ThinkWiki - User contributions [en]

Tp smapi

List of DMI IDs