Difference between revisions of "SMAPI support for Linux"

From ThinkWiki
Jump to: navigation, search
(Optical drive control features)
 
(41 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
ThinkPad laptops include a proprietary interface called SMAPI BIOS (System Management Application Program Interface) which provides some
 
ThinkPad laptops include a proprietary interface called SMAPI BIOS (System Management Application Program Interface) which provides some
hardware control functionality that is not exposed by any other interface (e.g., ACPI).
+
hardware control functionality that is not exposed by standard interfaces such as ACPI and APM.
 
 
The SMAPI interfaces changes a lot between models, and is poorly documented, so Linux support is not exhaustive for most models. There are currently two SMAPI access mechanisms available: <tt>thinkpad</tt> and <tt>tpctl</tt> for older ThinkPads, and <tt>tp_smapi</tt> for newer ones.
 
 
 
{{WARN|These drivers use undocumented features and direct hardware access. They thus cannot be guaranteed to work, and may cause arbitrary damage
 
(especially on models they weren't tested on).}}
 
 
 
==Using the <tt>tp_smapi</tt> module==
 
 
 
The <tt>tp_smapi</tt> kernel module exposes some features of the SMAPI BIOS found on recent ThinkPads via a sysfs interface. Currently, the  implemented functionality is control of battery charging (this is useful for [[Maintenance#Battery_Treatment|increasing battery lifetime]] or for using a leftover under-spec power supply that can't handle the combined power draw of running and charging), and control of CD/DVD speed.
 
 
 
* Project page: http://tpctl.sourceforge.net/
 
* You need to donwnload only the [http://sourceforge.net/project/showfiles.php?group_id=1212&package_id=171579 tp_smapi kernel module].
 
 
 
====Installation====
 
 
 
To compile and load the module:
 
 
 
# tar xzvf tp_smapi-0.12.tgz
 
# cd tp_smapi-0.12
 
# make load
 
 
 
To install permanently (optional):
 
 
 
# make install
 
# modprobe tp_smapi
 
 
 
====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
 
40
 
70
 
 
 
To unconditionally inhibit charging for 17 minutes:
 
 
 
# echo 17 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes
 
 
 
To cancel charge inhibiting:
 
 
 
# echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes
 
 
 
To force battery discharging even if connected to AC, use one of these:
 
 
 
# echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge1
 
# echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge2
 
 
 
(Probably only one of these will work on your laptop; please check the dmesg output to see which one, and update the status below.)
 
 
 
To cancel forced disharge, use one of these:
 
 
 
# echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge1
 
# echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge2
 
 
 
 
 
====Battery status features====
 
 
 
To view exteded battery status (see below about conflict with <tt>hdaps</tt>):
 
 
 
<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/serial
 
# cat /sys/devices/platform/smapi/BAT0/barcoding
 
# cat /sys/devices/platform/smapi/BAT0/chemistry
 
# cat /sys/devices/platform/smapi/ac_connected
 
</pre>
 
 
 
The raw status data, including some fields not in the above (in case
 
you can figure them out):
 
 
 
# 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.
 
 
 
====Optical drive control features====
 
 
 
To control the speed of the optical drive:
 
# echo 0 yes_crash_my_computer > /sys/devices/platform/smapi/cd_speed # slow
 
# echo 1 yes_crash_my_computer > /sys/devices/platform/smapi/cd_speed # medium
 
# echo 2 yes_crash_my_computer > /sys/devices/platform/smapi/cd_speed # fast
 
# cat /sys/devices/platform/smapi/cd_speed
 
2
 
{{WARN|Changing the CD speed simultaneously with a read or write to the CD will '''hang your computer'''. This feature is thus disabled by default, but can be enabled using <tt>#define PROVIDE_CD_SPEED</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 [http://safari.iki.fi/speedcontrol.c speedcontrol -x num] 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]].}}
 
 
 
====Other features====
 
 
 
Other things that can be controlled through SMAPI, but are not supported in this version of the driver, include forcing battery discharge, PCI bus power saving, CPU power saving control and fan control. 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). If you load <tt>hdaps</tt> first, <tt>tp_smapi</tt> will disable its battery status functions (and log a message in the kernel log). If you load <tt>tp_smapi</tt> first, <tt>hdaps</tt> will refuse to load. Use <tt>rmmod</tt> to switch between the two.
 
 
 
Some of the battery status is also visible through ACPI ({{path|/proc/acpi/battery/*}}).
 
 
 
The charging control files (<tt>*_charge_thresh</tt> and <tt>inhibit_charge_minutes</tt>) don't have this problem.
 
 
 
====Model-specific status====
 
 
 
{| border="1" cellpadding="2"
 
|+<tt>tp_smapi</tt> feature support matrix
 
|-
 
! &times;
 
! <tt>start_charge_<br />thresh</tt>
 
!          <tt>stop_charge_<br />thresh</tt>
 
!                      <tt>inhbit_charge_<br />minutes</tt>
 
!                                  <tt>cd_speed</tt>
 
!                                                <tt>force_<br />discharge1</tt>
 
!                                                          <tt>force_<br />discharge2</tt>
 
!                                                                    battery status files<br \><font size="-2">(see notice about <tt>hdaps</tt> above)</font>
 
|-
 
! {{G41}}
 
| {{Cyes}} || {{Cno}}  || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{R40}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{R50p}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cyes}} || {{Cno}} || {{Cno}} || {{Cyes}}
 
|-
 
! {{R51}}
 
| {{Cyes}} || {{Cno}}  || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{R52}}
 
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{T40}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}}
 
|-
 
! {{T40p}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cyes}} || {{Cno}}  || {{Cno}}  || {{Cyes}}
 
|-
 
! {{T41}}
 
| {{Cyes}} || {{Cno}}  || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{T41p}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{T42}}
 
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno}} || {{Cyes}}
 
|-
 
! {{T42p}}
 
| {{Cyes}} || {{Cno}}  || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{T43}}
 
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno}}  || {{Cyes}}
 
|-
 
! {{T43p}}
 
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno}} || {{Cyes}}
 
|-
 
! {{X24}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}}
 
|-
 
! {{X31}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}}
 
|-
 
! {{X32}}
 
| {{Cno}}  || {{Cno}}  || {{Cno}}  || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|-
 
! {{X40}}
 
| {{Cyes}} || {{Cno}}  || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}}
 
|-
 
! {{X41}}
 
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}}
 
|}
 
 
 
Please update the above and report your experience on the [[Talk:SMAPI support for Linux|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.
 
 
 
==Using the <tt>thinkpad</tt> module==
 
 
 
This solution consists of a module, called <tt>thinkpad</tt>, and a user-space tool caled <tt>tpctl</tt>. It provides very rich functionality for older ThinkPads, but on newer ThinkPads much of this functionality is exposed and supported through an ACPI interface and the SMAPI access does not work anymore. Kernel 2.6.9 and newer is unsupported; for kernel 2.6.3 and newer you need <tt>tpctl</tt> >=4.14 and <tt>thinkpad </tt> >=5.5. For details, see the [http://tpctl.sourceforge.net/README README] and [http://tpctl.sourceforge.net/SUPPORTED-MODELS list of supported models].
 
 
 
* Project page: http://tpctl.sourceforge.net/
 
* You need to download the [http://sourceforge.net/project/showfiles.php?group_id=1212&package_id=29354t thinkpad module] and [http://sourceforge.net/project/showfiles.php?group_id=1212&package_id=1204 tpctl userspace tool].
 
* There is also an optional GUI: [http://sourceforge.net/project/showfiles.php?group_id=1212&package_id=99929 configure-thinkpad].
 
  
 +
The SMAPI interfaces has mutated between models and is poorly documented, so Linux support is not exhaustive for most models. There are currently two SMAPI access mechanisms available:
 +
*[[tp_smapi]] for newer ThinkPad models. This module provides battery information for models produced since 2001 and possibly earlier, and additional features for models produced since 2003.
 +
*[[tpctl]] with the <tt>thinkpad</tt> kernel modules worked on older ThinkPad models but are now obsolete: the drivers no longer build (with the latest Linux versions). On modern ThinkPads tpctl has been superseded by the standardized ACPI subsystem and the tp_smapi driver.
  
 
[[Category:Tools]] [[Category:Patches]]
 
[[Category:Tools]] [[Category:Patches]]

Latest revision as of 19:04, 7 January 2008

ThinkPad laptops include a proprietary interface called SMAPI BIOS (System Management Application Program Interface) which provides some hardware control functionality that is not exposed by standard interfaces such as ACPI and APM.

The SMAPI interfaces has mutated between models and is poorly documented, so Linux support is not exhaustive for most models. There are currently two SMAPI access mechanisms available:

  • tp_smapi for newer ThinkPad models. This module provides battery information for models produced since 2001 and possibly earlier, and additional features for models produced since 2003.
  • tpctl with the thinkpad kernel modules worked on older ThinkPad models but are now obsolete: the drivers no longer build (with the latest Linux versions). On modern ThinkPads tpctl has been superseded by the standardized ACPI subsystem and the tp_smapi driver.