Difference between revisions of "Tp smapi"
(→Installation from source: tp_smapi 0.39 released) |
(Tone down the "will eat your babies" warning) |
||
Line 6: | Line 6: | ||
For older ThinkPad models, see also [[tpctl]]. | For older ThinkPad models, see also [[tpctl]]. | ||
− | + | 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=== | ===Features=== |
Revision as of 18:49, 28 September 2008
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. It also includes an improved version of the HDAPS driver. The underlying hardware interfaces are SMAPI and direct access to the embedded controller. For older ThinkPad models, see also tpctl. 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
Project Homepage / Availability
InstallationInstallation from sourceYou will need the kernel headers and makefiles corresponding to your current kernel version. On Fedora, this means
OR compile and install into the kernel's module path:
OR install into the kernel's module path:
To delete all autogenerated files:
The original kernel tree is never modified by any these commands.
The /lib/modules directory is modified only by Installation in GentooThe 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:
Then:
Then reboot, or run:
Installation on Debian unstable (sid) or testing (lenny)Debian now contains the packaged module source and prebuilt modules for Debian kernels. If you use a custom kernel, you can build tp_smapi with module-assistant:
If you use a stock Debian kernel, you can install the tp_smapi modules with:
Installation on Ubuntu HardyUbuntu 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 hdaps module to hdaps_ec. You should load hdaps_ec, not hdaps. Installation on older Ubuntu/DebianInstallation 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): apt-get install build-essential 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: uname -r This will give you the version of your current kernel. Debian users execute the following: apt-get install linux-source-`uname -r` Ubuntu users execute the following using the kernel-version only (exclude -XX-generic; e.g. 'linux-source-2.6.20'): apt-get install linux-source-`uname -r` Be sure to unpack the source file. The easiest way is to open Nautilus as root: sudo nautilus Then browse to /usr/src/ and extract the source file to that directory. Now change to the tp_smapi dir: cd tp_smapi-X.YY(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: root@localhost:~#ls -l /lib/modules/2.6.20-16-generic lrwxrwxrwx 1 root root 28 2007-02-02 08:39 source -> /usr/src/linux-source-2.6.20 Create the link if the line above is not existent: root@localhost:~#ln -s /usr/src/linux-source-2.6.20 /lib/modules/2.6.20-16-generic/source Now the following will build and install the correct modules to their locations: make install HDAPS=1 To make sure your system loads the modules at boot time, do this: echo "tp_smapi" >> /etc/modules echo "hdaps" >> /etc/modules and update your initramfs: update-initramfs -u To get tp_smapi running now, just load the modules: modprobe -a tp_smapi hdaps 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 featuresTo set the thresholds for starting and stopping battery charging (in percent of current full charge capacity):
Hint:
Battery charging thresholds can be used to keep Li-Ion ad Li-Polymer batteries partially charged, in order to increase their lifetime.
To prevent charging for 17 minutes (regardless of thresholds):
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 using an Ultrabay battery.
To cancel charging preventation:
To force battery discharging (even if connected to AC):
Hint:
This can be used to choose which battery is discharged when using an UltraBay battery.
To cancel forced discharge:
Battery status featuresTo 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):
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 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. ScriptsSome scripts can make it easier to grep the information you need from tp_smapi Other featuresThere 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 driverThe tp_smapi package includes a modified version of the hdaps Linux kernel driver used by the HDAPS system. 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):
or
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:
TroubleshootingIf 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. Model-specific status
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 orientation1 The HDAPS axis orientation is set using the invert module parameter (at load time) or sysfs attribute (at runtime). The tp_smapi's hdaps driver supports all 8 possible sensor orientations (inversion and swapping). You can use hdaps visualisation to check if the settings is correct. invert is an integer between 0 and 7, whose meaning is as follows. 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 driverThe driver's interface can be accessed directly through the files under /sys/devices/platform/smapi, or via the following tools:
|