ThinkWiki - User contributions [en]

How to control fan speed

2008-08-13T21:01:45Z

Pavel: /* Supported models */

This page discusses methods for controlling the system fan.

{| width="100%" columns="2"
|style="vertical-align:top;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |

{{WARN|When designing fan-control applets, never ignore a valid thermal sensor.

Even if it seems to be stuck at a certain temperature, you must take that sensor into account. While it will probably make the fan spin faster than if the sensor was ignored, that's exactly what would happen when the fan is under EC control, and could very well be the reason for the "stuck" value in the first place.

Always play it safe. If a battery pack seems to want the fan to always run faster, the only safe thing to do is to make it run faster.}}
|}

==For Linux==
===Using a patched kernel===
{{NOTE|The ibm-acpi driver is part of the Linux kernel 2.6.10 and later (option CONFIG_ACPI_IBM), so patching is not needed anymore.}}
{{WARN|This patch is superceded by the patches in [[ibm-acpi]] [[Git]] repository or [http://ibm-acpi.sourceforge.net ibm-acpi.sf.net] releases}}
{{NOTE|Advanced fan control through ibm-acpi has been merged in Linux 2.6.20-rc2 mainline, so users of 2.6.20 won't need to patch their kernels to get the '''fan level''' functionality anymore}}

The [[Patch for controlling fan speed]] provides a convenient interface via {{path|/proc/acpi/ibm/fan}}.

Manual speed control can be done through the [[patch for controlling fan speed]]:

'''#cat /proc/acpi/ibm/fan'''
status: enabled
level: auto
speed: 4219
commands: enable, disable, level <level>
(<level> is 0-7, auto or disengaged)

'''#echo level 2 > /proc/acpi/ibm/fan'''

'''#cat /proc/acpi/ibm/fan'''
status: enabled
level: 2
speed: 3142
commands: enable, disable, level <level>
(<level> is 0-7, auto or disengaged)

===Using a stock kernel===

{{NOTE|Fan control operations are disabled by default for safety reasons.}}

'''Linux Kernel 2.6.22 and Above (ibm-acpi has been replaced by [[thinkpad-acpi]])'''

To enable fan control, the module parameter <tt>fan_control=1</tt> must be given to thinkpad-acpi.

For example, in Ubuntu 8.04 (Hardy Heron), add the following to {{path|/etc/modprobe.d/options}}: <tt>options thinkpad_acpi fan_control=1</tt>

Having done so, reboot and you can use the following commands to control fan speed:

{{cmdroot|echo level 0 > /proc/acpi/ibm/fan}} (fan off)

{{cmdroot|echo level 2 > /proc/acpi/ibm/fan}} (low speed)

{{cmdroot|echo level 4 > /proc/acpi/ibm/fan}} (medium speed)

{{cmdroot|echo level 7 > /proc/acpi/ibm/fan}} (maximum speed)

{{cmdroot|echo level auto > /proc/acpi/ibm/fan}} (automatic - default)

{{cmdroot|echo level disengaged > /proc/acpi/ibm/fan}} (disengaged)

'''Older Linux Kernels (using [[ibm-acpi]])'''

To enable fan control, the module parameter <tt>experimental=1</tt> must be given to ibm-acpi. Then, you can control the fan by directly writing to the relevant embedded controller register, {{path|/proc/acpi/ibm/ecdump}}.

For example:

{{cmdroot|echo 0x2F 0x00 > /proc/acpi/ibm/ecdump}} (fan off)

{{cmdroot|echo 0x2F 0x02 > /proc/acpi/ibm/ecdump}} (low speed)

{{cmdroot|echo 0x2F 0x04 > /proc/acpi/ibm/ecdump}} (medium speed)

{{cmdroot|echo 0x2F 0x07 > /proc/acpi/ibm/ecdump}} (maximum speed)

{{cmdroot|echo 0x2F 0x80 > /proc/acpi/ibm/ecdump}} (automatic - default)

{{cmdroot|echo 0x2F 0x40 > /proc/acpi/ibm/ecdump}} (disengaged)

See the specifications below for the meaning of these modes.

===On/off control using stock kernel===

If you only wish to turn the fan on and off (with automatic control when it's on), you can use the following.

When loading [[ibm-acpi]] v0.11 with experimental switch ({{cmdroot|1=modprobe ibm_acpi experimental=1}}), it is possible to read and write the status of fan:

'''#cat /proc/acpi/ibm/fan'''
status: enabled
speed: 3580
commands: enable, disable

'''#echo disable > /proc/acpi/ibm/fan'''

'''cat /proc/acpi/ibm/fan'''
status: disabled
speed: 0
commands: enable, disable

When off, the fan will then '''never''' wake up. It is advised to use an automated control script to reduce the chance of hardware damage.

===Automated control scripts===

An [[ACPI fan control script#Variable speed control scripts|ACPI fan control script]] can be used to override the firmware's fan algorithm with gentler, quieter version. It monitors the laptop's [[thermal sensors]] and sets the fan speed accordingly, according to customizable thresholds. For the default behavior, simply save {{CodeRef|tp-fancontrol}} as {{path|tp-fancontrol}}, make sure you've loaded [[thinkpad-acpi]] with the "fan_control=1" parameter, and run:<br />
{{cmdroot|./tp-fancontrol}}

There is an distro independent daemon (http://projekte.f4.fhtw-berlin.de/trac/s0332819-linuxtools/wiki/), written in python. Packages are available for debian based linux systems.

[http://www.gambitchess.org/moin.py/ThinkPad_Fan_Control A GTK GUI program (packaged for Ubuntu 7.10 and 8.04)] may also help.

===Automated program - Simple ThinkPad Fan Control===
Written by Stanko, stanko [at] mfhinc [dot] net

This is program for controlling fans speed on IBM/Lenovo ThinkPads. It is written
for Linux only. This program is written in C, using GTK GUI.

You are required to have the Linux kernel with 'thinkpad-acpi' patch.
You must also enable manual control for your fans. For Linux 2.6.22 and above,
you must add 'fan_control=1' as a module parameter to 'thinkpad-acpi'.
For example, in Debian Lenny (and Ubuntu 8.04), you must add the following
to "/etc/modprobe.d/options":
options thinkpad_acpi fan_control=1

Having done so, reboot. Now you'll be able to use this program easily.

Here is screenshot:
[[Image:Tpfc.png|none]]

and direct download (src + i386 32bit binary). Please read README.txt file
included in package. [[http://stanko.mfhinc.net/projects/tpfc/tpfc0.5.tar.gz tpfc0.5.tar.gz]]

I wrote this for my own personal use, and thought that it would be a good idea
to release it to the world, and hope that it will be useful to someone!
Feel free to send comments, bug reports or a thanks to the e-mail above.

==For Windows==

Shimodax's ThinkPad fan control tool offers similar functionality (see [http://forum.thinkpads.com/viewtopic.php?t=17715 forum discussion] at thinkpads.com). Source and binaries are available through the [http://sourceforge.net/projects/tp4xfancontrol "Tp4xFanControl"] project on SourceForge.

==Hardware specs==

The following hardware behavior was discovered experimentally by [[User:Thinker|Thinker]] and neither provided by nor confirmed by IBM/Lenovo. The following description may be inaccurate and may vary by model (see list of models above). The terminology probably does not match the one used by IBM/Lenovo engineers.

{{NOTE|Information on other models is included in the [[ibm-acpi]] [[Git]] version.}}
{{NOTE|1=The ThinkPad {{X61s}} and {{X61}} with WWAN have a [http://forum.notebookreview.com/showthread.php?t=141931 second system fan]; its interface is currently unknown.}}

ACPI DSDT register HFSP (8 bits, offset 0x2F in the <tt>EmbeddedController</tt> address space, accessed through the standard EC interface at IO ports 0x62 and 0x66) is read/writable and has the following meaning:

Bits 7 6 5 4 3 2 1 0
---------------
Value 1 0 * * * * * * - automatic
* 1 * * * * * * - disengaged
0 0 N N N N N N - manual (0..63; 0=disable fan, 1=min, ..., 7=max)

Changing modes may not be immediate on all ThinkPads. Later ThinkPad models seem to take at least 5s to start responding to a fan mode change, for example.

After boot, the HFSP register may not reflect the true state of the EC (on some models it reads 0x07 even though the EC is actually in automatic mode).

=== Fan Tachometer ===

The embedded controller registers 0x84 (LSB), 0x85 (MSB) are the main fan tachometer, and report fan speed in RPM in everything since the {{A31}} and maybe a little earlier. Not much is know about the tachometer in earlier models, or even whether they had one or not.

=== Automatic mode ===
In ''automatic'' mode, the embedded controller sets the fan speed automatically according to system temperatures and some unknown algorithm.

Note that the ACPI DSDT may supplement this in some models. The {{X40}}, for example, changes the profile of speeds the automatic mode should use depending on battery status.

=== Manual mode ===

In ''manual'' mode, the fan level is forced to the given value and the EC will auto-regulate the fan to maintain at a (roughly) constant RPM, which is model-dependent. Manual speed levels 8-63 yield the same behavior as level 7, and the the ACPI DSDT uses level 7 for the emergency mode it enters upon critical CPU/GPU temperature, so apparently 7 is the real maximum level.

=== Disengaged (full-speed) mode ===

In ''disengaged'' mode, the embedded controller does not monitor the fan speed. It "disengages" the closed-loop control function that keeps track of fan speed, and uses an open-loop control function that ramps up the fan to its maximum speed (100% duty-cycle). The end speed is not stable, but it is often much faster than the maximum speed manual and automatic modes would set the fan to.

Most newer ThinkPads take quite a while (in excess of one minute) to fully enter disengaged mode. Exiting it is much faster. The {{A31}} acts differently, and switches to disengaged mode as fast as it switches to other modes.

For some reason, the embedded controller may stop updating the tachometer registers while entering or exiting disengaged mode in some ThinkPad firmware versions (hence the EC tachometer registers will not be updated on these models while entering/exiting disengaged mode). Once it arrives at maximum speed, or once it gets back at closed-loop cruise speed, the embedded controller starts updating the tachometer registers again. Later T models such as the {{T43}} have this problem, while the {{A31}} does not.

{{HINT|Apparently the [[Problem with fan noise|pulsing fan noise]] experienced by some users can be cured by repeatedly running 2-4 seconds of manual control followed by 0.5-1 seconds of disengaged mode. The pulse occurs when the the embedded controller computes the fan speed and adjusts the fan voltage adaptively every few seconds (~4.8sec for the ThinkPad T43); the aforementioned mode switching doesn't give it a chance to do so. One of the [[ACPI fan control script#Variable speed control scripts|ACPI fan control scripts]] implements this solution.}}

==Supported models==

The above was successfully tested on the following models:

* ThinkPad {{A31}} (fan levels RPM: 0 = off, 1-2 = ~3280-3380 (!), 3-5 = ~3200, 6-7 = ~3380, "disengaged" = ~4000 (see NOTE above))
* ThinkPad {{R50}} (highest manual level is 3; disengage mode works and reaches much higher RPM)
* ThinkPad {{R50p}} (fan levels RPM: 0 = off, 1-2 = ~3200, 3-5 = ~3500-3600, 6-7 = ~3700-3800, disengaged = ~5300)
* ThinkPad {{R51}} (fan levels RPM: 0 = off, 1-2 = ~3150, 3-5 = ~3350, 6 = ~3750, disengaged = ~5100)
* ThinkPad {{R51e}} (fan levels RPM: 0 = off, 1-2 = ~3300, 3-5 = ~3800, 6 = ~4150, disengaged = ~5100)
* ThinkPad {{R52}} (fan levels RPM: 0 = off, 1-2 = ~3350, 3-5 = ~3650, 6 = ~4250, disengaged = ~5245)
* ThinkPad {{R60}} (fan levels RPM: 0 = off, 1-1 = ~2650, 3-5 = ~3300, 6-7 = ~3950, disengaged = ~4800)
* ThinkPad {{R60e}}
* ThinkPad {{T22}}
* ThinkPad {{T23}} (low speed = ~2200, medium and maximum speed = ~4800; disengaged mode works at ~5800)
* ThinkPad {{T30}}
* ThinkPad {{T40}} (fan levels RPM: 1-2 = ~2950, 3-5 = ~3600, 6-7 = ~4050; disengaged = ~5400)
* ThinkPad {{T41}}, {{T41p}} (fan levels RPM: 1-2 = ~2980, 3-5 = ~3500, 6-7 = ~4050; disengaged mode works at ~5100)
* ThinkPad {{T42}}, {{T42p}} (fan levels RPM: 1-2 = ~2900, 3-5 = ~3700, 6-7 = ~4700; disengaged mode works at ~5200)
* ThinkPad {{T43}}, {{T43p}} (fan levels RPM: 1-2 = ~3300, 3-5 = ~4100, 6-7 = ~4700; disengaged mode works at ~6450)
* ThinkPad {{T60}} (fan levels RPM: 1-2 = 3000-3100, 3-5 = ~3600, 6-7 = ~4500; disengaged mode works at ~5500)
* ThinkPad {{T61}} (fan levels RPM: 0 = off, 1-2 = ~2980, 3-5 = ~3330, 6-7 = ~3760; disengaged mode works at ~4500)
* ThinkPad {{X30}} (level 0 = off, low = ~3900, medium = ~4200, maximum = ~4650, disengaged = ~5900)
* ThinkPad {{X31}} (fan levels RPM: 0 = off, 1-2 = ~2850, 3-5 = ~3450, 6 = ~4050, 7 = ~4150; disengaged mode works at ~4975)
* ThinkPad {{X40}}
* ThinkPad {{X41}}
* ThinkPad {{X41T}}
* ThinkPad {{X60}} (fan levels RPM: 7 = ~3700, disengaged ~4700)
* ThinkPad {{X61s}}
* ThinkPad {{Z60t}}, {{Z60m}} (fan levels RPM: 1-2 = ~1700, 3-5 = ~2800, 6-7 = ~3500)
* ThinkPad {{Z61m}}
* Thinkpad {{Z61p}} (fan levels 0-7, auto, disengaged; enable, disable; watchdog (untested))
Probably other models are supported too (please update this page if you confirm this; maintain some ordering too).

==Models using a different interface==

The following models also work, use a different access method which supported (only) via the {{path|/proc/acpi/ibm/fan}} of [[ibm-acpi]]. No need for patching.

* ThinkPad {{600E}}, {{600X}}, {{770E}}, {{770X}} (these use a different fan control interface)

==Unsupported models==

* ThinkPad {{560}} (these models don't have a fan)

Installing Ubuntu 6.06 Flight 6 on a ThinkPad X60s

2006-08-26T16:18:36Z

Pavel: /* Special Keys */

= Installation of Ubuntu 6.06 Flight 6 on X60s (model 1705-24U) =
== Summary ==
=== What works out of the box ===

* Graphics adapter and accelerator (Intel GMA 950)
* USB
* Firewire
* Lid switch (LCD off when lid closed)
* Volume control, keyboard light and screen brightness control
* Hard disk laptop-mode (/proc/sys/vm/laptop-mode)
* LCD brightness auto-adjusts depending on AC or battery operation
* Fn buttons generate ACPI events (/var/log/acpid)
* EVDO device

=== What needs to be fixed ===

* Network adapter (Intel PRO/1000)
* Dual core processor
* Wireless
* Processor frequency scaling
* Suspend to RAM
* Suspend to disk
* SD card reader
* Sound
* Fingerprint scanner

== Installing Ubuntu 6.06 Flight 6 ==

IBM Rescue and Recovery disks (seven CDs) can be created using preinstalled Windows: All programs→ThinkVantage→Create Recovery Media. However, as long as recovery partition (called ''predesktop'' in BIOS) is left intact, system '''can be restored to factory default without having recovery CDs'''.

Ubuntu Flight 6 installer boots normally using external (USB) IBM DVD-ROM/CD-RW. SATA disk is recognised, Xorg 7.0, gdm and Gnome start normally. Xorg is configured with i810. DRI works (glxinfo|grep rendering). Networking works, eth0 uses e1000. ALSA sound worked after original installation, but at some point it stopped working as Dapper instantly had numerous updates, including kernel.

== Fixes after installation ==

=== SMP kernel ===
Flight 6 installs 2.6.15-*-386 kernel without SMP support. After installation of -686 kernel (which appears to be SMP) {{path|/proc/cpuinfo}} reports CPU0 and CPU1.

=== Wi-Fi ===
Intel 3945ABG wireless driver is available from http://ipw3945.sourceforge.net/. Wireless works after following QUICK INSTALL STEPS in provided INSTALL file. Automating driver loading works as described too, except that {{path|/etc/modprobe.d/ipw3945}} has to be used instead of the proposed {{path|/etc/modules.d/ipw3945}}.

=== CPU frequency scaling ===
After installation CPU0 switches between 1.5 GHz (full speed) and 1 GHz depending on load, but CPU1 stays at full speed. This is caused by a bug in <code>powernowd</code>, which is resolved in <code>powernowd</code> 0.97. By defaqult Flight 6 uses <code>powernowd</code> with the <code>userspace</code> governor. Changing to <code>ondemand</code> governor ({{path|/sysfs/devices/system/cpu/cpu0,1/cpufreq/scaling_governor}}) and thus using kernel part for frequency scaling (modules <code>speedstep_centrino</code> and <code>freq_table</code>) fixes this. To keep the change between reboots, install <code>sysfsutils</code> package and add the following lines to {{path|/etc/sysfs.conf}}:

devices/system/cpu/cpu0/cpufreq/scaling_governor=ondemand
devices/system/cpu/cpu1/cpufreq/scaling_governor=ondemand

<code>powernowd</code> can then be disabled from auto-starting by <code>rcconf</code>. It can also be <code>apt-get remove</code>'d, but that also wants to remove <code>ubuntu-desktop</code> metapackage.

If you do not want to change governers, uprading <code>powernowd</code> from 0.96 to 0.97 also resolves the problem. Simply download <code>powernowd</code> 0.97 [http://www.deater.net/john/powernowd.html], compile it and replace the <code>/usr/sbin/powernowd</code> executable with the version that you have just compiled, then restart powernowd:

/etc/init.d/powernowd stop
/etc/init.d/powernowd start

However be careful if the powernowd package is upgraded and the original faulty executable is replaced.

=== High pitch noise while on battery ===
X60s CPU produces the [[Problem_with_high_pitch_noises#Limit_ACPI_CPU_power_states|infamous high pitch noise]] when in lower-power ACPI states (a.k.a. C-states). To eliminate the noise maximum (i.e. lowest power) C-state had to be limited to C2. In {{path|/etc/sysfs.conf}}:

module/processor/parameters/max_cstate=2

Alternatively upgrade the BIOS to 1.06

== Unsolved ==
* Suspend to RAM (suspends, but crashes on resume)
* Suspend to disk (suspends, but crashes on resume)
* Sound
* SD card reader (driver in Linux kernel >=2.6.17)

== Not tested ==
* PCMCIA slots
* Embeded Security Subsystem (TCPA)
* Active Protection System (HDAPS)
* Modem

= Installation of Ubuntu 6.06 Flight 6 on X60s (model 170466U) =
== Specifications ==

* Processor - Intel Core Duo 1.66GHZ
* Hard Drive - SATA 80GB - HTS541080
* Networking - Integrated Wireless (Atheros)
* Sound - Intel

<pre>
0000:00:00.0 Host bridge: Intel Corporation Mobile Memory Controller Hub (rev 03)
0000:00:02.0 VGA compatible controller: Intel Corporation Mobile Integrated Graphics Controller (rev 03)
0000:00:02.1 Display controller: Intel Corporation Mobile Integrated Graphics Controller (rev 03)
0000:00:1b.0 0403: Intel Corporation 82801G (ICH7 Family) High Definition Audio Controller (rev 02)
0000:00:1c.0 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 1 (rev 02)
0000:00:1c.1 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 2 (rev 02)
0000:00:1c.2 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 3 (rev 02)
0000:00:1c.3 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 4 (rev 02)
0000:00:1d.0 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #1 (rev 02)
0000:00:1d.1 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #2 (rev 02)
0000:00:1d.2 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #3 (rev 02)
0000:00:1d.3 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #4 (rev 02)
0000:00:1d.7 USB Controller: Intel Corporation 82801G (ICH7 Family) USB2 EHCI Controller (rev 02)
0000:00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev e2)
0000:00:1f.0 ISA bridge: Intel Corporation 82801GBM (ICH7-M) LPC Interface Bridge (rev 02)
0000:00:1f.1 IDE interface: Intel Corporation 82801G (ICH7 Family) IDE Controller (rev 02)
0000:00:1f.2 0106: Intel Corporation 82801GBM/GHM (ICH7 Family) Serial ATA Storage Controllers cc=AHCI (rev 02)
0000:00:1f.3 SMBus: Intel Corporation 82801G (ICH7 Family) SMBus Controller (rev 02)
0000:02:00.0 Ethernet controller: Intel Corporation 82573L Gigabit Ethernet Controller
0000:03:00.0 Ethernet controller: Atheros Communications, Inc. AR5212 802.11abg NIC (rev 01)
0000:15:00.0 ffff: Ricoh Co Ltd RL5c476 II (rev ff)
0000:15:00.1 ffff: Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev ff)
0000:15:00.2 ffff: Ricoh Co Ltd R5C822 SD/SDIO/MMC/MS/MSPro Host Adapter (rev ff)
</pre>

== Summary ==

=== What works out of the box ===
* Graphics adapter and accelerator (Intel GMA 950)
* USB
* Lid switch (LCD off when lid closed)
* Volume control, keyboard light and screen brightness control
* LCD brightness auto-adjusts depending on AC or battery operation
* Fn buttons generate ACPI events (/var/log/acpid)
* Sound, using the snd_hda_intel driver

=== What doesn't work out of the box===

* Network adapter (Intel PRO/1000)
* Suspend to ram
* Suspend to disk
* Wireless
** ''atheros driver in linux-restricted-modules-2.6.15-20-686 will not work, see below for instructions''

=== Sound ===
* The sound is very clean, loud enough and there doesn't appear to be any backround machine noise escaping through the card.

=== Annoyances ===
* '''Battery life''' - With the 8 cell battery Lenovo boasts that it gets about 8 hours of battery life. So far in Linux it is getting about 5-6. Need to mess around with more power saving options. To improve battery life rmmod uhci_hcd (disable USB).
* The Hitachi serial ATA harddrive makes a faint but noticeable high pitched clicking sound when running off the battery.
* The e1000 network driver currently has issues with the x60s. If you're having issues with eth0 appearing, give this bug report a read:
http://sourceforge.net/tracker/index.php?func=detail&aid=1474679&group_id=42302&atid=447449

== What works after installation ==

=== Wireless ===

* The X60s comes with an EVDO modem in the USA model of the laptop. The device seems to register correctly with usbserial (when given the correct options).
* The X60s comes with Bluetooth support it appears to work out of box.
* Unlike the earlier versions of the X60s this one uses the Atheros driver.
* The LED wireless indicator light does not switch on when wireless is enabled (unless you use ndiswrapper)
* The wireless toggle switch does nothing (although it appears to turn the led on momentarily)

==== EVDO ====

[[Verizon_1xEV-DO_WWAN|Some general EVDO info here]].

First we detect the device with lsusb. It should be the Sierra Wireless device unless IBM/Lenova changes it mid-stream:
<pre>
Bus 005 Device 003: ID 17ef:1000
Bus 005 Device 001: ID 0000:0000
Bus 002 Device 003: ID 1199:0218 Sierra Wireless, Inc.
Bus 002 Device 001: ID 0000:0000
Bus 003 Device 001: ID 0000:0000
Bus 001 Device 001: ID 0000:0000
Bus 004 Device 002: ID 0a5c:2110 Broadcom Corp.
Bus 004 Device 003: ID 0483:2016 SGS Thomson Microelectronics Fingerprint ReaderBus 004 Device 001: ID 0000:0000
</pre>

Then we modprobe the driver with the previously discovered values:
<pre>
modprobe usbserial vendor=0x1199 product=0x0218
</pre>

dmesg should show something like this:
<pre>
[17187980.292000] drivers/usb/serial/usb-serial.c: USB Serial support registered for generic
[17187980.292000] usbserial_generic 2-1:1.0: generic converter detected
[17187980.292000] usb 2-1: generic converter now attached to ttyUSB0
[17187980.292000] usb 2-1: generic converter now attached to ttyUSB1
[17187980.292000] usb 2-1: generic converter now attached to ttyUSB2
[17187980.292000] usbcore: registered new driver usbserial_generic
[17187980.292000] drivers/usb/serial/usb-serial.c: USB Serial Driver core
</pre>

You can have the driver automatically load by adding the following line to your /etc/modules file:
<pre>
usbserial vendor=0x1199 product=0x0218
</pre>

Your modem is now loaded and ready to go on /dev/ttyUSB0. Call your service provider for details.

==== Bluetooth ====
Bluetooth should work out of box. Ensure that you have the 'bluez-utils' package installed and then you can query your device with 'hciconfig -a':
<pre>
hci0: Type: USB
BD Address: 00:16:EC:B2:D1:90 ACL MTU: 1017:8 SCO MTU: 64:8
UP RUNNING PSCAN ISCAN
RX bytes:375 acl:0 sco:0 events:17 errors:0
TX bytes:319 acl:0 sco:0 commands:17 errors:0
Features: 0xff 0xff 0x8d 0xfe 0x9b 0xfd 0x00 0x80
Packet type: DM1 DM3 DM5 DH1 DH3 DH5 HV1 HV2 HV3
Link policy: RSWITCH HOLD SNIFF PARK
Link mode: SLAVE ACCEPT
Name: 'makho-0'
Class: 0x3e0100
Service Classes: Networking, Rendering, Capturing
Device Class: Computer, Uncategorized
HCI Ver: 2.0 (0x3) HCI Rev: 0x206c LMP Ver: 2.0 (0x3) LMP Subver: 0x415c Manufacturer: Broadcom Corporation (15)
</pre>

Note:
Bringing the device down with 'hciconfig hci0 down' will not disable the bluetooth light on the laptop. However you can disable the device entirely with the fn-f5 key combo. The device will vanish from hciconfig and the light will go out.

==== compiling the madwifi drivers from source - WORKS :) ====

* untar the latest drivers from teh madwifi website - http://sourceforge.net/projects/madwifi/
* prepare build environment
apt-get install build-essential
apt-get install linux-headers-`uname -r`
apt-get install sharutils
* in the madwifi directory build and install the module
make
make install
modprobe ahc_pci

==== WPA1 encryption - WORKS :) ====
* In order for this to work you '''must''' compile the wpa_supplicant from source.
** follow these instructions carefully - http://madwifi.org/wiki/UserDocs/802.11i

==== ndiswrapper - WORKS :) ====
* Why use ndiswrapper instead? Madwifi would not allow me to connect to 5+ wireless networks I had access to. So, if you too have this problem, try ndiswrapper, if not, support open source and use madwifi.
* Download and install ndiswrapper
* Download the driver and use wine to extract it (or another machine):
** http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-52527
* Goto the WINXP_2K directory where the driver is and do the following:
ndiswrapper -i NET5211.INF
modprobe ndiswrapper
* Your wireless card should now be the wlan0 interface, and the wireless light should light up!

== Fingerprint reader ==
The X60s comes with a small USB fingerprint reader attached below the mouse buttons. It appears as a USB device. Here's the relevant output of lsusb:
<pre>
Bus 004 Device 003: ID 0483:2016 SGS Thomson Microelectronics Fingerprint Reader
</pre>

It may be possible to use this device with the instructions found on the following two websites:
http://pavelmachek.livejournal.com/25060.html
http://66.102.7.104/search?q=cache:9VkP3DzVdoYJ:linuxbiometrics.com/modules/newbb/viewtopic.php%3Fviewmode%3Dflat%26order%3DASC%26topic_id%3D66%26forum%3D1%26move%3Dnext%26topic_time%3D1122861328%26PHPSESSID%3D677fd91c80089e4ba3edd25fbbbbc2f8+SGS+Thomson+Microelectronics+Fingerprint+Reader+Bus&hl=en&gl=us&ct=clnk&cd=5&client=firefox

== Special Keys ==

{|
|+ Post-install support for special keys in Ubuntu Linux 6.06 Flight 6
! Keys !! function !! status

|-
| {{key|Fn}}{{key|F2}} || lock screen || does not work
|-
| {{key|Fn}}{{key|F3}} || blank screen || does not work
|-
| {{key|Fn}}{{key|F4}} || suspend to ram || does not work
|-
| {{key|Fn}}{{key|F5}} || switch bluetooth || works
|-
| {{key|Fn}}{{key|F7}} || switch display || does not work
|-
| {{key|Fn}}{{key|F8}} || switch between touchpoint and touchpad || not applicable
|-
| {{key|Fn}}{{key|F9}} || eject from dock || not tested
|-
| {{key|Fn}}{{key|F12}} || suspend to disk || does not work
|-
| {{key|Fn}}{{key|END}} || reduce brightness || works
|-
| {{key|Fn}}{{key|HOME}} || increase brightness || works
|-
| {{key|Fn}}{{key|PGUP}} || keyboard light || works
|}

[[Category:X60s]]

Installing Ubuntu 6.06 Flight 6 on a ThinkPad X60s

2006-08-26T16:17:19Z

Pavel: /* Special Keys */

= Installation of Ubuntu 6.06 Flight 6 on X60s (model 1705-24U) =
== Summary ==
=== What works out of the box ===

* Graphics adapter and accelerator (Intel GMA 950)
* USB
* Firewire
* Lid switch (LCD off when lid closed)
* Volume control, keyboard light and screen brightness control
* Hard disk laptop-mode (/proc/sys/vm/laptop-mode)
* LCD brightness auto-adjusts depending on AC or battery operation
* Fn buttons generate ACPI events (/var/log/acpid)
* EVDO device

=== What needs to be fixed ===

* Network adapter (Intel PRO/1000)
* Dual core processor
* Wireless
* Processor frequency scaling
* Suspend to RAM
* Suspend to disk
* SD card reader
* Sound
* Fingerprint scanner

== Installing Ubuntu 6.06 Flight 6 ==

IBM Rescue and Recovery disks (seven CDs) can be created using preinstalled Windows: All programs→ThinkVantage→Create Recovery Media. However, as long as recovery partition (called ''predesktop'' in BIOS) is left intact, system '''can be restored to factory default without having recovery CDs'''.

Ubuntu Flight 6 installer boots normally using external (USB) IBM DVD-ROM/CD-RW. SATA disk is recognised, Xorg 7.0, gdm and Gnome start normally. Xorg is configured with i810. DRI works (glxinfo|grep rendering). Networking works, eth0 uses e1000. ALSA sound worked after original installation, but at some point it stopped working as Dapper instantly had numerous updates, including kernel.

== Fixes after installation ==

=== SMP kernel ===
Flight 6 installs 2.6.15-*-386 kernel without SMP support. After installation of -686 kernel (which appears to be SMP) {{path|/proc/cpuinfo}} reports CPU0 and CPU1.

=== Wi-Fi ===
Intel 3945ABG wireless driver is available from http://ipw3945.sourceforge.net/. Wireless works after following QUICK INSTALL STEPS in provided INSTALL file. Automating driver loading works as described too, except that {{path|/etc/modprobe.d/ipw3945}} has to be used instead of the proposed {{path|/etc/modules.d/ipw3945}}.

=== CPU frequency scaling ===
After installation CPU0 switches between 1.5 GHz (full speed) and 1 GHz depending on load, but CPU1 stays at full speed. This is caused by a bug in <code>powernowd</code>, which is resolved in <code>powernowd</code> 0.97. By defaqult Flight 6 uses <code>powernowd</code> with the <code>userspace</code> governor. Changing to <code>ondemand</code> governor ({{path|/sysfs/devices/system/cpu/cpu0,1/cpufreq/scaling_governor}}) and thus using kernel part for frequency scaling (modules <code>speedstep_centrino</code> and <code>freq_table</code>) fixes this. To keep the change between reboots, install <code>sysfsutils</code> package and add the following lines to {{path|/etc/sysfs.conf}}:

devices/system/cpu/cpu0/cpufreq/scaling_governor=ondemand
devices/system/cpu/cpu1/cpufreq/scaling_governor=ondemand

<code>powernowd</code> can then be disabled from auto-starting by <code>rcconf</code>. It can also be <code>apt-get remove</code>'d, but that also wants to remove <code>ubuntu-desktop</code> metapackage.

If you do not want to change governers, uprading <code>powernowd</code> from 0.96 to 0.97 also resolves the problem. Simply download <code>powernowd</code> 0.97 [http://www.deater.net/john/powernowd.html], compile it and replace the <code>/usr/sbin/powernowd</code> executable with the version that you have just compiled, then restart powernowd:

/etc/init.d/powernowd stop
/etc/init.d/powernowd start

However be careful if the powernowd package is upgraded and the original faulty executable is replaced.

=== High pitch noise while on battery ===
X60s CPU produces the [[Problem_with_high_pitch_noises#Limit_ACPI_CPU_power_states|infamous high pitch noise]] when in lower-power ACPI states (a.k.a. C-states). To eliminate the noise maximum (i.e. lowest power) C-state had to be limited to C2. In {{path|/etc/sysfs.conf}}:

module/processor/parameters/max_cstate=2

Alternatively upgrade the BIOS to 1.06

== Unsolved ==
* Suspend to RAM (suspends, but crashes on resume)
* Suspend to disk (suspends, but crashes on resume)
* Sound
* SD card reader (driver in Linux kernel >=2.6.17)

== Not tested ==
* PCMCIA slots
* Embeded Security Subsystem (TCPA)
* Active Protection System (HDAPS)
* Modem

= Installation of Ubuntu 6.06 Flight 6 on X60s (model 170466U) =
== Specifications ==

* Processor - Intel Core Duo 1.66GHZ
* Hard Drive - SATA 80GB - HTS541080
* Networking - Integrated Wireless (Atheros)
* Sound - Intel

<pre>
0000:00:00.0 Host bridge: Intel Corporation Mobile Memory Controller Hub (rev 03)
0000:00:02.0 VGA compatible controller: Intel Corporation Mobile Integrated Graphics Controller (rev 03)
0000:00:02.1 Display controller: Intel Corporation Mobile Integrated Graphics Controller (rev 03)
0000:00:1b.0 0403: Intel Corporation 82801G (ICH7 Family) High Definition Audio Controller (rev 02)
0000:00:1c.0 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 1 (rev 02)
0000:00:1c.1 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 2 (rev 02)
0000:00:1c.2 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 3 (rev 02)
0000:00:1c.3 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 4 (rev 02)
0000:00:1d.0 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #1 (rev 02)
0000:00:1d.1 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #2 (rev 02)
0000:00:1d.2 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #3 (rev 02)
0000:00:1d.3 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #4 (rev 02)
0000:00:1d.7 USB Controller: Intel Corporation 82801G (ICH7 Family) USB2 EHCI Controller (rev 02)
0000:00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev e2)
0000:00:1f.0 ISA bridge: Intel Corporation 82801GBM (ICH7-M) LPC Interface Bridge (rev 02)
0000:00:1f.1 IDE interface: Intel Corporation 82801G (ICH7 Family) IDE Controller (rev 02)
0000:00:1f.2 0106: Intel Corporation 82801GBM/GHM (ICH7 Family) Serial ATA Storage Controllers cc=AHCI (rev 02)
0000:00:1f.3 SMBus: Intel Corporation 82801G (ICH7 Family) SMBus Controller (rev 02)
0000:02:00.0 Ethernet controller: Intel Corporation 82573L Gigabit Ethernet Controller
0000:03:00.0 Ethernet controller: Atheros Communications, Inc. AR5212 802.11abg NIC (rev 01)
0000:15:00.0 ffff: Ricoh Co Ltd RL5c476 II (rev ff)
0000:15:00.1 ffff: Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev ff)
0000:15:00.2 ffff: Ricoh Co Ltd R5C822 SD/SDIO/MMC/MS/MSPro Host Adapter (rev ff)
</pre>

== Summary ==

=== What works out of the box ===
* Graphics adapter and accelerator (Intel GMA 950)
* USB
* Lid switch (LCD off when lid closed)
* Volume control, keyboard light and screen brightness control
* LCD brightness auto-adjusts depending on AC or battery operation
* Fn buttons generate ACPI events (/var/log/acpid)
* Sound, using the snd_hda_intel driver

=== What doesn't work out of the box===

* Network adapter (Intel PRO/1000)
* Suspend to ram
* Suspend to disk
* Wireless
** ''atheros driver in linux-restricted-modules-2.6.15-20-686 will not work, see below for instructions''

=== Sound ===
* The sound is very clean, loud enough and there doesn't appear to be any backround machine noise escaping through the card.

=== Annoyances ===
* '''Battery life''' - With the 8 cell battery Lenovo boasts that it gets about 8 hours of battery life. So far in Linux it is getting about 5-6. Need to mess around with more power saving options. To improve battery life rmmod uhci_hcd (disable USB).
* The Hitachi serial ATA harddrive makes a faint but noticeable high pitched clicking sound when running off the battery.
* The e1000 network driver currently has issues with the x60s. If you're having issues with eth0 appearing, give this bug report a read:
http://sourceforge.net/tracker/index.php?func=detail&aid=1474679&group_id=42302&atid=447449

== What works after installation ==

=== Wireless ===

* The X60s comes with an EVDO modem in the USA model of the laptop. The device seems to register correctly with usbserial (when given the correct options).
* The X60s comes with Bluetooth support it appears to work out of box.
* Unlike the earlier versions of the X60s this one uses the Atheros driver.
* The LED wireless indicator light does not switch on when wireless is enabled (unless you use ndiswrapper)
* The wireless toggle switch does nothing (although it appears to turn the led on momentarily)

==== EVDO ====

[[Verizon_1xEV-DO_WWAN|Some general EVDO info here]].

First we detect the device with lsusb. It should be the Sierra Wireless device unless IBM/Lenova changes it mid-stream:
<pre>
Bus 005 Device 003: ID 17ef:1000
Bus 005 Device 001: ID 0000:0000
Bus 002 Device 003: ID 1199:0218 Sierra Wireless, Inc.
Bus 002 Device 001: ID 0000:0000
Bus 003 Device 001: ID 0000:0000
Bus 001 Device 001: ID 0000:0000
Bus 004 Device 002: ID 0a5c:2110 Broadcom Corp.
Bus 004 Device 003: ID 0483:2016 SGS Thomson Microelectronics Fingerprint ReaderBus 004 Device 001: ID 0000:0000
</pre>

Then we modprobe the driver with the previously discovered values:
<pre>
modprobe usbserial vendor=0x1199 product=0x0218
</pre>

dmesg should show something like this:
<pre>
[17187980.292000] drivers/usb/serial/usb-serial.c: USB Serial support registered for generic
[17187980.292000] usbserial_generic 2-1:1.0: generic converter detected
[17187980.292000] usb 2-1: generic converter now attached to ttyUSB0
[17187980.292000] usb 2-1: generic converter now attached to ttyUSB1
[17187980.292000] usb 2-1: generic converter now attached to ttyUSB2
[17187980.292000] usbcore: registered new driver usbserial_generic
[17187980.292000] drivers/usb/serial/usb-serial.c: USB Serial Driver core
</pre>

You can have the driver automatically load by adding the following line to your /etc/modules file:
<pre>
usbserial vendor=0x1199 product=0x0218
</pre>

Your modem is now loaded and ready to go on /dev/ttyUSB0. Call your service provider for details.

==== Bluetooth ====
Bluetooth should work out of box. Ensure that you have the 'bluez-utils' package installed and then you can query your device with 'hciconfig -a':
<pre>
hci0: Type: USB
BD Address: 00:16:EC:B2:D1:90 ACL MTU: 1017:8 SCO MTU: 64:8
UP RUNNING PSCAN ISCAN
RX bytes:375 acl:0 sco:0 events:17 errors:0
TX bytes:319 acl:0 sco:0 commands:17 errors:0
Features: 0xff 0xff 0x8d 0xfe 0x9b 0xfd 0x00 0x80
Packet type: DM1 DM3 DM5 DH1 DH3 DH5 HV1 HV2 HV3
Link policy: RSWITCH HOLD SNIFF PARK
Link mode: SLAVE ACCEPT
Name: 'makho-0'
Class: 0x3e0100
Service Classes: Networking, Rendering, Capturing
Device Class: Computer, Uncategorized
HCI Ver: 2.0 (0x3) HCI Rev: 0x206c LMP Ver: 2.0 (0x3) LMP Subver: 0x415c Manufacturer: Broadcom Corporation (15)
</pre>

Note:
Bringing the device down with 'hciconfig hci0 down' will not disable the bluetooth light on the laptop. However you can disable the device entirely with the fn-f5 key combo. The device will vanish from hciconfig and the light will go out.

==== compiling the madwifi drivers from source - WORKS :) ====

* untar the latest drivers from teh madwifi website - http://sourceforge.net/projects/madwifi/
* prepare build environment
apt-get install build-essential
apt-get install linux-headers-`uname -r`
apt-get install sharutils
* in the madwifi directory build and install the module
make
make install
modprobe ahc_pci

==== WPA1 encryption - WORKS :) ====
* In order for this to work you '''must''' compile the wpa_supplicant from source.
** follow these instructions carefully - http://madwifi.org/wiki/UserDocs/802.11i

==== ndiswrapper - WORKS :) ====
* Why use ndiswrapper instead? Madwifi would not allow me to connect to 5+ wireless networks I had access to. So, if you too have this problem, try ndiswrapper, if not, support open source and use madwifi.
* Download and install ndiswrapper
* Download the driver and use wine to extract it (or another machine):
** http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-52527
* Goto the WINXP_2K directory where the driver is and do the following:
ndiswrapper -i NET5211.INF
modprobe ndiswrapper
* Your wireless card should now be the wlan0 interface, and the wireless light should light up!

== Fingerprint reader ==
The X60s comes with a small USB fingerprint reader attached below the mouse buttons. It appears as a USB device. Here's the relevant output of lsusb:
<pre>
Bus 004 Device 003: ID 0483:2016 SGS Thomson Microelectronics Fingerprint Reader
</pre>

It may be possible to use this device with the instructions found on the following two websites:
http://pavelmachek.livejournal.com/25060.html
http://66.102.7.104/search?q=cache:9VkP3DzVdoYJ:linuxbiometrics.com/modules/newbb/viewtopic.php%3Fviewmode%3Dflat%26order%3DASC%26topic_id%3D66%26forum%3D1%26move%3Dnext%26topic_time%3D1122861328%26PHPSESSID%3D677fd91c80089e4ba3edd25fbbbbc2f8+SGS+Thomson+Microelectronics+Fingerprint+Reader+Bus&hl=en&gl=us&ct=clnk&cd=5&client=firefox

== Special Keys ==

{|
|+ Post-install support for special keys in Ubuntu Linux 6.06 Flight 6
! Keys !! function !! status

|-
| {{key|Fn}}{{key|F2}} || lock screen || does not work
|-
| {{key|Fn}}{{key|F3}} || blank screen || does not work
|-
| {{key|Fn}}{{key|F4}} || suspend to ram || does not work
|-
| {{key|Fn}}{{key|F5}} || switch bluetooth || not tested
|-
| {{key|Fn}}{{key|F7}} || switch display || does not work
|-
| {{key|Fn}}{{key|F8}} || switch between touchpoint and touchpad || not applicable
|-
| {{key|Fn}}{{key|F9}} || eject from dock || not tested
|-
| {{key|Fn}}{{key|F12}} || suspend to disk || does not work
|-
| {{key|Fn}}{{key|END}} || reduce brightness || works
|-
| {{key|Fn}}{{key|HOME}} || increase brightness || works
|-
| {{key|Fn}}{{key|PGUP}} || keyboard light || works
|}

[[Category:X60s]]

TuxOnIce

2006-08-10T22:50:42Z

Pavel: suspend2's alternatives got better in meantime

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
===Software Suspend 2 - swsusp2===
Software Suspend 2, sometimes also called "swsusp2" and "suspend2", is an implementation of suspend-to-disk functionality in the form of a Linux kernel patch and several userspace utilities. It is an alternative to both the BIOS-driven hibernation feature found on most ThinkPad models, and the [[swsusp]] "software suspend" functionality built into recent Linux kernels.
|}

==Features==
Compared to the alternatives, Software Suspend 2 has some unique [http://suspend2.net/features features]:
* Saving the memory image into a swap file, a swap partition or normal a file on any filesystem.
* Cancelling a suspend in progress
* Different bugs -- if the alternatives don't work, try this one!

Since it is implemented purely in software, Software Suspend 2 is in principle machine-independent and should work on all modern ThinkPad models. However, in some cases problematic drivers need to be unloaded before suspension. This is handled by the <tt>hibernate</tt> script (see below).

==Availability / Project Homepage==
* [http://suspend2.net/ Project home page]

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| Suspend2 Version
! style="background:#efefef;"| Success
! style="background:#efefef;"| Note
|- style="background: white;"
| {{T42}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T43}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T21}}
|
|
|
|
! style ="color:green;"| Yes
| need to unload the sound module (<tt>snd-cs46xx</tt>) on suspend. May want to enable UseDummyXServer if running X
|- style="background: white; color:black;"
| {{X41T}}
|
| Fedore Core 4
|
|
! style ="color:green;"| Yes
| requires SATA resume patch and the SATA drivers compiled as built-in or in initrd (see [[Problems with SATA and Linux]]) and a {{path|hibernate.conf}} fix (see [[Installing Fedora Core 4 on a ThinkPad X41 Tablet]])
|- style="background: white; color:black;"
| {{X22}}
|
| Ubuntu Breezy
|
|
! style ="color:green;"| Yes
| see [[Installing Ubuntu (Breezy) on a ThinkPad X22]]
|- style="background: white; color:black;"
| {{G41}}
|
|
|
|
! style ="color:green;"| Yes
| see [[Installing Debian on a ThinkPad G41]]
|- style="background: white; color:black;"
| {{R52}}
|
|
| 2.6.17.1
| 2.2.7
! style ="color:green;"| Yes
| FC5 with kernel [http://mhensler.de/swsusp/download_en.php 2.6.17-1.2145_1.rhfc5.cubbi_suspend2]
|- style="background: white; color:black;"
| {{T23}}
| 2647-9KU
| Debian Etch
| 2.6.17.4
| 2.2.7
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
|}

==Installation Instructions==
The [http://suspend2.net/ project home page] has a detailed HOWTO and FAQ. The following are just a few highlights.

===Patching mkinitrd===
If your systems uses an <tt>initrd</tt> file (most do), you'll need to patch or replace your <tt>initrd</tt>-creation script.

*{{Fedora}} 4: in {{path|/sbin/mkinitrd}}, find this line:
echo "echo Mounted /proc filesystem" >> $RCFILE
and add the following immediately afterwards:
echo "echo > /proc/suspend2/do_resume" >>$RCFILE
*{{Fedora}} 5: in {{path|/sbin/mkinitrd}}, find this line:
mount -t proc /proc /proc
and add the following immediately afterwards:
echo > /proc/suspend2/do_resume
*{{Debian}}: copy [http://dagobah.ucc.asn.au/swsusp/2.0.0.102/swsusp-initrd.sh swsusp-initrd.sh] script to your {{path|/etc/mkinitrd/scripts}} directory before creating initrd image.

Make sure you regenerate your <tt>initrd</tt> file (using <tt>mkinitrd</tt> or by reinstalling the kernel) after patching <tt>mkinitrd</tt>.

===Hibernate script===
Software Suspend 2 works best with the <tt>hibernate</tt> script (available from the project home page), which takes care of auxiliary tasks needed on many systems (e.g., unloading problematic modules and restoring video modes).

====Availability====
*{{Gentoo}}: emerge hibernate-script
*{{Fedora}}: kernel and hibernate RPMs are available at http://mhensler.de/swsusp/
*{{Ubuntu}}: packages for Ubuntu Dapper Drake (kernel, hibernate, suspend2ui-userui): http://dagobah.ucc.asn.au/dapper-kernels/
*PLD: poldek -iv hibernate
*Other: check the home page for packages (deb, i386 rpm, tgz, and source rpm) from http://www.suspend2.net

==Configuration tips==
===RediSafe-like functionality===
The hibernate functionality on some ThinkPad BIOSes offers the useful "RediSafe" feature, which suspends to both RAM and disk. This way you get quick resumes (directly from RAM), plus the safey of suspend-to-disk in case the battery runs out.

Software Suspend 2 provides this feature too; simply add the following to {{path|/etc/hibernate/suspend2.conf}}:
PowerdownMethod 3

[[Category:Patches]] [[Category:Drivers]]

Tp smapi

2006-07-30T10:28:59Z

Pavel: Add row for x60

{| 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 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}}.

====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_<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%">(see [[#Enabling_this_feature|note]] above)</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}} ||
|-
! {{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}} || 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}} ||
|-
! {{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}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{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

Tp smapi

2006-07-30T10:28:25Z

Pavel: /* X 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 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}}.

====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_<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%">(see [[#Enabling_this_feature|note]] above)</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}} ||
|-
! {{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}} || 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}} ||
|-
! {{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}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{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

How to enable integrated fingerprint reader with BioAPI

2006-07-30T09:52:00Z

Pavel: fix typo in link

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
This page describes the process of getting the [[Integrated Fingerprint Reader|integrated fingerprint reader]] to work under Linux, using bioapi and binary-only drivers. It is based on experiences in {{Ubuntu}} on a T43. The same works on {{Fedora}} 4 and 5, RHEL4, SuSE 9.3, SuSE 10, and {{Gentoo}}. Note that experimental open-source driver is available, see [[Integrated Fingerprint Reader|fingerprint reader]] page for details.
|}

==Basic installation==
===Installing the bioapi framework===
====Automated installation script====
The [[Script for enabling the fingerprint reader]] automates the installation of most components (bioapi framework, driver, pam_bioapi, pam setup, device permissions, pamtester and enrolling), for some Linux distributions.

====Binary packages====

Note that these packages only take care of this one section. If you can use one, you should do so and then proceed to the section entitled, Installing and Configuring the Driver.

=====Debian/ Ubuntu Dapper=====
*If you're using {{Debian}} Sid (the unstable branch) or {{Ubuntu}} Dapper Drake 6.06 LTS you can try the packages from Michael R. Crusoe's site, either [http://www.qrivy.net/~michael/temp/ version 1.2.3] (recommended) or [http://www.qrivy.net/~michael/debs/unstable/ older versions] which might not work with the steps in this howto.

{{HINT|Ignore the warning about not finding ''/usr/lib/libqtpwbsp.so'', it's not fatal.}}

=====Gentoo=====
You can either grab the [http://www.qrivy.net/~michael/blua/bioapi/bioapi-1.2.2.ebuild.tar.bz2 ebuild], or use the source-install procedure below.

Also see [http://toe.ch/~tsa/ibm-fingerprint/ http://toe.ch/~tsa/ibm-fingerprint/] for alternative documentation on installing on Gentoo including ebuilds for all the packages used.
=====Fedora Core=====
RPM packages for Fedora Core and installation instructions are available [[Installing Fedora Core 5 on a ThinkPad X41 Tablet#Fingerprint_Reader|here]]

====Installing from source====
*Get the bioapi source:
:{{cmduser|wget http://www.qrivy.net/~michael/blua/bioapi/bioapi-latest.tar.bz2}}
*I could not compile bioapi with the graphical Qt tools. To do it manually, do the following:
:{{cmduser|tar xjf bioapi-latest.tar.bz2}}
:{{cmduser|cd bioapi-1.2.2}}
:{{cmduser|1=./configure --with-Qt-dir=no}}
:{{cmduser|make}}
:and then as root
:{{cmdroot|make install}}
:If make install fails, be sure you're root and then:
:{{cmdroot|1=export LD_LIBRARY_PATH=/usr/local/lib}}
:{{cmdroot|make install}}
:and if you want to compile pam_bioapi for auth later
:{{cmdroot|cp include/bioapi_util.h include/installdefs.h imports/cdsa/v2_0/inc/cssmtype.h /usr/include}}
:Be aware that checkinstall will not work!
:(I got through configure with Qt, but got a cryptic build error. It all worked fine with Qt disabled as above)
:buzz: This is due to a wrong qt include path, set it manually in configure and everything should work.
*Bioapi (at least version 1.2.2) doesn't compile with GCC4. You need to patch it:
*This is neccessary to compile on SUSE 10.1 which it using gcc version 4.1.0.
:{{cmduser|wget http://upir.cz/linux/patches/bioapi-1.2.2-gcc4.patch}}
:{{cmduser|patch -p1 < bioapi-1.2.2-gcc4.patch}}
*Patch for gcc 4.1 is available here - http://cvs.pld-linux.org/cgi-bin/cvsweb/SOURCES/bioapi-c++.patch?rev=1.3
* By default, bioapi will install numerous files in {{path|/usr/local/<nowiki>{</nowiki>bin,lib,include<nowiki>}</nowiki>}}, including files with "self-explanatory" names such as {{path|/usr/local/bin/Sample}}. To prevent this pollution:
:Create a dedicated directory, for example {{path|/opt/bioapi}} .
:Append <tt>--prefix=/opt/bioapi</tt> to the above <tt>./configure</tt> command.
:Append {{path|/opt/bioapi/bin}} to <tt>$PATH</tt> and {{path|/opt/bioapi/lib}} to <tt>$LD_LIBRARY_PATH</tt>.
:When installing the driver (below), tell it the new install path: {{cmdroot|sh install.sh /opt/bioapi/lib}}

====Adjusting ldconfigs library search path====
At least on {{Fedora}} or {{Aurox}} 11, you may need to add {{path|/usr/local/lib}} to the library path so that the libraries referenced from <tt>pam_bioapi.so</tt> get picked up properly. The usual way to do this is adding it to the ldconfig configuration:
:{{cmdroot|echo '/usr/local/lib' > /etc/ld.so.conf.d/bioapi.conf}}
:{{cmdroot|ldconfig}}
Alternatively you can add it to the LD_LIBRARY variable.

If you see bioapi libs in the output of
:{{cmdroot|ldconfig -p | grep bioapi}}
then it should work.

===Installing and configuring the driver===
====Installing the driver====
*Download {{path|TFMESS_BSP_LIN_1.0.zip}} from the [http://www.upek.com/support/dl_linux_bsp.asp UPEK support site] and unzip it into a seperate folder, as it will not create one.
*Change to that folder and do as root:
:{{cmdroot|sh install.sh}}
:If you're running Gentoo or Ubuntu Dapper, use
:{{cmdroot|sh install.sh /usr/lib}}
:If that fails, it may be that make install failed up above -- try setting LD_LIBRARY_PATH, do the make install again, and come back here and try this again. You also need {{cmd|mod_install|}} from bioapi in your PATH.
:May there still occures and error, which means mod_install: command not found.
:Then login as root - not su!
:Do this:
:{{cmdroot|sh install.sh}}
:again. It should work. SU to root does not work since then the /usr/local/bin directory is not used per default.

====Configuring permissions for non-root use====
If you want to use PAM-aware applications like xscreensaver that are NOT running with root permissions (as opposed to login, gdm or other authentication mechanisms), you may need to do all or at least some of the things in this section. More details on what is necessary on which distributions would be greately appreciated.
*Create two groups, one for access to BioAPI files and the other for access to the usb files. (This is done for full generality; i.e., you may have other USB devices which you want accessable to other users, without exposing your BioAPI configuration to them). Add your normal user (the one you wish to use PAM-aware applications with) to both of these groups.
On {{Debian}} this is done with
:{{cmdroot|addgroup --system bioapi}}
:{{cmdroot|addgroup --system usbfs}}
:{{cmdroot|adduser yournormaluser bioapi}}
:{{cmdroot|adduser yournormaluser usbfs}}
On {{SUSE}} this is done with
:{{cmdroot|groupadd --system bioapi}}
:{{cmdroot|groupadd --system usbfs}}
:{{cmdroot|groupmod -A yournormaluser bioapi}}
:{{cmdroot|groupmod -A yournormaluser usbfs}}
On {{Mandriva}} this is done with
:{{cmdroot|groupadd -r bioapi}}
:{{cmdroot|groupadd -r usbfs}}
:{{cmdroot|usermod -G bioapi,usbfs yournormaluser}}

:(where {{cmd|yournormaluser|}} is your normal user name). You will need to log out and log back in for this to take effect.
*Set permissions on the BioAPI config/registry directory:
:{{cmdroot|chown -R root:bioapi /usr/local/var/bioapi/}}
:{{cmdroot|chmod -R 770 /usr/local/var/bioapi/}}
:(change this path if you used an alternate BioAPI install directory above)
*Set permissions on the files in {{path|/proc/bus/usb}}:
:{{cmdroot|chown -R root:usbfs /proc/bus/usb}}
:{{cmdroot|chmod -R g+X /proc/bus/usb}}
:{{cmdroot|chown root:usbfs /proc/bus/usb/`lsusb <nowiki>|</nowiki> sed -ne "/0483:2016/s/Bus\ $.*$\ Device\ $.*$:\ .*/\1\/\2/p"`}}
:{{cmdroot|chmod 660 /proc/bus/usb/`lsusb <nowiki>|</nowiki> sed -ne "/0483:2016/s/Bus\ $.*$\ Device\ $.*$:\ .*/\1\/\2/p"`}}
:You may need to replace {{cmd|lsusb|}} with its full path, which is something like {{cmd|/sbin/lsusb|}} or {{cmd|/usr/bin/lsusb|}} depending on your distro. It might be necessary to put these lines into a script which is run at startup and resume from suspend/hibernate.
*As an alternative to the {{cmd|chown|}}/{{cmd|chmod|}} commands above, you can set mount options for usbfs with a line in {{path|/etc/fstab|}}; an example would be
none /proc/bus/usb usbfs defaults,devgid=108,devmode=0660,busgid=108,busmode=0770,listgid=108,listmode=0660 0 0
:where 108 is replaced with the numerical group ID of the usbfs group (you can determine this with something like {{cmd|cat /etc/group <nowiki>|</nowiki> grep usbfs <nowiki>|</nowiki> cut -d':' -f 3|}}). Make sure you only have one {{path|/proc/bus/usb}} entry in {{path|/etc/fstab}}. See the {{cmd|mount(8)|}} manpage for more information on these options. This is "cleaner" but seems to have a few weird issues -- see the talk page for details.
*You may also have files in {{path|/dev/bus/usb}}, which the driver will try before {{path|/proc/bus/usb}}. If this is another usbfs mount point ({{cmd|mount|}} shows a line containing {{cmdresult|/dev/bus/usb type usbfs}}), then simply follow the above instructions with {{path|/dev/bus/usb}} rather than {{path|/proc/bus/usb}}. Otherwise, you may be running a new kernel (i.e. 2.6.15) that makes usbfs-like files available through {{path|/dev/bus/usb}}.
*On systems running udev these files are dynamically created; you can configure their permissions by editing a udev config file. On Debian this is done by changing the <tt>usb_device</tt> line of {{path|/etc/udev/permissions.rules}} to read
SUBSYSTEM=="usb_device", MODE="0660", GROUP="usbfs"
*For the beta versions only, there is a logfile, which needs to exist with the proper permissions:
:{{cmdroot|touch /var/log/BSP.log && chown root:bioapi /var/log/BSP.log && chmod 660 /var/log/BSP.log}}

====Miscellaneous configuration====
* To increase the security level (minimize false accept rate), set this in {{path|/etc/tfmessbsp.cfg}}:
security-level="5"
{{WARN|Please see discussion section Security Level!}}

===Testing the driver and enrolling a fingerprint===
To test the driver and generate the file containing your fingerprint information, you need a sample program included with the driver. The compilation steps below were discovered by trial and error; if they don't work for you, try the binary {{cmd|Sample|}} utility that came with the beta versions of the driver (i.e., {{path|TFMESS_BSP_LIN_1.0beta2.zip}} as mentioned above).
Go to the folder where you extracted {{path|TFMESS_BSP_LIN_1.0.zip}} and do:
:{{cmdroot|cd NonGUI_Sample}}
:Edit {{path|main.c|}} and remove (or comment out) the line
#include "port/bioapi_port.h"
:{{cmdroot|gcc -o Sample main.c -L/usr/local/lib -lbioapi100 -DUNIX -DLITTLE_ENDIAN}}
:{{cmdroot|./Sample}}
:Note that Sample may only run as root, unless you've already configured the usbfs file permissions.
:You can try to "e"nroll (to record a fingerprint for an account) and then "v"erify (to test a fingerprint against the one it expects for an account).
:You'll save a step later if you use your own login username as the username to enroll here.
:If running {{cmd |./Sample|}} produces the error message 'BioAPI_ModuleLoad failed, BioAPI Error Code: 6477 (0x194d)'
:then uncommenting the line
://BioAPI_SetGUICallbacks(gModuleHandle, NULL, NULL,TextGuiCallback, NULL);
:in {{path|main.c|}} can help.

==Login via pam_bioapi==

The following explains how to add fingerprint authentiation to programs that use the PAM (Pluggable Authentication Modules) framework, such as Gnome's GDM and KDE's KDM and screensaver.

===Getting required libs & tools===
====Installing pam_bioapi====
*Prerequisites
:On SuSE 10, I needed to install the pam-devel RPM
:In general, you will need pam itself (standard for most distros) as well as the pam development files (probably an optional package for your distro).
*Get and compile the pam_bioapi module.
{{HINT|A new version, pam_bioapi 0.3.0, with multi-finger and identification support can be found [http://www.nax.cz/pub/bioapi/pam_bioapi/pam-bioapi_0.3.0.tar.gz here].}}
:{{cmduser|wget http://www.qrivy.net/~michael/blua/pam_bioapi/pam_bioapi-latest.tar.bz2}}
:{{cmduser|tar xjf pam_bioapi-latest.tar.bz2}}
:{{cmduser|cd pam_bioapi-0.2.1}}
:{{cmduser|wget http://badcode.de/downloads/fingerprint.patch}}
:{{cmduser|patch -p0 < fingerprint.patch}}
:If you want to, review the patch. In general you should review all code you download and compile, if possible.
:{{cmduser|<nowiki>./configure --libdir=/lib && make </nowiki>}}
:and as root
:{{cmdroot| make install}}
{{NOTE|If you get a 'rpl_malloc' error in /var/log/auth.log when trying to use the fingerprint reader, redo these steps and remove the related term from Makefile after running ./configure. (FC3, Debian etch)}}
*If you get 'configure: error: cannot find required header: security/_pam_macros.h' and are on a Debian-like system, do "apt-get install libpam0g-dev" and try again. If you are using a Mandriva distribution, do "urpmi libpam0-devel" instead.
*If you get 'PAM [dlerror: /lib/security/pam_bioapi.so: undefined symbol: BioAPIMemoryFuncs]' error in your syslog, replace 'LIBS = ' line in {{path|libpam_bioapi/makefile}} with the following (of course, replace {{path|/opt/bioapi/}} with the path where you installed bioapi):
LIBS = -L/opt/bioapi/lib -lbioapi100 -lbioapi_mds300 -lmds_util
*Use the sample tool from the fingerprint reader to create {{path|<username>.bir}} (<tt><username></tt> '''must''' be the username you want to login with. gdm will probably break for any login name that has no .bir file).
*As root do:
:{{cmdroot|SERIAL<nowiki>=`BioAPITest | sed -ne "/Fingerprint/{n;n;s/^.*: $.\{9\}$$.\{4\}$$.\{4\}$$.\{4\}$$.*$/\1-\2-\3-\4-\5/gp}"` </nowiki>}}
:{{cmdroot|echo $SERIAL}} should print something like {{cmdresult|<nowiki>{5550454b-2054-464d-2f45-535320425350}</nowiki>}} now.
:If it does, do:
:{{cmdroot|mkdir -p /etc/bioapi/pam/$SERIAL}}
:{{cmdroot|cp <username>.bir /etc/bioapi/pam/$SERIAL}}
:If not, you might just try
:{{cmdroot|SERIAL<nowiki>={5550454b-2054-464d-2f45-535320425350}</nowiki>}}
:as this value is hardcoded into the UPEK docs.

===Configuring pam===
The following part is distribution specific. On {{Ubuntu}} or {{SUSE}} you can modify {{path|/etc/pam.d/common-auth}} (on {{Gentoo}} and {{Fedora}} it is {{path|/etc/pam.d/system-auth}}) to look like this:

#
# /etc/pam.d/common-auth - authentication settings common to all services
#
# This file is included from other service-specific PAM config files,
# and should contain a list of the authentication modules that define
# the central authentication scheme for use on the system
# (e.g., /etc/shadow, LDAP, Kerberos, etc.). The default is to use the
# traditional Unix authentication mechanisms.
#
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
password sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
auth required pam_unix.so nullok_secure

----
For '''Gentoo'''-Users - this allows you to attempt a password first. If you simply press enter, it then prompts for a fingerprints. Create a file named {{path|/etc/pam.d/bioapi}}. This also means that remote services, such as SSH keep working:

auth required pam_env.so
auth sufficient pam_unix.so likeauth nullok
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
auth required pam_deny.so

account required pam_unix.so

session required pam_limits.so
session required pam_unix.so

----

Now, simply replace "auth include system-auth" in all services that you wish to use fingerprint for with "auth include bioapi". For example, {{path|/etc/pam.d/kde}} by default contains

auth include system-auth
auth required pam_nologin.so

account include system-auth

password include system-auth

session include system-auth

Simply replace the first "system-auth" with bioapi and you can also get rid of KDE desktop lock with a fingerprint. If you do not wish to allow for "password fallback" then remove

auth sufficient pam_unix.so likeauth nullok

from {{path|/etc/pam.d/bioapi}}.

{{WARN|If su/sudo expects to receive the root password (SuSE 10), you need to have fingerprint settings for root (that is, copy in a root.bir as well as a your-username.bir). Otherwise, they get a segmentation fault. Which is a little unfortunate, given that you need to su or sudo to change your settings... }}
{{WARN|Not only SuSE 10 requires root.bir to be available for su to work. Just make sure you have root.bir when su is not working with your fingerprint reader but other applications are...}}
Note that sshd may pick up the fingerprint settings from {{path|/etc/pam.d/common-auth}}. I didn't want that, so I removed the "auth include common-auth" line from {{path|/etc/pam.d/sshd}} and replaced it with the lines that were originally in my {{path|/etc/pam.d/common-auth}}. That way most local services use the fingerprint reader, but sshd does not.

Another way to do this is to create a file ({{path|/etc/pam.d/bioapi|}} for example) which contains the {{cmd|pam_bioapi.so|}} lines, and explicitly {{cmd|@include|}} this '''before''' {{path|/etc/pam.d/common-auth|}} in the files for services which should use the fingerprint reader. In this case you should leave {{path|/etc/pam.d/common-auth|}} alone.

{{NOTE|This was discovered through trial and success, if it is plain wrong, wikorrect it, please.}}

In {{Fedora}} the original 'session' terms in {{path|/etc/pam.d/system-auth}} need to be kept.

{{HINT|The setup described above will/could affect remote ssh logins to also use biometric logins, which is a bit silly (who wants to remote ssh to the laptop, and then have to walk over to it and swipe your finger)<br />To avoid that you can copy the default <tt>/etc/pam.d/system-auth</tt> to <tt>/etc/pam.d/sshd</tt> which will allow the sshd service to use the standard authentication procedure.}}

You can do some useful testing with [http://pamtester.sourceforge.net/ {{cmd|pamtester|}}], which calls the pam modules as if it were a program of your choice. Examples:
:{{cmdroot|pamtester xdm yourusername authenticate}}
:{{cmduser|pamtester xscreensaver yourusername authenticate}}
where {{cmd|yourusername|}} is your username. Note that {{cmd|pamtester|}} should run as root if and only if the program in question does.

===Application support===
The implementation of fingerprint scanning support in the relevant applications varies.

Here is the behaviour of the most common ones:
* In gdm enter your username and there should pop up an (ugly) image to swipe your finger and... magic - you can login without a password.
* kdm doesn't give any visual indication, other than that the cursor stops blinking. Just swipe your finger and hope it lets you log in.
* In xdm, enter your username and a blank password, then swipe (there is no popup as well). Identification support for xdm can be achieved with [http://www.nax.cz/pub/bioapi/2005/xdm/xdm_bio.patch this patch].
* The KDE screen saver in SUSE 10 requires you to enter an empty password (or select the correct user and then enter an empty password) in order to get the fingerprint prompt.
* For Fedora users, the redhat-config tools will crash if no root.bir presents. Also, there won't be any visual idication unless X server is properly configured for root to access. Just swipe your finger when the HDD stopped blinking or issue the following command in advance:
:{{cmduser|xhost +local:}}
* For RHEL4 users gdm, console (virtual terminal) logins and the xscreensaver all work

===kdm support===
To add graphical popup to kdm, you need following:
* Patch for pam_bioapi. This patch adds third parameter to {{path|pam_bioapi.so}} module, which is a name of file with additional environment variables that will be supplied to the UPEK driver.
:{{cmdroot|wget http://upir.cz/linux/patches/pam_bioapi-0.2.1-alter-environ.patch}}
:{{cmdroot|patch -p1 < pam_bioapi-0.2.1-alter-environ.patch}}
* Edit your {{path|Xsetup}} file (on SUSE 10 it's {{path|/etc/X11/xdm/Xsetup}}) and add these lines:
echo "XAUTHORITY=$XAUTHORITY" > /var/lib/xdm/kdm_env
echo "DISPLAY=$DISPLAY" >> /var/lib/xdm/kdm_env
* In {{path|/etc/pam.d/xdm}} file, add {{path|/var/lib/xdm/kdm_env}} as a third parameter for {{path|pam_bioapi.so}} module:
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/ /var/lib/xdm/kdm_env

Please note, that this won't work if you have more than one Xserver.

==Make xscreensaver use the scanner==
If you are using Gentoo, you can get a portage overlay with the necessary patches here: http://www.zzamboni.org/brt/files/xscreensaver-fingerprint-overlay.tar.gz
*Get the needed xscreensaver sources:
:{{cmduser|wget http://www.jwz.org/xscreensaver/xscreensaver-4.23.tar.gz}}
:{{cmduser|tar xzf xscreensaver-4.23.tar.gz}}
:{{cmduser|cd xscreensaver-4.23}}
:{{cmduser|wget http://www.nax.cz/pub/bioapi/2005/xscreensaver/xscreensaver-4.22_alternativeAuth.diff<br/> mirror: http://zepan.org/files/xscreensaver-4.22_alternativeAuth.diff<br/>For xscreensaver 5.00, you can get a patch here: http://www.zzamboni.org/brt/files/xscreensaver-5.00-alternativeauth.patch}}
*After reviewing the patch (it's small and straightforward), do
:{{cmduser|patch -p1 < xscreensaver-4.22_alternativeAuth.diff}}<br />The patch prevents xscreensaver from opening an authentification window and dispatches the authentification request to another program, in our case <tt>pam</tt> and <tt>pam_bioapi</tt>. It should apply with some offset, don't mind that. If it says something about rejected though, then there's a problem.
*Compile with
:{{cmduser|./configure --with-pam && make}}<br />
*If you receive an error like "Couldn't find X11 headers/libs" and are running a Debian-like system, try "apt-get install xlibs-dev"
*If you receive an error like "undefined reference to `XmuPrintDefaultErrorMessage'" then install the libxmu-dev package and run the previous line again and then install as root with
:{{cmduser|su -c make install}} .
*Make sure that the newly compiled xscreensaver is used:
:{{cmduser|which xscreensaver}} should return
:{{cmdresult|/usr/local/bin/xscreensaver}} .
*In case it doesn't, try adjusting your PATH.

How to enable integrated fingerprint reader with BioAPI

2006-07-30T09:50:52Z

Pavel: Added notice that this driver is binary-only, and add link to open source driver.

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
This page describes the process of getting the [[Integrated Fingerprint Reader|integrated fingerprint reader]] to work under Linux, using bioapi and binary-only drivers. It is based on experiences in {{Ubuntu}} on a T43. The same works on {{Fedora}} 4 and 5, RHEL4, SuSE 9.3, SuSE 10, and {{Gentoo}}. Note that experimental open-source driver is available, see [[Integrated Fingerprint Reader||fingerprint reader]] page for details.
|}

==Basic installation==
===Installing the bioapi framework===
====Automated installation script====
The [[Script for enabling the fingerprint reader]] automates the installation of most components (bioapi framework, driver, pam_bioapi, pam setup, device permissions, pamtester and enrolling), for some Linux distributions.

====Binary packages====

Note that these packages only take care of this one section. If you can use one, you should do so and then proceed to the section entitled, Installing and Configuring the Driver.

=====Debian/ Ubuntu Dapper=====
*If you're using {{Debian}} Sid (the unstable branch) or {{Ubuntu}} Dapper Drake 6.06 LTS you can try the packages from Michael R. Crusoe's site, either [http://www.qrivy.net/~michael/temp/ version 1.2.3] (recommended) or [http://www.qrivy.net/~michael/debs/unstable/ older versions] which might not work with the steps in this howto.

{{HINT|Ignore the warning about not finding ''/usr/lib/libqtpwbsp.so'', it's not fatal.}}

=====Gentoo=====
You can either grab the [http://www.qrivy.net/~michael/blua/bioapi/bioapi-1.2.2.ebuild.tar.bz2 ebuild], or use the source-install procedure below.

Also see [http://toe.ch/~tsa/ibm-fingerprint/ http://toe.ch/~tsa/ibm-fingerprint/] for alternative documentation on installing on Gentoo including ebuilds for all the packages used.
=====Fedora Core=====
RPM packages for Fedora Core and installation instructions are available [[Installing Fedora Core 5 on a ThinkPad X41 Tablet#Fingerprint_Reader|here]]

====Installing from source====
*Get the bioapi source:
:{{cmduser|wget http://www.qrivy.net/~michael/blua/bioapi/bioapi-latest.tar.bz2}}
*I could not compile bioapi with the graphical Qt tools. To do it manually, do the following:
:{{cmduser|tar xjf bioapi-latest.tar.bz2}}
:{{cmduser|cd bioapi-1.2.2}}
:{{cmduser|1=./configure --with-Qt-dir=no}}
:{{cmduser|make}}
:and then as root
:{{cmdroot|make install}}
:If make install fails, be sure you're root and then:
:{{cmdroot|1=export LD_LIBRARY_PATH=/usr/local/lib}}
:{{cmdroot|make install}}
:and if you want to compile pam_bioapi for auth later
:{{cmdroot|cp include/bioapi_util.h include/installdefs.h imports/cdsa/v2_0/inc/cssmtype.h /usr/include}}
:Be aware that checkinstall will not work!
:(I got through configure with Qt, but got a cryptic build error. It all worked fine with Qt disabled as above)
:buzz: This is due to a wrong qt include path, set it manually in configure and everything should work.
*Bioapi (at least version 1.2.2) doesn't compile with GCC4. You need to patch it:
*This is neccessary to compile on SUSE 10.1 which it using gcc version 4.1.0.
:{{cmduser|wget http://upir.cz/linux/patches/bioapi-1.2.2-gcc4.patch}}
:{{cmduser|patch -p1 < bioapi-1.2.2-gcc4.patch}}
*Patch for gcc 4.1 is available here - http://cvs.pld-linux.org/cgi-bin/cvsweb/SOURCES/bioapi-c++.patch?rev=1.3
* By default, bioapi will install numerous files in {{path|/usr/local/<nowiki>{</nowiki>bin,lib,include<nowiki>}</nowiki>}}, including files with "self-explanatory" names such as {{path|/usr/local/bin/Sample}}. To prevent this pollution:
:Create a dedicated directory, for example {{path|/opt/bioapi}} .
:Append <tt>--prefix=/opt/bioapi</tt> to the above <tt>./configure</tt> command.
:Append {{path|/opt/bioapi/bin}} to <tt>$PATH</tt> and {{path|/opt/bioapi/lib}} to <tt>$LD_LIBRARY_PATH</tt>.
:When installing the driver (below), tell it the new install path: {{cmdroot|sh install.sh /opt/bioapi/lib}}

====Adjusting ldconfigs library search path====
At least on {{Fedora}} or {{Aurox}} 11, you may need to add {{path|/usr/local/lib}} to the library path so that the libraries referenced from <tt>pam_bioapi.so</tt> get picked up properly. The usual way to do this is adding it to the ldconfig configuration:
:{{cmdroot|echo '/usr/local/lib' > /etc/ld.so.conf.d/bioapi.conf}}
:{{cmdroot|ldconfig}}
Alternatively you can add it to the LD_LIBRARY variable.

If you see bioapi libs in the output of
:{{cmdroot|ldconfig -p | grep bioapi}}
then it should work.

===Installing and configuring the driver===
====Installing the driver====
*Download {{path|TFMESS_BSP_LIN_1.0.zip}} from the [http://www.upek.com/support/dl_linux_bsp.asp UPEK support site] and unzip it into a seperate folder, as it will not create one.
*Change to that folder and do as root:
:{{cmdroot|sh install.sh}}
:If you're running Gentoo or Ubuntu Dapper, use
:{{cmdroot|sh install.sh /usr/lib}}
:If that fails, it may be that make install failed up above -- try setting LD_LIBRARY_PATH, do the make install again, and come back here and try this again. You also need {{cmd|mod_install|}} from bioapi in your PATH.
:May there still occures and error, which means mod_install: command not found.
:Then login as root - not su!
:Do this:
:{{cmdroot|sh install.sh}}
:again. It should work. SU to root does not work since then the /usr/local/bin directory is not used per default.

====Configuring permissions for non-root use====
If you want to use PAM-aware applications like xscreensaver that are NOT running with root permissions (as opposed to login, gdm or other authentication mechanisms), you may need to do all or at least some of the things in this section. More details on what is necessary on which distributions would be greately appreciated.
*Create two groups, one for access to BioAPI files and the other for access to the usb files. (This is done for full generality; i.e., you may have other USB devices which you want accessable to other users, without exposing your BioAPI configuration to them). Add your normal user (the one you wish to use PAM-aware applications with) to both of these groups.
On {{Debian}} this is done with
:{{cmdroot|addgroup --system bioapi}}
:{{cmdroot|addgroup --system usbfs}}
:{{cmdroot|adduser yournormaluser bioapi}}
:{{cmdroot|adduser yournormaluser usbfs}}
On {{SUSE}} this is done with
:{{cmdroot|groupadd --system bioapi}}
:{{cmdroot|groupadd --system usbfs}}
:{{cmdroot|groupmod -A yournormaluser bioapi}}
:{{cmdroot|groupmod -A yournormaluser usbfs}}
On {{Mandriva}} this is done with
:{{cmdroot|groupadd -r bioapi}}
:{{cmdroot|groupadd -r usbfs}}
:{{cmdroot|usermod -G bioapi,usbfs yournormaluser}}

:(where {{cmd|yournormaluser|}} is your normal user name). You will need to log out and log back in for this to take effect.
*Set permissions on the BioAPI config/registry directory:
:{{cmdroot|chown -R root:bioapi /usr/local/var/bioapi/}}
:{{cmdroot|chmod -R 770 /usr/local/var/bioapi/}}
:(change this path if you used an alternate BioAPI install directory above)
*Set permissions on the files in {{path|/proc/bus/usb}}:
:{{cmdroot|chown -R root:usbfs /proc/bus/usb}}
:{{cmdroot|chmod -R g+X /proc/bus/usb}}
:{{cmdroot|chown root:usbfs /proc/bus/usb/`lsusb <nowiki>|</nowiki> sed -ne "/0483:2016/s/Bus\ $.*$\ Device\ $.*$:\ .*/\1\/\2/p"`}}
:{{cmdroot|chmod 660 /proc/bus/usb/`lsusb <nowiki>|</nowiki> sed -ne "/0483:2016/s/Bus\ $.*$\ Device\ $.*$:\ .*/\1\/\2/p"`}}
:You may need to replace {{cmd|lsusb|}} with its full path, which is something like {{cmd|/sbin/lsusb|}} or {{cmd|/usr/bin/lsusb|}} depending on your distro. It might be necessary to put these lines into a script which is run at startup and resume from suspend/hibernate.
*As an alternative to the {{cmd|chown|}}/{{cmd|chmod|}} commands above, you can set mount options for usbfs with a line in {{path|/etc/fstab|}}; an example would be
none /proc/bus/usb usbfs defaults,devgid=108,devmode=0660,busgid=108,busmode=0770,listgid=108,listmode=0660 0 0
:where 108 is replaced with the numerical group ID of the usbfs group (you can determine this with something like {{cmd|cat /etc/group <nowiki>|</nowiki> grep usbfs <nowiki>|</nowiki> cut -d':' -f 3|}}). Make sure you only have one {{path|/proc/bus/usb}} entry in {{path|/etc/fstab}}. See the {{cmd|mount(8)|}} manpage for more information on these options. This is "cleaner" but seems to have a few weird issues -- see the talk page for details.
*You may also have files in {{path|/dev/bus/usb}}, which the driver will try before {{path|/proc/bus/usb}}. If this is another usbfs mount point ({{cmd|mount|}} shows a line containing {{cmdresult|/dev/bus/usb type usbfs}}), then simply follow the above instructions with {{path|/dev/bus/usb}} rather than {{path|/proc/bus/usb}}. Otherwise, you may be running a new kernel (i.e. 2.6.15) that makes usbfs-like files available through {{path|/dev/bus/usb}}.
*On systems running udev these files are dynamically created; you can configure their permissions by editing a udev config file. On Debian this is done by changing the <tt>usb_device</tt> line of {{path|/etc/udev/permissions.rules}} to read
SUBSYSTEM=="usb_device", MODE="0660", GROUP="usbfs"
*For the beta versions only, there is a logfile, which needs to exist with the proper permissions:
:{{cmdroot|touch /var/log/BSP.log && chown root:bioapi /var/log/BSP.log && chmod 660 /var/log/BSP.log}}

====Miscellaneous configuration====
* To increase the security level (minimize false accept rate), set this in {{path|/etc/tfmessbsp.cfg}}:
security-level="5"
{{WARN|Please see discussion section Security Level!}}

===Testing the driver and enrolling a fingerprint===
To test the driver and generate the file containing your fingerprint information, you need a sample program included with the driver. The compilation steps below were discovered by trial and error; if they don't work for you, try the binary {{cmd|Sample|}} utility that came with the beta versions of the driver (i.e., {{path|TFMESS_BSP_LIN_1.0beta2.zip}} as mentioned above).
Go to the folder where you extracted {{path|TFMESS_BSP_LIN_1.0.zip}} and do:
:{{cmdroot|cd NonGUI_Sample}}
:Edit {{path|main.c|}} and remove (or comment out) the line
#include "port/bioapi_port.h"
:{{cmdroot|gcc -o Sample main.c -L/usr/local/lib -lbioapi100 -DUNIX -DLITTLE_ENDIAN}}
:{{cmdroot|./Sample}}
:Note that Sample may only run as root, unless you've already configured the usbfs file permissions.
:You can try to "e"nroll (to record a fingerprint for an account) and then "v"erify (to test a fingerprint against the one it expects for an account).
:You'll save a step later if you use your own login username as the username to enroll here.
:If running {{cmd |./Sample|}} produces the error message 'BioAPI_ModuleLoad failed, BioAPI Error Code: 6477 (0x194d)'
:then uncommenting the line
://BioAPI_SetGUICallbacks(gModuleHandle, NULL, NULL,TextGuiCallback, NULL);
:in {{path|main.c|}} can help.

==Login via pam_bioapi==

The following explains how to add fingerprint authentiation to programs that use the PAM (Pluggable Authentication Modules) framework, such as Gnome's GDM and KDE's KDM and screensaver.

===Getting required libs & tools===
====Installing pam_bioapi====
*Prerequisites
:On SuSE 10, I needed to install the pam-devel RPM
:In general, you will need pam itself (standard for most distros) as well as the pam development files (probably an optional package for your distro).
*Get and compile the pam_bioapi module.
{{HINT|A new version, pam_bioapi 0.3.0, with multi-finger and identification support can be found [http://www.nax.cz/pub/bioapi/pam_bioapi/pam-bioapi_0.3.0.tar.gz here].}}
:{{cmduser|wget http://www.qrivy.net/~michael/blua/pam_bioapi/pam_bioapi-latest.tar.bz2}}
:{{cmduser|tar xjf pam_bioapi-latest.tar.bz2}}
:{{cmduser|cd pam_bioapi-0.2.1}}
:{{cmduser|wget http://badcode.de/downloads/fingerprint.patch}}
:{{cmduser|patch -p0 < fingerprint.patch}}
:If you want to, review the patch. In general you should review all code you download and compile, if possible.
:{{cmduser|<nowiki>./configure --libdir=/lib && make </nowiki>}}
:and as root
:{{cmdroot| make install}}
{{NOTE|If you get a 'rpl_malloc' error in /var/log/auth.log when trying to use the fingerprint reader, redo these steps and remove the related term from Makefile after running ./configure. (FC3, Debian etch)}}
*If you get 'configure: error: cannot find required header: security/_pam_macros.h' and are on a Debian-like system, do "apt-get install libpam0g-dev" and try again. If you are using a Mandriva distribution, do "urpmi libpam0-devel" instead.
*If you get 'PAM [dlerror: /lib/security/pam_bioapi.so: undefined symbol: BioAPIMemoryFuncs]' error in your syslog, replace 'LIBS = ' line in {{path|libpam_bioapi/makefile}} with the following (of course, replace {{path|/opt/bioapi/}} with the path where you installed bioapi):
LIBS = -L/opt/bioapi/lib -lbioapi100 -lbioapi_mds300 -lmds_util
*Use the sample tool from the fingerprint reader to create {{path|<username>.bir}} (<tt><username></tt> '''must''' be the username you want to login with. gdm will probably break for any login name that has no .bir file).
*As root do:
:{{cmdroot|SERIAL<nowiki>=`BioAPITest | sed -ne "/Fingerprint/{n;n;s/^.*: $.\{9\}$$.\{4\}$$.\{4\}$$.\{4\}$$.*$/\1-\2-\3-\4-\5/gp}"` </nowiki>}}
:{{cmdroot|echo $SERIAL}} should print something like {{cmdresult|<nowiki>{5550454b-2054-464d-2f45-535320425350}</nowiki>}} now.
:If it does, do:
:{{cmdroot|mkdir -p /etc/bioapi/pam/$SERIAL}}
:{{cmdroot|cp <username>.bir /etc/bioapi/pam/$SERIAL}}
:If not, you might just try
:{{cmdroot|SERIAL<nowiki>={5550454b-2054-464d-2f45-535320425350}</nowiki>}}
:as this value is hardcoded into the UPEK docs.

===Configuring pam===
The following part is distribution specific. On {{Ubuntu}} or {{SUSE}} you can modify {{path|/etc/pam.d/common-auth}} (on {{Gentoo}} and {{Fedora}} it is {{path|/etc/pam.d/system-auth}}) to look like this:

#
# /etc/pam.d/common-auth - authentication settings common to all services
#
# This file is included from other service-specific PAM config files,
# and should contain a list of the authentication modules that define
# the central authentication scheme for use on the system
# (e.g., /etc/shadow, LDAP, Kerberos, etc.). The default is to use the
# traditional Unix authentication mechanisms.
#
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
password sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
auth required pam_unix.so nullok_secure

----
For '''Gentoo'''-Users - this allows you to attempt a password first. If you simply press enter, it then prompts for a fingerprints. Create a file named {{path|/etc/pam.d/bioapi}}. This also means that remote services, such as SSH keep working:

auth required pam_env.so
auth sufficient pam_unix.so likeauth nullok
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
auth required pam_deny.so

account required pam_unix.so

session required pam_limits.so
session required pam_unix.so

----

Now, simply replace "auth include system-auth" in all services that you wish to use fingerprint for with "auth include bioapi". For example, {{path|/etc/pam.d/kde}} by default contains

auth include system-auth
auth required pam_nologin.so

account include system-auth

password include system-auth

session include system-auth

Simply replace the first "system-auth" with bioapi and you can also get rid of KDE desktop lock with a fingerprint. If you do not wish to allow for "password fallback" then remove

auth sufficient pam_unix.so likeauth nullok

from {{path|/etc/pam.d/bioapi}}.

{{WARN|If su/sudo expects to receive the root password (SuSE 10), you need to have fingerprint settings for root (that is, copy in a root.bir as well as a your-username.bir). Otherwise, they get a segmentation fault. Which is a little unfortunate, given that you need to su or sudo to change your settings... }}
{{WARN|Not only SuSE 10 requires root.bir to be available for su to work. Just make sure you have root.bir when su is not working with your fingerprint reader but other applications are...}}
Note that sshd may pick up the fingerprint settings from {{path|/etc/pam.d/common-auth}}. I didn't want that, so I removed the "auth include common-auth" line from {{path|/etc/pam.d/sshd}} and replaced it with the lines that were originally in my {{path|/etc/pam.d/common-auth}}. That way most local services use the fingerprint reader, but sshd does not.

Another way to do this is to create a file ({{path|/etc/pam.d/bioapi|}} for example) which contains the {{cmd|pam_bioapi.so|}} lines, and explicitly {{cmd|@include|}} this '''before''' {{path|/etc/pam.d/common-auth|}} in the files for services which should use the fingerprint reader. In this case you should leave {{path|/etc/pam.d/common-auth|}} alone.

{{NOTE|This was discovered through trial and success, if it is plain wrong, wikorrect it, please.}}

In {{Fedora}} the original 'session' terms in {{path|/etc/pam.d/system-auth}} need to be kept.

{{HINT|The setup described above will/could affect remote ssh logins to also use biometric logins, which is a bit silly (who wants to remote ssh to the laptop, and then have to walk over to it and swipe your finger)<br />To avoid that you can copy the default <tt>/etc/pam.d/system-auth</tt> to <tt>/etc/pam.d/sshd</tt> which will allow the sshd service to use the standard authentication procedure.}}

You can do some useful testing with [http://pamtester.sourceforge.net/ {{cmd|pamtester|}}], which calls the pam modules as if it were a program of your choice. Examples:
:{{cmdroot|pamtester xdm yourusername authenticate}}
:{{cmduser|pamtester xscreensaver yourusername authenticate}}
where {{cmd|yourusername|}} is your username. Note that {{cmd|pamtester|}} should run as root if and only if the program in question does.

===Application support===
The implementation of fingerprint scanning support in the relevant applications varies.

Here is the behaviour of the most common ones:
* In gdm enter your username and there should pop up an (ugly) image to swipe your finger and... magic - you can login without a password.
* kdm doesn't give any visual indication, other than that the cursor stops blinking. Just swipe your finger and hope it lets you log in.
* In xdm, enter your username and a blank password, then swipe (there is no popup as well). Identification support for xdm can be achieved with [http://www.nax.cz/pub/bioapi/2005/xdm/xdm_bio.patch this patch].
* The KDE screen saver in SUSE 10 requires you to enter an empty password (or select the correct user and then enter an empty password) in order to get the fingerprint prompt.
* For Fedora users, the redhat-config tools will crash if no root.bir presents. Also, there won't be any visual idication unless X server is properly configured for root to access. Just swipe your finger when the HDD stopped blinking or issue the following command in advance:
:{{cmduser|xhost +local:}}
* For RHEL4 users gdm, console (virtual terminal) logins and the xscreensaver all work

===kdm support===
To add graphical popup to kdm, you need following:
* Patch for pam_bioapi. This patch adds third parameter to {{path|pam_bioapi.so}} module, which is a name of file with additional environment variables that will be supplied to the UPEK driver.
:{{cmdroot|wget http://upir.cz/linux/patches/pam_bioapi-0.2.1-alter-environ.patch}}
:{{cmdroot|patch -p1 < pam_bioapi-0.2.1-alter-environ.patch}}
* Edit your {{path|Xsetup}} file (on SUSE 10 it's {{path|/etc/X11/xdm/Xsetup}}) and add these lines:
echo "XAUTHORITY=$XAUTHORITY" > /var/lib/xdm/kdm_env
echo "DISPLAY=$DISPLAY" >> /var/lib/xdm/kdm_env
* In {{path|/etc/pam.d/xdm}} file, add {{path|/var/lib/xdm/kdm_env}} as a third parameter for {{path|pam_bioapi.so}} module:
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/ /var/lib/xdm/kdm_env

Please note, that this won't work if you have more than one Xserver.

==Make xscreensaver use the scanner==
If you are using Gentoo, you can get a portage overlay with the necessary patches here: http://www.zzamboni.org/brt/files/xscreensaver-fingerprint-overlay.tar.gz
*Get the needed xscreensaver sources:
:{{cmduser|wget http://www.jwz.org/xscreensaver/xscreensaver-4.23.tar.gz}}
:{{cmduser|tar xzf xscreensaver-4.23.tar.gz}}
:{{cmduser|cd xscreensaver-4.23}}
:{{cmduser|wget http://www.nax.cz/pub/bioapi/2005/xscreensaver/xscreensaver-4.22_alternativeAuth.diff<br/> mirror: http://zepan.org/files/xscreensaver-4.22_alternativeAuth.diff<br/>For xscreensaver 5.00, you can get a patch here: http://www.zzamboni.org/brt/files/xscreensaver-5.00-alternativeauth.patch}}
*After reviewing the patch (it's small and straightforward), do
:{{cmduser|patch -p1 < xscreensaver-4.22_alternativeAuth.diff}}<br />The patch prevents xscreensaver from opening an authentification window and dispatches the authentification request to another program, in our case <tt>pam</tt> and <tt>pam_bioapi</tt>. It should apply with some offset, don't mind that. If it says something about rejected though, then there's a problem.
*Compile with
:{{cmduser|./configure --with-pam && make}}<br />
*If you receive an error like "Couldn't find X11 headers/libs" and are running a Debian-like system, try "apt-get install xlibs-dev"
*If you receive an error like "undefined reference to `XmuPrintDefaultErrorMessage'" then install the libxmu-dev package and run the previous line again and then install as root with
:{{cmduser|su -c make install}} .
*Make sure that the newly compiled xscreensaver is used:
:{{cmduser|which xscreensaver}} should return
:{{cmdresult|/usr/local/bin/xscreensaver}} .
*In case it doesn't, try adjusting your PATH.

Integrated Fingerprint Reader

2006-07-30T09:48:26Z

Pavel: Removed another dead link

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;" | [[Image:fingerprintreader.jpg|IBM Integrated Fingerprint Reader]] __NOTOC__
|style="vertical-align:top" |
<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#F8F8FF; align:right;">
===Integrated Fingerprint Reader===
IBM released a second generation of T42 models in Autumn 2004 featuring Intel Pentium M 765 processors and an integrated fingerprint reader.

The fingerprint reader is produced by a company called UPEK, which specializes in the manufacture of fingerprint readers. It is integrated as an USB device, and does all the matching in hardware, making it rather easy to use. Furthermore, IBM states that there's an interface with the [[Embedded Security Subsystem]].
</div>
|}

==Linux Support==

There is a new GPL driver here: http://pavelmachek.livejournal.com/25060.html

A closed source driver from the vendor has been released. It interfaces to the hardware as a user-space USB driver through {{path|/proc/bus/usb|}} and provides a BioAPI 1.10 device, which can then be interfaced to pam for authentication by user programs. The driver can be downloaded from http://www.upek.com/support/dl_linux_bsp.asp; see the [[How to enable the fingerprint reader|corresponding HOWTO]] for detailed instructions.

==Related Links==
* [http://www.trustedreviews.com/article.aspx?page=1643&head=36 Review from TrustedReviews of the fingerprint scanner]
* [http://biomark.org.ru/en/ A (Russian) project that provides support for a (different model) of fingerprint scanner] (also a USB device, though)

==Models featuring this Technology==
*ThinkPad {{T42}}, {{T42p}}, {{T43}}, {{T43p}}, {{T60}}, {{T60p}}
*ThinkPad {{X41}}, {{X41T}}, {{X60}}, {{X60s}}
*ThinkPad {{Z60m}}, {{Z60t}}

[[Category:Glossary]]

Integrated Fingerprint Reader

2006-07-30T09:47:08Z

Pavel: binary-only bioapi support is reality, not something planned. Remove obsolete link.

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;" | [[Image:fingerprintreader.jpg|IBM Integrated Fingerprint Reader]] __NOTOC__
|style="vertical-align:top" |
<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#F8F8FF; align:right;">
===Integrated Fingerprint Reader===
IBM released a second generation of T42 models in Autumn 2004 featuring Intel Pentium M 765 processors and an integrated fingerprint reader.

The fingerprint reader is produced by a company called UPEK, which specializes in the manufacture of fingerprint readers. It is integrated as an USB device, and does all the matching in hardware, making it rather easy to use. Furthermore, IBM states that there's an interface with the [[Embedded Security Subsystem]].
</div>
|}

==Linux Support==

There is a new GPL driver here: http://pavelmachek.livejournal.com/25060.html

A closed source driver from the vendor has been released. It interfaces to the hardware as a user-space USB driver through {{path|/proc/bus/usb|}} and provides a BioAPI 1.10 device, which can then be interfaced to pam for authentication by user programs. The driver can be downloaded from http://www.upek.com/support/dl_linux_bsp.asp; see the [[How to enable the fingerprint reader|corresponding HOWTO]] for detailed instructions.

==Related Links==
* [http://www.upek.com/customers/ct_notebook_ibm.asp UPEK customer report about the deal with IBM]
* [http://www.trustedreviews.com/article.aspx?page=1643&head=36 Review from TrustedReviews of the fingerprint scanner]
* [http://biomark.org.ru/en/ A (Russian) project that provides support for a (different model) of fingerprint scanner] (also a USB device, though)

==Models featuring this Technology==
*ThinkPad {{T42}}, {{T42p}}, {{T43}}, {{T43p}}, {{T60}}, {{T60p}}
*ThinkPad {{X41}}, {{X41T}}, {{X60}}, {{X60s}}
*ThinkPad {{Z60m}}, {{Z60t}}

[[Category:Glossary]]

Integrated Fingerprint Reader

2006-07-30T09:45:32Z

Pavel: Remove link to dead site

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;" | [[Image:fingerprintreader.jpg|IBM Integrated Fingerprint Reader]] __NOTOC__
|style="vertical-align:top" |
<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#F8F8FF; align:right;">
===Integrated Fingerprint Reader===
IBM released a second generation of T42 models in Autumn 2004 featuring Intel Pentium M 765 processors and an integrated fingerprint reader.

The fingerprint reader is produced by a company called UPEK, which specializes in the manufacture of fingerprint readers. It is integrated as an USB device, and does all the matching in hardware, making it rather easy to use. Furthermore, IBM states that there's an interface with the [[Embedded Security Subsystem]].
</div>
|}

==Linux Support==

There is a new GPL driver here: http://pavelmachek.livejournal.com/25060.html

A closed source driver from the vendor has been released. It interfaces to the hardware as a user-space USB driver through {{path|/proc/bus/usb|}} and provides a BioAPI 1.10 device, which can then be interfaced to pam for authentication by user programs. The driver can be downloaded from http://www.upek.com/support/dl_linux_bsp.asp; see the [[How to enable the fingerprint reader|corresponding HOWTO]] for detailed instructions.

==Related Links==
* [http://www.upek.com/customers/ct_notebook_ibm.asp UPEK customer report about the deal with IBM]
* [http://www.trustedreviews.com/article.aspx?page=1643&head=36 Review from TrustedReviews of the fingerprint scanner]
* [http://biomark.org.ru/en/ A (Russian) project that provides support for a (different model) of fingerprint scanner] (also a USB device, though)
* [http://linuxbiometrics.com/modules/news/article.php?storyid=16 UPEK announcement (planned, closed-source) support for BioAPI on Linux] The first release was scheduled for September 2005; the final driver came out in December 2005.

==Models featuring this Technology==
*ThinkPad {{T42}}, {{T42p}}, {{T43}}, {{T43p}}, {{T60}}, {{T60p}}
*ThinkPad {{X41}}, {{X41T}}, {{X60}}, {{X60s}}
*ThinkPad {{Z60m}}, {{Z60t}}

[[Category:Glossary]]

Integrated Fingerprint Reader

2006-07-30T09:40:17Z

Pavel: Add few more facts about fingerprint scanner

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;" | [[Image:fingerprintreader.jpg|IBM Integrated Fingerprint Reader]] __NOTOC__
|style="vertical-align:top" |
<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#F8F8FF; align:right;">
===Integrated Fingerprint Reader===
IBM released a second generation of T42 models in Autumn 2004 featuring Intel Pentium M 765 processors and an integrated fingerprint reader.

The fingerprint reader is produced by a company called UPEK, which specializes in the manufacture of fingerprint readers. It is integrated as an USB device, and does all the matching in hardware, making it rather easy to use. Furthermore, IBM states that there's an interface with the [[Embedded Security Subsystem]].
</div>
|}

==Linux Support==

There is a new GPL driver here: http://pavelmachek.livejournal.com/25060.html

A closed source driver from the vendor has been released. It interfaces to the hardware as a user-space USB driver through {{path|/proc/bus/usb|}} and provides a BioAPI 1.10 device, which can then be interfaced to pam for authentication by user programs. The driver can be downloaded from http://www.upek.com/support/dl_linux_bsp.asp; see the [[How to enable the fingerprint reader|corresponding HOWTO]] for detailed instructions.

==Related Links==
* [http://www.upek.com/customers/ct_notebook_ibm.asp UPEK customer report about the deal with IBM]
* [http://www.trustedreviews.com/article.aspx?page=1643&head=36 Review from TrustedReviews of the fingerprint scanner]
* [http://biomark.org.ru/en/ A (Russian) project that provides support for a (different model) of fingerprint scanner] (also a USB device, though)
* [http://linuxbiometrics.com/modules/newbb/viewtopic.php?topic_id=8&forum=1 Discussion of the T42/T42p fingerprint scanner on the Linux Biometrics site] ''(Linux Biometrics site has blown up so for now this link does not work)''
* [http://linuxbiometrics.com/modules/news/article.php?storyid=16 UPEK announcement (planned, closed-source) support for BioAPI on Linux] The first release was scheduled for September 2005; the final driver came out in December 2005.

==Models featuring this Technology==
*ThinkPad {{T42}}, {{T42p}}, {{T43}}, {{T43p}}, {{T60}}, {{T60p}}
*ThinkPad {{X41}}, {{X41T}}, {{X60}}, {{X60s}}
*ThinkPad {{Z60m}}, {{Z60t}}

[[Category:Glossary]]