ThinkWiki - User contributions [en]

Ipw2200

2009-11-01T21:17:18Z

Whoopie:

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |

The '''Ipw2200''' is the Linux driver for the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]] and [[Intel PRO/Wireless 2915ABG Mini-PCI Adapter]] found in [[Centrino]] laptops. This driver only works on 2.6.x kernels (2.6.4 or newer).

Starting with kernels 2.6.14 the driver is included in kernel.

{{NOTE|Make sure you have installed the firmware! The ipw2200 documentation will tell you where to find these firmware files and where to install those.}}

Included in mainline Linux kernels, tracking the SourceForge version with about 6 months delay.

== Packages ==
*{{Fedora}} Packages(1): Fedora Core includes the ipw2200-drivers in FC3 (with updates) and FC4. You still need to grab the firmware from http://rpm.livna.org/
*{{Fedora}} Packages(2): http://www.atrpms.net/name/ipw2200/
*{{Mandriva}}: The ipw2200 driver modules are included in the stock kernel package; the firmware is included in the commercial distribution or available from http://plf.zarb.org/.
*{{Gentoo}}: The driver is in the portage tree: emerge net-wireless/ipw2200 and net-wireless/ipw2200-firmware
*{{Debian Sarge}} includes the source code for the modules in package ipw2200-source (http://packages.debian.org/ipw2200-source). You additionally need to download firmware manually.
*{{Debian Etch}} includes a version of the modules in its kernel or for a later version install package ipw2200-modules-2.6-486 or ipw2200-modules-2.6-686 or ipw2200-modules-2.6-686-bigmem or ipw2200-modules-2.6-k7 or ipw2200-modules-2.6-amd64; or the source code for them in ipw2200-source (http://packages.debian.org/ipw2200-source) to compile one yourself. You additionally need to download firmware manually.

== Status ==
In development, usable, WEP 128bit encryption works, WPA and WPA2 work with drivers >= 1.0.2 using [[wpa_supplicant]], monitor/rfmon is supported as with version >= 1.0.6. Generally works well, but some users experience problems (especially with firmware restarts and with WPA functionality using [[wpa_supplicant]]). Passing the <tt>hwcrypto=0</tt> module parameter improves reliability for many users.

The ipw2200 driver up to version 1.0.6 (in combination with some newer kernels) had a problem getting DHCP leases (it turned out to be a bug in the broadcasting code). Version 1.0.7 seems to have fixed this.

Older ipw2200 driver versions shipped by many distributions have been reported to freeze a T43 after several minutes of intensive communication. Installing version 1.1.2 of the driver solved the problem.

Latest stable versions:
* ipw2200 driver: 1.2.0
* firmware: 3.0
* ieee80211 stack: 1.2.15

Latest development versions:
* ipw2200 driver: 1.2.2
* firmware: 3.1
* ieee80211 stack: 1.2.18

Mainline kernels contain older (but mostly functional) versions of ipw2200 and ieee80211, and still require the addition of the [http://ipw2200.sourceforge.net/firmware.php firmware] files. To get the latest versions you need to separately install the [http://ipw2200.sourceforge.net/downloads.php ipw2200] module and [http://ieee80211.sourceforge.net/downloads.php ieee80211] stack.

==Installation==
=== Source Code ===
Download the latest [http://ieee80211.sourceforge.net/downloads.php ieee80211] stack and install it:
:{{cmdroot|tar xzvf ieee80211-1.2.15.tgz}}
:{{cmdroot|cd ieee80211-1.2.15}}
:{{cmdroot|make}}
:{{cmdroot|make install}}

Download the latest [http://ipw2200.sourceforge.net/downloads.php ipw2200] module and install it:
:{{cmdroot|tar xzvf ipw2200-1.2.0.tgz}}
:{{cmdroot|cd ipw2200-1.2.0}}
:{{cmdroot|make}}
:{{cmdroot|make install}}

Download the matching [http://ipw2200.sourceforge.net/firmware.php firmware] and install it:
:{{cmdroot|tar xzvf ipw2200-fw-3.1.tgz -C /lib/firmware}}

=== Debian Sarge ===
{{cmdroot|apt-get install ipw2200-source}}

{{cmdroot|module-assistant -t build ipw2200-source}}

[is this how module-assistant works in Sarge?]

=== Debian Etch ===

The kernel includes a version but if you want a more recent version install the module ipw2200-modules-2.6-486 or ipw2200-modules-2.6-686 or ipw2200-modules-2.6-686-bigmem or ipw2200-modules-2.6-k7 or ipw2200-modules-2.6-amd64 depending on your architecture.

The firmware is not distributed with Debian due to licensing reasons, download the matching version 3.0 [http://ipw2200.sourceforge.net/firmware.php firmware] and install it:

:{{cmdroot|tar -xvf ipw2200-fw-3.1.tgz -C /lib/firmware}}

:{{cmdroot|mv /lib/firmware/ipw2200-fw-3.1/* /lib/firmware}}

=== Debian Unstable ===
Install ieee80211-source:
:{{cmdroot|apt-get install ieee80211-source}}
:{{cmdroot|module-assistant -t build ieee80211-source}}

The kernel includes a version but if you want a more recent version install the module ipw2200-modules-2.6-486 or ipw2200-modules-2.6-686 or ipw2200-modules-2.6-686-bigmem or ipw2200-modules-2.6-k7 or ipw2200-modules-2.6-amd64 depending on your architecture.

There is a bug in the {{Debian}} package (last checked: Dec 30th 2005) that prevents from linking to <tt>ieee80211</tt> modules using module-assistant. In case it is not fixed in your version, fall back to the regular source installation procedure described above.

The firmware is not distributed with Debian due to licensing reasons, download the matching [http://ipw2200.sourceforge.net/firmware.php firmware] and install it:

:{{cmdroot|tar xzvf ipw2200-fw-2.4.tgz -C /usr/lib/hotplug/firmware}}

see /etc/hotplug/firmware.agent for details on configured firmware locations

Make sure that your firmware files are not in a subdirectory (dmesg will give you warnings after any modprobe when firmware can't be loaded)

=== Fedora Core ===
Installation on Fedora Core 5 works out of the box provided you install the ipw2200-firmware package. However, certain parts of the install process may not set up the wireless networking in a friendly manner using GNOME system tray icons and other tools. Bill Moss has written some excellent HowTo articles, including using VPNC to connect to a remote Cisco IPSec network.

* [http://www.ces.clemson.edu/linux/fc2-ipw2200.shtml Fedora Core 5 and the IPW2200 Wireless Driver]
* [http://www.ces.clemson.edu/linux/nm.shtml Fedora Core 5 NetworkManager, NetworkManager-vpnc and Wireless Driver IPW2200]

== Testing the driver ==
:{{cmdroot|modprobe ipw2200}}
:{{cmdroot|iwconfig}}

{{cmdroot|dmesg}} output might look similar to this:
ieee80211: 802.11 data/management/control stack, 1.1.6
ieee80211: Copyright (C) 2004-2005 Intel Corporation <jketreno@linux.intel.com>
ipw2200: Intel(R) PRO/Wireless 2200/2915 Network Driver, 1.0.8
ipw2200: Copyright(c) 2003-2005 Intel Corporation
ipw2200: Detected Intel PRO/Wireless 2915ABG Network Connection

NB: To make the wifi LED work on the thinkpad, pass the option {{bootparm|led|1}} to the kernel while loading the module. eg. {{cmdroot|1=modprobe ipw2200 led=1}}. This can also be accomplished by adding that option to the file where your distribution looks for modprobe options so that it becomes automatic.

In debian this can be done by putting a file named after the module in /etc/modutils with the options in it

here we might run a cmd like this

:{{cmdroot|1=echo options ipw2200 led=1 > /etc/modutils/ipw2200 }}

then we must run update-modules to remake /etc/module.conf

:{{cmdroot|update-modules}}

== WPA support ==

Use [[wpa_supplicant]] with the <tt>-Dwext</tt> argument (not <tt>-Dipw</tt>), and pass the <tt>hwcrypto=0</tt> argument to the <tt>ipw2200</tt> module.

There are some very detailed instructions with working sample configurations on the following link:
[http://www.bughost.org/ipw/wpa_howto.txt ipw2200 WPA instruction]

== Power Management ==
The ipw2200 driver has power management capabilities, which comes in handy while operating on battery.

To enable reduced power consumption mode, issue:
:{{cmdroot|iwpriv wlan0 set_power 7}}
where <tt>wlan0</tt> is the name of your interface. This will reduce idle power consumption by 1-2 Watts compared to no power management. To return to the "normal" operation mode, you can issue:
:{{cmdroot|iwpriv wlan0 set_power 6}}.

In order to check current settings, you can issue:
:{{cmdroot|iwpriv wlan0 get_power}}.

More information on these option is available in the {{path|README.ipw3945}} file in the <tt>ipw3945</tt> package ({{path|README.ipw2200}} seems to be rather sketchy about the details of power management). You may want to turn power management on/off on demand in an ACPI script that catches battery/AC events, so that this happens automatically.

Note that there have been [http://www.bughost.org/bugzilla/show_bug.cgi?id=1074 reports] that some versions of ipw2200 react with a firmware error to power management commands. This [http://www.bughost.org/bugzilla/attachment.cgi?id=1024 patch] could alleviate the problem.

*To disable the radio (and further reduce power consumption) when the card is not in use, issue:
:{{cmdroot|echo 1 > /sys/bus/pci/drivers/ipw2200/*/rf_kill}}
*To enable the radio, issue:
:{{cmdroot|echo 0 > /sys/bus/pci/drivers/ipw2200/*/rf_kill}}
*To make the radio off by default after boot, add
options ipw2200 disable=1
to your {{path|/etc/modprobe.conf}} or equivalent (on kubuntu 6.10 {{path|/etc/modprobe.d/options}}).

See {{path|README.ipw2200}} in the <tt>ipw2200</tt> package for details and other options.

== Changing the enabled channels ==
Permitted WiFi channels vary with geography due to regulation. The EEPROM in this chip contains a country code (programmed by the hardware manufacturer), and the driver converts this to a channel list and enforces it.

If you carry your laptop to a different regulatory region, you may need to change the list of permitted channels according to local regulations. There are two ways to accomplish this:

===Patching the ipw2200 driver===
You can alter the ipw2200 driver sourcecode to hard-code the country code instead of reading it from EEPROM. For example, this will allow all 14 channels (perfect for those special occasions in international water):
<pre>
--- ipw2200.c.orig
+++ ipw2200.c
@@ -11344,7 +11344,7 @@ static int ipw_up(struct ipw_priv *priv)
memcpy(priv->net_dev->dev_addr, priv->mac_addr, ETH_ALEN);

for (j = 0; j < ARRAY_SIZE(ipw_geos); j++) {
- if (!memcmp(&priv->eeprom[EEPROM_COUNTRY_CODE],
+ if (!memcmp("ZZR",
ipw_geos[j].name, 3))
break;
}
</pre>

For the list of codes and their meaning, see the "<tt>ipw_geos</tt>" table in the [http://lxr.free-electrons.com/source/drivers/net/wireless/ipw2x00/ipw2200.c#10382 ipw2200.c sourcecode].

===Patching the EEPROM===

Alternatively, you can change the country code in the EEPROM once and for all, and then use the standard ipw2200 driver.

See this guide:
* [http://saftware.de/#ipw2200 Patching the EEPROM].

Instead of the <tt>hd</tt> program mentioned there, you can use the more common <tt>od</tt> program:
echo -n ZZD | od -t x1
0000000 5a 5a 44
0000003

{{WARN|If this procedure goes wrong, you may ruin your wireless card.}}

== Additional Comments ==
Your kernel may include an old version of the ipw2200 driver. It is recommended to use the latest version.

Make sure you also install the firmware version needed by the driver version you use. You can find the firmware [http://ipw2200.sourceforge.net/firmware.php here]. To install it, decompress the <tt>.tgz</tt> file into {{path|/usr/lib/hotplug/firmware}} or {{path|/lib/firmware}} depending on your disto.

The driver doesn't appear to support the MII interface, so any tools like automatic network configuration managers (i.e. whereami) that rely on mii-tool do not work.

== External links ==
* [http://ipw2200.sourceforge.net/ Official website]

[[Category:Drivers]]

BIOS Upgrade Downloads

2009-05-22T14:47:37Z

Whoopie: /* X Series */ new firmware for X61 Tablet

{| width="100%" columns="2"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" rowspan="2" | __TOC__
|style="vertical-align:top" |

{{NOTE|Firefox or Konqueror users should disable the '''Use IBM Download Director''' option when downloading files.}}

{{NOTE|All Lenovo T, X and R laptops have several bugs in the BIOS that are being actively fixed by Lenovo. For these laptops, BIOS updates are not optional if you find anything to not be working properly, be it the brightness control, or suspend to RAM, or volume keys.}}

{{WARN|You must make sure that the BIOS ID you are trying to install matches what was installed in your ThinkPad by the factory. A few models like the A31 and R61 have different BIOSes, and will malfunction if you pick the wrong one and somehow manage to force it to install.}}
|-
|

You can check current BIOS and Embedded Controller versions using dmidecode command line tool. For example:
bash# dmidecode -s bios-version && dmidecode -t11
1RETDRWW (3.23 )
# dmidecode 2.9
SMBIOS 2.33 present.
Handle 0x0029, DMI type 11, 5 bytes
OEM Strings
String 1: IBM ThinkPad Embedded Controller -[1RHT71WW-3.04 ]-

The following table lists direct links to BIOS updates for most Thinkpad Models. Refer to [[BIOS Upgrade]] for instructions on how to perform a BIOS upgrade.

The '''FW model''' column is what actually identifies which sort of firmware (BIOS and Embedded Controller) should be installed in a ThinkPad. Machines with the same firmware model use the same BIOS and Embedded Controller firmware. It can also be found as the OEM table ID in the ACPI DSDT. It is formed by the characters "TP-", plus the first two characters from the BIOS/EC update part number.

|}

{| width="100%" {{prettytable}}
| style="background:#ffdead;" rowspan="3"| '''Models'''
| style="background:#ffdead;" rowspan="3"| '''FW Model'''
| style="background:#ffdead;" colspan="2"| '''Non-Diskette'''
| style="background:#ffdead;" colspan="3"| '''Diskette (or bootable CD)'''
|-
| style="background:#ffdead;" rowspan="2"| '''BIOS'''
| style="background:#ffdead;" rowspan="2"| '''EC'''
| style="background:#ffdead;" colspan="2"| '''BIOS'''
| style="background:#ffdead;" rowspan="2"| '''EC'''
|-
| style="background:#ffdead;"| '''Windows'''
| style="background:#ffdead;"| '''Linux'''
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===200 Series===
|-
| {{240}}
| TP-IR
|
|
| {{IBMDOCURL|MIGR-496LGR|1.18}}
|
|
|-
| {{240X}}
| (none)
|
|
| {{IBMDOCURL|MIGR-4MCKB8|1.09}}
|
|
|-
| 240Z
| TP-11
|
|
| {{IBMDOCURL|MIGR-4PYQAK|1.72}}
|
|
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===300 Series===
|-
| {{365C}}, {{365CD}}, {{365CS}}, {{365CSD}}, {{365E}}, {{365ED}}
| (none)
|
|
| {{IBMDOCURL|MIGR-60567|2.0.14}}
|
|
|-
| {{365X}}, {{365XD}}
| (none)
|
|
| {{IBMDOCURL|MIGR-60567|1.10}}
|
|
|-
| {{380}}, {{380D}}, {{380E}}, {{380ED}}, {{385D}}, {{385ED}}
| TP-I1
|
|
| {{IBMDOCURL|DSHY-3XWNVG|1.14}}
|
|
|-
| {{380XD}}, {{385XD}}
| TP-IF
|
|
| {{IBMDOCURL|DSHY-3XWNVG|1.19}}
|
|
|-
| {{380Z}}
| TP-IG
|
|
| {{IBMDOCURL|DSHY-3XWNVG|1.08}}
|
|
|-
| {{390}}, i1720, i1721
| (none)
|
|
| {{IBMDOCURL|DSHY-427MCG|5.62}}
|
|
|-
| {{390E}}
| (none)
|
|
| {{IBMDOCURL|DSHY-46AKPY|1.55}}
|
|
|-
| {{390X}}, i1700
| TP-IS
|
|
| {{IBMDOCURL|MIGR-4C5UP9|0.55}}
|
|
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===500 Series===
|-
| {{560}}
| (none)
|
|
| {{IBMDOCURL|MIGR-60522|1.20}}
|
|
|-
| {{560E}}
| TP-HR
|
|
| {{IBMDOCURL|MIGR-60522|1.13}}
|
|
|-
| {{560X}}
| TP-I8
|
|
| {{IBMDOCURL|DSHY-3QYK7L|1.15}}
|
|
|-
| {{560Z}}
| TP-IE
|
|
| {{IBMDOCURL|DSHY-3YTKKV|1.07}}
|
|
|-
| {{570}}
| TP-IM
|
|
| {{IBMDOCURL|MIGR-47JS5Z|1.16}}
|
|
|-
| {{570E}}
| TP-IU
| {{IBMDOCURL|MIGR-4HT3RD|1.07}}
|
| {{IBMDOCURL|MIGR-4HA2BF|1.07}}
|
|
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===600 Series===
|-
| {{600}}
| TP-IB
|
|
| {{IBMDOCURL|DSHY-3VRJPK|1.22}}
|
|
|-
| {{600E}} (2645 selected models, 2646)
| TP-IN
|
|
| {{IBMDOCURL|DSHY-46HLKQ|1.16}}
|
|
|-
| {{600E}} (2645: 55x, 56x, 57x, 58x, A5x, A6x, Bxx [except for BAU], JJ1, JJ2, RRA)
| TP-IH
|
|
| {{IBMDOCURL|DSHY-43DNQ5|1.15}}
|
|
|-
| {{600X}}
| TP-IT
| {{IBMDOCURL|MIGR-4HVUYL|1.11}}
|
| {{IBMDOCURL|MIGR-4FYS2U|1.11}}
|
|
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===700 Series===
|-
| {{750}}, {{750CS}}, {{755C}}, {{755CS}}, {{750P}}
| (none)
|
|
| {{IBMDOCURL|MIGR-60440|1.43}}
|
|
|-
| {{755CE}}, {{755CSE}}, {{755CD}}, {{755CX}}, {{755CV}}, {{755CDV}}
| (none)
|
|
| {{IBMDOCURL|MIGR-60440|1.44}}
|
|
|-
| {{760C}}, {{760CD}}, {{760L}}, {{760LD}}
| TP-HV
|
|
| {{IBMDOCURL|MIGR-59734|1.30}}
|
|
|-
| {{760E}} (XGA), {{760ED}} (XGA), {{760XD}}, {{765D}}, {{765L}}
| TP-HX
|
|
| {{IBMDOCURL|MIGR-59734|2.13}}
|
|
|-
| {{760E}} (SVGA), {{760ED}} (SVGA), {{760EL}}, {{760ELD}}, {{760XL}}
| TP-HZ, TP-HY
|
|
| {{IBMDOCURL|MIGR-59734|2.13}}
|
|
|-
| {{770}}, {{770E}}, {{770ED}}
| TP-ID
|
|
| {{IBMDOCURL|DSHY-3P2MCB|1.34}}
|
|
|-
| {{770X}}
| TP-II
|
|
| {{IBMDOCURL|DSHY-42QLVU|1.10}}
|
|
|-
| {{770Z}}
| TP-IO
|
|
| {{IBMDOCURL|MIGR-47F3VA|1.05}}
|
|
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===A Series===
|-
| {{A20m}}
| TP-IW
| {{IBMDOCURL|MIGR-4MNN8Z|1.13}}
|
| {{IBMDOCURL|MIGR-4JWNTQ|1.13}}
|
|
|-
| {{A20p}}
| TP-IV
| {{IBMDOCURL|MIGR-4MNN8Y|1.11}}
|
| {{IBMDOCURL|MIGR-4JWNTR|1.11}}
|
|
|-
| {{A21e}} (2655)
| TP-10
| {{IBMDOCURL|MIGR-4UNQKX|1.07}}
|
| {{IBMDOCURL|MIGR-4UNRRF|1.07}}
|
|
|-
| {{A21e}} (2628)
| TP-KU
| {{IBMDOCURL|MIGR-4Q2KLU|1.13}}
|
| {{IBMDOCURL|MIGR-4Q2KLV|1.13}}
|
|
|-
| {{A21m}}
| TP-KX
| {{IBMDOCURL|MIGR-4PJMXK|1.09}}
|
| {{IBMDOCURL|MIGR-4Q2KM4|1.09}}
|
|
|-
| {{A21p}}
| TP-KY
| {{IBMDOCURL|MIGR-4Q2KM3|1.11}}
|
| {{IBMDOCURL|MIGR-4PJN8X|1.11}}
|
|
|-
| {{A22e}} Celeron
| TP-10
| {{IBMDOCURL|MIGR-4UNQKX|1.07}}
|
| {{IBMDOCURL|MIGR-4UNRRF|1.07}}
|
|
|-
| {{A22e}} Pentium
| TP-1B
| {{IBMDOCURL|MIGR-4XQKLK|1.05}}
|
| {{IBMDOCURL|MIGR-4XQL7B|1.05}}
|
|
|-
| {{A22m}}
| TP-KX
| {{IBMDOCURL|MIGR-4Q2KM4|1.09}}
|
| {{IBMDOCURL|MIGR-4PJMXK|1.09}}
|
|
|-
| {{A22m}} (2628-Sxx)
| TP-13
| {{IBMDOCURL|MIGR-4VXS2T|1.05}}
|
| {{IBMDOCURL|MIGR-4VXRG4|1.05}}
|
|
|-
| {{A22p}}
| TP-KY
| {{IBMDOCURL|MIGR-4Q2KM3|1.11}}
|
| {{IBMDOCURL|MIGR-4PJN8X|1.11}}
|
|
|-
| {{A30}}, {{A30p}}
| TP-1E
| {{IBMDOCURL|MIGR-39863|1.18}}
| {{IBMDOCURL|MIGR-40846|1.08}}
| {{IBMDOCURL|MIGR-39861|1.18}}
|
| {{IBMDOCURL|MIGR-40847|1.08}}
|-
| {{A31}}, {{A31p}} (Bios 1G*)
| TP-1G
| {{IBMDOCURL|MIGR-42654|1.12}}
| {{IBMDOCURL|MIGR-45771|1.05}}
| {{IBMDOCURL|MIGR-42660|1.12}}
| {{IBMDOCURL|MIGR-45900|1.05}}
| {{IBMDOCURL|MIGR-45770|1.05}}
|-
| {{A31}}, {{A31p}} (Bios 1N*)
| TP-1N
| {{IBMDOCURL|MIGR-44450|1.10}}
| {{IBMDOCURL|MIGR-45662|1.05}}
| {{IBMDOCURL|MIGR-44451|1.10}}
| {{IBMDOCURL|MIGR-45898|1.02}}
| {{IBMDOCURL|MIGR-45663|1.05}}
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===G Series===
|-
| {{G40}}
| TP-1T
| {{IBMDOCURL|MIGR-50672|1.21}}
|
| {{IBMDOCURL|MIGR-50673|1.21}}
|
|
|-
| {{G41}}
| TP-1X
| {{IBMDOCURL|MIGR-58127|1.14}}
|
| {{IBMDOCURL|MIGR-58129|1.14}}
|
|
|-
! colspan=7 style="text-align:center;background:#efefef;" |
===R Series===
|-
| {{R30}}
| TP-1C
| {{IBMDOCURL|MIGR-40216|1.38}}
|
| {{IBMDOCURL|MIGR-40217|1.38}}
|
|
|-
| {{R31}}
| TP-1F
| {{IBMDOCURL|MIGR-41378|3.11}}
|
| {{IBMDOCURL|MIGR-41535|3.11}}
|
|
|-
| {{R32}}
| TP-1M
| {{IBMDOCURL|MIGR-43571|2.16}}
|
| {{IBMDOCURL|MIGR-43572|2.16}}
|
|
|-
| {{R40}} (2681, 2682, 2683, 2896, 2898, 2899)
| TP-1O
| {{IBMDOCURL|MIGR-46055|1.27}}
| {{IBMDOCURL|MIGR-46143|1.14}}
| {{IBMDOCURL|MIGR-46061|1.27}}
|
| {{IBMDOCURL|MIGR-46144|1.14}}
|-
| {{R40}} (2722, 2723, 2724, 2897)
| TP-1P
| {{IBMDOCURL|MIGR-50320|1.33}}
| {{IBMDOCURL|MIGR-46143|1.14}}
| {{IBMDOCURL|MIGR-50321|1.33}}
|
| {{IBMDOCURL|MIGR-46144|1.14}}
|-
| {{R40e}}
| TP-1S
| {{IBMDOCURL|MIGR-50302|1.38}}
| {{IBMDOCURL|MIGR-50344|1.04}}
| {{IBMDOCURL|MIGR-50301|1.38}}
|
| {{IBMDOCURL|MIGR-50343|1.04}}
|-
| {{R50}}, {{R50p}}
| TP-1R
| {{IBMDOCURL|MIGR-50273|3.23}}
| {{IBMDOCURL|MIGR-50279|3.04}}
| {{IBMDOCURL|MIGR-50275|3.23}}
|
| {{IBMDOCURL|MIGR-50277|3.04}}
|-
| {{R50e}}
| TP-1W
| {{IBMDOCURL|MIGR-55000|2.10}}
| {{IBMDOCURL|MIGR-54996|1.04}}
| {{IBMDOCURL|MIGR-55001|2.10}}
|
| {{IBMDOCURL|MIGR-54997|1.04}}
|-
| {{R51}} (1829, 1830, 1831, 1836)
| TP-1R
| {{IBMDOCURL|MIGR-50273|3.23}}
| {{IBMDOCURL|MIGR-50279|3.04}}
| {{IBMDOCURL|MIGR-50275|3.23}}
|
| {{IBMDOCURL|MIGR-50277|3.04}}
|-
| {{R51}} (2883, 2887, 2888, 2889, 2894, 2895)
| TP-1V
| {{IBMDOCURL|MIGR-55003|1.29}}
| {{IBMDOCURL|MIGR-54996|1.04}}
| {{IBMDOCURL|MIGR-55004|1.29}}
|
| {{IBMDOCURL|MIGR-54997|1.04}}
|-
| {{R51e}}
| TP-78
| {{IBMDOCURL|MIGR-61681|1.59}}
| {{IBMDOCURL|MIGR-61677|1.01}}
| {{IBMDOCURL|MIGR-61680|1.59}}
|
| {{IBMDOCURL|MIGR-61675|1.01}}
|-
| {{R52}} (1846, 1847, 1848, 1849, 1850, 1870)
| TP-76
| {{IBMDOCURL|MIGR-59221|1.29}}
| {{IBMDOCURL|MIGR-59184|1.06}}
| {{IBMDOCURL|MIGR-59220|1.29}}
|
| {{IBMDOCURL|MIGR-59183|1.06}}
|-
| {{R52}} (1858, 1859, 1860, 1861, 1862, 1863)
| TP-70
| {{IBMDOCURL|MIGR-59379|1.29}}
| {{IBMDOCURL|MIGR-59439|1.05}}
| {{IBMDOCURL|MIGR-59380|1.29}}
|
| {{IBMDOCURL|MIGR-59440|1.05}}
|-
| {{R60}}, R60i (94xx)
| TP-7C
| {{IBMDOCURL|MIGR-64578|2.22}}
| 1.10
| {{IBMDOCURL|MIGR-64580|2.22}} (CD)
|
| 1.10
|-
| {{R60e}}, R60i (06xx)
| TP-7E
| {{IBMDOCURL|MIGR-64393|2.20}}
| 1.07
| {{IBMDOCURL|MIGR-64394|2.20}} (CD)
|
| 1.07
|-
| {{R61}} (8942, 8943, 8944, 8945, 8947, 8948, 8949)
| TP-7Q
| {{IBMDOCURL|MIGR-68186|1.21}}
| 1.00
| {{IBMDOCURL|MIGR-68187|1.21}} (CD)
|
| 1.00
|-
| {{R61}}, {{R61i}} (BIOS 7K*)
| TP-7K
| {{IBMDOCURL|MIGR-68168|2.26}}
| 1.08
| {{IBMDOCURL|MIGR-68178|2.26}} (CD)
|
| 1.08
|-
| {{R61}}, {{R61i}} (BIOS 7L*)
| TP-7L
| {{IBMDOCURL|MIGR-67988|2.25}}
| TP-7K 1.08
| {{IBMDOCURL|MIGR-67989|2.25}} (CD)
|
| TP-7K 1.08
|-
| R61e, {{R61i}} (BIOS 7O*)
| TP-7O
| {{IBMDOCURL|MIGR-68183|2.21}}
| TP-7K 1.08
| {{IBMDOCURL|MIGR-68185|2.21}} (CD)
|
| TP-7K 1.08
|-
| R61e (7650), {{R61i}} (7650)
| TP-7P
| {{IBMDOCURL|MIGR-68242|2.20}}
| TP-7K 1.08
| {{IBMDOCURL|MIGR-68243|2.20}} (CD)
|
| TP-7K 1.08
|-
| {{R400}} (7438, 7439, 7440, 7440, 7443, 7445, 7446, 7447)
| TP-7U
|
|
| {{IBMDOCURL|MIGR-70351|1.19}}? (CD)
| {{IBMDOCURL|MIGR-70351|1.19}}? (CD)
| 7UET49WW (1.19)
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===T Series===
|-
| {{T20}}
| TP-IY
| {{IBMDOCURL|MIGR-4MNN8X|1.22}}
|
| {{IBMDOCURL|MIGR-4JWNJC|1.22}}
|
|
|-
| {{T21}}
| TP-KZ
| {{IBMDOCURL|MIGR-4Q2KM5|1.16}}
|
| {{IBMDOCURL|MIGR-4PJN8Y|1.16}}
|
|
|-
| {{T22}}
| TP-16
| {{IBMDOCURL|MIGR-4VWPPU|1.12}}
|
| {{IBMDOCURL|MIGR-4VWP54|1.12}}
|
|
|-
| {{T23}}
| TP-1A
| {{IBMDOCURL|MIGR-39366|1.20}}
| {{IBMDOCURL|MIGR-40022|1.06a}}
| {{IBMDOCURL|MIGR-39362|1.20}}
|
| {{IBMDOCURL|MIGR-40021|1.06a}}
|-
| {{T30}}
| TP-1I
| {{IBMDOCURL|MIGR-42694|2.10}}
| {{IBMDOCURL|MIGR-42711|1.07}}
| {{IBMDOCURL|MIGR-42720|2.10}}
| {{IBMDOCURL|MIGR-45745|2.02}}
| {{IBMDOCURL|MIGR-42725|1.07}}
|-
| {{T40}}, {{T40p}}, {{T41}}, {{T41p}}, {{T42}}, {{T42p}}
| TP-1R
| {{IBMDOCURL|MIGR-50275|3.23}}
| {{IBMDOCURL|MIGR-50279|3.04}}
| {{IBMDOCURL|MIGR-50273|3.23}}
|
| {{IBMDOCURL|MIGR-50277|3.04}}
|-
| {{T43}} (1871, 1872, 1873, 1874, 1875, 1876)
| TP-70
| {{IBMDOCURL|MIGR-59379|1.29}}
| {{IBMDOCURL|MIGR-59439|1.05}}
| {{IBMDOCURL|MIGR-59380|1.29}}
|
| {{IBMDOCURL|MIGR-59440|1.05}}
|-
| {{T43}} (2668, 2669, 2678, 2679, 2686, 2687), {{T43p}}
| TP-1Y
| {{IBMDOCURL|MIGR-59096|1.29}}
| {{IBMDOCURL|MIGR-59120|1.06}}
| {{IBMDOCURL|MIGR-59097|1.29}}
|
| {{IBMDOCURL|MIGR-59121|1.06}}
|-
| {{T60}}, {{T60p}}
| TP-79
| {{IBMDOCURL|MIGR-63024|2.23}}
| 1.07
| {{IBMDOCURL|MIGR-63027|2.23}} (CD)
|
| 1.07
|-
| {{T60}}, {{T60p}} wide-screen
| TP-7I
| {{IBMDOCURL|MIGR-67018|1.15}}
| TP-79 1.07
| {{IBMDOCURL|MIGR-67020|1.15}} (CD)
|
| TP-79 1.07
|-
| {{T61}}
| TP-7L/7K
| {{IBMDOCURL|MIGR-67989|2.25}}
| 1.08
| {{IBMDOCURL|MIGR-67989|2.25}} (CD)
|
| 1.08
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===X Series===
|-
| {{X20}}, {{X21}}
| TP-IZ
| {{IBMDOCURL|MIGR-4P52BM|2.25}}
| {{IBMDOCURL|MIGR-4VQNTP|1.36}}
| {{IBMDOCURL|MIGR-4P52BL|2.25}}
|
| {{IBMDOCURL|MIGR-4PBMCT|1.36}}
|-
| {{X22}}, {{X23}}, {{X24}}
| TP-1D
| {{IBMDOCURL|MIGR-39672|1.32}}
| {{IBMDOCURL|MIGR-39806|1.30}}
| {{IBMDOCURL|MIGR-39665|1.32}}
|
| {{IBMDOCURL|MIGR-39808|1.30}}
|-
| {{X30}}
| TP-1K
| {{IBMDOCURL|MIGR-44135|1.09}}
| {{IBMDOCURL|MIGR-44152|1.06}}
| {{IBMDOCURL|MIGR-44131|1.09}}
|
| {{IBMDOCURL|MIGR-44149|1.06}}
|-
| {{X31}}, {{X32}}
| TP-1Q
| {{IBMDOCURL|MIGR-50298|3.02}}
| {{IBMDOCURL|MIGR-53480|1.08}}
| {{IBMDOCURL|MIGR-50308|3.02}}
|
| {{IBMDOCURL|MIGR-53479|1.08}}
|-
| {{X40}}
| TP-1U
| {{IBMDOCURL|MIGR-53881|2.08}}
| {{IBMDOCURL|MIGR-53882|1.62}}
| {{IBMDOCURL|MIGR-53883|2.08}}
|
| {{IBMDOCURL|MIGR-53885|1.62}}
|-
| {{X41}}
| TP-74
| {{IBMDOCURL|MIGR-59206|2.09}}
| {{IBMDOCURL|MIGR-59208|1.02}}
| {{IBMDOCURL|MIGR-59205|2.09}}
|
| {{IBMDOCURL|MIGR-59207|1.02}}
|-
| {{X41_Tablet}}
| TP-75
| {{IBMDOCURL|MIGR-60193|2.06}}
| {{IBMDOCURL|MIGR-60191|1.02}}
| {{IBMDOCURL|MIGR-60194|2.06}}
|
| {{IBMDOCURL|MIGR-60189|1.02}}
|-
| {{X60}}, {{X60s}}
| TP-7B
| {{IBMDOCURL|MIGR-63144|2.18}}
| 1.13
| {{IBMDOCURL|MIGR-63145|2.18}} (CD)
|
| 1.13
|-
| {{X60_Tablet}}
| TP-7J
| {{IBMDOCURL|MIGR-67148|1.13}}
| 1.04
| {{IBMDOCURL|MIGR-67149|1.13}} (CD)
|
| 1.04
|-
| {{X61}}, {{X61s}}
| TP-7N
| {{IBMDOCURL|MIGR-67982|2.19}}
| 1.03
| {{IBMDOCURL|MIGR-67983|2.19}} (CD)
|
| 1.03
|-
| {{X61_Tablet}}
| TP-7S
| {{IBMDOCURL|MIGR-68005|1.23}}
| 1.02
| {{IBMDOCURL|MIGR-68006|1.23}} (CD)
|
| 1.02
|-
| {{X200}}
| TP-6D/7X
| {{IBMDOCURL|MIGR-70347|1.07}}
| 1.03
| {{IBMDOCURL|MIGR-70348|1.07}} (CD)
|
| 1.03
|-
| {{X300}}
| TP-7T
| {{IBMDOCURL|MIGR-69538|1.08}}
| 1.00c
| {{IBMDOCURL|MIGR-69539|1.08}} (CD)
|
| 1.00c
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===Z Series===
|-
| {{Z60m}}, {{Z60t}}
| TP-77
| {{IBMDOCURL|MIGR-61687|1.22}}
| {{IBMDOCURL|MIGR-61686|1.18}}
| {{IBMDOCURL|MIGR-61688|1.22}}
|
| {{IBMDOCURL|MIGR-61685|1.18}}
|-
| {{Z61e}}, {{Z61m}}, {{Z61p}}, {{Z61t}}
| TP-7F
| {{IBMDOCURL|MIGR-64409|2.26}}
| 1.08
| {{IBMDOCURL|MIGR-64305|2.26}} (CD)
|
| 1.08
|-
! colspan=7 style="text-align:center;background:#efefef;" |

===Other===
|-
| {{TransNote}}
| TP-KV
| {{IBMDOCURL|MIGR-4UDSMK|1.02}}
|
| {{IBMDOCURL|MIGR-4UDRRF|1.02}}
|
|
|}

How to hotswap Ultrabay devices

2009-03-27T14:19:59Z

Whoopie: /* Using the generic bay driver and udev */

The following discusses hotswap (AKA "hotplug") of devices in the [[Ultrabay]].

==Which driver?==
Since the following may be confusing for SATA ThinkPad owners, which are likely all the same for now, you have two busses and drivers: one SATA bus which works with the AHCI driver and one IDE bus for the Ultrabay for which you should pick <tt>ata_piix</tt> ('''not''' piix/CONFIG_BLK_DEV_PIIX). See below for hotswapping.

Debian users: at least up the the kernel released with Lenny, Debian applies a patch in the Debian kernel sources which prevents the use of <tt>ata_piix</tt> with PATA devices (like the IDE bus for the Ultrabay). You will have to either use an upstream kernel or (re)patch the Debian kernel sources.
You may want to have a look at the following Debian bug reports as well: [http://bugs.debian.org/444182 #444182], [http://bugs.debian.org/463833 #463833].

==Choosing the right driver: new style <tt>ata_piix</tt> vs old style <tt>piix</tt> together with <tt>ide-disk</tt>==
For ICH5,6,7,8, systems, whether you have an older IDE only thinkpad, or a newer thinkpad like the T/Z61p, there is one SATA bus for the system hard drive and an IDE bus for the Ultrabay (even if your Ultrabay happens to have a SATA drive, as it'll be seen as an IDE device), you'll have two drivers to chose from for your ultrabay: the old IDE/<tt>piix</tt>+<tt>ide-disk</tt> driver, and the newer PATA (=IDE) support of the newer <tt>ata_piix</tt> driver. 
<tt>piix</tt>+<tt>ide-disk</tt> are part of the old original IDE driver and your Ultrabay device will show up as <tt>/dev/hda</tt>. <tt>ata-piix</tt> is the new SATA/PATA (=IDE) driver that will cause your Ultrabay hard drive to show up as <tt>/dev/sda</tt> and your CD-ROM as <tt>/dev/sr0</tt>.

The two things to know are: (1) you want to use <tt>ata_piix</tt> and (2) if you build <tt>piix</tt> in (CONFIG_BLK_DEV_PIIX enabled), or load it as a module, it'll take over the IDE bus and prevent ATA_PIIX from seeing your Ultrabay. You don't want that.

The longer details are: 
You don't want the <tt>piix</tt>+<tt>ide-disk</tt> combo because even as modules, you will not be able to unload <tt>piix</tt> to reset the bus if there are issues swapping devices (with <tt>ata_piix</tt>, even if you forget to unregister a drive before removing it, you can unload the module and reload it to reset the bus after the fact if you have a newer ThinkPad with a separate AHCI/SATA bus for the boot drive).

As for hotswap, with <tt>piix</tt>+<tt>ide-disk</tt>, you can read the section below, but after more than one day of trying on 2.6.22.15 (as <tt>piix</tt>+<tt>ide-disk</tt> was taking over my IDE bus, and stopping me from using ata_piix before I removed it), I was not able to get hotswapping to work with piix+ide-disk (lt_hotswap would not even build on 2.6.22.15).

hotswap just works with <tt>ata_pixx</tt> on 2.6.22, and reportedly with anything newer than 2.6.18, so you want to get rid of <tt>piix</tt>+<tt>ide-disk</tt>.
There are several ways to do that:
* if <tt>piix</tt> is built in your kernel (CONFIG_BLK_DEV_PIIX):
** rebuild your kernel with CONFIG_BLK_DEV_PIIX turned off.
** if you don't want to rebuild your kernel, try disabling the IDE bus grabbing by that driver with <tt>ide0=noprobe hda=noprobe hdb=noprobe</tt> in your grub/lilo config (adjust the drive letters as appropriate, but note that this did not work for me on 2.6.22.15: the drive didn't show up on the <tt>piix</tt> bus, but it didn't show up on the <tt>ata_piix</tt> bus either).
* if <tt>piix</tt> is built in as a module
** you can move out the module in {{path|/lib/modules/ver/kernel/drivers/ide/pci/piix.ko}} and reboot.
** or build a new kernel, again with CONFIG_BLK_DEV_PIIX turned off.
** or add <tt>options ide_core options="ide0=noprobe hda=noprobe hdb=noprobe"</tt> to your modprobe.conf is supposed to work too (but didn't work on 2.6.22.15, see comment above)

Then, continue this document to see how to do hotswap with <tt>ata_piix</tt> (if you are lucky enough to have a newer SATA ThinkPad where the <tt>ata_piix</tt> driver only runs the Ultrabay, and you have a separate <tt>bus</tt> and <tt>ahci</tt> driver for your main drive, it is recommended to have <tt>ata_piix</tt> as a module (<tt>CONFIG_ATA_PIIX=m</tt>) so that you can unload/reload it if your bus gets in a bad state after a failed hotswap)

==When using the <tt>ata_piix</tt> driver==
The following applies when using the <tt>ata_piix</tt> driver, which is necessary for many recent ThinkPad models that use an [[Intel ICH6-M]] controller. See also [[Problems with SATA and Linux]].

Mainline kernels before 2.6.18 cannot reliably recognize newly (re-)inserted Ultrabay drives without a reboot. There are experimental hotplug patches against pre-2.6.18 mainline kernels [http://home-tj.org/wiki/index.php/Libata-tj-stable here].

* Available hotplug patches
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.16.16-20060512.tar.bz2 Patch tarball against 2.6.16.16] ([http://lwn.net/Articles/183407/ Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17-20060625-1.tar.bz2 Patch tarball against 2.6.17/2.6.17.1] ([http://article.gmane.org/gmane.linux.ide/11598 Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17.4-20060710.tar.bz2 Patch tarball against 2.6.17.4]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/00-libata-tj-2.6.17.4-20060710.patch Patch against 2.6.17.14]

* Confirmed to work on the following laptops, with bus the following ID
**ThinkPad {{T23}}
**ThinkPad {{T30}}
**ThinkPad {{T43}}, {{T43p}}
**ThinkPad {{R52}}
**ThinkPad {{T60}} ID=4
**ThinkPad {{T61}} ID=0
**ThinkPad {{Z61p}} ID=4 (0-3:ahci, 5-6: ata_piix)
ID will typically be 1 if you only have an IDE bus (0 is boot drive, 1 is Ultrabay), and it'll be 4 if you have a SATA bus your system boots from (ID 0-3) and an IDE bus for your Ultrabay (ID 4-5). 
Note that even on a given laptop model the ID can vary depending on whether your kernel has drivers that configure your boot drive is using the old style IDE driver (which doesn't add IDs before your Ultrabay), or whether your boot drive is using the new style driver (which adds IDs before your Ultrabay)

Hotplug just works with kernels newer than 2.6.18 ( or older kernels that were patched to support <tt>ata_piix</tt> hotplug (don't try it otherwise!)) 
First, it is recommended you find the right SCSI ID for your drive to hotswap and unregister it before removing it (this works with all recent mainline kernels):
{{cmdroot|echo 1 > /sys/class/scsi_device/$ID:0:0:0/device/delete}}
{{cmdroot|echo eject > /proc/acpi/ibm/bay}}
The drive can now be ejected (without this, your IDE bus may complain if you just yank a drive, but you can usually recover by unloading/reloading the <tt>ata_piix</tt> module on a SATA laptop if your main drive is not on the <tt>ata_piix</tt> bus)

You can then issue the following after inserting an Ultrabay drive to rescan the port:
{{cmdroot|echo 0 0 0 > /sys/class/scsi_host/host$ID/scan}}
The inserted drive should now be recognized by the kernel, and appropriate {{path|/dev/*}} entries created automatically (e.g., by <tt>udev</tt>).

Ted T'so has also written this hotswap patch, which may or may not be needed for you, see [http://www.mail-archive.com/linux-acpi@vger.kernel.org/msg04716.html hotswap patch] and report back

===Scripts for hotswapping===

The following scripts and [[acpid]] daemon configuration files do the following:
* Automatically unmounts the relevant filesystems and power off the Ultrabay when the Ultrabay eject lever is released. Screams if some filesystem can't be unmounted.
* Rescans the Ultrabay port when then Ultrabay eject lever is pushed back in.

They assumes you're using the <tt>ata_piix</tt> driver with an appropriate kernel (see above).

Create {{path|/usr/local/sbin/ultrabay_insert}} with permissions 755:
<pre>
#!/bin/bash
echo 12 > /proc/acpi/ibm/beep
sync
echo 0 0 0 > /sys/class/scsi_host/host1/scan
</pre>

Create {{path|/usr/local/sbin/ultrabay_eject}} with permissions 755:
<pre>
#!/bin/bash
ULTRABAY_SYSDIR='/sys/class/scsi_device/1:0:0:0/device'
shopt -s nullglob

# Umount the filesystem(s) backed by the given major:minor device(s)
unmount_rdev() { perl - "$@" <<'EOPERL' # let's do it in Perl
for $major_minor (@ARGV) {
$major_minor =~ m/^(\d+):(\d+)$/ or die;
push(@tgt_rdevs, ($1<<8)|$2);
}
# Sort by reverse length of mount point, to unmount sub-directories first
open MOUNTS,"</proc/mounts" or die "$!";
@mounts=sort { length($b->[1]) <=> length($a->[1]) } map { [ split ] } <MOUNTS>;
close MOUNTS;
foreach $m (@mounts) {
($dev,$dir)=@$m;
next unless -b $dev; $rdev=(stat($dev))[6];
next unless grep($_==$rdev, @tgt_rdevs);
system("umount","-v","$dir")==0 or $bad=1;
}
exit 1 if $bad;
EOPERL
}

# Get the UltraBay's /dev/foo block device node
ultrabay_dev_node() {
UDEV_PATH="`readlink -e "$ULTRABAY_SYSDIR/block:"*`" || return 1
UDEV_NAME="`udevinfo -q name -p $UDEV_PATH`" || return 1
echo /dev/$UDEV_NAME
}

if [ -d $ULTRABAY_SYSDIR ]; then
sync
# Unmount filesystems backed by this device
unmount_rdev `cat $ULTRABAY_SYSDIR/block\:*/dev \
$ULTRABAY_SYSDIR/block\:*/*/dev` \
|| {
echo 10 > /proc/acpi/ibm/beep; # error tone
exit 1;
}
sync
# Nicely power off the device
DEVNODE=`ultrabay_dev_node` && hdparm -Y $DEVNODE
# Let HAL+KDE notice the unmount and let the disk spin down
sleep 0.5
# Unregister this SCSI device:
sync
echo 1 > $ULTRABAY_SYSDIR/delete
fi
sync
# We really need a 3 sec pause here otherwise the system will freeze..
sleep 3
# Turn off power to the UltraBay:
if [ -d /sys/devices/platform/bay.0 ]; then
echo 1 > /sys/devices/platform/bay.0/eject
elif [ -e /proc/acpi/ibm/bay ]; then
echo eject > /proc/acpi/ibm/bay
fi
# Tell the user we're OK
echo 12 > /proc/acpi/ibm/beep
</pre>

Use the modified version below if the above doesn't work for you (for kernels 2.6.25+ due to "ULTRABAY_SYSDIR/block\:*/dev" path change). It was tested on a Thinkpad X41 with Fedora 9 and kernel 2.6.25.11:

<pre>
#!/bin/bash
ULTRABAY_SYSDIR='/sys/class/scsi_device/1:0:0:0/device'
shopt -s nullglob

# Umount the filesystem(s) backed by the given major:minor device(s)
unmount_rdev() { perl - "$@" <<'EOPERL' # let's do it in Perl
for $major_minor (@ARGV) {
$major_minor =~ m/^(\d+):(\d+)$/ or die;
push(@tgt_rdevs, ($1<<8)|$2);
}
# Sort by reverse length of mount point, to unmount sub-directories first
open MOUNTS,"</proc/mounts" or die "$!";
@mounts=sort { length($b->[1]) <=> length($a->[1]) } map { [ split ] } <MOUNTS>;
close MOUNTS;
foreach $m (@mounts) {
($dev,$dir)=@$m;
next unless -b $dev; $rdev=(stat($dev))[6];
next unless grep($_==$rdev, @tgt_rdevs);
system("umount","-v","$dir")==0 or $bad=1;
}
exit 1 if $bad;
EOPERL
}

# Get the UltraBay's /dev/foo block device node
ultrabay_dev_node() {
UDEV_PATH="`readlink -e "$ULTRABAY_SYSDIR/block/"*`" || return 1
UDEV_NAME="`udevinfo -q name -p $UDEV_PATH`" || return 1
echo /dev/$UDEV_NAME
}

if [ -d $ULTRABAY_SYSDIR ]; then
sync
# Unmount filesystems backed by this device
unmount_rdev `cat $ULTRABAY_SYSDIR/block/*/dev \
$ULTRABAY_SYSDIR/block/*/*/dev` \
|| {
echo 10 > /proc/acpi/ibm/beep; # error tone
exit 1;
}
sync
# Nicely power off the device
DEVNODE=`ultrabay_dev_node` && hdparm -Y $DEVNODE
# Let HAL+KDE notice the unmount and let the disk spin down
sleep 0.5
# Unregister this SCSI device:
sync
echo 1 > $ULTRABAY_SYSDIR/delete
fi

# We really need a 3 sec pause here otherwise the system will freeze..
sleep 3

# Turn off power to the UltraBay:
dock=$( /bin/grep ata_bay /sys/devices/platform/dock.?/type )
dock=${dock%%/type:ata_bay} # needed for 2.6.27 and later
if [ -n "$dock" -a -d "$dock" ]; then
echo 1 > $dock/undock
elif [ -d /sys/devices/platform/bay.0 ]; then
echo 1 > /sys/devices/platform/bay.0/eject
elif [ -e /proc/acpi/ibm/bay ]; then
echo eject > /proc/acpi/ibm/bay
fi
# Tell the user we're OK
echo 12 > /proc/acpi/ibm/beep
</pre>

Create {{path|/etc/acpi/events/ultrabay-insert}}:
<pre>
event=ibm/bay MSTR 00000001 00000000
action=/usr/local/sbin/ultrabay_insert
</pre>

Create {{path|/etc/acpi/events/ultrabay-eject}}:
<pre>
event=ibm/bay MSTR 00000003 00000000
action=/usr/local/sbin/ultrabay_eject
</pre>

Restart <tt>acpid</tt>.

If the <tt>ata_piix</tt> driver is built in the kernel, it will catch bay events and you will see the
following message in your system log:
<pre>
thinkpad_acpi: another device driver is already handling bay events
thinkpad_acpi: disabling subdriver bay
</pre>
You should load <tt>thinkpad_acpi</tt> before <tt>ata_piix</tt> if you want it to handle bay events.

===Using the generic bay driver and udev===

Starting from kernel 2.6.23-rc3, it's possible to use the generic <tt>bay</tt> driver in combination with udev to hotswap. Please check if CONFIG_ACPI_BAY is enabled (module or built-in) in your kernel configuration.

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
ENV{BAY_EVENT}=="3", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_eject"
ENV{BAY_EVENT}=="1", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_insert"

Starting with kernel 2.6.28, the <tt>bay</tt> driver was removed from the mainline kernel. The <tt>dock</tt> driver replaced it completely. Make sure CONFIG_ACPI_DOCK is enabled in the kernel, and use the following udev rules:

ENV{EVENT}=="undock", KERNEL=="dock.2", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_eject"
ENV{EVENT}=="dock", KERNEL=="dock.2", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_insert"

However, the ultra_eject script needs to be changed, otherwise udev goes into an infinite event loop. It will send undock events every few seconds forever. That means as soon as the ultrabay is plugged in again, it will be immediately ejected. For kernels 2.6.28 and higher, the bay cannot be powered off using this method, so change the end of the script to read:
# Turn off power to the UltraBay:
if [ -d /sys/devices/platform/bay.0 ]; then
echo 1 > /sys/devices/platform/bay.0/eject
elif [ -e /proc/acpi/ibm/bay ]; then
echo eject > /proc/acpi/ibm/bay
fi
# Tell the user we're OK
echo 12 > /proc/acpi/ibm/beep

Alternatively, instead of modifying the script, use the libata-acpi method below.
This was tested on a T61p running Gentoo with tuxonice 2.6.28-r8 without any issues.

===Using libata-acpi and udev===

Starting from kernel 2.6.26-rc5, it's possible to use <tt>libata-acpi</tt> in combination with udev to hotswap. Please check if CONFIG_ATA_ACPI is enabled in your kernel configuration.

For 2.6.25, you need two patches which can be easily backported ([http://article.gmane.org/gmane.linux.acpi.devel/31159],[http://article.gmane.org/gmane.linux.acpi.devel/31369]).

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
<pre>
ENV{BAY_EVENT}=="3", ACTION=="change", SUBSYSTEM=="scsi", RUN+="/usr/local/sbin/ultrabay_eject"
</pre>

===Model-specific notes===
See the table above for a list of ata_piix supported laptops and the bus ID to use.

===HAL support===

{{NOTE| Starting from HAL 0.5.11, you need to replace "storage.physical_device" with "info.parent".}}

Many programs, KDE included, rely on [[HAL]] to get notifications and information about device hotplugging. You need to tell HAL that devices connected the UltraBay port are hotpluggable. To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="scsi">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>

The string "8086_2653" may need to be changed to match your ThinkPad model; see below.

====Details====

By default, HAL doesn't know that UltraBay devices are hotpluggable:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
false

After creating {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as above and re-plugging the device, it will get marked correctly:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
true

The string "8086_2653" gives the PCI ID of the [[Intel 82801FBM]] southbridge. If your model has a different southbridge, or the UltraBay is attached to a different port, then you can find the appropriate <tt>storage.physical_device</tt> value by finding out the block device of the currently running UltraBay device (<tt>/dev/sdb</tt> in the following example) and then running:

# DEVICE=/dev/sdb
# UDI=`hal-find-by-property --key block.device --string $DEVICE` || echo Failed
# hal-get-property --udi $UDI --key storage.physical_device
/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0

If you have a different <tt>storage.physical_device</tt> value, please report your findings.

{| border=1
|+ Known South Bridge PCI IDs
! ID !! ThinkPad model !! South Bridge chip
|-
| 8086_248a || 2366-83U (T30), 2647-MG3 (T23)|| Intel 82801CAM IDE U100 (rev 2)
|-
| 8086_2653 || 2525FAG (X41), ? (T43) || Intel 82801FBM (ICH6-M)
|-
| 8086_24ca || 237358U (T40), 2373KXU (T42p) || Intel 82801DBM (ICH4-M)
|-
| 8086_27c4 || X60 || Intel 82801GBM (ICH7 Family)
|-
| 8086_27df || Z61p, T60, T60p || Intel 82801GBM/GHM (ICH7 Family)
|-
| 8086_2850 || T61, T61p || Intel 82801H (ICH8 Family)
|}

==When using the <tt>ide-disk</tt> driver==
The following applies if you use the <tt>ide-disk</tt> driver for the UltraBay device. 
Note that essentially, you shouldn't be using this driver, and use ata_piix instead unless you're running an older kernel where ata_piix won't work for you

Hotswapping is supposed to be supported as well, using either hdparm/[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] or [[lt_hotswap]] to (un)register IDE devices. The latter is the recommended method with kernels from 2.6, since it will leave DMA working. However, for recent models (R52, T43, X41, Z60 and later) no method is known to work while maintaining DMA support; see [[Problems with SATA and Linux]].

Only IDE devices (HDD's, optical drives, zip drives) require special treatment - batteries, floppies and other devices can just be pulled from the bay, provided they are not mounted or in use at the time. However, you should still power them down first using the [[ibm-acpi]] eject function.

The [[ibm-acpi]] kernel module has an eject function ({{cmdroot|echo eject > /proc/acpi/ibm/bay}}). This only manages the ACPI calls to power down the device and the bay. It does not actually unregister the device from the IDE driver. {{cmdroot|cat /proc/acpi/ibm/bay}} shows "unoccupied" unless an IDE device is present, but the eject function still works and should still be used.

To unregister the device, you can either use the [http://packages.debian.org/unstable/admin/hotswap Debian hotswap] package, or [[lt_hotswap]]. Note that lt_hotswap doesn't seem to even build on recent (at 2.6.22 or newer, although it probably broke before 2.6.22) and on newer kernels, you should not build/load the old IDE PIIX (CONFIG_BLK_DEV_PIIX) and use the natively hotswapping ata_piix (CONFIG_ATA_PIIX) as explained on the top of this page.

[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] also allows the drive to be swapped as a normal user by default, which is useful. You should use <tt>hotswap</tt> to unregister the device and then {{cmdroot|echo eject > /proc/acpi/ibm/bay}}. However, if you use this method on a 2.6 kernel, you will lose DMA support for the reinserted drive. This is due to kernel issues. This method was reported to work on a ThinkPad {{T23}} (kernels 2.6.8.1, 2.6.14.2 and 2.6.15-arch) and {{T42}} (kernel 2.6.13), but fails on a ThinkPad {{T43}} (kernel 2.6.14.3).

[[lt_hotswap]] is now the recommended method to un- and reregister the IDE device. It installs as a kernel module and has support for automatically unregistering (if loaded with the auto_eject=1 option) the device when the eject event is generated by [[ibm-acpi]]. It will leave DMA support intact. It has supported to work on a ThinkPad {{T22}} and {{T40}} and should work with many other models (but not recent models which require the <tt>ata_piix</tt> driver for disk DMA support). With the [[lt_hotswap]] kernel module loaded, run: {{cmdroot|modprobe -r ide_cd && modprobe -r cdrom && echo "MSTR eject" > /proc/acpi/lths}}

===HAL support===

HAL support also can also be configured To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="ide">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_24ca_ide_1_0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>
For more details see HAL section for ata driver.

==Other comments==

If you are hot-swapping a hard disk on a disk tray, make sure the disk does not have a password set, otherwise it will not be recognized on reinsertion.

[[Category:Scripts]]
[[Category:HOWTOs]]

HDAPS

2009-01-22T20:39:46Z

Whoopie: /* GUI monitoring */ new gnome-hdaps-applet version

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
=== HDAPS - IBM Active Protection System Linux Driver ===
This is the Linux driver for monitoring the accelerometer known as [[Active Protection System|IBM Active Protection System]].

The driver only enables reading of the acceleration data. It does '''not''' perform [[#Harddisk Protection|automatic disk head parking]]. But there are already some other useful [[#Applications|applications]] for HDAPS, using the {{path|/sys}} interface it provides.

{{WARN|There are two versions of the hdaps driver, one in the Linux kernel mainline, and another provided by [[tp_smapi]]. '''Use of the tp_smapi version of hdaps is strongly recommended by the current hdaps developers.'''}}
|}

=== Features ===
*provides accelerometer values via sysfs
*provides a joystick type input device

=== Project Homepage / Availability ===
*[http://hdaps.sourceforge.net/ Project Homepage]
*The driver is included in the 2.6-mm series of kernels since August, 26th 2005.
*The driver is now in the mainline (2.6.14).
*The [[tp_smapi]] package contains some patches to this driver. These are necessary for some recent models, and recommended for all.

=== Status ===
A driver is included in recent Linux kernels and is actively maintained, but it is very inferior to the driver in tp_smapi (which provides its own hdaps module).

=== How to install the driver ===
Recent Linux kernels include the <tt>hdaps</tt> driver. However, the driver in the mainline Linux kernel has two problems with recent models:
* It doesn't whitelist them (you have to edit hdaps_init() in drivers/hwmon/hdaps.c to include a line like <tt>HDAPS_DMI_MATCH_LENOVO("ThinkPad T60")</tt>)
* It doesn't work reliably, e.g., it may read out constant values (0,0). See [http://sourceforge.net/mailarchive/message.php?msg_id=15350314 here].

To solve both problems, install the modified hdaps that is bundled with [[tp_smapi]].

=== Harddisk Protection ===
As mentioned above, the hdaps kernel driver is only responsible for reading the accelerometer data and exporting it through the sysfs interface. In order to use this information to protect the disk, some additional steps are required.

See [[How to protect the harddisk through APS]].

=== Input device support ===
In more recent versions of the Linux kernel, the hdaps exports event devices with the accelerometer data. These devices can be used as-is by some programs (e.g. hdapsd), but for most they must be handled by the additional kernel module <code>joydev</code>.

When both modules are loaded, joydev will provide standard joystick device emulation for hdaps (standard hdaps exports just one joystick device. enhanced hdaps from tp_smapi will export two due to issues still unsolved on joydev, but the second one must not be used as a joystick).

{{WARN|Letting a program bind to these joystick devices can cause surprising results if you are not aware of it. e.g.: mplayer can act quite strangely. Also, letting a program bind to the second joystick device from enhanced HDAPS is guaranteed to be trouble}}

Udev can be used to create device nodes in /dev for use by user space programs that access the joystick, and to set appropriate permissions.

In order for non-root users to access these device files, their permissions must be tweaked a little through an appropriate udev rule and corresponding "joy" group.

{{cmdroot|addgroup joy}} 
{{cmdroot|adduser <you> joy}} 
<code># echo 'SUBSYSTEM=="input", KERNEL=="js*", MODE="0660", GROUP="joy"' >> /etc/udev/hdaps-joy.rules</code> 
{{cmdroot|ln -s ../hdaps-joy.rules /etc/udev/rules.d/z60_hdaps-joy.rules}} 

Programs you can use to test and calibrate the device files include <code>jscalibrator</code> (gui) and <code>jstest</code>/<code>jscal</code> (cli) packaged together (at least in Debian) simply as "joystick".

=== Applications ===
====Disk head parking====
You will need the kernel patch below and the hdapsd userspace daemon. The GUI monitoring is optional.

See [[How to protect the harddisk through APS]] for more information.

===== Kernel patch =====
Due to significant changes in the way the libata module which handles disk i/o, applying any of the currently available patches to kernel 2.6.24 will intermittently cause system hangs when the queue is frozen (i.e., the heads are parked). It is recommended either that you stay at kernel [http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.23.17.tar.bz2 2.6.23] or do without disk protection in 2.6.24 until the kinks have been worked out. There has been significant work on the part of [http://lkml.org/lkml/2008/2/25/478 Elias Oltmanns], author of the more recent patches, to get this worked out and eventually get shock protection built into the mainline kernel.

Below are some links to patches for various Linux kernel versions. As noted above, your mileage may vary with the 2.6.24-rc3 patch as it was after this release candidate that things stopped working nicely.
{{HINT|To apply a patch, change to the root directory of the kernel tree and run <code>patch -p1 -l < hdaps_xx.patch</code>}}
* New interface (requires hdapsd dated 2008-10-04 or newer)
** In mainline kernel 2.6.28
** [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1393 disk-protect patch for kernel 2.6.27.2]
* Old interface
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1324/raw disk-protect patch for kernel 2.6.26]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1297/raw disk-protect patch for kernel 2.6.26-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1245/raw disk-protect patch for kernel 2.6.25-rc9] — may cause system locks (same as patch for 2.6.24-rc3). Apply [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix] before.
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1094 disk-protect patch for kernel 2.6.24-rc3] — may cause system locks (see [http://marc.info/?l=linux-thinkpad&m=120259594519907 here], [http://marc.info/?l=linux-thinkpad&m=120259929023300 here] and try [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix])
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1092 disk-protect patch for 2.6.23.8] + [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1113 error check fix]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1077 disk-protect patch for 2.6.22.9 and 2.6.23-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/993 disk-protect patch for 2.6.20-rc6]
* Ancient interface
**[http://www.nabble.com/attachment/9047418/0/hdaps_protect-2.6.20.patch.bz2 Latest sata/ide disk protection patch for 2.6.20]
**[http://article.gmane.org/gmane.linux.kernel/470413 Latest sata/ide disk protection patch for 2.6.19-rc6]
**[http://www.dresco.co.uk/hdaps/hdaps_protect-2.6.18.3-2.patch Latest sata/ide disk protection patch for 2.6.18.3]
**[http://exitzero.de/t41p-configs/hdaps_protect-2.6.17.1-20060625.patch Untested patch for 2.6.17.1]: see [http://thread.gmane.org/gmane.linux.drivers.hdaps.devel/708/focus=708]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/03-hdaps_protect-20060430-for-2.6.17-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.17.4 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://whoopie.gmxhome.de/linux/patches/2.6.16-tj/05-hdaps_protect-20060430-for-2.6.16-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.16.16 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060430.patch Latest sata/ide disk protection patch for 2.6.16]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060118.patch sata/ide disk protection patch for 2.6.15]
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.15.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.15 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.14.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.14 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://lwn.net/Articles/154923/ disk park patch] <tt>an experimental patch for parking the disk (Linux 2.6.14 for 2.6.15 see below)</tt>

===== Userspace daemon =====
*Current version: [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1372] or [http://www.zen24593.zen.co.uk/hdaps/hdapsd-20081004.c] 
This version optionally reduces timer interrupts (as measured by [[PowerTOP]]), and thereby reduces power consumption on modern ("tickless") Linux kernels. Interrupt reduction requires the <tt>hdaps</tt> kernel module from [[tp_smapi]] 0.32 or newer, and a udev rule. If these are not present, it will default to an older polling method that is slightly more power-hungry. The udev rule helps hdapsd find the input device, and on most distributions it can be created as follows:
# echo 'KERNEL=="event[0-9]*", ATTRS{phys}=="hdaps/input1",ATTRS{modalias}=="input:b0019v1014p5054e4801-*",SYMLINK+="input/hdaps/accelerometer-event"' \
> /etc/udev/rules.d/51-hdaps.rules
Then reboot or run {{cmdroot|/sbin/udevtrigger}}, and verify that the {{path|/dev/input/hdaps/accelerometer-event}} symlink exists.

*[ftp://rohrmoser-engineering.de/pub Modified adaptive algorithm version] - uses a different (and potentially better) algorithm for the adaptive sensivity threshold.
{{HINT| Gentoo users : due to new interface your initscript won't be longer working. Read documentation before upgrading to this version.
Use an overlay listed bellow with updated versions of related packages}}

===== GUI monitoring =====
*[http://roy.marples.name/node/269 khdapmonitor] KDE System Tray Monitor
*[http://www.dresco.co.uk/hdaps/gnome-hdaps-applet-20081204.tar.gz gnome-hdaps-applet] visual display of disk protection status in gnome panel
*[http://www.kde-look.org/content/show.php/Applet+HDAPS?content=78387 applet_hdaps] KDE4 Plasmoid display disk protection status
*[http://awn.planetblur.org/index.php?shard=forum&action=g_reply&ID=1916&page=1&isLive=true ThinkHDAPS] Avant Window Manager applet for disk protection status
*[http://web.student.tuwien.ac.at/~e0726415/thinkhdaps.html ThinkHDAPS] A standalone (=gtk.StatusIcon) version of onox' awn applet; v0.2 supports new sysfs layout (kernel >=2.6.27); Should work for the new HP driver as well.

====Security & safety====
*[[Script for theft alarm using HDAPS]]

====Tilt monitoring====
*[http://www.mulliner.org/collin/gkibm-acpi.php gkhdaps] <tt>a GKrellM applet displaying tilt data</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 gnome-tilt] <tt>a gnome applet showing tilt data</tt>

====Visualisation of ThinkPad orientation====
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdaps-gl] <tt>a little app animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdapsgl-applet] <tt> a GNOME applet animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 wmadhps] <tt>a WindowMaker DockApp animating a 3D-ThinkPad</tt>
*[http://www.cs.cmu.edu/~ecc/gyro.tar.gz OpenGL gyroscope hack] <tt>keeps your display levelled when tilting the ThinkPad</tt> (warning: [http://en.wikipedia.org/wiki/Tarbomb uncompresses in the current directory]!)

====Games====
*[http://icculus.org/neverball/ Neverball] is quite fun with HDAPS. (You'll need to have the HDAPS joystick device)
*Turn your ThinkPad into a Jedi Weapon (hey, it [http://isnoop.net/blog/2006/05/20/macsaber-turn-your-mac-into-a-jedi-weapon works for Mac laptops])

====Other====

*[http://blog.micampe.it/articles/2006/06/04/here-comes-the-smackpad smack.py] - switch workspace by smacking your laptop, inspired by the [http://blog.medallia.com/2006/05/smacbook_pro.html SmackBook] (uses EWMH)
**an [http://weblogs.mozillazine.org/gerv/archives/2006/09/stablilised_smackpad.html improved version] adds stabilization (by comparing smacks to previous ones, uses EWMH)
**another [http://pberndt.com/Programme/Linux/pyhdaps/index.html approach] adds stabilization (by requiring a certain type of value deflection, uses xmacroplay)
**[http://www.gnome.org/~fherrera/gtollina.c GTollina] is another smack program for use with compiz (video [http://www.gnome.org/~fherrera/blog/gtollina.html here]).
*[http://blog.odonnell.nu/61.html xmms-smack.py] - move through your xmms playlist by smacking, based on the two smack scripts above.
*[http://www-128.ibm.com/developerworks/linux/library/l-knockage.html?ca=dgr-lnxw02aKnockBasedCommands KnockBasedCommands] - Execute commands by tapping your laptop.
*[http://people.ksp.sk/~mic/?menu=32&file=rotate.py rotate.py] - rotate desktop by turning your laptop
*[[hdaps_ess|Enhanced smack script]] ess.py is based on the smacks scripts listed in this section. It includes stabilization, a lot of tuning options and it handles both axis (at best you should be able to map 8 commands, even if it is possible I was not able to do so). It is not perfect but on my Thinkpad it works better than the other scripts.

=== Interesting links related to this project ===
* [https://lists.sourceforge.net/lists/listinfo/hdaps-devel HDAPS mailinglist and its archive]
* #hdaps channel on irc.freenode.org
* [https://sourceforge.net/projects/hdaps/ hdaps projects] overview of userspace programs using hdaps
* [http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=TPAD-HDFIRM IBM ThinkPads hardware drive firmware site]
* [http://www.paul.sladen.org/thinkpad-r31/accelerometer.html http://www.paul.sladen.org/thinkpad-r31/accelerometer/]
* http://bugs.gentoo.org/show_bug.cgi?id=119845 Gentoo ebuild for hdaps driver and daemon including a initscript*
* http://bugs.gentoo.org/show_bug.cgi?id=137345 Gentoo ebuild for gkhdaps gkrell plugin
* http://bugs.gentoo.org/show_bug.cgi?id=137350 Gentoo ebuild for hdaps-gl application
* http://bugs.gentoo.org/show_bug.cgi?id=137351 Gentoo ebuild for gnome hdapsgl-applet
* http://bugs.gentoo.org/show_bug.cgi?id=137352 Gentoo ebuild for gnome tilt application
* http://bugs.gentoo.org/show_bug.cgi?id=137353 Gentoo ebuild for wmhdaps
* http://gentoo.o0o.nu Gentoo sectools overlay with fresh hdaps-related ebuilds and patches
* [http://lenovoblogs.com/insidethebox/?p=71 Why the ThinkPad accelerometer is only 2D] - explanation by Lenovo

[[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:R60]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Drivers]] [[Category:Z61m]]

HDAPS

2008-12-09T10:51:44Z

Whoopie: /* Userspace daemon */ point to 2nd download location

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
=== HDAPS - IBM Active Protection System Linux Driver ===
This is the Linux driver for monitoring the accelerometer known as [[Active Protection System|IBM Active Protection System]].

The driver only enables reading of the acceleration data. It does '''not''' perform [[#Harddisk Protection|automatic disk head parking]]. But there are already some other useful [[#Applications|applications]] for HDAPS, using the {{path|/sys}} interface it provides.

{{WARN|There are two versions of the hdaps driver, one in the Linux kernel mainline, and another provided by [[tp_smapi]]. '''Use of the tp_smapi version of hdaps is strongly recommended by the current hdaps developers.'''}}
|}

=== Features ===
*provides accelerometer values via sysfs
*provides a joystick type input device

=== Project Homepage / Availability ===
*[http://hdaps.sourceforge.net/ Project Homepage]
*The driver is included in the 2.6-mm series of kernels since August, 26th 2005.
*The driver is now in the mainline (2.6.14).
*The [[tp_smapi]] package contains some patches to this driver. These are necessary for some recent models, and recommended for all.

=== Status ===
A driver is included in recent Linux kernels and is actively maintained, but it is very inferior to the driver in tp_smapi (which provides its own hdaps module).

=== How to install the driver ===
Recent Linux kernels include the <tt>hdaps</tt> driver. However, the driver in the mainline Linux kernel has two problems with recent models:
* It doesn't whitelist them (you have to edit hdaps_init() in drivers/hwmon/hdaps.c to include a line like <tt>HDAPS_DMI_MATCH_LENOVO("ThinkPad T60")</tt>)
* It doesn't work reliably, e.g., it may read out constant values (0,0). See [http://sourceforge.net/mailarchive/message.php?msg_id=15350314 here].

To solve both problems, install the modified hdaps that is bundled with [[tp_smapi]].

=== Harddisk Protection ===
As mentioned above, the hdaps kernel driver is only responsible for reading the accelerometer data and exporting it through the sysfs interface. In order to use this information to protect the disk, some additional steps are required.

See [[How to protect the harddisk through APS]].

=== Input device support ===
In more recent versions of the Linux kernel, the hdaps exports event devices with the accelerometer data. These devices can be used as-is by some programs (e.g. hdapsd), but for most they must be handled by the additional kernel module <code>joydev</code>.

When both modules are loaded, joydev will provide standard joystick device emulation for hdaps (standard hdaps exports just one joystick device. enhanced hdaps from tp_smapi will export two due to issues still unsolved on joydev, but the second one must not be used as a joystick).

{{WARN|Letting a program bind to these joystick devices can cause surprising results if you are not aware of it. e.g.: mplayer can act quite strangely. Also, letting a program bind to the second joystick device from enhanced HDAPS is guaranteed to be trouble}}

Udev can be used to create device nodes in /dev for use by user space programs that access the joystick, and to set appropriate permissions.

In order for non-root users to access these device files, their permissions must be tweaked a little through an appropriate udev rule and corresponding "joy" group.

{{cmdroot|addgroup joy}} 
{{cmdroot|adduser <you> joy}} 
<code># echo 'SUBSYSTEM=="input", KERNEL=="js*", MODE="0660", GROUP="joy"' >> /etc/udev/hdaps-joy.rules</code> 
{{cmdroot|ln -s ../hdaps-joy.rules /etc/udev/rules.d/z60_hdaps-joy.rules}} 

Programs you can use to test and calibrate the device files include <code>jscalibrator</code> (gui) and <code>jstest</code>/<code>jscal</code> (cli) packaged together (at least in Debian) simply as "joystick".

=== Applications ===
====Disk head parking====
You will need the kernel patch below and the hdapsd userspace daemon. The GUI monitoring is optional.

See [[How to protect the harddisk through APS]] for more information.

===== Kernel patch =====
Due to significant changes in the way the libata module which handles disk i/o, applying any of the currently available patches to kernel 2.6.24 will intermittently cause system hangs when the queue is frozen (i.e., the heads are parked). It is recommended either that you stay at kernel [http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.23.17.tar.bz2 2.6.23] or do without disk protection in 2.6.24 until the kinks have been worked out. There has been significant work on the part of [http://lkml.org/lkml/2008/2/25/478 Elias Oltmanns], author of the more recent patches, to get this worked out and eventually get shock protection built into the mainline kernel.

Below are some links to patches for various Linux kernel versions. As noted above, your mileage may vary with the 2.6.24-rc3 patch as it was after this release candidate that things stopped working nicely.
{{HINT|To apply a patch, change to the root directory of the kernel tree and run <code>patch -p1 -l < hdaps_xx.patch</code>}}
* New interface (requires hdapsd dated 2008-10-04 or newer)
** Expected in mainline kernel 2.6.28
** [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1393 disk-protect patch for kernel 2.6.27.2]
* Old interface
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1324/raw disk-protect patch for kernel 2.6.26]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1297/raw disk-protect patch for kernel 2.6.26-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1245/raw disk-protect patch for kernel 2.6.25-rc9] — may cause system locks (same as patch for 2.6.24-rc3). Apply [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix] before.
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1094 disk-protect patch for kernel 2.6.24-rc3] — may cause system locks (see [http://marc.info/?l=linux-thinkpad&m=120259594519907 here], [http://marc.info/?l=linux-thinkpad&m=120259929023300 here] and try [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix])
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1092 disk-protect patch for 2.6.23.8] + [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1113 error check fix]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1077 disk-protect patch for 2.6.22.9 and 2.6.23-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/993 disk-protect patch for 2.6.20-rc6]
* Ancient interface
**[http://www.nabble.com/attachment/9047418/0/hdaps_protect-2.6.20.patch.bz2 Latest sata/ide disk protection patch for 2.6.20]
**[http://article.gmane.org/gmane.linux.kernel/470413 Latest sata/ide disk protection patch for 2.6.19-rc6]
**[http://www.dresco.co.uk/hdaps/hdaps_protect-2.6.18.3-2.patch Latest sata/ide disk protection patch for 2.6.18.3]
**[http://exitzero.de/t41p-configs/hdaps_protect-2.6.17.1-20060625.patch Untested patch for 2.6.17.1]: see [http://thread.gmane.org/gmane.linux.drivers.hdaps.devel/708/focus=708]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/03-hdaps_protect-20060430-for-2.6.17-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.17.4 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://whoopie.gmxhome.de/linux/patches/2.6.16-tj/05-hdaps_protect-20060430-for-2.6.16-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.16.16 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060430.patch Latest sata/ide disk protection patch for 2.6.16]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060118.patch sata/ide disk protection patch for 2.6.15]
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.15.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.15 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.14.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.14 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://lwn.net/Articles/154923/ disk park patch] <tt>an experimental patch for parking the disk (Linux 2.6.14 for 2.6.15 see below)</tt>

===== Userspace daemon =====
*Current version: [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1372] or [http://www.zen24593.zen.co.uk/hdaps/hdapsd-20081004.c] 
This version optionally reduces timer interrupts (as measured by [[PowerTOP]]), and thereby reduces power consumption on modern ("tickless") Linux kernels. Interrupt reduction requires the <tt>hdaps</tt> kernel module from [[tp_smapi]] 0.32 or newer, and a udev rule. If these are not present, it will default to an older polling method that is slightly more power-hungry. The udev rule helps hdapsd find the input device, and on most distributions it can be created as follows:
# echo 'KERNEL=="event[0-9]*", ATTRS{phys}=="hdaps/input1",ATTRS{modalias}=="input:b0019v1014p5054e4801-*",SYMLINK+="input/hdaps/accelerometer-event"' \
> /etc/udev/rules.d/51-hdaps.rules
Then reboot or run {{cmdroot|/sbin/udevtrigger}}, and verify that the {{path|/dev/input/hdaps/accelerometer-event}} symlink exists.

*[ftp://rohrmoser-engineering.de/pub Modified adaptive algorithm version] - uses a different (and potentially better) algorithm for the adaptive sensivity threshold.
{{HINT| Gentoo users : due to new interface your initscript won't be longer working. Read documentation before upgrading to this version.
Use an overlay listed bellow with updated versions of related packages}}

===== GUI monitoring =====
*[http://roy.marples.name/node/269 khdapmonitor] KDE System Tray Monitor
*[http://www.dresco.co.uk/hdaps/gnome-hdaps-applet-20060120.tar.gz gnome-hdaps-applet] visual display of disk protection status in gnome panel
*[http://www.kde-look.org/content/show.php/Applet+HDAPS?content=78387 applet_hdaps] KDE4 Plasmoid display disk protection status
*[http://awn.planetblur.org/index.php?shard=forum&action=g_reply&ID=1916&page=1&isLive=true ThinkHDAPS] Avant Window Manager applet for disk protection status

====Security & safety====
*[[Script for theft alarm using HDAPS]]

====Tilt monitoring====
*[http://www.mulliner.org/collin/gkibm-acpi.php gkhdaps] <tt>a GKrellM applet displaying tilt data</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 gnome-tilt] <tt>a gnome applet showing tilt data</tt>

====Visualisation of ThinkPad orientation====
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdaps-gl] <tt>a little app animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdapsgl-applet] <tt> a GNOME applet animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 wmadhps] <tt>a WindowMaker DockApp animating a 3D-ThinkPad</tt>
*[http://www.cs.cmu.edu/~ecc/gyro.tar.gz OpenGL gyroscope hack] <tt>keeps your display levelled when tilting the ThinkPad</tt> (warning: [http://en.wikipedia.org/wiki/Tarbomb uncompresses in the current directory]!)

====Games====
*[http://icculus.org/neverball/ Neverball] is quite fun with HDAPS. (You'll need to have the HDAPS joystick device)
*Turn your ThinkPad into a Jedi Weapon (hey, it [http://isnoop.net/blog/2006/05/20/macsaber-turn-your-mac-into-a-jedi-weapon works for Mac laptops])

====Other====

*[http://blog.micampe.it/articles/2006/06/04/here-comes-the-smackpad smack.py] - switch workspace by smacking your laptop, inspired by the [http://blog.medallia.com/2006/05/smacbook_pro.html SmackBook] (uses EWMH)
**an [http://weblogs.mozillazine.org/gerv/archives/2006/09/stablilised_smackpad.html improved version] adds stabilization (by comparing smacks to previous ones, uses EWMH)
**another [http://pberndt.com/Programme/Linux/pyhdaps/index.html approach] adds stabilization (by requiring a certain type of value deflection, uses xmacroplay)
**[http://www.gnome.org/~fherrera/gtollina.c GTollina] is another smack program for use with compiz (video [http://www.gnome.org/~fherrera/blog/gtollina.html here]).
*[http://blog.odonnell.nu/61.html xmms-smack.py] - move through your xmms playlist by smacking, based on the two smack scripts above.
*[http://www-128.ibm.com/developerworks/linux/library/l-knockage.html?ca=dgr-lnxw02aKnockBasedCommands KnockBasedCommands] - Execute commands by tapping your laptop.
*[http://people.ksp.sk/~mic/?menu=32&file=rotate.py rotate.py] - rotate desktop by turning your laptop
*[[hdaps_ess|Enhanced smack script]] ess.py is based on the smacks scripts listed in this section. It includes stabilization, a lot of tuning options and it handles both axis (at best you should be able to map 8 commands, even if it is possible I was not able to do so). It is not perfect but on my Thinkpad it works better than the other scripts.

=== Interesting links related to this project ===
* [https://lists.sourceforge.net/lists/listinfo/hdaps-devel HDAPS mailinglist and its archive]
* #hdaps channel on irc.freenode.org
* [https://sourceforge.net/projects/hdaps/ hdaps projects] overview of userspace programs using hdaps
* [http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=TPAD-HDFIRM IBM ThinkPads hardware drive firmware site]
* [http://www.paul.sladen.org/thinkpad-r31/accelerometer.html http://www.paul.sladen.org/thinkpad-r31/accelerometer/]
* http://bugs.gentoo.org/show_bug.cgi?id=119845 Gentoo ebuild for hdaps driver and daemon including a initscript*
* http://bugs.gentoo.org/show_bug.cgi?id=137345 Gentoo ebuild for gkhdaps gkrell plugin
* http://bugs.gentoo.org/show_bug.cgi?id=137350 Gentoo ebuild for hdaps-gl application
* http://bugs.gentoo.org/show_bug.cgi?id=137351 Gentoo ebuild for gnome hdapsgl-applet
* http://bugs.gentoo.org/show_bug.cgi?id=137352 Gentoo ebuild for gnome tilt application
* http://bugs.gentoo.org/show_bug.cgi?id=137353 Gentoo ebuild for wmhdaps
* http://gentoo.o0o.nu Gentoo sectools overlay with fresh hdaps-related ebuilds and patches
* [http://lenovoblogs.com/insidethebox/?p=71 Why the ThinkPad accelerometer is only 2D] - explanation by Lenovo

[[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:R60]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Drivers]] [[Category:Z61m]]

HDAPS

2008-10-23T09:45:06Z

Whoopie: /* Kernel patch */ update link to patch, don't use "raw" as it's easier to download the patch without it.

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
=== HDAPS - IBM Active Protection System Linux Driver ===
This is the Linux driver for monitoring the accelerometer known as [[Active Protection System|IBM Active Protection System]].

The driver only enables reading of the acceleration data. It does '''not''' perform [[#Harddisk Protection|automatic disk head parking]]. But there are already some other useful [[#Applications|applications]] for HDAPS, using the {{path|/sys}} interface it provides.

{{WARN|There are two versions of the hdaps driver, one in the Linux kernel mainline, and another provided by [[tp_smapi]]. '''Use of the tp_smapi version of hdaps is strongly recommended by the current hdaps developers.'''}}
|}

=== Features ===
*provides accelerometer values via sysfs
*provides a joystick type input device

=== Project Homepage / Availability ===
*[http://hdaps.sourceforge.net/ Project Homepage]
*The driver is included in the 2.6-mm series of kernels since August, 26th 2005.
*The driver is now in the mainline (2.6.14).
*The [[tp_smapi]] package contains some patches to this driver. These are necessary for some recent models, and recommended for all.

=== Status ===
A driver is included in recent Linux kernels and is actively maintained, but it is very inferior to the driver in tp_smapi (which provides its own hdaps module).

=== How to install the driver ===
Recent Linux kernels include the <tt>hdaps</tt> driver. However, the driver in the mainline Linux kernel has two problems with recent models:
* It doesn't whitelist them (you have to edit hdaps_init() in drivers/hwmon/hdaps.c to include a line like <tt>HDAPS_DMI_MATCH_LENOVO("ThinkPad T60")</tt>)
* It doesn't work reliably, e.g., it may read out constant values (0,0). See [http://sourceforge.net/mailarchive/message.php?msg_id=15350314 here].

To solve both problems, install the modified hdaps that is bundled with [[tp_smapi]].

=== Harddisk Protection ===
As mentioned above, the hdaps kernel driver is only responsible for reading the accelerometer data and exporting it through the sysfs interface. In order to use this information to protect the disk, some additional steps are required.

See [[How to protect the harddisk through APS]].

=== Input device support ===
In more recent versions of the Linux kernel, the hdaps exports event devices with the accelerometer data. These devices can be used as-is by some programs (e.g. hdapsd), but for most they must be handled by the additional kernel module <code>joydev</code>.

When both modules are loaded, joydev will provide standard joystick device emulation for hdaps (standard hdaps exports just one joystick device. enhanced hdaps from tp_smapi will export two due to issues still unsolved on joydev, but the second one must not be used as a joystick).

{{WARN|Letting a program bind to these joystick devices can cause surprising results if you are not aware of it. e.g.: mplayer can act quite strangely. Also, letting a program bind to the second joystick device from enhanced HDAPS is guaranteed to be trouble}}

Udev can be used to create device nodes in /dev for use by user space programs that access the joystick, and to set appropriate permissions.

In order for non-root users to access these device files, their permissions must be tweaked a little through an appropriate udev rule and corresponding "joy" group.

{{cmdroot|addgroup joy}} 
{{cmdroot|adduser <you> joy}} 
<code># echo 'SUBSYSTEM=="input", KERNEL=="js*", MODE="0660", GROUP="joy"' >> /etc/udev/hdaps-joy.rules</code> 
{{cmdroot|ln -s ../hdaps-joy.rules /etc/udev/rules.d/z60_hdaps-joy.rules}} 

Programs you can use to test and calibrate the device files include <code>jscalibrator</code> (gui) and <code>jstest</code>/<code>jscal</code> (cli) packaged together (at least in Debian) simply as "joystick".

=== Applications ===
====Disk head parking====
You will need the kernel patch below and the hdapsd userspace daemon. The GUI monitoring is optional.

See [[How to protect the harddisk through APS]] for more information.

===== Kernel patch =====
Due to significant changes in the way the libata module which handles disk i/o, applying any of the currently available patches to kernel 2.6.24 will intermittently cause system hangs when the queue is frozen (i.e., the heads are parked). It is recommended either that you stay at kernel [http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.23.17.tar.bz2 2.6.23] or do without disk protection in 2.6.24 until the kinks have been worked out. There has been significant work on the part of [http://lkml.org/lkml/2008/2/25/478 Elias Oltmanns], author of the more recent patches, to get this worked out and eventually get shock protection built into the mainline kernel.

Below are some links to patches for various Linux kernel versions. As noted above, your mileage may vary with the 2.6.24-rc3 patch as it was after this release candidate that things stopped working nicely.
{{HINT|To apply a patch, change to the root directory of the kernel tree and run <code>patch -p1 -l < hdaps_xx.patch</code>}}
* New interface (requires hdapsd dated 2008-10-04 or newer)
** Expected in mainline kernel 2.6.28
** [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1393 disk-protect patch for kernel 2.6.27.2]
* Old interface
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1324/raw disk-protect patch for kernel 2.6.26]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1297/raw disk-protect patch for kernel 2.6.26-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1245/raw disk-protect patch for kernel 2.6.25-rc9] — may cause system locks (same as patch for 2.6.24-rc3). Apply [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix] before.
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1094 disk-protect patch for kernel 2.6.24-rc3] — may cause system locks (see [http://marc.info/?l=linux-thinkpad&m=120259594519907 here], [http://marc.info/?l=linux-thinkpad&m=120259929023300 here] and try [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix])
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1092 disk-protect patch for 2.6.23.8] + [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1113 error check fix]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1077 disk-protect patch for 2.6.22.9 and 2.6.23-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/993 disk-protect patch for 2.6.20-rc6]
* Ancient interface
**[http://www.nabble.com/attachment/9047418/0/hdaps_protect-2.6.20.patch.bz2 Latest sata/ide disk protection patch for 2.6.20]
**[http://article.gmane.org/gmane.linux.kernel/470413 Latest sata/ide disk protection patch for 2.6.19-rc6]
**[http://www.dresco.co.uk/hdaps/hdaps_protect-2.6.18.3-2.patch Latest sata/ide disk protection patch for 2.6.18.3]
**[http://exitzero.de/t41p-configs/hdaps_protect-2.6.17.1-20060625.patch Untested patch for 2.6.17.1]: see [http://thread.gmane.org/gmane.linux.drivers.hdaps.devel/708/focus=708]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/03-hdaps_protect-20060430-for-2.6.17-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.17.4 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://whoopie.gmxhome.de/linux/patches/2.6.16-tj/05-hdaps_protect-20060430-for-2.6.16-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.16.16 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060430.patch Latest sata/ide disk protection patch for 2.6.16]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060118.patch sata/ide disk protection patch for 2.6.15]
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.15.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.15 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.14.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.14 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://lwn.net/Articles/154923/ disk park patch] <tt>an experimental patch for parking the disk (Linux 2.6.14 for 2.6.15 see below)</tt>

===== Userspace daemon =====
*[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1372 Current version] 
This version optionally reduces timer interrupts (as measured by [[PowerTOP]]), and thereby reduces power consumption on modern ("tickless") Linux kernels. Interrupt reduction requires the <tt>hdaps</tt> kernel module from [[tp_smapi]] 0.32 or newer, and a udev rule. If these are not present, it will default to an older polling method that is slightly more power-hungry. The udev rule helps hdapsd find the input device, and on most distributions it can be created as follows:
# echo 'KERNEL=="event[0-9]*", ATTRS{phys}=="hdaps/input1",ATTRS{modalias}=="input:b0019v1014p5054e4801-*",SYMLINK+="input/hdaps/accelerometer-event"' \
> /etc/udev/rules.d/51-hdaps.rules
Then reboot or run {{cmdroot|/sbin/udevtrigger}}, and verify that the {{path|/dev/input/hdaps/accelerometer-event}} symlink exists.

*[ftp://rohrmoser-engineering.de/pub Modified adaptive algorithm version] - uses a different (and potentially better) algorithm for the adaptive sensivity threshold.

===== GUI monitoring =====
*[http://roy.marples.name/node/269 khdapmonitor] KDE System Tray Monitor
*[http://www.dresco.co.uk/hdaps/gnome-hdaps-applet-20060120.tar.gz gnome-hdaps-applet] visual display of disk protection status in gnome panel
*[http://www.kde-look.org/content/show.php/Applet+HDAPS?content=78387 applet_hdaps] KDE4 Plasmoid display disk protection status
*[http://awn.planetblur.org/index.php?shard=forum&action=g_reply&ID=1916&page=1&isLive=true ThinkHDAPS] Avant Window Manager applet for disk protection status

====Security & safety====
*[[Script for theft alarm using HDAPS]]

====Tilt monitoring====
*[http://www.mulliner.org/collin/gkibm-acpi.php gkhdaps] <tt>a GKrellM applet displaying tilt data</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 gnome-tilt] <tt>a gnome applet showing tilt data</tt>

====Visualisation of ThinkPad orientation====
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdaps-gl] <tt>a little app animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdapsgl-applet] <tt> a GNOME applet animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 wmadhps] <tt>a WindowMaker DockApp animating a 3D-ThinkPad</tt>
*[http://www.cs.cmu.edu/~ecc/gyro.tar.gz OpenGL gyroscope hack] <tt>keeps your display levelled when tilting the ThinkPad</tt> (warning: [http://en.wikipedia.org/wiki/Tarbomb uncompresses in the current directory]!)

====Games====
*[http://icculus.org/neverball/ Neverball] is quite fun with HDAPS. (You'll need to have the HDAPS joystick device)
*Turn your ThinkPad into a Jedi Weapon (hey, it [http://isnoop.net/blog/2006/05/20/macsaber-turn-your-mac-into-a-jedi-weapon works for Mac laptops])

====Other====

*[http://blog.micampe.it/articles/2006/06/04/here-comes-the-smackpad smack.py] - switch workspace by smacking your laptop, inspired by the [http://blog.medallia.com/2006/05/smacbook_pro.html SmackBook] (uses EWMH)
**an [http://weblogs.mozillazine.org/gerv/archives/2006/09/stablilised_smackpad.html improved version] adds stabilization (by comparing smacks to previous ones, uses EWMH)
**another [http://pberndt.com/Programme/Linux/pyhdaps/index.html approach] adds stabilization (by requiring a certain type of value deflection, uses xmacroplay)
**[http://www.gnome.org/~fherrera/gtollina.c GTollina] is another smack program for use with compiz (video [http://www.gnome.org/~fherrera/blog/gtollina.html here]).
*[http://blog.odonnell.nu/61.html xmms-smack.py] - move through your xmms playlist by smacking, based on the two smack scripts above.
*[http://www-128.ibm.com/developerworks/linux/library/l-knockage.html?ca=dgr-lnxw02aKnockBasedCommands KnockBasedCommands] - Execute commands by tapping your laptop.
*[http://people.ksp.sk/~mic/?menu=32&file=rotate.py rotate.py] - rotate desktop by turning your laptop
*[[hdaps_ess|Enhanced smack script]] ess.py is based on the smacks scripts listed in this section. It includes stabilization, a lot of tuning options and it handles both axis (at best you should be able to map 8 commands, even if it is possible I was not able to do so). It is not perfect but on my Thinkpad it works better than the other scripts.

=== Interesting links related to this project ===
* [https://lists.sourceforge.net/lists/listinfo/hdaps-devel HDAPS mailinglist and its archive]
* #hdaps channel on irc.freenode.org
* [https://sourceforge.net/projects/hdaps/ hdaps projects] overview of userspace programs using hdaps
* [http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=TPAD-HDFIRM IBM ThinkPads hardware drive firmware site]
* [http://www.paul.sladen.org/thinkpad-r31/accelerometer.html http://www.paul.sladen.org/thinkpad-r31/accelerometer/]
* http://bugs.gentoo.org/show_bug.cgi?id=119845 Gentoo ebuild for hdaps driver and daemon including a initscript*
* http://bugs.gentoo.org/show_bug.cgi?id=137345 Gentoo ebuild for gkhdaps gkrell plugin
* http://bugs.gentoo.org/show_bug.cgi?id=137350 Gentoo ebuild for hdaps-gl application
* http://bugs.gentoo.org/show_bug.cgi?id=137351 Gentoo ebuild for gnome hdapsgl-applet
* http://bugs.gentoo.org/show_bug.cgi?id=137352 Gentoo ebuild for gnome tilt application
* http://bugs.gentoo.org/show_bug.cgi?id=137353 Gentoo ebuild for wmhdaps
* http://gentoo.o0o.nu Gentoo sectools overlay with fresh hdaps-related ebuilds and patches
* [http://lenovoblogs.com/insidethebox/?p=71 Why the ThinkPad accelerometer is only 2D] - explanation by Lenovo

[[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:R60]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Drivers]] [[Category:Z61m]]

HDAPS

2008-10-21T09:41:10Z

Whoopie: revert changes, everything is already there, just some lines below

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
=== HDAPS - IBM Active Protection System Linux Driver ===
This is the Linux driver for monitoring the accelerometer known as [[Active Protection System|IBM Active Protection System]].

The driver only enables reading of the acceleration data. It does '''not''' perform [[#Harddisk Protection|automatic disk head parking]]. But there are already some other useful [[#Applications|applications]] for HDAPS, using the {{path|/sys}} interface it provides.

{{WARN|There are two versions of the hdaps driver, one in the Linux kernel mainline, and another provided by [[tp_smapi]]. '''Use of the tp_smapi version of hdaps is strongly recommended by the current hdaps developers.'''}}
|}

=== Features ===
*provides accelerometer values via sysfs
*provides a joystick type input device

=== Project Homepage / Availability ===
*[http://hdaps.sourceforge.net/ Project Homepage]
*The driver is included in the 2.6-mm series of kernels since August, 26th 2005.
*The driver is now in the mainline (2.6.14).
*The [[tp_smapi]] package contains some patches to this driver. These are necessary for some recent models, and recommended for all.

=== Status ===
A driver is included in recent Linux kernels and is actively maintained, but it is very inferior to the driver in tp_smapi (which provides its own hdaps module).

=== How to install the driver ===
Recent Linux kernels include the <tt>hdaps</tt> driver. However, the driver in the mainline Linux kernel has two problems with recent models:
* It doesn't whitelist them (you have to edit hdaps_init() in drivers/hwmon/hdaps.c to include a line like <tt>HDAPS_DMI_MATCH_LENOVO("ThinkPad T60")</tt>)
* It doesn't work reliably, e.g., it may read out constant values (0,0). See [http://sourceforge.net/mailarchive/message.php?msg_id=15350314 here].

To solve both problems, install the modified hdaps that is bundled with [[tp_smapi]].

=== Harddisk Protection ===
As mentioned above, the hdaps kernel driver is only responsible for reading the accelerometer data and exporting it through the sysfs interface. In order to use this information to protect the disk, some additional steps are required.

See [[How to protect the harddisk through APS]].

=== Input device support ===
In more recent versions of the Linux kernel, the hdaps exports event devices with the accelerometer data. These devices can be used as-is by some programs (e.g. hdapsd), but for most they must be handled by the additional kernel module <code>joydev</code>.

When both modules are loaded, joydev will provide standard joystick device emulation for hdaps (standard hdaps exports just one joystick device. enhanced hdaps from tp_smapi will export two due to issues still unsolved on joydev, but the second one must not be used as a joystick).

{{WARN|Letting a program bind to these joystick devices can cause surprising results if you are not aware of it. e.g.: mplayer can act quite strangely. Also, letting a program bind to the second joystick device from enhanced HDAPS is guaranteed to be trouble}}

Udev can be used to create device nodes in /dev for use by user space programs that access the joystick, and to set appropriate permissions.

In order for non-root users to access these device files, their permissions must be tweaked a little through an appropriate udev rule and corresponding "joy" group.

{{cmdroot|addgroup joy}} 
{{cmdroot|adduser <you> joy}} 
<code># echo 'SUBSYSTEM=="input", KERNEL=="js*", MODE="0660", GROUP="joy"' >> /etc/udev/hdaps-joy.rules</code> 
{{cmdroot|ln -s ../hdaps-joy.rules /etc/udev/rules.d/z60_hdaps-joy.rules}} 

Programs you can use to test and calibrate the device files include <code>jscalibrator</code> (gui) and <code>jstest</code>/<code>jscal</code> (cli) packaged together (at least in Debian) simply as "joystick".

=== Applications ===
====Disk head parking====
You will need the kernel patch below and the hdapsd userspace daemon. The GUI monitoring is optional.

See [[How to protect the harddisk through APS]] for more information.

===== Kernel patch =====
Due to significant changes in the way the libata module which handles disk i/o, applying any of the currently available patches to kernel 2.6.24 will intermittently cause system hangs when the queue is frozen (i.e., the heads are parked). It is recommended either that you stay at kernel [http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.23.17.tar.bz2 2.6.23] or do without disk protection in 2.6.24 until the kinks have been worked out. There has been significant work on the part of [http://lkml.org/lkml/2008/2/25/478 Elias Oltmanns], author of the more recent patches, to get this worked out and eventually get shock protection built into the mainline kernel.

Below are some links to patches for various Linux kernel versions. As noted above, your mileage may vary with the 2.6.24-rc3 patch as it was after this release candidate that things stopped working nicely.
{{HINT|To apply a patch, change to the root directory of the kernel tree and run <code>patch -p1 -l < hdaps_xx.patch</code>}}
* New interface (requires hdapsd dated 2008-10-04 or newer)
** Expected in mainline kernel 2.6.28
** [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1379/raw disk-protect patch for kernel 2.6.27-rc8]
* Old interface
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1324/raw disk-protect patch for kernel 2.6.26]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1297/raw disk-protect patch for kernel 2.6.26-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1245/raw disk-protect patch for kernel 2.6.25-rc9] — may cause system locks (same as patch for 2.6.24-rc3). Apply [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix] before.
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1094 disk-protect patch for kernel 2.6.24-rc3] — may cause system locks (see [http://marc.info/?l=linux-thinkpad&m=120259594519907 here], [http://marc.info/?l=linux-thinkpad&m=120259929023300 here] and try [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2008-February/042226.html this fix])
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1092 disk-protect patch for 2.6.23.8] + [http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1113 error check fix]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1077 disk-protect patch for 2.6.22.9 and 2.6.23-rc9]
**[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/993 disk-protect patch for 2.6.20-rc6]
* Ancient interface
**[http://www.nabble.com/attachment/9047418/0/hdaps_protect-2.6.20.patch.bz2 Latest sata/ide disk protection patch for 2.6.20]
**[http://article.gmane.org/gmane.linux.kernel/470413 Latest sata/ide disk protection patch for 2.6.19-rc6]
**[http://www.dresco.co.uk/hdaps/hdaps_protect-2.6.18.3-2.patch Latest sata/ide disk protection patch for 2.6.18.3]
**[http://exitzero.de/t41p-configs/hdaps_protect-2.6.17.1-20060625.patch Untested patch for 2.6.17.1]: see [http://thread.gmane.org/gmane.linux.drivers.hdaps.devel/708/focus=708]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/03-hdaps_protect-20060430-for-2.6.17-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.17.4 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://whoopie.gmxhome.de/linux/patches/2.6.16-tj/05-hdaps_protect-20060430-for-2.6.16-tj.patch Latest sata/ide disk protection patch for use with the libata hotplug 2.6.16.16 patches] - See [[How_to_hotswap_UltraBay_devices]]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060430.patch Latest sata/ide disk protection patch for 2.6.16]
**[http://www.dresco.co.uk/hdaps/hdaps_protect.20060118.patch sata/ide disk protection patch for 2.6.15]
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.15.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.15 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://jenster.dyndns.org/files/blk_freeze-01-nodetection-for-2.6.14.patch disk park patch adapted for the t41p model] <tt> kernel 2.6.14 ([http://sourceforge.net/mailarchive/message.php?msg_id=13214288 capability detection disabled], no libata support)</tt>
**[http://lwn.net/Articles/154923/ disk park patch] <tt>an experimental patch for parking the disk (Linux 2.6.14 for 2.6.15 see below)</tt>

===== Userspace daemon =====
*[http://article.gmane.org/gmane.linux.drivers.hdaps.devel/1372 Current version] 
This version optionally reduces timer interrupts (as measured by [[PowerTOP]]), and thereby reduces power consumption on modern ("tickless") Linux kernels. Interrupt reduction requires the <tt>hdaps</tt> kernel module from [[tp_smapi]] 0.32 or newer, and a udev rule. If these are not present, it will default to an older polling method that is slightly more power-hungry. The udev rule helps hdapsd find the input device, and on most distributions it can be created as follows:
# echo 'KERNEL=="event[0-9]*", ATTRS{phys}=="hdaps/input1",ATTRS{modalias}=="input:b0019v1014p5054e4801-*",SYMLINK+="input/hdaps/accelerometer-event"' \
> /etc/udev/rules.d/51-hdaps.rules
Then reboot or run {{cmdroot|/sbin/udevtrigger}}, and verify that the {{path|/dev/input/hdaps/accelerometer-event}} symlink exists.

*[ftp://rohrmoser-engineering.de/pub Modified adaptive algorithm version] - uses a different (and potentially better) algorithm for the adaptive sensivity threshold.

===== GUI monitoring =====
*[http://roy.marples.name/node/269 khdapmonitor] KDE System Tray Monitor
*[http://www.dresco.co.uk/hdaps/gnome-hdaps-applet-20060120.tar.gz gnome-hdaps-applet] visual display of disk protection status in gnome panel
*[http://www.kde-look.org/content/show.php/Applet+HDAPS?content=78387 applet_hdaps] KDE4 Plasmoid display disk protection status
*[http://awn.planetblur.org/index.php?shard=forum&action=g_reply&ID=1916&page=1&isLive=true ThinkHDAPS] Avant Window Manager applet for disk protection status

====Security & safety====
*[[Script for theft alarm using HDAPS]]

====Tilt monitoring====
*[http://www.mulliner.org/collin/gkibm-acpi.php gkhdaps] <tt>a GKrellM applet displaying tilt data</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 gnome-tilt] <tt>a gnome applet showing tilt data</tt>

====Visualisation of ThinkPad orientation====
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdaps-gl] <tt>a little app animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 hdapsgl-applet] <tt> a GNOME applet animating a 3D-ThinkPad</tt>
*[https://sourceforge.net/project/showfiles.php?group_id=138242 wmadhps] <tt>a WindowMaker DockApp animating a 3D-ThinkPad</tt>
*[http://www.cs.cmu.edu/~ecc/gyro.tar.gz OpenGL gyroscope hack] <tt>keeps your display levelled when tilting the ThinkPad</tt> (warning: [http://en.wikipedia.org/wiki/Tarbomb uncompresses in the current directory]!)

====Games====
*[http://icculus.org/neverball/ Neverball] is quite fun with HDAPS. (You'll need to have the HDAPS joystick device)
*Turn your ThinkPad into a Jedi Weapon (hey, it [http://isnoop.net/blog/2006/05/20/macsaber-turn-your-mac-into-a-jedi-weapon works for Mac laptops])

====Other====

*[http://blog.micampe.it/articles/2006/06/04/here-comes-the-smackpad smack.py] - switch workspace by smacking your laptop, inspired by the [http://blog.medallia.com/2006/05/smacbook_pro.html SmackBook] (uses EWMH)
**an [http://weblogs.mozillazine.org/gerv/archives/2006/09/stablilised_smackpad.html improved version] adds stabilization (by comparing smacks to previous ones, uses EWMH)
**another [http://pberndt.com/Programme/Linux/pyhdaps/index.html approach] adds stabilization (by requiring a certain type of value deflection, uses xmacroplay)
**[http://www.gnome.org/~fherrera/gtollina.c GTollina] is another smack program for use with compiz (video [http://www.gnome.org/~fherrera/blog/gtollina.html here]).
*[http://blog.odonnell.nu/61.html xmms-smack.py] - move through your xmms playlist by smacking, based on the two smack scripts above.
*[http://www-128.ibm.com/developerworks/linux/library/l-knockage.html?ca=dgr-lnxw02aKnockBasedCommands KnockBasedCommands] - Execute commands by tapping your laptop.
*[http://people.ksp.sk/~mic/?menu=32&file=rotate.py rotate.py] - rotate desktop by turning your laptop
*[[hdaps_ess|Enhanced smack script]] ess.py is based on the smacks scripts listed in this section. It includes stabilization, a lot of tuning options and it handles both axis (at best you should be able to map 8 commands, even if it is possible I was not able to do so). It is not perfect but on my Thinkpad it works better than the other scripts.

=== Interesting links related to this project ===
* [https://lists.sourceforge.net/lists/listinfo/hdaps-devel HDAPS mailinglist and its archive]
* #hdaps channel on irc.freenode.org
* [https://sourceforge.net/projects/hdaps/ hdaps projects] overview of userspace programs using hdaps
* [http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=TPAD-HDFIRM IBM ThinkPads hardware drive firmware site]
* [http://www.paul.sladen.org/thinkpad-r31/accelerometer.html http://www.paul.sladen.org/thinkpad-r31/accelerometer/]
* http://bugs.gentoo.org/show_bug.cgi?id=119845 Gentoo ebuild for hdaps driver and daemon including a initscript*
* http://bugs.gentoo.org/show_bug.cgi?id=137345 Gentoo ebuild for gkhdaps gkrell plugin
* http://bugs.gentoo.org/show_bug.cgi?id=137350 Gentoo ebuild for hdaps-gl application
* http://bugs.gentoo.org/show_bug.cgi?id=137351 Gentoo ebuild for gnome hdapsgl-applet
* http://bugs.gentoo.org/show_bug.cgi?id=137352 Gentoo ebuild for gnome tilt application
* http://bugs.gentoo.org/show_bug.cgi?id=137353 Gentoo ebuild for wmhdaps
* http://gentoo.o0o.nu Gentoo sectools overlay with fresh hdaps-related ebuilds and patches
* [http://lenovoblogs.com/insidethebox/?p=71 Why the ThinkPad accelerometer is only 2D] - explanation by Lenovo

[[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:R60]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Drivers]] [[Category:Z61m]]

Category:R52

2008-08-22T11:37:39Z

Whoopie: Undo revision 36950 by Lithiumbattery (Talk)

{| width="100%"
|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;">
=== ThinkPad R52 ===
This page gives an overview of all ThinkPad R52 related topics.

Machine Type: 1858, 1859, 1860, 1861, 1862, 1863, 1958 (Intel graphics) 
Machine Type: 1846, 1847, 1848, 1849, 1850, 1870 (ATI graphics)
==== Standard Features ====
* One of the following processors:
** [[Intel Celeron M]] 1.3, 1.4 or 1.5 GHz
** [[Intel Pentium M (Dothan)]] 1.73, 1.86 or 2.0 GHz
* One of the following video adapters:
** [[Intel Graphics Media Accelerator 900]] ([http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-58833#vid no dvi docking support])
** [[ATI Mobility Radeon X300]] with 32 or 64 MB
* One of the following displays:
** 14.1" TFT display with 1024x768 resolution
** 15.0" TFT display with 1024x768 resolution
** 15.0" TFT display with 1400x1050 resolution
* 256, 512 MB or 1 GB [[PC2-4200]] memory standard
* 40, 60, 80 or 100 GB IDE HDD
* [[AD1981B]] AC'97 Audio controller
* [[UltraBay|UltraBay Enhanced]] with the following:
** CD-ROM drive
** CD-RW/DVD-ROM Combo drive
** DVD±RW drive
* [[Ethernet Controllers#Broadcom Gigabit (10/100/1000)|Broadcom 10/100/1000]] Ethernet
* [[CDC slot]] with one of the following:
** [[IBM Integrated 56K Modem (MDC-2)]]
** [[IBM Integrated Bluetooth IV with 56K Modem (BMDC-3)]]
* [[MiniPCI slot]] with one of the following:
** none (open)
** [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]]
** [[Intel PRO/Wireless 2915ABG Mini-PCI Adapter]]
* [[CardBus slot]] (Type 2)
* [[ExpressCard slot|ExpressCard/54 slot]]
* [[Embedded Security Subsystem|IBM Embedded Security Subsystem 2.0]]
* [[Active Protection System|IBM Active Protection System]]
* FireWire (IEEE1394) on select systems
</div>
|style="vertical-align:top" |
[[image:ThinkPadR50.jpg|ThinkPad R52]]
|}
* [ftp://ftp.software.ibm.com/pc/pccbbs/mobiles_pdf/39t2462.pdf ThinkPad R50e, R51e, R52 - Hardware Maintenance Manual (August 2005)] (4,398,428 Bytes)

[[Category:R Series]]

Category:T42

2008-08-22T11:35:57Z

Whoopie: remove two other spam links

{| width="100%"
|style="vertical-align:top" |
[[image:ThinkPadT40.jpg|ThinkPad T42]]
|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;">
=== ThinkPad T42 ===
This pages gives an overview of all ThinkPad T42 related topics.

Machine Type: 2373, 2374, 2378, 2379
==== Features ====
* One of the following processors:
** [[Intel Pentium M (Banias)]] 1.5 GHz
** [[Intel Pentium M (Dothan)]] 1.6, 1.7, 1.8 or 2.0 GHz
* One of the following graphics controllers:
** [[ATI Mobility Radeon 7500]] with 32MB
** [[ATI Mobility Radeon 9000]] with 64MB
** [[ATI Mobility Radeon 9600]] with 64MB
* One of the following displays:
** 14.1" TFT display with 1024x768 resolution (XGA)
** 14.1" TFT display with 1400x1050 resolution (SXGA+)
** 15.0" TFT display with 1024x768 resolution (XGA)
** 15.0" TFT display with 1400x1050 resolution (SXGA+)
* 256, 512MB or 1GB [[PC2700]] memory standard, 2GB maximum
* 30, 40, 60 or 80GB HDD
* [[AD1981B]] AC'97 Audio controller
* [[Ethernet Controllers|Intel 10/100/1000 Ethernet]]
* [[UltraBay|UltraBay Slim]] with one of the following:
** DVD-ROM
** DVD-ROM/CD-RW Combo
** DVD-RW
* [[CDC slot]] with one of the following:
** [[IBM Integrated 56K Modem (MDC-2)]]
** [[IBM Integrated Bluetooth III with 56K Modem (BMDC-2)]]
* [[MiniPCI slot]] with one of the following:
** none (open)
** [[IBM 11b/g Wireless LAN Mini PCI Adapter]]
** [[IBM 11a/b/g Wireless LAN Mini PCI Adapter]]
** [[IBM 11a/b/g Wireless LAN Mini PCI Adapter II]]
** [[Intel PRO/Wireless LAN 2100 3B Mini PCI Adapter]]
** [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]]
** [[Intel PRO/Wireless 2915ABG Mini-PCI Adapter]]
* (2) Type II [[CardBus slot|CardBus slots]] or (1) type III
* [[Embedded Security Subsystem|IBM Embedded Security Subsystem 2.0]]
* [[Active Protection System|IBM Active Protection System]]
* [[Integrated Fingerprint Reader]] on selected systems
</div>
|}
* [ftp://ftp.software.ibm.com/pc/pccbbs/mobiles_pdf/13n6243.pdf ThinkPad T40/p, T41/p, T42/p - Hardware Maintenance Manual (April 2004)] (5,391,719 Bytes)
* [ftp://ftp.software.ibm.com/pc/pccbbs/mobiles_pdf/39t6192_01.pdf ThinkPad T40, T40p, T41, T41p, T42, T42p Hardware Maintenance Manual (February 2006)] (4,772,697 Bytes)
* [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-50233 ThinkPad T40/p, T41/p, T42/p, T43/p Videos of Hardware removal and installation]
[[Category:T Series]]

How to hotswap Ultrabay devices

2008-06-05T06:45:39Z

Whoopie: /* using libata-acpi and udev */ the patches are included in 2.6.26-rc5

The following discusses hotswap (AKA "hotplug") of devices in the [[UltraBay]].

==Which driver?==
Since this may be confusing for SATA thinkpad owners, which are likely all the same for now, you have two busses and drivers: one SATA bus which works with the AHCI driver and one IDE bus for the ultrabay for which you should pick ata_piix (not piix/CONFIG_BLK_DEV_PIIX). See below for hotswapping.

==Choosing the right driver: new style <tt>ata_piix</tt> vs old style <tt>piix/ide-disk</tt>==
For ICH5,6,7,8, systems, whether you have an older IDE only thinkpad, or a newer thinkpad like the T/Z61p, there is one SATA bus for the system hard drive and an IDE bus for the ultrabay (even if your ultrabay happens to have a SATA drive, as it'll be seen as an IDE device), you'll have two drivers to chose from for your ultrabay: the old IDE/piix+ide-disk driver, and the newer PATA (=IDE) support of the newer ata_piix driver. 
<tt>piix+ide-disk</tt> are part of the old original IDE driver and your ultrabay device will show up as <tt>/dev/hda</tt>. <tt>ata-piix</tt> is the new SATA/PATA (=IDE) driver that will cause your ultrabay Hard Drive to show up as <tt>/dev/sda</tt> and your CD-Rom as <tt>/dev/sr0</tt>

The two things to know are: 1) you want to use ata_piix and 2) if you build piix in (CONFIG_BLK_DEV_PIIX enabled), or load it as a module, it'll take over the IDE bus and prevent ATA_PIIX from seeing your ultrabay. You don't want that.

The longer details are: 
You don't want the piix+ide-disk combo because even as modules, you will not be able to unload piix to reset the bus if there are issues swapping devices (with ata_piix, even if you forget to unregister a drive before removing it, you can unload the module and reload it to reset the bus after the fact if you have a newer thinkpad with a separate AHCI/SATA bus for the boot drive).

As for hotswap, with piix+ide-disk, you can read the section below, but after more than one day of trying on 2.6.22.15 (as piix+ide-disk was taking over my IDE bus, and stopping me from using ata_piix before I removed it), I was not able to get hotswapping to work with piix+ide-disk (lt_hotswap would not even build on 2.6.22.15).

hotswap just works with ata_pixx on 2.6.22, and reportedly with anything newer than 2.6.18, so you want to get rid of piix+ide-disk.
There are several ways to do that:
* if piix is built in your kernel (CONFIG_BLK_DEV_PIIX):
** rebuild your kernel with CONFIG_BLK_DEV_PIIX turned off.
** if you don't want to rebuild your kernel, try disabling the IDE bus grabbing by that driver with <tt>ide0=noprobe hda=noprobe hdb=noprobe</tt> in your grub/lilo config (adjust the drive letters as appropriate, but note that this did not work for me on 2.6.22.15: the drive didn't show up on the piix bus, but it didn't show up on the ata_piix bus either).
* if piix is built in as a module
** you can move out the module in {{path|/lib/modules/ver/kernel/drivers/ide/pci/piix.ko}} and reboot.
** or build a new kernel, again with CONFIG_BLK_DEV_PIIX turned off.
** or add <tt>options ide_core options="ide0=noprobe hda=noprobe hdb=noprobe"</tt> to your modprobe.conf is supposed to work too (but didn't work on 2.6.22.15, see comment above)

Then, continue this document to see how to do hotswap with ata_piix (if you are lucky enough to have a newer SATA thinkpad where the ata_piix driver only runs the ultrabay, and you have a separate bus and ahci driver for your main drive, it is recommended to have ata_piix as a module (<tt>CONFIG_ATA_PIIX=m</tt>) so that you can unload/reload it if your bus gets in a bad state after a failed hotswap)

==When using the <tt>ata_piix</tt> driver==
The following applies when using the <tt>ata_piix</tt> driver, which is necessary for many recent ThinkPad models that use an [[Intel ICH6-M]] controller. See also [[Problems with SATA and Linux]].

Mainline kernels before 2.6.18 cannot reliably recognize newly (re-)inserted UltraBay drives without a reboot. There are experimental hotplug patches against pre-2.6.18 mainline kernels [http://home-tj.org/wiki/index.php/Libata-tj-stable here].

* Available hotplug patches
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.16.16-20060512.tar.bz2 Patch tarball against 2.6.16.16] ([http://lwn.net/Articles/183407/ Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17-20060625-1.tar.bz2 Patch tarball against 2.6.17/2.6.17.1] ([http://article.gmane.org/gmane.linux.ide/11598 Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17.4-20060710.tar.bz2 Patch tarball against 2.6.17.4]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/00-libata-tj-2.6.17.4-20060710.patch Patch against 2.6.17.14]

* Confirmed to work on the following laptops, with bus the following ID
**ThinkPad {{T30}}
**ThinkPad {{T43}}, {{T43p}}
**ThinkPad {{R52}}
**ThinkPad {{T60}} ID=4
**ThinkPad {{T61}} ID=0
**ThinkPad {{Z61p}} ID=4 (0-3:ahci, 5-6: ata_piix)
ID will typically be 1 if you only have an IDE bus (0 is boot drive, 1 is ultrabay), and it'll be 4 if you have a SATA bus your system boots from (ID 0-3) and an IDE bus for your ultrabay (ID 4-5). 
Note that even on a given laptop model the ID can vary depending on whether your kernel has drivers that configure your boot drive is using the old style IDE driver (which doesn't add IDs before your ultrabay), or whether your boot drive is using the new style driver (which adds IDs before your ultrabay)

Hotplug just works with kernels newer than 2.6.18 ( or older kernels that were patched to support <tt>ata_piix</tt> hotplug (don't try it otherwise!)) 
First, it is recommended you find the right SCSI ID for your drive to hotswap and unregister it before removing it (this works with all recent mainline kernels):
{{cmdroot|echo 1 > /sys/class/scsi_device/$ID:0:0:0/device/delete}}
{{cmdroot|echo eject > /proc/acpi/ibm/bay}}
The drive can now be ejected (without this, your IDE bus may complain if you just yank a drive, but you can usually recover by unloading/reloading the ata_piix module on a SATA laptop if your main drive is not on the ata_piix bus)

You can then issue the following after inserting an UltraBay drive to rescan the port:
{{cmdroot|echo 0 0 0 > /sys/class/scsi_host/host$ID/scan}}
The inserted drive should now be recognized by the kernel, and appropriate {{path|/dev/*}} entries created automatically (e.g., by <tt>udev</tt>).

Ted T'so has also written this hotswap patch, which may or may not be needed for you, see [http://www.mail-archive.com/linux-acpi@vger.kernel.org/msg04716.html hotswap patch] and report back

===Scripts for hotswapping===

The following scripts and [[acpid]] daemon configuration files do the following:
* Automatically unmounts the relevant filesystems and power off the UltraBay when the UltraBay eject lever is released. Screams if some filesystem can't be unmounted.
* Rescans the UltraBay port when then UltraBay eject lever is pushed back in.

They assumes you're using the <tt>ata_piix</tt> driver with an appropriate kernel (see above).

Create {{path|/usr/local/sbin/ultrabay_insert}} with permissions 755:
<pre>
#!/bin/bash
echo 12 > /proc/acpi/ibm/beep
sync
echo 0 0 0 > /sys/class/scsi_host/host1/scan
</pre>

Create {{path|/usr/local/sbin/ultrabay_eject}} with permissions 755:
<pre>
#!/bin/bash
ULTRABAY_SYSDIR='/sys/class/scsi_device/1:0:0:0/device'
shopt -s nullglob

# Umount the filesystem(s) backed by the given major:minor device(s)
unmount_rdev() { perl - "$@" <<'EOPERL' # let's do it in Perl
for $major_minor (@ARGV) {
$major_minor =~ m/^(\d+):(\d+)$/ or die;
push(@tgt_rdevs, ($1<<8)|$2);
}
# Sort by reverse length of mount point, to unmount sub-directories first
open MOUNTS,"</proc/mounts" or die "$!";
@mounts=sort { length($b->[1]) <=> length($a->[1]) } map { [ split ] } <MOUNTS>;
close MOUNTS;
foreach $m (@mounts) {
($dev,$dir)=@$m;
next unless -b $dev; $rdev=(stat($dev))[6];
next unless grep($_==$rdev, @tgt_rdevs);
system("umount","-v","$dir")==0 or $bad=1;
}
exit 1 if $bad;
EOPERL
}

# Get the UltraBay's /dev/foo block device node
ultrabay_dev_node() {
UDEV_PATH="`readlink -e "$ULTRABAY_SYSDIR/block:"*`" || return 1
UDEV_NAME="`udevinfo -q name -p $UDEV_PATH`" || return 1
echo /dev/$UDEV_NAME
}

if [ -d $ULTRABAY_SYSDIR ]; then
sync
# Unmount filesystems backed by this device
unmount_rdev `cat $ULTRABAY_SYSDIR/block\:*/dev \
$ULTRABAY_SYSDIR/block\:*/*/dev` \
|| {
echo 10 > /proc/acpi/ibm/beep; # error tone
exit 1;
}
sync
# Nicely power off the device
DEVNODE=`ultrabay_dev_node` && hdparm -Y $DEVNODE
# Let HAL+KDE notice the unmount and let the disk spin down
sleep 0.5
# Unregister this SCSI device:
sync
echo 1 > $ULTRABAY_SYSDIR/delete
fi
sync
# Turn off power to the UltraBay:
if [ -d /sys/devices/platform/bay.0 ]; then
echo 1 > /sys/devices/platform/bay.0/eject
elif [ -e /proc/acpi/ibm/bay ]; then
echo eject > /proc/acpi/ibm/bay
fi
# Tell the user we're OK
echo 12 > /proc/acpi/ibm/beep
</pre>

Create {{path|/etc/acpi/events/ultrabay-insert}}:
<pre>
event=ibm/bay MSTR 00000001 00000000
action=/usr/local/sbin/ultrabay_insert
</pre>

Create {{path|/etc/acpi/events/ultrabay-eject}}:
<pre>
event=ibm/bay MSTR 00000003 00000000
action=/usr/local/sbin/ultrabay_eject
</pre>

Restart <tt>acpid</tt>.

===using the generic bay driver and udev===

Starting from kernel 2.6.23-rc3, it's possible to use the generic <tt>bay</tt> driver in combination with udev to hotswap. Please check if CONFIG_ACPI_BAY is enabled (module or built-in) in your kernel configuration.

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
<pre>
ENV{BAY_EVENT}=="3", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_eject"
ENV{BAY_EVENT}=="1", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_insert"
</pre>

===using libata-acpi and udev===

Starting from kernel 2.6.26-rc5, it's possible to use <tt>libata-acpi</tt> in combination with udev to hotswap. Please check if CONFIG_ATA_ACPI is enabled in your kernel configuration.

For 2.6.25, you need two patches which can be easily backported ([http://article.gmane.org/gmane.linux.acpi.devel/31159],[http://article.gmane.org/gmane.linux.acpi.devel/31369]).

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
<pre>
ENV{BAY_EVENT}=="3", ACTION=="change", SUBSYSTEM=="scsi", RUN+="/usr/local/sbin/ultrabay_eject"
</pre>

===Model-specific notes===
See the table above for a list of ata_piix supported laptops and the bus ID to use.

===HAL support===

{{NOTE| Starting from HAL 0.5.11, you need to replace "storage.physical_device" with "info.parent".}}

Many programs, KDE included, rely on [[HAL]] to get notifications and information about device hotplugging. You need to tell HAL that devices connected the UltraBay port are hotpluggable. To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="scsi">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>

The string "8086_2653" may need to be changed to match your ThinkPad model; see below.

====Details====

By default, HAL doesn't know that UltraBay devices are hotpluggable:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
false

After creating {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as above and re-plugging the device, it will get marked correctly:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
true

The string "8086_2653" gives the PCI ID of the [[Intel 82801FBM]] southbridge. If your model has a different southbridge, or the UltraBay is attached to a different port, then you can find the appropriate <tt>storage.physical_device</tt> value by finding out the block device of the currently running UltraBay device (<tt>/dev/sdb</tt> in the following example) and then running:

# DEVICE=/dev/sdb
# UDI=`hal-find-by-property --key block.device --string $DEVICE` || echo Failed
# hal-get-property --udi $UDI --key storage.physical_device
/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0

If you have a different <tt>storage.physical_device</tt> value, please report your findings.

{| border=1
|+ Known South Bridge PCI IDs
! ID !! ThinkPad model !! South Bridge chip
|-
| 8086_248a || 2366-83U (T30) || Intel 82801CAM IDE U100 (rev 2)
|-
| 8086_2653 || 2525FAG (X41) || Intel 82801FBM (ICH6-M)
|-
| 8086_24ca || 237358U (T40), 2373KXU (T42p) || Intel 82801DBM (ICH4-M)
|-
| 8086_27c4 || X60 || Intel 82801GBM (ICH7 Family)
|-
| 8086_27df || Z61p, T60, T60p || Intel 82801GBM/GHM (ICH7 Family)
|-
| 8086_2850 || T61p || Intel 82801H (ICH8 Family)
|}

==When using the <tt>ide-disk</tt> driver==
The following applies if you use the <tt>ide-disk</tt> driver for the UltraBay device. 
Note that essentially, you shouldn't be using this driver, and use ata_piix instead unless you're running an older kernel where ata_piix won't work for you

Hotswapping is supposed to be supported as well, using either hdparm/[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] or [[lt_hotswap]] to (un)register IDE devices. The latter is the recommended method with kernels from 2.6, since it will leave DMA working. However, for recent models (R52, T43, X41, Z60 and later) no method is known to work while maintaining DMA support; see [[Problems with SATA and Linux]].

Only IDE devices (HDD's, optical drives, zip drives) require special treatment - batteries, floppies and other devices can just be pulled from the bay, provided they are not mounted or in use at the time. However, you should still power them down first using the [[ibm-acpi]] eject function.

The [[ibm-acpi]] kernel module has an eject function ({{cmdroot|echo eject > /proc/acpi/ibm/bay}}). This only manages the ACPI calls to power down the device and the bay. It does not actually unregister the device from the IDE driver. {{cmdroot|cat /proc/acpi/ibm/bay}} shows "unoccupied" unless an IDE device is present, but the eject function still works and should still be used.

To unregister the device, you can either use the [http://packages.debian.org/unstable/admin/hotswap Debian hotswap] package, or [[lt_hotswap]]. Note that lt_hotswap doesn't seem to even build on recent (at 2.6.22 or newer, although it probably broke before 2.6.22) and on newer kernels, you should not build/load the old IDE PIIX (CONFIG_BLK_DEV_PIIX) and use the natively hotswapping ata_piix (CONFIG_ATA_PIIX) as explained on the top of this page.

[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] also allows the drive to be swapped as a normal user by default, which is useful. You should use <tt>hotswap</tt> to unregister the device and then {{cmdroot|echo eject > /proc/acpi/ibm/bay}}. However, if you use this method on a 2.6 kernel, you will lose DMA support for the reinserted drive. This is due to kernel issues. This method was reported to work on a ThinkPad {{T23}} (kernels 2.6.8.1, 2.6.14.2 and 2.6.15-arch) and {{T42}} (kernel 2.6.13), but fails on a ThinkPad {{T43}} (kernel 2.6.14.3).

[[lt_hotswap]] is now the recommended method to un- and reregister the IDE device. It installs as a kernel module and has support for automatically unregistering (if loaded with the auto_eject=1 option) the device when the eject event is generated by [[ibm-acpi]]. It will leave DMA support intact. It has supported to work on a ThinkPad {{T22}} and {{T40}} and should work with many other models (but not recent models which require the <tt>ata_piix</tt> driver for disk DMA support). With the [[lt_hotswap]] kernel module loaded, run: {{cmdroot|modprobe -r ide_cd && modprobe -r cdrom && echo "MSTR eject" > /proc/acpi/lths}}

===HAL support===

HAL support also can also be configured To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="ide">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_24ca_ide_1_0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>
For more details see HAL section for ata driver.

==Other comments==

If you are hot-swapping a hard disk on a disk tray, make sure the disk does not have a password set, otherwise it will not be recognized on reinsertion.

[[Category:Scripts]]
[[Category:HOWTOs]]

How to hotswap Ultrabay devices

2008-06-03T20:54:02Z

Whoopie: /* HAL support */

The following discusses hotswap (AKA "hotplug") of devices in the [[UltraBay]].

==Which driver?==
Since this may be confusing for SATA thinkpad owners, which are likely all the same for now, you have two busses and drivers: one SATA bus which works with the AHCI driver and one IDE bus for the ultrabay for which you should pick ata_piix (not piix/CONFIG_BLK_DEV_PIIX). See below for hotswapping.

==Choosing the right driver: new style <tt>ata_piix</tt> vs old style <tt>piix/ide-disk</tt>==
For ICH5,6,7,8, systems, whether you have an older IDE only thinkpad, or a newer thinkpad like the T/Z61p, there is one SATA bus for the system hard drive and an IDE bus for the ultrabay (even if your ultrabay happens to have a SATA drive, as it'll be seen as an IDE device), you'll have two drivers to chose from for your ultrabay: the old IDE/piix+ide-disk driver, and the newer PATA (=IDE) support of the newer ata_piix driver. 
<tt>piix+ide-disk</tt> are part of the old original IDE driver and your ultrabay device will show up as <tt>/dev/hda</tt>. <tt>ata-piix</tt> is the new SATA/PATA (=IDE) driver that will cause your ultrabay Hard Drive to show up as <tt>/dev/sda</tt> and your CD-Rom as <tt>/dev/sr0</tt>

The two things to know are: 1) you want to use ata_piix and 2) if you build piix in (CONFIG_BLK_DEV_PIIX enabled), or load it as a module, it'll take over the IDE bus and prevent ATA_PIIX from seeing your ultrabay. You don't want that.

The longer details are: 
You don't want the piix+ide-disk combo because even as modules, you will not be able to unload piix to reset the bus if there are issues swapping devices (with ata_piix, even if you forget to unregister a drive before removing it, you can unload the module and reload it to reset the bus after the fact if you have a newer thinkpad with a separate AHCI/SATA bus for the boot drive).

As for hotswap, with piix+ide-disk, you can read the section below, but after more than one day of trying on 2.6.22.15 (as piix+ide-disk was taking over my IDE bus, and stopping me from using ata_piix before I removed it), I was not able to get hotswapping to work with piix+ide-disk (lt_hotswap would not even build on 2.6.22.15).

hotswap just works with ata_pixx on 2.6.22, and reportedly with anything newer than 2.6.18, so you want to get rid of piix+ide-disk.
There are several ways to do that:
* if piix is built in your kernel (CONFIG_BLK_DEV_PIIX):
** rebuild your kernel with CONFIG_BLK_DEV_PIIX turned off.
** if you don't want to rebuild your kernel, try disabling the IDE bus grabbing by that driver with <tt>ide0=noprobe hda=noprobe hdb=noprobe</tt> in your grub/lilo config (adjust the drive letters as appropriate, but note that this did not work for me on 2.6.22.15: the drive didn't show up on the piix bus, but it didn't show up on the ata_piix bus either).
* if piix is built in as a module
** you can move out the module in {{path|/lib/modules/ver/kernel/drivers/ide/pci/piix.ko}} and reboot.
** or build a new kernel, again with CONFIG_BLK_DEV_PIIX turned off.
** or add <tt>options ide_core options="ide0=noprobe hda=noprobe hdb=noprobe"</tt> to your modprobe.conf is supposed to work too (but didn't work on 2.6.22.15, see comment above)

Then, continue this document to see how to do hotswap with ata_piix (if you are lucky enough to have a newer SATA thinkpad where the ata_piix driver only runs the ultrabay, and you have a separate bus and ahci driver for your main drive, it is recommended to have ata_piix as a module (<tt>CONFIG_ATA_PIIX=m</tt>) so that you can unload/reload it if your bus gets in a bad state after a failed hotswap)

==When using the <tt>ata_piix</tt> driver==
The following applies when using the <tt>ata_piix</tt> driver, which is necessary for many recent ThinkPad models that use an [[Intel ICH6-M]] controller. See also [[Problems with SATA and Linux]].

Mainline kernels before 2.6.18 cannot reliably recognize newly (re-)inserted UltraBay drives without a reboot. There are experimental hotplug patches against pre-2.6.18 mainline kernels [http://home-tj.org/wiki/index.php/Libata-tj-stable here].

* Available hotplug patches
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.16.16-20060512.tar.bz2 Patch tarball against 2.6.16.16] ([http://lwn.net/Articles/183407/ Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17-20060625-1.tar.bz2 Patch tarball against 2.6.17/2.6.17.1] ([http://article.gmane.org/gmane.linux.ide/11598 Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17.4-20060710.tar.bz2 Patch tarball against 2.6.17.4]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/00-libata-tj-2.6.17.4-20060710.patch Patch against 2.6.17.14]

* Confirmed to work on the following laptops, with bus the following ID
**ThinkPad {{T30}}
**ThinkPad {{T43}}, {{T43p}}
**ThinkPad {{R52}}
**ThinkPad {{T60}} ID=4
**ThinkPad {{T61}} ID=0
**ThinkPad {{Z61p}} ID=4 (0-3:ahci, 5-6: ata_piix)
ID will typically be 1 if you only have an IDE bus (0 is boot drive, 1 is ultrabay), and it'll be 4 if you have a SATA bus your system boots from (ID 0-3) and an IDE bus for your ultrabay (ID 4-5). 
Note that even on a given laptop model the ID can vary depending on whether your kernel has drivers that configure your boot drive is using the old style IDE driver (which doesn't add IDs before your ultrabay), or whether your boot drive is using the new style driver (which adds IDs before your ultrabay)

Hotplug just works with kernels newer than 2.6.18 ( or older kernels that were patched to support <tt>ata_piix</tt> hotplug (don't try it otherwise!)) 
First, it is recommended you find the right SCSI ID for your drive to hotswap and unregister it before removing it (this works with all recent mainline kernels):
{{cmdroot|echo 1 > /sys/class/scsi_device/$ID:0:0:0/device/delete}}
{{cmdroot|echo eject > /proc/acpi/ibm/bay}}
The drive can now be ejected (without this, your IDE bus may complain if you just yank a drive, but you can usually recover by unloading/reloading the ata_piix module on a SATA laptop if your main drive is not on the ata_piix bus)

You can then issue the following after inserting an UltraBay drive to rescan the port:
{{cmdroot|echo 0 0 0 > /sys/class/scsi_host/host$ID/scan}}
The inserted drive should now be recognized by the kernel, and appropriate {{path|/dev/*}} entries created automatically (e.g., by <tt>udev</tt>).

Ted T'so has also written this hotswap patch, which may or may not be needed for you, see [http://www.mail-archive.com/linux-acpi@vger.kernel.org/msg04716.html hotswap patch] and report back

===Scripts for hotswapping===

The following scripts and [[acpid]] daemon configuration files do the following:
* Automatically unmounts the relevant filesystems and power off the UltraBay when the UltraBay eject lever is released. Screams if some filesystem can't be unmounted.
* Rescans the UltraBay port when then UltraBay eject lever is pushed back in.

They assumes you're using the <tt>ata_piix</tt> driver with an appropriate kernel (see above).

Create {{path|/usr/local/sbin/ultrabay_insert}} with permissions 755:
<pre>
#!/bin/bash
echo 12 > /proc/acpi/ibm/beep
sync
echo 0 0 0 > /sys/class/scsi_host/host1/scan
</pre>

Create {{path|/usr/local/sbin/ultrabay_eject}} with permissions 755:
<pre>
#!/bin/bash
ULTRABAY_SYSDIR='/sys/class/scsi_device/1:0:0:0/device'
shopt -s nullglob

# Umount the filesystem(s) backed by the given major:minor device(s)
unmount_rdev() { perl - "$@" <<'EOPERL' # let's do it in Perl
for $major_minor (@ARGV) {
$major_minor =~ m/^(\d+):(\d+)$/ or die;
push(@tgt_rdevs, ($1<<8)|$2);
}
# Sort by reverse length of mount point, to unmount sub-directories first
open MOUNTS,"</proc/mounts" or die "$!";
@mounts=sort { length($b->[1]) <=> length($a->[1]) } map { [ split ] } <MOUNTS>;
close MOUNTS;
foreach $m (@mounts) {
($dev,$dir)=@$m;
next unless -b $dev; $rdev=(stat($dev))[6];
next unless grep($_==$rdev, @tgt_rdevs);
system("umount","-v","$dir")==0 or $bad=1;
}
exit 1 if $bad;
EOPERL
}

# Get the UltraBay's /dev/foo block device node
ultrabay_dev_node() {
UDEV_PATH="`readlink -e "$ULTRABAY_SYSDIR/block:"*`" || return 1
UDEV_NAME="`udevinfo -q name -p $UDEV_PATH`" || return 1
echo /dev/$UDEV_NAME
}

if [ -d $ULTRABAY_SYSDIR ]; then
sync
# Unmount filesystems backed by this device
unmount_rdev `cat $ULTRABAY_SYSDIR/block\:*/dev \
$ULTRABAY_SYSDIR/block\:*/*/dev` \
|| {
echo 10 > /proc/acpi/ibm/beep; # error tone
exit 1;
}
sync
# Nicely power off the device
DEVNODE=`ultrabay_dev_node` && hdparm -Y $DEVNODE
# Let HAL+KDE notice the unmount and let the disk spin down
sleep 0.5
# Unregister this SCSI device:
sync
echo 1 > $ULTRABAY_SYSDIR/delete
fi
sync
# Turn off power to the UltraBay:
if [ -d /sys/devices/platform/bay.0 ]; then
echo 1 > /sys/devices/platform/bay.0/eject
elif [ -e /proc/acpi/ibm/bay ]; then
echo eject > /proc/acpi/ibm/bay
fi
# Tell the user we're OK
echo 12 > /proc/acpi/ibm/beep
</pre>

Create {{path|/etc/acpi/events/ultrabay-insert}}:
<pre>
event=ibm/bay MSTR 00000001 00000000
action=/usr/local/sbin/ultrabay_insert
</pre>

Create {{path|/etc/acpi/events/ultrabay-eject}}:
<pre>
event=ibm/bay MSTR 00000003 00000000
action=/usr/local/sbin/ultrabay_eject
</pre>

Restart <tt>acpid</tt>.

===using the generic bay driver and udev===

Starting from kernel 2.6.23-rc3, it's possible to use the generic <tt>bay</tt> driver in combination with udev to hotswap. Please check if CONFIG_ACPI_BAY is enabled (module or built-in) in your kernel configuration.

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
<pre>
ENV{BAY_EVENT}=="3", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_eject"
ENV{BAY_EVENT}=="1", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_insert"
</pre>

===using libata-acpi and udev===

You can also use <tt>libata-acpi</tt> for hotswapping and udev for unmounting. You need two patches which can be easily backported to 2.6.25 ([http://article.gmane.org/gmane.linux.acpi.devel/31159],[http://article.gmane.org/gmane.linux.acpi.devel/31369]).

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
<pre>
ENV{BAY_EVENT}=="3", ACTION=="change", SUBSYSTEM=="scsi", RUN+="/usr/local/sbin/ultrabay_eject"
</pre>

===Model-specific notes===
See the table above for a list of ata_piix supported laptops and the bus ID to use.

===HAL support===

{{NOTE| Starting from HAL 0.5.11, you need to replace "storage.physical_device" with "info.parent".}}

Many programs, KDE included, rely on [[HAL]] to get notifications and information about device hotplugging. You need to tell HAL that devices connected the UltraBay port are hotpluggable. To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="scsi">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>

The string "8086_2653" may need to be changed to match your ThinkPad model; see below.

====Details====

By default, HAL doesn't know that UltraBay devices are hotpluggable:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
false

After creating {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as above and re-plugging the device, it will get marked correctly:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
true

The string "8086_2653" gives the PCI ID of the [[Intel 82801FBM]] southbridge. If your model has a different southbridge, or the UltraBay is attached to a different port, then you can find the appropriate <tt>storage.physical_device</tt> value by finding out the block device of the currently running UltraBay device (<tt>/dev/sdb</tt> in the following example) and then running:

# DEVICE=/dev/sdb
# UDI=`hal-find-by-property --key block.device --string $DEVICE` || echo Failed
# hal-get-property --udi $UDI --key storage.physical_device
/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0

If you have a different <tt>storage.physical_device</tt> value, please report your findings.

{| border=1
|+ Known South Bridge PCI IDs
! ID !! ThinkPad model !! South Bridge chip
|-
| 8086_248a || 2366-83U (T30) || Intel 82801CAM IDE U100 (rev 2)
|-
| 8086_2653 || 2525FAG (X41) || Intel 82801FBM (ICH6-M)
|-
| 8086_24ca || 237358U (T40), 2373KXU (T42p) || Intel 82801DBM (ICH4-M)
|-
| 8086_27c4 || X60 || Intel 82801GBM (ICH7 Family)
|-
| 8086_27df || Z61p, T60, T60p || Intel 82801GBM/GHM (ICH7 Family)
|-
| 8086_2850 || T61p || Intel 82801H (ICH8 Family)
|}

==When using the <tt>ide-disk</tt> driver==
The following applies if you use the <tt>ide-disk</tt> driver for the UltraBay device. 
Note that essentially, you shouldn't be using this driver, and use ata_piix instead unless you're running an older kernel where ata_piix won't work for you

Hotswapping is supposed to be supported as well, using either hdparm/[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] or [[lt_hotswap]] to (un)register IDE devices. The latter is the recommended method with kernels from 2.6, since it will leave DMA working. However, for recent models (R52, T43, X41, Z60 and later) no method is known to work while maintaining DMA support; see [[Problems with SATA and Linux]].

Only IDE devices (HDD's, optical drives, zip drives) require special treatment - batteries, floppies and other devices can just be pulled from the bay, provided they are not mounted or in use at the time. However, you should still power them down first using the [[ibm-acpi]] eject function.

The [[ibm-acpi]] kernel module has an eject function ({{cmdroot|echo eject > /proc/acpi/ibm/bay}}). This only manages the ACPI calls to power down the device and the bay. It does not actually unregister the device from the IDE driver. {{cmdroot|cat /proc/acpi/ibm/bay}} shows "unoccupied" unless an IDE device is present, but the eject function still works and should still be used.

To unregister the device, you can either use the [http://packages.debian.org/unstable/admin/hotswap Debian hotswap] package, or [[lt_hotswap]]. Note that lt_hotswap doesn't seem to even build on recent (at 2.6.22 or newer, although it probably broke before 2.6.22) and on newer kernels, you should not build/load the old IDE PIIX (CONFIG_BLK_DEV_PIIX) and use the natively hotswapping ata_piix (CONFIG_ATA_PIIX) as explained on the top of this page.

[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] also allows the drive to be swapped as a normal user by default, which is useful. You should use <tt>hotswap</tt> to unregister the device and then {{cmdroot|echo eject > /proc/acpi/ibm/bay}}. However, if you use this method on a 2.6 kernel, you will lose DMA support for the reinserted drive. This is due to kernel issues. This method was reported to work on a ThinkPad {{T23}} (kernels 2.6.8.1, 2.6.14.2 and 2.6.15-arch) and {{T42}} (kernel 2.6.13), but fails on a ThinkPad {{T43}} (kernel 2.6.14.3).

[[lt_hotswap]] is now the recommended method to un- and reregister the IDE device. It installs as a kernel module and has support for automatically unregistering (if loaded with the auto_eject=1 option) the device when the eject event is generated by [[ibm-acpi]]. It will leave DMA support intact. It has supported to work on a ThinkPad {{T22}} and {{T40}} and should work with many other models (but not recent models which require the <tt>ata_piix</tt> driver for disk DMA support). With the [[lt_hotswap]] kernel module loaded, run: {{cmdroot|modprobe -r ide_cd && modprobe -r cdrom && echo "MSTR eject" > /proc/acpi/lths}}

===HAL support===

HAL support also can also be configured To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="ide">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_24ca_ide_1_0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>
For more details see HAL section for ata driver.

==Other comments==

If you are hot-swapping a hard disk on a disk tray, make sure the disk does not have a password set, otherwise it will not be recognized on reinsertion.

[[Category:Scripts]]
[[Category:HOWTOs]]

How to hotswap Ultrabay devices

2008-06-03T20:07:02Z

Whoopie: adding info for libata-acpi and udev

The following discusses hotswap (AKA "hotplug") of devices in the [[UltraBay]].

==Which driver?==
Since this may be confusing for SATA thinkpad owners, which are likely all the same for now, you have two busses and drivers: one SATA bus which works with the AHCI driver and one IDE bus for the ultrabay for which you should pick ata_piix (not piix/CONFIG_BLK_DEV_PIIX). See below for hotswapping.

==Choosing the right driver: new style <tt>ata_piix</tt> vs old style <tt>piix/ide-disk</tt>==
For ICH5,6,7,8, systems, whether you have an older IDE only thinkpad, or a newer thinkpad like the T/Z61p, there is one SATA bus for the system hard drive and an IDE bus for the ultrabay (even if your ultrabay happens to have a SATA drive, as it'll be seen as an IDE device), you'll have two drivers to chose from for your ultrabay: the old IDE/piix+ide-disk driver, and the newer PATA (=IDE) support of the newer ata_piix driver. 
<tt>piix+ide-disk</tt> are part of the old original IDE driver and your ultrabay device will show up as <tt>/dev/hda</tt>. <tt>ata-piix</tt> is the new SATA/PATA (=IDE) driver that will cause your ultrabay Hard Drive to show up as <tt>/dev/sda</tt> and your CD-Rom as <tt>/dev/sr0</tt>

The two things to know are: 1) you want to use ata_piix and 2) if you build piix in (CONFIG_BLK_DEV_PIIX enabled), or load it as a module, it'll take over the IDE bus and prevent ATA_PIIX from seeing your ultrabay. You don't want that.

The longer details are: 
You don't want the piix+ide-disk combo because even as modules, you will not be able to unload piix to reset the bus if there are issues swapping devices (with ata_piix, even if you forget to unregister a drive before removing it, you can unload the module and reload it to reset the bus after the fact if you have a newer thinkpad with a separate AHCI/SATA bus for the boot drive).

As for hotswap, with piix+ide-disk, you can read the section below, but after more than one day of trying on 2.6.22.15 (as piix+ide-disk was taking over my IDE bus, and stopping me from using ata_piix before I removed it), I was not able to get hotswapping to work with piix+ide-disk (lt_hotswap would not even build on 2.6.22.15).

hotswap just works with ata_pixx on 2.6.22, and reportedly with anything newer than 2.6.18, so you want to get rid of piix+ide-disk.
There are several ways to do that:
* if piix is built in your kernel (CONFIG_BLK_DEV_PIIX):
** rebuild your kernel with CONFIG_BLK_DEV_PIIX turned off.
** if you don't want to rebuild your kernel, try disabling the IDE bus grabbing by that driver with <tt>ide0=noprobe hda=noprobe hdb=noprobe</tt> in your grub/lilo config (adjust the drive letters as appropriate, but note that this did not work for me on 2.6.22.15: the drive didn't show up on the piix bus, but it didn't show up on the ata_piix bus either).
* if piix is built in as a module
** you can move out the module in {{path|/lib/modules/ver/kernel/drivers/ide/pci/piix.ko}} and reboot.
** or build a new kernel, again with CONFIG_BLK_DEV_PIIX turned off.
** or add <tt>options ide_core options="ide0=noprobe hda=noprobe hdb=noprobe"</tt> to your modprobe.conf is supposed to work too (but didn't work on 2.6.22.15, see comment above)

Then, continue this document to see how to do hotswap with ata_piix (if you are lucky enough to have a newer SATA thinkpad where the ata_piix driver only runs the ultrabay, and you have a separate bus and ahci driver for your main drive, it is recommended to have ata_piix as a module (<tt>CONFIG_ATA_PIIX=m</tt>) so that you can unload/reload it if your bus gets in a bad state after a failed hotswap)

==When using the <tt>ata_piix</tt> driver==
The following applies when using the <tt>ata_piix</tt> driver, which is necessary for many recent ThinkPad models that use an [[Intel ICH6-M]] controller. See also [[Problems with SATA and Linux]].

Mainline kernels before 2.6.18 cannot reliably recognize newly (re-)inserted UltraBay drives without a reboot. There are experimental hotplug patches against pre-2.6.18 mainline kernels [http://home-tj.org/wiki/index.php/Libata-tj-stable here].

* Available hotplug patches
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.16.16-20060512.tar.bz2 Patch tarball against 2.6.16.16] ([http://lwn.net/Articles/183407/ Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17-20060625-1.tar.bz2 Patch tarball against 2.6.17/2.6.17.1] ([http://article.gmane.org/gmane.linux.ide/11598 Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17.4-20060710.tar.bz2 Patch tarball against 2.6.17.4]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/00-libata-tj-2.6.17.4-20060710.patch Patch against 2.6.17.14]

* Confirmed to work on the following laptops, with bus the following ID
**ThinkPad {{T30}}
**ThinkPad {{T43}}, {{T43p}}
**ThinkPad {{R52}}
**ThinkPad {{T60}} ID=4
**ThinkPad {{T61}} ID=0
**ThinkPad {{Z61p}} ID=4 (0-3:ahci, 5-6: ata_piix)
ID will typically be 1 if you only have an IDE bus (0 is boot drive, 1 is ultrabay), and it'll be 4 if you have a SATA bus your system boots from (ID 0-3) and an IDE bus for your ultrabay (ID 4-5). 
Note that even on a given laptop model the ID can vary depending on whether your kernel has drivers that configure your boot drive is using the old style IDE driver (which doesn't add IDs before your ultrabay), or whether your boot drive is using the new style driver (which adds IDs before your ultrabay)

Hotplug just works with kernels newer than 2.6.18 ( or older kernels that were patched to support <tt>ata_piix</tt> hotplug (don't try it otherwise!)) 
First, it is recommended you find the right SCSI ID for your drive to hotswap and unregister it before removing it (this works with all recent mainline kernels):
{{cmdroot|echo 1 > /sys/class/scsi_device/$ID:0:0:0/device/delete}}
{{cmdroot|echo eject > /proc/acpi/ibm/bay}}
The drive can now be ejected (without this, your IDE bus may complain if you just yank a drive, but you can usually recover by unloading/reloading the ata_piix module on a SATA laptop if your main drive is not on the ata_piix bus)

You can then issue the following after inserting an UltraBay drive to rescan the port:
{{cmdroot|echo 0 0 0 > /sys/class/scsi_host/host$ID/scan}}
The inserted drive should now be recognized by the kernel, and appropriate {{path|/dev/*}} entries created automatically (e.g., by <tt>udev</tt>).

Ted T'so has also written this hotswap patch, which may or may not be needed for you, see [http://www.mail-archive.com/linux-acpi@vger.kernel.org/msg04716.html hotswap patch] and report back

===Scripts for hotswapping===

The following scripts and [[acpid]] daemon configuration files do the following:
* Automatically unmounts the relevant filesystems and power off the UltraBay when the UltraBay eject lever is released. Screams if some filesystem can't be unmounted.
* Rescans the UltraBay port when then UltraBay eject lever is pushed back in.

They assumes you're using the <tt>ata_piix</tt> driver with an appropriate kernel (see above).

Create {{path|/usr/local/sbin/ultrabay_insert}} with permissions 755:
<pre>
#!/bin/bash
echo 12 > /proc/acpi/ibm/beep
sync
echo 0 0 0 > /sys/class/scsi_host/host1/scan
</pre>

Create {{path|/usr/local/sbin/ultrabay_eject}} with permissions 755:
<pre>
#!/bin/bash
ULTRABAY_SYSDIR='/sys/class/scsi_device/1:0:0:0/device'
shopt -s nullglob

# Umount the filesystem(s) backed by the given major:minor device(s)
unmount_rdev() { perl - "$@" <<'EOPERL' # let's do it in Perl
for $major_minor (@ARGV) {
$major_minor =~ m/^(\d+):(\d+)$/ or die;
push(@tgt_rdevs, ($1<<8)|$2);
}
# Sort by reverse length of mount point, to unmount sub-directories first
open MOUNTS,"</proc/mounts" or die "$!";
@mounts=sort { length($b->[1]) <=> length($a->[1]) } map { [ split ] } <MOUNTS>;
close MOUNTS;
foreach $m (@mounts) {
($dev,$dir)=@$m;
next unless -b $dev; $rdev=(stat($dev))[6];
next unless grep($_==$rdev, @tgt_rdevs);
system("umount","-v","$dir")==0 or $bad=1;
}
exit 1 if $bad;
EOPERL
}

# Get the UltraBay's /dev/foo block device node
ultrabay_dev_node() {
UDEV_PATH="`readlink -e "$ULTRABAY_SYSDIR/block:"*`" || return 1
UDEV_NAME="`udevinfo -q name -p $UDEV_PATH`" || return 1
echo /dev/$UDEV_NAME
}

if [ -d $ULTRABAY_SYSDIR ]; then
sync
# Unmount filesystems backed by this device
unmount_rdev `cat $ULTRABAY_SYSDIR/block\:*/dev \
$ULTRABAY_SYSDIR/block\:*/*/dev` \
|| {
echo 10 > /proc/acpi/ibm/beep; # error tone
exit 1;
}
sync
# Nicely power off the device
DEVNODE=`ultrabay_dev_node` && hdparm -Y $DEVNODE
# Let HAL+KDE notice the unmount and let the disk spin down
sleep 0.5
# Unregister this SCSI device:
sync
echo 1 > $ULTRABAY_SYSDIR/delete
fi
sync
# Turn off power to the UltraBay:
if [ -d /sys/devices/platform/bay.0 ]; then
echo 1 > /sys/devices/platform/bay.0/eject
elif [ -e /proc/acpi/ibm/bay ]; then
echo eject > /proc/acpi/ibm/bay
fi
# Tell the user we're OK
echo 12 > /proc/acpi/ibm/beep
</pre>

Create {{path|/etc/acpi/events/ultrabay-insert}}:
<pre>
event=ibm/bay MSTR 00000001 00000000
action=/usr/local/sbin/ultrabay_insert
</pre>

Create {{path|/etc/acpi/events/ultrabay-eject}}:
<pre>
event=ibm/bay MSTR 00000003 00000000
action=/usr/local/sbin/ultrabay_eject
</pre>

Restart <tt>acpid</tt>.

===using the generic bay driver and udev===

Starting from kernel 2.6.23-rc3, it's possible to use the generic <tt>bay</tt> driver in combination with udev to hotswap. Please check if CONFIG_ACPI_BAY is enabled (module or built-in) in your kernel configuration.

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
<pre>
ENV{BAY_EVENT}=="3", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_eject"
ENV{BAY_EVENT}=="1", KERNEL=="bay.0", ACTION=="change", SUBSYSTEM=="platform", RUN+="/usr/local/sbin/ultrabay_insert"
</pre>

===using libata-acpi and udev===

You can also use <tt>libata-acpi</tt> for hotswapping and udev for unmounting. You need two patches which can be easily backported to 2.6.25 ([http://article.gmane.org/gmane.linux.acpi.devel/31159],[http://article.gmane.org/gmane.linux.acpi.devel/31369]).

Create {{path|/etc/udev/rules.d/ibm-ultrabay.rules}}:
<pre>
ENV{BAY_EVENT}=="3", ACTION=="change", SUBSYSTEM=="scsi", RUN+="/usr/local/sbin/ultrabay_eject"
</pre>

===Model-specific notes===
See the table above for a list of ata_piix supported laptops and the bus ID to use.

===HAL support===

Many programs, KDE included, rely on [[HAL]] to get notifications and information about device hotplugging. You need to tell HAL that devices connected the UltraBay port are hotpluggable. To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="scsi">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>

The string "8086_2653" may need to be changed to match your ThinkPad model; see below.

====Details====

By default, HAL doesn't know that UltraBay devices are hotpluggable:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
false

After creating {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as above and re-plugging the device, it will get marked correctly:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
true

The string "8086_2653" gives the PCI ID of the [[Intel 82801FBM]] southbridge. If your model has a different southbridge, or the UltraBay is attached to a different port, then you can find the appropriate <tt>storage.physical_device</tt> value by finding out the block device of the currently running UltraBay device (<tt>/dev/sdb</tt> in the following example) and then running:

# DEVICE=/dev/sdb
# UDI=`hal-find-by-property --key block.device --string $DEVICE` || echo Failed
# hal-get-property --udi $UDI --key storage.physical_device
/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_0_scsi_device_lun0

If you have a different <tt>storage.physical_device</tt> value, please report your findings.

{| border=1
|+ Known South Bridge PCI IDs
! ID !! ThinkPad model !! South Bridge chip
|-
| 8086_248a || 2366-83U (T30) || Intel 82801CAM IDE U100 (rev 2)
|-
| 8086_2653 || 2525FAG (X41) || Intel 82801FBM (ICH6-M)
|-
| 8086_24ca || 237358U (T40), 2373KXU (T42p) || Intel 82801DBM (ICH4-M)
|-
| 8086_27c4 || X60 || Intel 82801GBM (ICH7 Family)
|-
| 8086_27df || Z61p, T60, T60p || Intel 82801GBM/GHM (ICH7 Family)
|-
| 8086_2850 || T61p || Intel 82801H (ICH8 Family)
|}

==When using the <tt>ide-disk</tt> driver==
The following applies if you use the <tt>ide-disk</tt> driver for the UltraBay device. 
Note that essentially, you shouldn't be using this driver, and use ata_piix instead unless you're running an older kernel where ata_piix won't work for you

Hotswapping is supposed to be supported as well, using either hdparm/[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] or [[lt_hotswap]] to (un)register IDE devices. The latter is the recommended method with kernels from 2.6, since it will leave DMA working. However, for recent models (R52, T43, X41, Z60 and later) no method is known to work while maintaining DMA support; see [[Problems with SATA and Linux]].

Only IDE devices (HDD's, optical drives, zip drives) require special treatment - batteries, floppies and other devices can just be pulled from the bay, provided they are not mounted or in use at the time. However, you should still power them down first using the [[ibm-acpi]] eject function.

The [[ibm-acpi]] kernel module has an eject function ({{cmdroot|echo eject > /proc/acpi/ibm/bay}}). This only manages the ACPI calls to power down the device and the bay. It does not actually unregister the device from the IDE driver. {{cmdroot|cat /proc/acpi/ibm/bay}} shows "unoccupied" unless an IDE device is present, but the eject function still works and should still be used.

To unregister the device, you can either use the [http://packages.debian.org/unstable/admin/hotswap Debian hotswap] package, or [[lt_hotswap]]. Note that lt_hotswap doesn't seem to even build on recent (at 2.6.22 or newer, although it probably broke before 2.6.22) and on newer kernels, you should not build/load the old IDE PIIX (CONFIG_BLK_DEV_PIIX) and use the natively hotswapping ata_piix (CONFIG_ATA_PIIX) as explained on the top of this page.

[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] also allows the drive to be swapped as a normal user by default, which is useful. You should use <tt>hotswap</tt> to unregister the device and then {{cmdroot|echo eject > /proc/acpi/ibm/bay}}. However, if you use this method on a 2.6 kernel, you will lose DMA support for the reinserted drive. This is due to kernel issues. This method was reported to work on a ThinkPad {{T23}} (kernels 2.6.8.1, 2.6.14.2 and 2.6.15-arch) and {{T42}} (kernel 2.6.13), but fails on a ThinkPad {{T43}} (kernel 2.6.14.3).

[[lt_hotswap]] is now the recommended method to un- and reregister the IDE device. It installs as a kernel module and has support for automatically unregistering (if loaded with the auto_eject=1 option) the device when the eject event is generated by [[ibm-acpi]]. It will leave DMA support intact. It has supported to work on a ThinkPad {{T22}} and {{T40}} and should work with many other models (but not recent models which require the <tt>ata_piix</tt> driver for disk DMA support). With the [[lt_hotswap]] kernel module loaded, run: {{cmdroot|modprobe -r ide_cd && modprobe -r cdrom && echo "MSTR eject" > /proc/acpi/lths}}

===HAL support===

HAL support also can also be configured To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="ide">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_24ca_ide_1_0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>
For more details see HAL section for ata driver.

==Other comments==

If you are hot-swapping a hard disk on a disk tray, make sure the disk does not have a password set, otherwise it will not be recognized on reinsertion.

[[Category:Scripts]]
[[Category:HOWTOs]]

Conexant HSF modem drivers

2008-05-04T11:57:04Z

Whoopie: /* The Linuxant hsf driver */

The following modems, available in some ThinkPad models, use the Conexant HSF softmodem chip, and require an appropriate driver:

* [[ThinkPad 56K Modem (MDC-1.5)]]
* [[IBM Integrated 56K Modem (MDC-2)]]
* [[IBM Integrated Bluetooth III with 56K Modem (BMDC-2)]]
* [[IBM Integrated Bluetooth IV with 56K Modem (BMDC-3)]]

Two drivers are currently available.

===The Smartlink smlink driver===
The Linux driver for Agere modems from [http://www.smlink.com/ SmartLink] supports both 2.4 and 2.6 kernels. However, it does not work with the newer Intel ICH6 controllers (used, e.g., on the ThinkPad {{R52}} and {{T43}}; trouble on the {{G41}} has also been [[Installing Debian on a ThinkPad G41|reported]]). Some users report that AT commands work but dialing does not.

The {{path|snd_intel8x0m}} kernel module also (incorrectly?) recognizes the [[IBM Integrated Bluetooth III with 56K Modem (BMDC-2)|BMDC-2]]. At least scanModem works with it. About {{path|snd_intel8x0m}} see [[Modem_Daughter_Card_(MDC)|MDC]].

===The Linuxant hsf driver===
The commercial [http://www.linuxant.com/drivers/hsf/index.php Conexant HSF] driver from [http://www.linuxant.com Linuxant] supports these modem and work also on ICH6 models (e.g., ThinkPad {{R52}}, {{R51}}, {{T43}}, and {{Z60m}}).

It offers free limited evaluation at 14.4kbps, and the full version costs $19.99. The license is tied to the specific CDC modem daughter card, so if you replace your modem card you will need to buy a new license.

Download: http://www.linuxant.com/drivers/hsf/full/downloads.php
* For Ubuntu, Dell released an OEM version of the linux driver (with 56K and fax support). You can download it [http://support.dell.com/support/downloads/download.aspx?c=us&l=en&s=gen&releaseid=R155004&SystemID=INSPIRONI6400/E1505&servicetag=&os=UBLN&osl=en&deviceid=8593&devlib=0&typecnt=0&vercnt=1&catid=-1&impid=-1&formatcnt=1&libid=20&fileid=206745 here]. Newer versions for i386 and x86_64 packaged in .tar.gz, .deb and .rpm can be found [http://linux.dell.com/files/ubuntu/hardy/modem-drivers/hsf/ here]

This driver works well with reliable connections. It does not support voice or telephony features.

====Installation====
* Fedora Core: use the provided RPMs. If using a custom kernel, choose the "Generic packages with source" in the [https://www.linuxant.com/drivers/hsf/full/downloads.php#generic HSF downloads page].
* Debian: run {{cmdroot|dpkg -i hsfblablabla.deb}}. When asked you for the code, enter "FREE" for the 14.4kbps evaluation.
* Gentoo: the hsfmodem package is in portage.

If you are running a 2.6.15.* kernel, you might consider running:
# hsfconfig --patch
first, and apply the appropriate patch (there is an issue with hsfmodem and 2.6.15 tree that results in kernel oops.
The patch provided by Conexant fixes that). It looks like this command has to be run in console (rather than e.g. xterm,
as the menu issues some escape sequences that garble the output in xterm)

====Suspend/resume====
The hsfmodem driver may prevent your machine from going into suspend. If so, you may remove them prior to sleep by adding to your suspend script:
modprobe -r hsfmc97ich hsfserial hsfengine hsfosspec hsfsoar
The drivers should be automatically re-loaded upon resume by the hotplug system, if not, just manually restart hotplug or modprobe the individual drivers, adding this to your suspend script if needed.

If you use the <tt>hibernate</tt> script on Fedora Core, simple add this to {{path|/etc/hibernate/hibernate.conf}}:
OnSuspend 12 service hsf stop
OnResume 12 service hsf start

====Problem with Software Suspend 2====
Version 7.47.00.01 works fine with [[Software Suspend 2]].

The version 7.43.00.01 of the HSF driver conflicted with [[Software Suspend 2]]. The needed patch isn't available from Linuxant anymore.

For {{Fedora}} systems, the procedure for generating and installing a patched RPM is as follows:
*Download tarball and patches:
:{{cmdroot|wget http://www.linuxant.com/dri[[Software Suspend 2]]vers/hsf/full/archive/hsfmodem-7.43.00.01full/hsfmodem-7.43.00.01full.tar.gz}}
:{{cmdroot|wget http://www.linuxant.com/drivers/hsf/full/archive/patches/hsf-7.43.00.01-suspend2.patch}}
:{{cmdroot|wget http://www.linuxant.com/drivers/hsf/full/archive/patches/hsf-7.43.00.01-try_to_freeze-2.patch}}
*Build the RPM:
:{{cmdroot|mkdir hsf-workdir}}
:{{cmdroot|cd hsf-workdir}}
:{{cmdroot|tar xzvf ../hsfmodem-7.43.00.01full.tar.gz}}
:{{cmdroot|cd hsfmodem-7.43.00.01full}}
:{{cmdroot|patch -i ../../hsf-7.43.00.01-suspend2.patch -p1}}
:{{cmdroot|patch -i ../../hsf-7.43.00.01-try_to_freeze-2.patch -p1}}
:{{cmdroot|cd ..}}
:{{cmdroot|tar czvf hsfmodem-7.43.00.01full.tar.gz hsfmodem-7.43.00.01full}}
:{{cmdroot|rpmbuild -ta hsfmodem-7.43.00.01full.tar.gz}}
*Install the RPM:
:{{cmdroot|rpm -e hsfmodem}}
:{{cmdroot|rpm -Uvh /usr/src/redhat/RPMS/i386/hsfmodem-7.43.00.01full-1.i386.rpm}}

Problems with fglrx

2008-04-30T15:09:06Z

Whoopie: Undo revision 37511 by Dave abrahams (Talk) This page is about problems with fglrx, not USB devices

This page discusses issues with the ATI proprietary [[fglrx]] display driver.

== Known Troubles and Solutions ==

=== X-specific issues ===

==== upgrading xserver-xorg ====
ATI proprietary drivers version 8.21.7 and later work with x.org 6.9.

If you are running an older version (8.20.8) under Debian sid and you upgrade your xserver-xorg, apt will force you to remove any debian-packaged fglrx drivers (package fglrx-driver depends on x.org << 6.8.99). You can just download the driver from the ATI site and install after modifying the Debian packager script to allow dependencies to be satisfied by x.org 6.9, or just download 8.21.7 and install manually. See talk page for step-by-step commands.

After installing the fglrx driver, you can use module-assist to build the appropriate kernel module.

==== new Xorg ID Scheme ====
ATI proprietary drivers <=8.36.5 with xorg >=7.1.0-18 (==1.3.0.0) in Debian Sid and Fedora ([http://www.sidux.com/PNphpBB2-viewtopic-t-3162-postdays-0-postorder-asc.html Debian] and [http://www.phoronix.net/forums/showthread.php?t=2382 Fedora] Forum Entries)

Ubuntu feisty made their own xorg with the standard id of 7.2, to work around this issue.

Xorg has changed its ID Scheme in newer Versions, and fglrx cannot cope with that (Error message saying "[...] X version mismatch - detected X.org 1.3.-1.905, required X.org 7.1.0.0 [...]").

A binary hack solves the Problem [http://rage3d.com/board/showthread.php?s=4638d94143536f6acacbccd8f0443472&t=33889029 (rage3d.com Forum Entry)]. This is a very '''dirty''' solution, and is probably violating the ATI driver license.

Simply using the open source ati driver (or holding back the xorg upgrades) until a new driver is released, is suggested.

As of version 8.37.6, this issue is solved. No more binary hacking needed.

=== Kernel-specific troubles ===

Using ATI drivers <=8.21.7 with kernel >=2.6.15 needs a [http://marc.theaimsgroup.com/?l=linux-kernel&m=113429835515001&w=2 patch]. (see table below for detail.) If you can't compile the driver modules with 2.6.15 or later, you should apply this [http://www.ksp.sk/~rasto/fglrx_with_2.6.15.patch patch] instead.

If you do not use one of these patches, you may experience peculiar lockups of X. Try {{cmduser|fglrxinfo}} - if your shell hangs at the end of this command, you may have an issue and should try the patch or upgrade.

Although unproven, there is a substantial amount of user / developer concern that the above patches prevent hard lockups but do not provide full reliability with 2.6.15 and there are larger / redisgn issues preventing compatibility. These issues have been fixed with later ATI drivers (> 8.21.7) so you can simply upgrade if you are running a more modern kernel.

==== 2.6.23 ====
In 2.6.23 release cycle, config option CONFIG_SUSPEND_SMP got renamed to CONFIG_PM_SLEEP_SMP. fglrx uses this variable for disabling power management on older kernels. As a result, SMP users running 2.6.23 weren't able to resume properly (almost instant lockup in that rare case fglrx managed to show a few usable pixels. A [http://linux.derkeiler.com/Mailing-Lists/Kernel/2007-10/msg03437.html quick patch] is available.

=== No hardware acceleration ===

====Acceleration lost after driver update====
If you lose hardware acceleration after a driver update this can be caused by an old fglrx kernel module being loaded.

Check out {{path|1=/var/log/Xorg.0.log}} for a message like:
:<code>(WW) fglrx(0): Kernel Module version does *not* match driver.</code>
:<code>(EE) fglrx(0): incompatible kernel module detected - HW accelerated OpenGL will not work</code>

You can verify this yourself by looking at the version message some lines above. It should read something not matching the installed version like:
:<code>(II) fglrx(0): Kernel Module Version Information:</code>
:<code>(II) fglrx(0): Name: fglrx</code>
:<code>(II) fglrx(0): Version: 8.10.19</code>

The cause for this trouble might be that there resist multiple versions of the fglrx module within the kernel module search path. 
Go to {{path|1=/lib/modules/<your linux kernel version>/}} and type {{cmdroot|1=grep fglrx modules.dep}}. 
If grep finds multiple lines you nailed down the problem. All you have to do now is to delete any versions of the module (look at the filedate) but the most current one. Then run {{cmdroot|1=depmod}} and you are done.

{{HINT|Newer versions (8.21.7) of the fglrx module seem to be installed in the <code>extra/</code> subdirectory. 
Older versions (8.19.10) used to be located in the <code>kernel/drivers/char/drm/</code> subdirectory.}}

====GCC 3.4====
If the ATI driver works only without the hardware acceleration, take into consideration that {{path|fglrx_dri.so}} was linked against libstdc++.so.5 which may not be present if your system uses gcc-3.4.

To fix this, compile gcc-3.3.5 and copy <tt>libstdc++.so.5*</tt> to {{path|/usr/lib}} and update the dynamic linker cache via {{cmdroot|ldconfig}}.

Or install a compat package for your favorite distro. FC4 users can do:
:{{cmdroot|yum install libstdc++.so.5}}

====radeonfb framebuffer====
Another possible cause for broken hardware acceleration (2D and 3D) is the radeonfb framebuffer: Switching to vesafb or vesafb-tng is reported to solve the problem on some systems. Also it has proven helpful to not perform {{cmdroot|modprobe fglrx}} after boot but to have the module loaded via {{path|/etc/modules.autoload/kernel2.x}} at boottime instead.

====Perpetual Mesa GLX Indirect on Debian====
If you've done everything right and you're still seeing:

:{{cmduser|fglrxinfo}}
:{{cmdresult|display: :0.0 screen: 0}}
:{{cmdresult|OpenGL vendor string: Mesa project: www.mesa3d.org}}
:{{cmdresult|OpenGL renderer string: Mesa GLX Indirect}}
:{{cmdresult|OpenGL version string: 1.2 (1.5 Mesa 6.4.1)}}

try this:

:{{cmdroot|mkdir -p /usr/X11R6/lib/modules/dri}}
:{{cmdroot|ln -s /usr/lib/dri/fglrx_dri.so /usr/X11R6/lib/modules/dri}}

Thanks to Maciej Matysiak for the clear debug [http://lists.debian.org/debian-amd64/2006/02/msg00217.html here] and solution [http://lists.debian.org/debian-amd64/2006/02/msg00311.html here].

More generally, use LIBGL_DEBUG=verbose fglrxinfo, to see what's happening, and whether you get this:
:{{cmduser|<nowiki>LIBGL_DEBUG=verbose</nowiki> fglrxinfo}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.26.18 fglrx (screen 0)}}
:{{cmdresult|libGL: OpenDriver: trying /usr/X11R6/lib/modules/dri/fglrx_dri.so}}
:{{cmdresult|libGL error: dlopen /usr/X11R6/lib/modules/dri/fglrx_dri.so failed (/usr/X11R6/lib/modules/dri/fglrx_dri.so: cannot open shared object file: No such file or directory)}}
:{{cmdresult|libGL error: unable to find driver: fglrx_dri.so}}
:{{cmdresult|display: :0.0 screen: 0}}
:{{cmdresult|OpenGL vendor string: Mesa project: www.mesa3d.org}}
:{{cmdresult|OpenGL renderer string: Mesa GLX Indirect}}
:{{cmdresult|OpenGL version string: 1.2 (1.5 Mesa 6.4.2)}}

instead of that:
:{{cmduser|<nowiki>LIBGL_DEBUG=verbose</nowiki> fglrxinfo}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.26.18 fglrx (screen 0)}}
:{{cmdresult|libGL: OpenDriver: trying /usr/X11R6/lib/modules/dri/fglrx_dri.so}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.26.18 fglrx (screen 0)}}
:{{cmdresult|drmOpenByBusid: busid is PCI:1:0:0}}
:{{cmdresult|drmOpenDevice: minor is 0}}
:{{cmdresult|drmOpenDevice: node name is /dev/dri/card0}}
:{{cmdresult|drmOpenDevice: open result is 4, (OK)}}
:{{cmdresult|drmOpenByBusid: drmOpenMinor returns 4}}
:{{cmdresult|drmOpenByBusid: drmGetBusid reports PCI:1:0:0}}
:{{cmdresult|Can't open configuration file /home/merlin/.drirc: No such file or directory.}}
:{{cmdresult|fglrx: DPD supported.}}
:{{cmdresult|display: :0.0 screen: 0}}
:{{cmdresult|OpenGL vendor string: ATI Technologies Inc.}}
:{{cmdresult|OpenGL renderer string: MOBILITY FIREGL T2 Pentium 4 (SSE2) (FireGL) (GNU_ICD)}}
:{{cmdresult|OpenGL version string: 2.0.5879 (8.26.18)}}

I have contacted ATI to add that info by default, the mesa guys to do that in glxinfo too, as well as the debian packager to fix the debian packaging bug (2006/07/22), so hopefully the situation will improve soon

You may have to run fglrxinfo as root to get this detail rather than a useless message.

==== Where to look for fglrx_dri.so (gentoo and general)====
After installing a new kernel (linux-2.6.20-gentoo-r7) with gentoo I again was not able to get the ATI driver working
correctly. But now I found out what the problem was:

I tried
:{{cmduser|<nowiki>LIBGL_DEBUG=verbose</nowiki> fglrxinfo}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.35.5 fglrx (screen 0)}}
:{{cmdresult|libGL: OpenDriver: trying /usr/lib32/dri/fglrx_dri.so}}
:{{cmdresult|libGL error: dlopen /usr/lib32/dri/fglrx_dri.so failed (/usr/lib32/dri/fglrx_dri.so: wrong ELF class: ELFCLASS32)}}
:{{cmdresult|libGL error: unable to find driver: fglrx_dri.so}}

The error itself makes sense, because I am running a 64-Bit linux on AMD. The question was, why libGL tries to look
in /usr/lib32 only...

After some digging around I found out, that apparently 8.35.5 version of the driver uses the environment variable
'''LIBGL_DRIVERS_PATH''' to find out where it should look for the "fglrx_dri.so" driver.

Now in my case this environment variable pointed to "/usr/lib32/dri" and that was what caused the problem.
So doing
:{{cmduser|<nowiki>export LIBGL_DRIVERS_PATH='/usr/lib64/dri:/usr/lib32/dri'</nowiki>}}
solved the problem in my case.

As mentioned I use gentoo. After some more digging around I found out, that it is apparently necessary to call
:{{cmduser|env-update}}
after a re-install of the ATI driver. To be more specific, it seems that "eselect opengl set ati" sometimes
does something wrong. "env-update" seems to repair the problem so that afterwards the '''LIBGL_DRIVERS_PATH'''
environment variable is set correctly when you log in.

If you want to check, look in <code>/etc/profile.env</code> and <code>/etc/profile.csh</code>. This is the
place where the '''LIBGL_DRIVERS_PATH''' environment variable gets set.

=== Softlink hell ===
The [[fglrx]] installer replaces the standard X.org OpenGL implementation (Mesa) with its own files, potentially causing collisions with the distribution's file and package management. It is best to install the driver via a package built for your distribution, which will typically include the necessary kludges to make things work. See the [[fglrx]] page for pointers.

====Discussion====
If using {{cmduser|fglrxinfo}} after installing [[fglrx]] indicates that you are still using the mesa indirect software GL renderer, you likely have some misplaced softlinks. It seems like it has to do with an apt-get upgrade that sometimes replaces these links. Anyway, go to
:{{cmdroot|cd /usr/X11R6/lib}}
and list your GL libraries and links
:{{cmdroot|ls -la *GL*}}
You should see something like the following two lines amoung others:
:{{cmdresult|libGL.so -> libGL.so.1.2}}
:{{cmdresult|libGL.so.1 -> libGL.so.1.2}}
If you see a link to a mesa library (something like {{cmdresult|... -> libGL.mesa.1.2}}), then that's your problem! Restore the softlink like this (use your actual library version, though):
:{{cmdroot|ln -s libGL.so.1.2 libGL.so.1}}

For some reason, this link might "break" later, giving you the software rendering once more. Even after renaming the mesa library to something like <tt>mesa.bkup</tt>, the system might still find it and link to it despite the name change. If you have to do this a lot, you could write a restoreGL script.

=====Gentoo=====
{{Gentoo}} has built in tools for managing the OpenGL symlinks.
:{{cmdroot|eselect opengl set ati}}
If <tt>eselect opengl ati</tt> doesn't fix it for you, you should probably tell [http://bugs.gentoo.org Gentoo Bugzilla] (assuming they don't know yet).

If {{cmdroot|ldd /usr/X11R6/bin/glxinfo}} shows that your system still uses the xorg-x11 mesa libs after trying one of the above commands, i.e. a line like this:
:{{cmdresult|1=libGL.so.1 => /usr/lib/opengl/xorg-x11/lib/libGL.so.1 (0x400a8000)}}
you will also need to relink {{path|libGl.so.1.2}}:
:{{cmdroot|cd /usr/lib/opengl/xorg-x11/lib/}}
:{{cmdroot|mv libGL.so.1.2 libGL.so.1.2_backup}}
:{{cmdroot|ln -s /usr/lib/libGL.so.1.2 libGL.so.1.2}}
After another restart of X {{cmduser|fglrxinfo}} should show that it's using the right libs now.

=====Debian=====

:{{cmdroot|rm /usr/lib/libGL.so*}}
:{{cmdroot|rm /usr/X11R6/lib/libGL.so*}}
:{{cmdroot|cd /usr/X11R6/lib}}
:{{cmdroot|cp /usr/lib/fglrx/diversions/lib/libGL.so.1.2 .}}
:{{cmdroot|ln -s libGL.so.1.2 libGL.so.1}}
:{{cmdroot|ldconfig}}

=== Troubles using software suspend ===

Resume doesn't work when any AIGLX clients are active. See https://bugs.launchpad.net/ubuntu/+source/linux-restricted-modules-2.6.24/+bug/197209 for details and a workaround.

Suspend won't work on any distribution which has activated the new SLUB allocator with fglrx < 8.42. This affects e.g. Ubuntu 7.10 Gutsy (see https://bugs.launchpad.net/ubuntu/+source/linux-source-2.6.22/+bug/121653/). The only workaround is currently to compile a custom kernel with SLAB support!

When the computer resumes from suspend, X only displays a garbled image and the computer is frozen.
The problem is acknowledged in ATI's release notes and in knowledge base entry <strike>[https://support.ati.com/ics/support/KBResult.asp?searchFor=Search+Words&search.x=0&search.y=0&searchOption=id&questionID=737-218+&task=knowledge&searchTime=-1&productID=&folderID=-1&resultLimit=50 737-218]</strike> [https://support.ati.com/ics/support/KBAnswer.asp?questionID=218 737-218]. Driver version 8.19.10 has "initial support for Suspend and Resume" but is working very nicely for most people (verified on T43, T43p and T42) without vbetool.

If you are using an older version of fglrx, using [http://www.srcf.ucam.org/~mjg59/vbetool/ vbetool] to save/restore the video card state before/after suspend worked for some people. If you use [[Software Suspend 2|Software Suspend 2 (suspend2)]] scripts, you can simply uncomment <tt>EnableVbetool yes</tt> in {{path|/etc/hibernate/hibernate.conf}}. Be aware though that it breaks suspend/resume for drivers beginning with version 8.19.10, so remember to disable it again when upgrading.

{| cellspacing="0" cellpadding="2" border="1"
|+ tested with the following configurations
!model!!distro||kernel!!fglrx!!PM!!success!!comments
|-
|{{T42}}||SUSE 9.3||2.6.11||8.14.13||swsusp||yes||
|-
|{{T41p}}||???||2.6.14||8.19.10||suspend2 2.2-rc9||yes||needs a small [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030381.html patch]
|-
|{{T42p}}||Debian||2.6.10||Debian packaged||suspend2||yes||
|-
|{{T43}}||Debian sid||2.6.14.2||8.19.10||swsusp||yes||works perfectly with 8.19.10 (but not earlier versions!)
|-
|{{T43}}||Debian etch||2.6.14.2||8.19.10||swsusp||yes||works perfectly with 8.19.10 and without vbetool
|-
|{{T43}}||Ubuntu Breezy||2.6.12-10||8.19.10||swsusp||yes||Perfect. (Finally.)
|-
|{{T43}}||FC4||2.6.14.1||8.19.10||suspend2 2.2-rc9||yes||needs a small [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030381.html patch], requires DRI disabled in {{path|xorg.conf}} (hence no 3D acceleration)
|-
|{{T43}}||FC4||2.6.14.2||8.19.10||suspend2 2.2-rc11||yes||requires DRI disabled in {{path|xorg.conf}} (hence no 3D acceleration)
|-
|{{T43}}||FC4||2.6.14.3||8.19.10||suspend2 2.2-rc13||no||DRI enabled
|-
|{{T43}}||FC4||2.6.14.3||8.20.8||suspend2 2.2-rc13||no||DRI enabled
|-
|{{T43p}}||FC6||2.6.20-1.2933||8.34.8||swsusp, STR||yes||DRI enabled, occasionally fails, reason unknown.
|-
|{{R50p}}||???||???||8.19.10||swsusp||yes||
|-
|{{T43p}}||Debian sid||2.6.14||8.19.10||Suspend to RAM||yes||without vbetool or UseDummyXServer, those two ''break'' the resume process here, with DRI enabled
|-
|{{T43p}}||Debian sid||2.6.14.3||8.20.8||Suspend to RAM||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{R52}}||Debian sid||2.6.15-rc5||8.20.8||swsup||yes||both vbetool and UseDummyXServer disabled, DRI enabled, needs [http://marc.theaimsgroup.com/?l=linux-kernel&m=113429835515001&w=2 patch]
|-
|{{T43p}}||Gentoo||[http://packages.gentoo.org/ebuilds/?suspend2-sources-2.6.15-r6 2.6.15]||8.22.5||Suspend to RAM||yes||without vbetool or UseDummyXServer, with DRI enabled - console is garbled until switching back from X
|-
|{{T43p}}||Gentoo||[http://packages.gentoo.org/ebuilds/?suspend2-sources-2.6.15-r6 2.6.15]||8.22.5||suspend2 2.2||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{T43}}||SUSE 10.1||2.6.16||8.25.18||swsusp||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{T43}}||SUSE 10.1||2.6.16||8.25.18||Suspend to RAM||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{T60}}||Gentoo 2006.1||2.6.19-suspend2||8.31.5||Suspend2||yes||Everything works: 3D, suspend-to-disk, suspend-to-ram, suspend in X.org, switching to VT's at any moment. Never needed to unload any modules manually, worked immediately. Fglrx driver 8.32.5 totally broke suspend for me, so i'm sticking with 8.31.5. T60 2008-B62 model.
|-
|{{T60p}}||Kubuntu 6.06||2.6.15||8.25.18||swsusp||no||Switching to VT to suspend: no resume, X restarts; Not switching: suspend works, garbled X display on resume, later X restarts
|-
|{{T60p}}||Kubuntu 6.06 Text Mode||2.6.15||---||swsusp||yes||suspend works in textmode after rmmod fglrx.
|-
|{{T60p}}||Debian/unstable/experimental||2.6.18||8.31.5-1 (from debian experimental)||susptoram hibernate debian packages||yes||suspend and resume works with X, 3D acc., Xv overlay...
|-
|{{T60p}}||Fedora Core 6 x86_64||2.6.20-1.2962_1.fc6.cubbi_suspend2|| 8.38.6||suspend2 hibernate||yes||suspend2 hibernate and resume working with libata driver (ahci not tested). Xv still broken since 8.35.5. Have not needed to set extra_pages_allowance thus far.
|-
|{{Z61m}}||Debian Sid||2.6.20.7||8.35.5-1||Suspend to RAM||yes||works without any problems, justs needs the usual acpi_sleep hacks
|-
|{{Z61m}}||Debian Sid||2.6.20.7||8.35.5-1||Suspend to Disk (Software Suspend)||yes||works without any problems
|-
|{{Z61m}}||Debian Sid||2.6.21||8.35.5-1||Suspend to RAM||yes||fglrx module must not be loaded into the kernel, or it won't resume
|-
|{{Z61m}}||openSUSE 10.2||2.6.21.5||8.37.6||suspend2 2.2.10||yes||/sys/power/suspend2/extra_pages_allowance must be set to 20000
|-
|{{Z61p}}||ARCH Linux||2.6.20||8.35.5-1||Suspend to RAM||yes||works with KDE suspend
|-
|{{T60p}}||Gentoo||2.6.22-r8 gentoo-sources||8.39.4||Suspend to RAM,swsusp||yes||swsusp works without hibernate-script installed (installing breaks it), s-to-RAM works only with CONFIG_FB ''disabled'' in kernel. No acpi_sleep=... parameter, no special script, no vbetool.
|}

=== Troubles with large RAM ===
Version 8.14.13 (and probably earlier versions) of the driver does not seem to be able to cope with large amounts of RAM: with 512 MB it works, with 1.5 GB it crashes the machine as soon as X is started. The problem is present only if the <tt>fglrx</tt> kernel module is loaded, but independently of whether {{kernelconf|CONFIG_HIGHMEM||||||}} is enabled. A workaround is to limit RAM by adding the {{bootparm|mem|864m}} kernel parameter.

Version 8.16.20 fixes the problem.

===Display switching ===
The switching between internal and external display doesn't work with fglrx versions <= 8.24.8, because the driver blocks messing around with the chipset via ACPI. If you want to use this feature (i.e. during presentations), you should use the <tt>vesa</tt> server instead (experienced with a R52, Kernel 2.6.11, xorg 6.8.2, fglrx 8.16.20). Or boot notebook with CRT connected, it will automatically detect it and display on both.

===Composite Support===
ATI, as of fglrx 8.42.3 added composite windowing (alpha channel), enabling hardware accelerated translucent windows (primarily for 'eye candy.') This has not been tested yet, and reports will be added here as users evaluate this versus the R300 open source drivers.

For reference, some discussion of current status of drivers can be found in the Rage3d forums' (http://rage3d.com/board) Linux area.

Composite support is also supported with recent Mesa and Xorg > 7 with the open source 3d radeon / R300 drivers found in the linux kernel or debian's driver repository. It works with the [[R300]] / FireGL T2 series as found on the T43p extremely well. This has made rapid progress in speed with the latest few releases, and as of kernel 2.6.23 runs perfectly well with an R300 based card.

===Hardlock on X logout===
Up from driver version 8.19.10 you will experience a system hard lock when logging out from X, if the session manager (kdm/gdm) is not properly configured. You have to tell the session manager to restart X.

In the kdm config file (gentoo: {{path|/usr/kde/<VERSION>/share/config/kdm/kdmrc}}) you have to add following to the section <code>[X-:*-Core]</code>:
TerminateServer=true

In the gdm config (/etc/gdm/gdm.conf) file add the following to the daemon-section:
AlwaysRestartServer=true

Information from the ATI bugtracker: http://ati.cchtml.com/show_bug.cgi?id=239

Another reason of hardlock my be using the wrong AGP driver. Make sure that you have proper drivers for your motherboard loaded before fglrx: (gentoo: {{path|/etc/modules.autoload.d/kernel-2.6}}):
intel-agp
fglrx

A common problem seems to be mistakenly using ATI Chipset drivers instead of Intel.

Information from gentoo bugtracker: <s>[http://bugs.gentoo.org/show_bug.cgi?id=113685 113685]</s>. Fixed in 8.25.18

===Cannot switch to VT===

With usplash boot enabled, it may not be possible to switch to a VT from X (Using Alt+Fn). Tested on T60p (Mobility Fire GLV5200) on Ubuntu 6.06 / 6.10 and fglrx 8.25.18 / 8.28.8. Display may become garbled and system might freeze. Solution (testet on Ubuntu 6.10) is to either remove the "splash" kernel boot parameter or add "vga=791" parameter ("vga=794" can be used on 1400x1050 panel).

http://ati.cchtml.com/show_bug.cgi?id=37 
https://launchpad.net/distros/ubuntu/+source/usplash/+bug/63558

===Flickering Display===

Some people have reported problems with their display flickering when using ati-drivers newer than 8.14.13. The problem is unclear
(possibly associated with an incorrect modeline setting) and no known solution exists except to use the open source radeon drivers.
You can follow this problem here: http://ati.cchtml.com/show_bug.cgi?id=248

===Error messages in system log===

If you find something like the following in {{path|/var/log/messages}}:

:{{cmdresult|kernel: mtrr: base(0xc0000000) is not aligned on a size(0x7ff0000) boundary}}
:{{cmdresult|kernel: [fglrx:firegl_addmap] *ERROR* mtrr allocation failed (-22)}}
:{{cmdresult|kernel: [fglrx:firegl_unlock] *ERROR* Process 5132 using kernel context 0}}

try to execute the following line and reload the fglrx module:

:{{cmdroot|1=echo "base=0xd0000000 size=0x8000000 type=write-combining" > /proc/mtrr}}

More detailed instructions can be found [http://ubuntuforums.org/showthread.php?t=115104 here].

===Hang when logging out===

A common problem is that when logging out from X, instead of gettign the KDM or GDM prompt, the system hangs.

This is discussed, including workarounds here: http://ati.cchtml.com/show_bug.cgi?id=239

===No power saving when CRT in use===

When both CRT and LCD are in use, power saving cannot be enabled.

This is reported here: http://ati.cchtml.com/show_bug.cgi?id=304

===WineX / Cedega Installs Software But Errors on Loading Games===

Some users may experience problems with certain FIREGL cards (in my case an ibm t43p laptop with a v3200 ati firegl) whereby projects such as cedega and wine refuse to work with 3d graphics, but native binaries (e.g. quake 4) work fine. A possible workaround is to add the following line in the drivers section of your /etc/X11/xorg.conf

Option "UseFastTLS" "2"

This option used to be configured with the older ati drivers when you ran "fglrxconfig". I have not yet found a way to get it to appear with "aticonfig", hence the manual insertion. This option is good for several linux distros I have tried, fedora core 5, ubuntu dapper and suse 10.1. It does not appear to effect performance on natively run programs.

{{NOTE|This may cause problems on machines with a Linux kernel version of 2.6.20 or higher (observed choppy video and video color inversion on T60p with both 2.6.20 and 2.6.21).}}

===Line Appears Below Mouse Cursor===

Some users have reported seeing a line approximately 1 mouse height below the bottom edge of the cursor, which follows the mouse and appears to change color based on the image below the cursor. This has been seen to happen using fglrx without the kernel module installed (in 2D mode) and additionally on external displays or multiple X servers. To work around the problem, try disabling the DGA extension by making the following changes to your XFree86.conf or xorg.conf file. Replace (or comment-out)
Load "extmod"
with
SubSection "extmod"
Option "omit xfree86-dga"
EndSubSection

===Freeze while using OpenGL Apps===

Some OpenGL applications such as screensavers or games (SecondLife) cause freezes. The cursor still moves, but otherwise the machine is unresponsive. This is the case with Xorg 7.1 and fglrx 8.29.6 using an x1400 and other cards. The solution is to add the following options to the video Device section in xorg.conf:
Option "Capabilities" "0x00000800"
Option "KernelModuleParm" "locked-userpages=0"

===Xv doesn't work correctly with drivers >= 8.36 and Xyyyy-cards===

See [http://ati.cchtml.com/show_bug.cgi?id=677] for further information. It seems as if only Xyyyy-cards are affected. Problem: graphical glitches with mplayer, programs like xine and totem might not start up at all. 8.35 doesn't seem to be affected

===Floating Point Exception with various X apps===

When the X server is left to autodetect the DPI, the fglrx driver may fail to supply the monitor dimensions. Video output switching may contribute to this bug.

Problems were experienced on T42p with Ubuntu 7.04, xorg-driver-fglrx 7.1.0-8.34.8+2.6.20.5-16.29.

This can be observed with xdpyinfo

:{{cmduser|xdpyinfo | grep dimensions}}
:{{cmdresult|dimensions: 1280x1024 pixels (0x0 millimeters)}}

Many applications will use the screen size and attempt to calculate DPI, resulting in a divide by zero operation and a SIGFPE.

A work around is to supply the dimensions in /etc/X11/xorg.conf. Use the DisplaySize parameter within your monitor's configuration. For example:

Section "Monitor"
Identifier "Generic Monitor"
HorizSync 28.0 - 64.0
VertRefresh 43.0 - 60.0
Option "DPMS"
DisplaySize 433 351
EndSection

=== Corrupted 3D display ===
With driver version 7-12 or later, you may experience a corrupted 3D display, if your horizontal screen resolution is not a multiple of 64. This is a known bug[http://support.ati.com/ics/support/default.asp?deptID=894&task=knowledge&questionID=31720] but ATI support does not have a solution to it yet.

There are two possible workarounds for this bug:

1/ Open the Catalyst Control Center and force the anti-aliasing to at least 2x for all applications. This surprisingly fixes the problem, at the expense of framerate.

2/ As suggested by ATI support, edit the /etc/X11/xorg.conf and find the section "Display". Add the following line into the "Display" section:
Virtual <width> <height>
where <width> is the width of your screen in pixels rounded up to the next multiple of 64 and <height> is the height of your screen in pixels.
For example, if your native resolution is 1400x1050, use
Virtual 1408 1050

After starting the X server you can run {{cmdresult|xrandr -s 0}} to restore the X server to a native display resolution, and 3D rendering will still work.

== Patches ==
The following patches might be needed for certain versions of fglrx. Before you apply any of these, make sure that you really need them, as some distributions include all the necessary patches with the appropriate package (e.g. ati-drivers in gentoo).

===fglrx 8.37.6===
* For kernel 2.6.22 you need this patch from a [http://www.phoronix.com/forums/showthread.php?t=2849 Phoronix thread].

===fglrx 8.35.5===
* [http://whoopie.gmxhome.de/linux/patches/2.6.20/fglrx-8.35.5-for-2.6.20.patch For kernel 2.6.20], part of the Fedora packaging scripts in the ATI installer

===fglrx 8.34.8===
* [http://whoopie.gmxhome.de/linux/patches/2.6.20/fglrx-8.34.8-for-2.6.20.patch For kernel 2.6.20]

===fglrx 8.32.5===
* [http://whoopie.gmxhome.de/linux/patches/2.6.19/fglrx-8.32.5-for-2.6.19.patch For kernel 2.6.19]

===fglrx 8.23.7===
* For kernel 2.6.16: [http://mirror.espri.arizona.edu/gentoo/rsync/x11-drivers/ati-drivers/files/ati-drivers-8.22.5-intermodule.patch <tt>intermodule</tt> patch] and [http://mirror.espri.arizona.edu/gentoo/rsync/x11-drivers/ati-drivers/files/ati-drivers-8.23.7-noiommu.patch <tt>noiommu</tt> patch]

===fglrx 8.21.7===

* [http://www.ksp.sk/~rasto/fglrx_with_2.6.15.patch for kernels >= 2.6.15]

===fglrx 8.20.8===

* [http://marc.theaimsgroup.com/?l=linux-kernel&m=113429835515001&w=2 for kernel 2.6.15]
or
* [http://www.ksp.sk/~rasto/fglrx_with_2.6.15.patch for kernels >= 2.6.15]

===fglrx (problem met at least with version 8.18.8)===
* [http://lkml.org/lkml/2005/9/22/183 for kernel >= 2.6.13 ] Missing verify_area bug

===fglrx 8.8.25 ===
* [http://www.rage3d.com/board/showthread.php?t=33798874 for kernels >= 2.6.10]
* [http://www.gehirn.org.uk/wiki/images/8.8.25-kernel-2.6.11+.patch For kernels >= 2.6.11-rc1]

===Links ===
* [http://gentoo-wiki.com/HOWTO_ATI_Drivers Gentoo HOWTO ATI]

How to enable the integrated fingerprint reader with ThinkFinger

2008-04-05T10:50:33Z

Whoopie: /* GNOME */ add note about sudo and links to bug reports

[[How to enable the fingerprint reader]] has a good explanation for using the fingerprint reader with the closed-source binary driver. But there is also an opensource project called [http://thinkfinger.sourceforge.net ThinkFinger] which does the same, but open.

However: The fingerprint reader is an INSECURE device and gives a false sense of security! There has been quite a bit of research by a hacker named Starbug, a member of the Chaos Computer Club, Berlin, Germany. He outlined in two very good talks how to forge each and every available fingerprint sensor available at the cost of a few euros, using materials from your local hardware store, a digicam and a laser printer! Here's some links:
* [http://www.ccc.de/updates/2007/umsonst-im-supermarkt?language=en Fingerprint recognition in supermarkets]
* [ftp://ftp.ccc.de/pub/video/Fingerabdruck_Hack/fingerabdruck.mpg?language=en Video tutorial for forging fingerprints]

== Installing ==
=== From source ===

Download thinkfinger-0.3.tar.gz from the [http://thinkfinger.sourceforge.net/ homepage] and unpack it somewhere, make sure you have the gcc compiler, libtool, pkg-config, libusb-dev and libpam0g-dev installed, then:

{{cmduser|cd thinkfinger-0.3}}

<code style="white-space:nowrap;color:#495988;background-color:white;"><nowiki>$</nowiki> ./configure --prefix=/usr --sysconfdir=/etc --with-securedir=/lib/security --with-birdir=/etc/pam_thinkfinger</code>

{{cmduser|make}}

{{cmdroot|make install}}

{{NOTE|/lib/security is the directory, where PAM assumes its modules on Debian and openSUSE, it may vary for your distro!}}

"make install" doesn't create the birdir we specified (where thinkfinger will store users' biometric info), so create it:

{{cmdroot|mkdir /etc/pam_thinkfinger}}

If everything went OK assert that you find pam_thinkfinger.so in /lib/security typing:

{{cmduser|ls /lib/security}}

=== From package ===

==== Debian ====
[http://packages.debian.org/source/experimental/thinkfinger Packages] arrived in Debian experimental on Aug 2nd, 2007 (cf. [http://bugs.debian.org/409563 bug #409563]). To access the experimental packages via apt, add the following lines to your sources.list:
<pre>
# experimental
deb ftp://mirrors.kernel.org/debian/ experimental main contrib non-free
deb-src ftp://mirrors.kernel.org/debian/ experimental main contrib non-free
</pre>
where of course you may replace mirrors.kernel.org with your mirror of choice. Just make sure that it hosts the experimental repositories.
<pre>
aptitude update
aptitude install libthinkfinger0 libpam-thinkfinger thinkfinger-tools
</pre>
should then get you up and running.

==== Ubuntu ====
From https://wiki.ubuntu.com/ThinkFinger

Add PPA repositories to your sources.list:
<pre>
deb http://ppa.launchpad.net/jldugger/ubuntu gutsy main restricted universe multiverse
deb-src http://ppa.launchpad.net/jldugger/ubuntu gutsy main restricted universe multiverse
</pre>

Install necessary packages:
<pre>
sudo apt-get install thinkfinger-tools libpam-thinkfinger
</pre>

==== Fedora/Fedora Core ====
*Packages for Fedora Core 6 are available in "extras" repository (# yum install thinkfinger).
*Packages for Fedora 7 are available in the "updates" repository (# yum install thinkfinger).

==== Gentoo ====
<pre>
emerge sys-auth/thinkfinger
</pre>

==== OpenSUSE ====
openSUSE 10.2 includes the package "libthinkfinger" (version 0.1-7) - you will find newer packages [http://beta1.suse.com/private/thoenig/10.2/thinkfinger/ here].

== Testing the driver ==

Now the driver is installed and should be working. You can try it (as root) with

{{cmdroot|tf-tool --acquire}}

and

{{cmdroot|tf-tool --verify}}

This will ask you to swipe your finger three times, save the fingerprint to /tmp/test.bir and then verify your fingerprint with the bir-file.

== Configuring PAM to use ThinkFinger ==
Now you can configure PAM to use ThinkFinger:

Open {{path|/etc/pam.d/common-auth}} (In FC6, F7, and Gentoo, this file is {{path|/etc/pam.d/system-auth}}):

{{cmdroot|nano -w /etc/pam.d/common-auth}}

Add this line before any pam_unix or pam_unix2 directives:
auth sufficient pam_thinkfinger.so

If your PAM uses the pam_unix and not the pam_unix2 module, you need to pass a specific argument in
the /etc/pam.d/common-auth directive to make it consider the password entered at the pam_thinkfinger prompt.
auth required pam_unix.so try_first_pass

For instance, {{path|/etc/pam.d/common-auth}} looks like this:
auth sufficient pam_thinkfinger.so
auth required pam_unix.so nullok_secure try_first_pass

On openSUSE 10.2, it looks like this now:
auth required pam_env.so
auth sufficient pam_thinkfinger.so
auth required pam_unix2.so

Now we are ready to add users to thinkfinger. You can add a fingerprint for a user with:

{{cmdroot|tf-tool --add-user $USERNAME}}

Now the user should be able to login with his finger instead of the password.

If you would like to use thinkfinger for su, you have to enroll the fingerprint for root user with:

{{cmdroot|tf-tool --add-user root}}

{{NOTE|You should see the "Password or swipe finger:" prompt when trying to sudo or su. If you don't, you probably do not have the "User level driver support" compiled into your kernel or the "uinput" module loaded!}}

== xscreensaver/gnome-screensaver ==
{{NOTE|In Fedora 7, the package has been modified in such a way as to make doing this unnecessary.}}

If you'd like to be able to unlock your screen using the fingerprint reader, you must have current versions of xscreesaver (>~5.03) or gnome-screensaver (>~2.18.2). Then you must give yourself access to the fingerprint reader and your bir-file, because unlike login/gdm/su/sudo, both gnome-screensaver and xscreensaver do not run as root. The following procedure will make the fingerprint reader accessible to members of the "fingerprint" group.

Make the group: {{cmdroot|groupadd fingerprint}}

Save the following as {{path|/etc/udev/rules.d/60-thinkfinger.rules}} (you may need to reboot for this to take effect):
#
# udev rules file for the thinkfinger fingerprint scanner
#
# gives access to the fingerprint reader to those in the "fingerprint" group
#
# Taken from:
# http://www.thinkwiki.org/wiki/How_to_enable_the_fingerprint_reader_with_ThinkFinger
# which was taken and modified from:
# http://article.gmane.org/gmane.linux.drivers.thinkfinger/329
#

# SGS Thomson Microelectronics Fingerprint Reader
SYSFS{idVendor}=="0483", SYSFS{idProduct}=="2016", SYMLINK+="input/thinkfinger-%k", MODE="0660", GROUP="fingerprint"

# the also-needed uinput device
KERNEL=="uinput", MODE="0660", GROUP="fingerprint"

Finally, edit {{path|/etc/pam.d/gnome-screensaver}} so that it looks like this:
auth sufficient pam_thinkfinger.so
auth required pam_unix.so try_first_pass nullok_secure

Per user:

# Add him to the group: {{cmdroot|gpasswd -a $USERNAME fingerprint}}
# Make him owner of his bir-file: {{cmdroot|chown $USERNAME:root /etc/pam_thinkfinger/$USERNAME.bir}}
# Give him read-only access to his bir-file: {{cmdroot|chmod 400 /etc/pam_thinkfinger/$USERNAME.bir}}
# Give "execute only" access to everyone for the /etc/pam_thinkfinger/ directory: {{cmdroot|chmod o+x /etc/pam_thinkfinger}} (WARNING: this opens up security a little).

== GNOME ==

{{NOTE|1=This problem should be solved if you're using sudo >= 1.6.9p9. Links: [http://savannah.nongnu.org/bugs/?19132], [http://www.sudo.ws/bugs/show_bug.cgi?id=180], [https://bugs.launchpad.net/ubuntu/+source/gksu/+bug/86843]}}

gksu/gksudo doesn't work correctly. It just stays invisible. When starting a su privileged application such as synaptics you will not get prompted for the password. Nevertheless you can swipe your finger and it should authenticate you. Starting synaptics twice makes gksudo visible.

There are two possibilities to solve it:
* Changing the string "Password or swipe finger:" to a plain "Password:" (like sudo normally would do) in the file pam/pam_thinkfinger.c of the thinkfinger source directory. Of course, in the console you will then only see a "Password:" instead of "Password or swipe finger:" but this is still more usefull than having gksu/gksudo crashing everytime.
* Patching libgksu with the following patch. This is also a nasty hack until a better solution is implemented.
<pre>
--- libgksu-2.0.3/libgksu/libgksu.c.orig 2007-06-17 16:00:24.000000000 +0200
+++ libgksu-2.0.3/libgksu/libgksu.c 2007-06-17 16:00:47.000000000 +0200
@@ -2663,7 +2663,7 @@
*/
for (counter = 0; counter < 50; counter++)
{
- if (strncmp (buffer, "GNOME_SUDO_PASS", 15) == 0)
+ if (strncmp (buffer, "GNOME_SUDO_PASS", 15) == 0 || strncmp (buffer, "Password or swi", 15) == 0)
break;

read_line (parent_pipe[0], buffer, 256);
@@ -2675,7 +2675,7 @@
if (context->debug)
fprintf (stderr, "brute force GNOME_SUDO_PASS ended...\n");

- if (strncmp(buffer, "GNOME_SUDO_PASS", 15) == 0)
+ if (strncmp(buffer, "GNOME_SUDO_PASS", 15) == 0 || strncmp(buffer, "Password or swi", 15) == 0)
{
gchar *password = NULL;
gboolean prompt_grab;
</pre>

== KDE ==

Integration in KDE and kdm seems not to be easily possible now. There is a filed [https://bugs.kde.org/show_bug.cgi?id=116682 bug] at kde.org where you can vote for this.

Moreover, kdm in openSUSE 10.3 crashes when pam_thinkfinger is enabled. A possible "workaround" is downgrading to thinkfinger 0.2.2.

Another workaround is to use Fprint from [http://www.reactivated.net/fprint/wiki/Main_Page] which works quite nicely on my X61s and Kubuntu Hardy.

This Howto was copied from [[Installing Ubuntu 6.06 on a ThinkPad T43#Fingerprint_Reader]] and then slightly modified.

User talk:Suvankarc

2008-03-30T09:46:42Z

Whoopie: PLEASE delete this SPAM account

How to get special keys to work

2008-03-29T14:33:03Z

Whoopie: /* Firefox (<3.0) */ remove strange link

==Overview==
The following table gives an overview over the special keys found on ThinkPads and what is needed to make them work.
{| {{prettytable}}
! key !! standard function{{footnote|1}} !! tools supporting key{{footnote|2}} !! configurability{{footnote|3}} !! remarks
|-
| {{key|Fn}} || - || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || on release without completed key combination
|-
| {{key|Fn}}{{key|F1}} || - || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F2}} || lock screen || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || in models from T/X/Z 60 onwards
|-
| {{key|Fn}}{{key|F3}} || blank screen || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F4}} || suspend to ram || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|F5}} || switch bluetooth || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || in models starting from 2002
|-
| {{key|Fn}}{{key|F6}} || - || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F7}} || toggle display || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions || [[Sample Fn-F7 script]]
|-
| {{key|Fn}}{{key|F8}} || toggle trackpoint/touchpad || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions ||
|-
| {{key|Fn}}{{key|F9}} || eject from dock || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F10}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F11}} || - || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F12}} || hibernate || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || brightness up || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|End}} || brightness down || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|PageUp}} || toggle thinklight || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|Space}} || toggle zoom || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{key|Fn}}{{key|Ins}} || - || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]]|| full ||
|-
| {{key|Fn}}{{key|Del}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|Backspace}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|NumLock}} || - || [[#xmodmap configuration|xmodmap]] || make working ||
|-
| {{key|Windows}} || - || [[#xmodmap configuration|xmodmap]] || remapping ||
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || help application || [[thinkpad-acpi]],[[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{ibmkey|Home|#494949}} || open web browser || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Search|#494949}} || open search application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Mail|#494949}} || open mail application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Favorites|#494949}} || open favorites || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Reload|#494949}} || reload web page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Abort|#494949}} || abort loading page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Backward|#494949}} || previous page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Forward|#494949}} || next page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Volume up|#494949}} || volume up || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume down|#494949}} || volume down || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume mute|#494949}} || mute volume || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Play/Pause|#494949}} || start/pause playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Down)
|-
| {{ibmkey|Stop|#494949}} || stop playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Up)
|-
| {{ibmkey|Next|#494949}} || play next || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Right)
|-
| {{ibmkey|Previous|#494949}} || play previous || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Left)
|-
| {{ibmkey|Power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]],[[thinkpad-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| Display lid || blank screen || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| Ultrabay lid || announce ultrabay change || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| Dock eject || eject from dock || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{ibmkey|Tablet power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| {{ibmkey|Tablet orientation|#494949}} || rotates screen || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet shortcut|#494949}} || shortcut menu || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Esc|#494949}} || esc key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Enter|#494949}} || enter key || [[#mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Up|#494949}} || up key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Down|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|}

For completeness, note that the WiFi enable/disable switch is located (on the X61 and other models that have it) just under the front edge of the base of the machine. You should see a small horizontal slider switch. Enable by sliding it rightwards, disable by sliding it leftwards.

==Triggering key events==
===ibm-acpi/thinkpad-acpi events===
Some of the following events require a {{cmdroot|echo enable,0xffff >/proc/acpi/ibm/hotkey}} (when using ibm-acpi) in order to make acpi able to get information on them. Since the newer thinkpad-acpi has a larger number of bits that can be set in the mask, you might try {{cmdroot|echo enable,0xffffffff >/proc/acpi/ibm/hotkey}} if you are using this driver. These events can be used to [[How to configure acpid|configure acpid]].

{| {{prettytable}}
|+ events triggered by [[ibm-acpi]] for {{path|/etc/acpi/events}} files. May vary on different models.
! key !! event
|-
| {{key|Fn}}{{key|F1}} || ibm/hotkey HKEY 00000080 00001001
|-
| {{key|Fn}}{{key|F2}} || ibm/hotkey HKEY 00000080 00001002
|-
| {{key|Fn}}{{key|F3}} || ibm/hotkey HKEY 00000080 00001003
|-
| {{key|Fn}}{{key|F4}} || ibm/hotkey HKEY 00000080 00001004
|-
| {{key|Fn}}{{key|F5}} || ibm/hotkey HKEY 00000080 00001005
|-
| {{key|Fn}}{{key|F6}} || ibm/hotkey HKEY 00000080 00001006
|-
| {{key|Fn}}{{key|F7}} || ibm/hotkey HKEY 00000080 00001007
|-
| {{key|Fn}}{{key|F8}} || ibm/hotkey HKEY 00000080 00001008
|-
| {{key|Fn}}{{key|F9}} || ibm/hotkey HKEY 00000080 00001009
|-
| {{key|Fn}}{{key|F10}} || ibm/hotkey HKEY 00000080 0000100a
|-
| {{key|Fn}}{{key|F11}} || ibm/hotkey HKEY 00000080 0000100b
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c
|-
| {{key|Fn}}{{key|Backspace}} || ibm/hotkey HKEY 00000080 0000100d
|-
| {{key|Fn}}{{key|Ins}} || ibm/hotkey HKEY 00000080 0000100e
|-
| {{key|Fn}}{{key|Del}} || ibm/hotkey HKEY 00000080 0000100f
|-
| {{key|Fn}}{{key|Home}}/{{key|Fn}}{{key|Pos1}} || ibm/hotkey HKEY 00000080 00001010
|-
| {{key|Fn}}{{key|End}} || ibm/hotkey HKEY 00000080 00001011
|-
| {{key|Fn}}{{key|PgUp}} || ibm/hotkey HKEY 00000080 00001012
|-
| {{key|Fn}}{{key|Space}} || ibm/hotkey HKEY 00000080 00001014
|-
| {{ibmkey|Volume up|#494949}}|| ibm/hotkey HKEY 00000080 00001015
|-
| {{ibmkey|Volume down|#494949}} || ibm/hotkey HKEY 00000080 00001016
|-
| {{ibmkey|Volume mute|#494949}} || ibm/hotkey HKEY 00000080 00001017
|-
| Ultrabay eject || ibm/bay MSTR 00000003 00000000
|-
| Ultrabay inserted || ibm/bay MSTR 00000001 00000000
|-
| Dock eject || ibm/dock GDCK 00000003 00000001
|-
| Wireless switch || ibm/hotkey HKEY 00000080 00007000
|}

By disassembling and editing the DSDT, more events can be added. HKEY events are triggered by calls to the MKHQ function, e.g. <tt>\_SB.PCI0.LPC.EC.HKEY.MHKQ(0Ã—1007)</tt> will trigger "ibm/hotkey HKEY 00000080 00001007". Most of these can be found in <tt>_Qxx</tt> methods within the DSDT, which are executed on embedded controller events, e.g. _Q10 is triggered by pressing Fn-F7. You can add a call to MKHQ into an existing <tt>_Qxx</tt> method to get it recognized by ibm-acpi as well as creating new <tt>_Qxx</tt> methods, which if you're lucky will correspond to an EC event that IBM never used (e.g. A 770 will send Fn-Home/End/PgUp/PgDn to ibm-acpi if hacked in this fashion). For example, [http://www.wormnet.eu/ibm-g40/morebuttons.dsl this is a modified block of DSDT for a G40].

=== ACPI events from the <tt>button</tt> module===

A few keys can generate ACPI events that result from the <tt>button</tt> kernel module, as long as they are masked off in the <tt>ibm-acpi</tt>/<tt>thinkpad-acpi</tt> hotkey's mask or the hotkey function of the latter module is disabled.

If you want the ThinkPad's BIOS and ACPI methods to know about these keys being pressed, you probably want to leave them masked out from ibm-acpi, and use their non-HKEY events listed below, instead.

{| {{prettytable}}
|+ events triggered by ACPI when hotkey is masked out or disabled.
! key !! event !! T60 event
|-
| {{ibmkey|Power|#494949}} || button/power PWRF 00000080 xxxxxxxx || button/power PWRF 00000080 00000001
|-
| {{key|Fn}}{{key|F4}} || button/sleep SLPB 00000080 00000001 || button/sleep SLPB 00000080 00000001
|-
| Display lid || button/lid LID 00000080 xxxxxxxx || button/lid LID 00000080 00000001
|}

===tpb configuration===
{| {{prettytable}}
|+ configuration keywords for [[tpb]] (to put in {{path|/etc/tpbrc}})
! key !! config keyword
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || THINKPAD
|-
| {{ibmkey|Home|#494949}} || HOME
|-
| {{ibmkey|Search|#494949}} || SEARCH
|-
| {{ibmkey|Mail|#494949}} || MAIL
|-
| {{ibmkey|Favorites|#494949}} || FAVORITES
|-
| {{ibmkey|Reload|#494949}} || RELOAD
|-
| {{ibmkey|Abort|#494949}} || ABORT
|-
| {{ibmkey|Backward|#494949}} || BACKWARD
|-
| {{ibmkey|Forward|#494949}} || FORWARD
|-
| {{key|Fn}} || FN
|-
| {{key|Fn}}{{key|Space}} || CALLBACK (zoom on/off)
|-
| {{key|Fn}}{{key|PageUp}} || CALLBACK (thinklight on/off)
|-
| {{key|Fn}}{{key|F7}} || CALLBACK (display lcd/crt/both)
|-
| {{key|Fn}}{{key|F8}} || CALLBACK (expand on/off)
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || CALLBACK (brightness <percent>)
|-
| {{key|Fn}}{{key|End}} || CALLBACK (brightness <percent>)
|-
| {{ibmkey|Volume up|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume down|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume mute|#494949}} || CALLBACK (mute on/off)
|}

To all parameter keywords should be assigned the full path to the executables supposed to be started on key press.
The exectable provided for the CALLBACK keyword should take the parameters given in parentheses and act according to them.
If you want to use xmodmap for the HOME, SEARCH, MAIL, FAVORITES, RELOAD, ABORT, BACKWARD, FORWARD and FN keys you should
provide a <tt>XEVENTS OFF</tt> in your {{path|/etc/tpbrc}}.
You can use an appropriate executable to [[How to inject fake keystrokes|inject fake keystrokes]].

For Debian users, tpb is started from {{path|/etc/X11/Xsession.d/90tpb}}.

'''Sound Button configuration'''

''Note: Tested on T60p with Ubuntu 6.06 LTS''

Most Thinkpads have a hardware sound mixer, thus the volumes buttons should work without configuration. However, this change is not reflected in the software mixer. tpb has a switch to enable software mixer support via OSS. The manual recommends this only for devices without a hardware mixer, but it also works for other hadware mixer enabled devices, even with the ALSA system. Just put MIXER ON in your {{path|/etc/tpbrc}} file and you can see the effect immediately in any ALSA mixer (e.g. kmix). For this to work you need write permissions to {{path|/dev/nvram}}.

''Note: Tested on X21 with Ubuntu 6.06 LTS''

On the ThinkPad X21 (and maybe some other older models) ACPI causes problems with tpb. On an X21 using acpi the volume buttons would work occasionally, and the OSD for tpb functions would rarely work. If a volume buttons was pressed too often, sometimes the computer would enter a low power (unplugged state) and would require a reboot. The solution is to use APM instead of ACPI. Instructions can be found in [[How_to_make_APM_work]].

===KMilo configuration===
The programs to be executed by [[KMilo]] are configured via the KDE Control Center (<tt>kcontrol</tt>), under <tt>System Administration --> IBM Thinkpad Laptop</tt>. Note that you can use appropriate commands to [[How to inject fake keystrokes|inject fake keystrokes]].

===xmodmap configuration===
xmodmap enables you to edit the modifier map and keymap tables that are used to translate keycodes into keysyms.
Understood? Well, basically it allows you to give the X server a dictionary for the translation of keycodes like "97" into more human readable synonyms like "Home". This way xmodmap allows you to make the special keys of your keyboard known to X applications.

To discover the keycode that a certain keypress produces, use the tool {{cmduser|xev}}

Usually you should write your keycode-keysym associations into the file {{path|~/.Xmodmap}}. This file is usually read by the X session startup scripts of your system, so that the mappings automatically get included everytime you run the X server.

The {{path|~/.Xmodmap}} lines for our purpose are in the form of
keycode <keycode> = <keysym>

Load the assocation using the command

{{cmduser|xmodmap ~/.Xmodmap}}

(some configurations do this automatically upon X startup).

The following table shows the keycodes generated by the ThinkPad special keys and sensible keysyms to assign them to.
{| {{prettytable}}
|+ keycodes and recommended keysyms
! key !! keycode !! keysym
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || 159 || XF86LaunchA
|-
| {{ibmkey|Backward|#494949}} || 234 || XF86Back or F19
|-
| {{ibmkey|Forward|#494949}} || 233 || XF86Forward or F20
|-
| {{ibmkey|Play/Pause|#494949}} || 162 || XF86AudioPlay
|-
| {{ibmkey|Stop|#494949}} || 164 || XF86AudioStop
|-
| {{ibmkey|Next|#494949}} || 153 || XF86AudioNext
|-
| {{ibmkey|Previous|#494949}} || 144 || XF86AudioPrev
|-

| {{ibmkey|Home|#494949}} || 178 || XF86HomePage
|-
| {{ibmkey|Search|#494949}} || 229 || XF86Search
|-
| {{ibmkey|Mail|#494949}} || 236 || XF86Mail
|-
| {{ibmkey|Favorites|#494949}} || 230 || XF86AddFavorite or XF86Favorites
|-
| {{ibmkey|Reload|#494949}} || 231 || XF86Reload
|-
| {{ibmkey|Abort|#494949}} || 232 || XF86Stop
|-
| {{key|Fn}} || 227 || F35
|}

Note: You can also use xkeycaps (an X tool to display and edit the X keyboard mapping) to generate proper .Xmodmap.

Note: if you are running [[tpb]] you might need to add the line <tt>XEVENTS=off</tt> into your tpbrc to stop it from grabbing the key events and allow them to get through to X instead. See [[http://www.thinkwiki.org/wiki/Tpb]] for more detailed instruction on how to use tpb and xmodmap.

Note: XF86Forward and XF86Back do not work correctly in Firefox. You may want to map them to F19 and F20 instead if you use Firefox.

Note: The "XF86AudioPlay" etc. just works with a few programs. To make it work with more multimedia programs you have map the key to use something like [http://www.kde-apps.org/content/show.php/ReMoot?content=63140 ReMoot]. ReMoot is a command line wrapper that control 18 of the most common multimedia applications.

=====Enabling the Windows and Menu Keys=====
On some systems the Windows and Menu keys may not be recognized. You can enable then by
making the following changes:

keycode 115 = F13
keycode 227 = F35

F13 and F35 are used for the Windows and and Menu keys respectively. Labelling keycpode 227 as "Menu" may conflict with the right-mouse-click event.

=====Using Caps Lock as Super L (Windows key)=====
You can easily use Caps Lock as Win key by adding the following in your ~/.Xmodmap:
! No Caps Lock
clear lock
! Caps Lock as Win key
add mod4 = Caps_Lock
=====NumLock=====
On the ThinkPad {{600}}, {{T20}}, {{T21}}, {{T22}}, {{T30}}, {{X20}}, {{X21}}, {{X31}}, {{X40}}, {{T42p}}, {{T43}}, {{R51}}, {{R52}} and possibly other models, X does not recognize the keycode for {{key|NumLk}} = {{key|Shift}}+{{key|ScrLk}}. To fix this, add the following to {{path|~/.Xmodmap}} in your home directory or {{path|/etc/X11/Xmodmap}} and run <tt>xmodmap</tt>, ex: <tt>xmodmap ~/.Xmodmap</tt>:
keycode 77 = Num_Lock

This configuration also enables the respective LED.

Please note, pressing the {{key|Shift}}+{{key|ScrLk}} key combination, without first following the above configuration, will start an accessibility feature, which will allow the numeric keypad to maneuver the mouse pointer. Starting this accessibility feature and subsequently running xmodmap, as described above, results in the accessibility feature and the numeric lock LED functioning simultaneously. As such, the above configuration should be completed before the accessibility feature is started in order to produce numbers.
======T60 (and possibly others)======
It seems that on the T60, PrtSc, ScrLk and Pause all generate the correct keycodes, however Fn-PrtSc (labelled as SysRq) generates keycode 64 (Alt_L) followed by the expected 111 (Sys_Req) on down and the same thing in the opposite order on release. Fn-ScrLk (labelled as NmLk) does indeed toggle the Numlock, but only seems to register as an X event the first time it is engaged. The above solution does not appear to work. This is perhaps because the Numlock toggle is built into the firmware rather than controlled by the kernel. Finally, Fn-Pause (labelled as Break) generates keycode 37 (Control_L) followed by the expected keycode 110 (Break) on down and the same thing in reverse order on release.

===Mapping keys with setkeycodes===
You can use the setkeycodes command to remap certain keys. I.e. you can use {{cmdroot|setkeycodes 6e 109 6d 104 69 28 6b 1}} to map the Tablets Up and Down keys to the standard PageUp and PageDown keys and Tablet Escape and Enter to their respective keys.

The following table shows the keycodes generated by the ThinkPad keys.
{| {{prettytable}}
|+ keycodes
! key !! keycode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x6e
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x68
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6c
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || 0x67
|}

===acpi_fakekey===
You can turn acpi events into user-level xevents by putting <tt>acpi_fakekey</tt> commands into the acpi action scripts. There are several layers involved in using acpi keys in this way, so I'll go through the example of using the ThinkVantage button to open xmms.

My ThinkVantage button generates an '''acpi event''' "ibm/hotkey HKEY 00000080 00001018", so we have the event file <tt>/etc/acpi/events/ThinkVantage</tt> for it which executes the script <tt>/etc/acpi/actions/fakekey-macro.sh</tt>.
<pre>
event=ibm/hotkey HKEY 00000080 00001018
action=/etc/acpi/actions/fakekey-macro.sh
</pre>
In turn, the executable <tt>/etc/acpi/actions/fakekey-macro.sh</tt> script calls acpi_fakekey with the '''key number''' defined in <tt>/usr/share/acpi-support/key-constants</tt> as $KEY_MACRO which is 112 (you could just as well choose an other key number, just make sure that it doesn't belong to something else like the "j" key or something).
<pre>
#!/bin/sh
. /usr/share/acpi-support/key-constants
acpi_fakekey $KEY_MACRO
</pre>
I have no idea how this actually corresponds to which xevent is generated, so I can find out out by running the program <tt>xev</tt> and hitting the ThinkVantage button while the mouse is in the <tt>xev</tt> window (remember to <tt>/etc/init.d/acpid restart</tt> first if you just created the <tt>/etc/acpi/events/ThinkVantage</tt> file). I get something popping up in the terminal where I ran xev that looks like this:
<pre>
KeyPress event, serial 30, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2000522842, (138,83), root:(781,500),
state 0x0, keycode 239 (keysym 0x0, NoSymbol), same_screen YES,
XLookupString gives 0 bytes:
XmbLookupString gives 0 bytes:
XFilterEvent returns: False

KeyRelease event, serial 30, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2000522842, (138,83), root:(781,500),
state 0x0, keycode 239 (keysym 0x0, NoSymbol), same_screen YES,
XLookupString gives 0 bytes:
XFilterEvent returns: False
</pre>
This tells me that the <tt>acpi_fakekey 112</tt> as executed by hitting the ThinkVantage button generates KeyPress event followed by a KeyRelease event with '''keycode''' 239 and that this keycode has been assigned no corresponding '''keysym'''. Thus, I am free to assign the keycode to any keysym I want. You can find a list of available keysyms in <tt>/usr/share/X11/XKeysymDB</tt>. Again try and pick one that is not likely to have already been taken by something, such as <tt>XF86LaunchA</tt>. To assign this keysym to keycode 239, you can either edit ~/.Xmodmap on an individual user basis, or edit the systemwide <tt>/etc/X11/Xmodmap</tt> file to contain the line
<pre>
keycode 239 = XF86LaunchA
</pre>
If you choose to go with the former, you may need to run <tt>xmodmap ~/.Xmodmap</tt> for every login session in order to read in your ~/.Xmodmap file if your window manager does not do it for you. Regardless of which option you choose, you can run <tt>xmodmap <file></tt> to read in the updated Xmodmap file without logging out and logging back in.

You should now find that hitting the ThinkVantage button creates the following output from <tt>xev</tt>:
<pre>
KeyPress event, serial 55, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2001286078, (0,106), root:(643,523),
state 0x0, keycode 239 (keysym 0x1008ff4a, XF86LaunchA), same_screen YES,
XLookupString gives 0 bytes:
XmbLookupString gives 0 bytes:
XFilterEvent returns: False

KeyRelease event, serial 55, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2001286078, (0,106), root:(643,523),
state 0x0, keycode 239 (keysym 0x1008ff4a, XF86LaunchA), same_screen YES,
XLookupString gives 0 bytes:
XFilterEvent returns: False
</pre>
Note the change of <tt>(keysym 0x0, NoSymbol)</tt> to <tt>(keysym 0x1008ff4a, XF86LaunchA)</tt>.

You're now ready to map <tt>XF86LaunchA</tt> to executing xmms. This is highly dependent on what keygrabber you decide to use. For openbox, I edit my <tt>~/.config/openbox/rc.xml</tt> file and add the following entry in the <keyboard> section:
<pre>
<keybind key="XF86LaunchA">
<action name="Execute">
<startupnotify>
<enabled>true</enabled>
</startupnotify>
<command>
xmms
</command>
</action>
</keybind>
</pre>
After, right clicking on the desktop and selecting the "Reconfigure" menu option, you should then have xmms pop up when you hit the ThinkVantage key.

==Example Applications==
===Web Browsers===
====Firefox (<3.0)====

There are various ways to assign actions to the browser keys. The easiest way is to install [http://mozilla.dorando.at/keyconfig.xpi keyconfig.xpi] from http://mozilla.dorando.at, which adds a menu entry Tools->Keyconfig. Then you can assign any action you want to the F19/F20 keys (you still need to create {{path|~/.Xmodmap}} as explained above).

The remaining discussion gives you various more complicated ways to achieve the same thing.
To have firefox make use of the browser keys you need to modify one of its files{{footnote|4}}.
To do this you will first need to extract it from the {{path|browser.jar}} archive. Do...

Step 1: Edit .Xmodmap and add entries for F19 and F20 as explained above.

Step 2:

Note: <firefox-directory> is probably /usr/lib/firefox.

:{{cmdroot|cd <firefox-directory>/chrome}} 
:{{cmdroot|unzip browser.jar}}

The file of interest is {{path|content/browser/browser.xul}}. Edit it {and don't forget to make a backup copy first}...
:{{cmdroot|vi content/browser/browser.xul}}

Look for the '''<keyset id="mainKeyset">''' section and add the following lines within...
<key id="goBackKb" keycode="VK_F19" command="Browser:Back" />
<key id="goForwardKb" keycode="VK_F20" command="Browser:Forward" />

The Command you need for Next Tab
<key id="goBackTabKb" keycode="VK_F19" oncommand="gBrowser.mTabContainer.advanceSelectedTab(-1)" />
For the Previous Tab
<key id="goForwardTabKb" keycode="VK_F20" oncommand="gBrowser.mTabContainer.advanceSelectedTab(1)" />

Now save the file and repackage the {{path|browser.jar}} archive...
:{{cmdroot|zip -rD0 browser.jar content/browser/}}

That's it.

Step 3: Restart Firefox.

{{HINT|Outdated: Another interesting Page on Firefox is http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ It uses different key mappings (F19 resp. F20) but a ready [http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/dqdnavkeys-1.2.xpi .xpi] is provided which is pretty comfortable. However, this xpi file does not install on Firefox 1.5. or later.}}

{{HINT| You can also use the [http://extensionroom.mozdev.org/more-info/keyconfig keyconfig] extension to configure custom keys. This extension works with Firefox 1.5 and also with Firefox 2.0. The Command you need for Next Tab is gBrowser.mTabContainer.advanceSelectedTab(1,true); For Previous Tab its gBrowser.mTabContainer.advanceSelectedTab(-1,true); You can alternatively install the [http://www.pqrs.org/~tekezo/firefox/extensions/functions_for_keyconfig/index.html functions for keyconfig] and set the variable f4kc_NextTab to F20 and f4kc_PrevTab to F19.}}.

====Firefox 3.0====
Thankfully the people at Mozilla decided to include the expected functionality for the XF86Back and XF86Forward keysyms in the new release so all you need to do is
 <code># printf 'keycode 234 = XF86Back\nkeycode 233 = XF86Forward' >> /etc/X11/Xmodmap</code> 
And to make this take effect immediately (i.e., without having to log out and log in again), as a regular user run:
 <code>{{cmduser|Xmodmap /etc/X11/Xmodmap}}</code>
====Konqueror====
KDE allows you set key mappings for KDE applications (Go to KMenu > System > Control Center > Regional & Accessibility > Keyboard Shortcuts). By default (at least in KDE 3.5), XF86Back and XF86Forward are set as alternatives to Alt-Left and Alt-Right, and are mapped to KDE Back and Forward navigation actions.

If you use Konqueror as your only browser, you only need to set up {{path|~/.Xmodmap}} as described [[#xmodmap configuration|above]] to assign ThinkPad back/forward keys to the symbols XF86Back/XF86Forward. This also make these keys work for other KDE applications such as Quanta Plus, KPackage and so on (not all KDE applications honor this setting, e.g. KDE help system doesn't).

If you want to use Firefox, however, the above settings do not work. You will have to map ThinkPad back/forward keys to F19/F20 as described [[#Firefox|above]], and change KDE navigation key settings to use F19/F20 instead of the default.

====Opera====
However this isn't a simple configration file, you can set your browser manually. 
Go to Tool > Settings > Mouse and keyboard > Keyboard settings > Edit > Browser Window. There add F19 - Back and F20 - Forward. Now you can surf using your TP keys ;-)

===Open an application===

To configure the ThinkVantage button to open a terminal window in Gnome:

Step 1:
Use xev to find the keycode generated by the button on your machine. In my case is is 159.

Step 2:
Create an entry in .Xmodmap like so

keycode 159 = XF86LaunchA

replacing 159 by the keycode found in step 1. Load the map using

:{{cmd|xmodmap ~/.Xmodmap}}

Step 3:
Configure the required function (e.g. open terminal window) in System->Preferences->Keyboard shortcuts

===Window Managers===
====fvwm====
To get the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fvwmrc}}:
Key XF86Back A A Scroll -100000 0
Key XF86Forward A A Scroll +100000 0
If you use multiple virtual desktops, you could instead use the keys to flip between them by using GotoDesk.

====fluxbox====
To get the keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fluxbox/keys}}:
None F19 :PrevWorkspace
None F20 :NextWorkspace

====pekwm configuration====
You can make the two browser keys switch workspaces in pekwm, by adding the following two lines to the {{path|~/.pekwm/keys}} file:
KeyPress = "Mod1 XF86Back" { Actions = "GoToWorkspace prev" }
KeyPress = "Mod1 XF86Forward" { Actions = "GoToWorkspace next" }

====pwm====
Another example how to use these two keys to switch between pwm tabs. These two lines should be added to {{path|~/.pwm/keys-default.conf}} or {{path|/etc/pwm/keys-default.conf}}:
kbind "Back", "switch_rot", -1
kbind "Forward", "switch_rot", 1

====IceWM====
To make IceWM cycle workspaces using the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys, change these two options in {{path|~/.icewm/preferences}} (Provided you assigned keysyms F19 and F20 with xmodmap):
# "Previous workspace" shortcut
KeySysWorkspacePrev="F19"
# "Next workspace" shortcut
KeySysWorkspaceNext="F20"

==== Gnome/metacity ====

Follow the [https://wiki.ubuntu.com/Keybindings Ubuntu guide].

===Other Uses===
====Console tools configuraton====
To make the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys useful in console, add this to your keymap ({{path|/etc/console/boottime.kmap.gz}} in {{Debian}}):
keycode 158 = Decr_Console
keycode 159 = Incr_Console

Alternatively you can load this script (perhaps on system startup) to enable Backward/Forward button console (VT) switch:

#!/bin/sh
echo keycode 158 = Decr_Console | loadkeys
echo keycode 159 = Incr_Console | loadkeys

It should work with any distro.

====Cycling through tabs====
In Gnome and Xfce4, Ctrl-PageUp/Ctrl-PageDown move to the previous/following open tab in all applications that have tabbed user interfaces (terminal emulator, web browser, ...). To make use of the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys for this task, there're two possibilities.

For both ways, you should map the keycodes 233 and 234 to XF86Back and XF86Forward as described in [[#xmodmap_configuration|xmodmap configuration]].

=====Using xautomation=====
xautomation can be found [http://hoopajoo.net/projects/xautomation.html here].

Create two files with permissions 755:

{{path|/usr/local/bin/tp_back}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Up' 'keyup Page_Up' 'keyup Control_L'
</bash>

{{path|/usr/local/bin/tp_forward}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Down' 'keyup Page_Down' 'keyup Control_L'
</bash>

Use your desktop's keyboard shortcut editor to assign XF86Back as a shortcut for tp_back and XF86Forward as a shortcut for tp_forward.

This should work in all distros and with all window managers (you might have to use other key combinations than Ctrl-PageUp and Ctrl-PageDown).

=====Redirecting XF86Back/XF86Forward=====
Create {{path|/etc/X11/xkb/compat/thinkpad}}:
<pre>
// $XFree86$
// XFree86 special keysyms
default partial xkb_compatibility "basic" {
interpret.repeat= True;

interpret XF86Back {
action = Redirect(Key=<PGUP>, modifiers=Control);
};
interpret XF86Forward {
action = Redirect(Key=<PGDN>, modifiers=Control);
};
};
</pre>

Edit {{path|/etc/X11/xkb/compat/complete}} and add <tt>'''augment "thinkpad"'''</tt> so that it looks similar to the following:
<pre>
// $XKeyboardConfig: xkbdesc/compat/complete,v 1.3 2005/10/17 00:42:11 svu Exp $
// $Xorg: complete,v 1.3 2000/08/17 19:54:34 cpqbld Exp $
default xkb_compatibility "complete" {
include "basic"
augment "iso9995"
augment "mousekeys"
augment "accessx(full)"
augment "misc"
augment "xfree86"
augment "level5"
augment "thinkpad"
};
</pre>

==External Sources==
*[http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-51537 IBMs page on configuring the ThinkPad buttons (ThinkPad, Access IBM, Mail, Search, and Home buttons) under Linux]
*[http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ Rob Mayoffs page on using IBM Keyboard Navigation Keys in Linux Mozilla and Firefox]
*[http://snarfed.org/space/thinkpad+keys+in+firefox Ryan Barretts blog article about using the browser keys in Firefox]
*[http://chaotika.org/~bluesceada/?page=soft&sub=thinkpad#acpibutn DennisG's help to get the ibm-acpi buttons do useful things] on a {{Z61e}} and possibly {{Z61m}}, {{Z61t}} and {{Z61p}}

{{footnotes|
#Note that the associated functionality for Fn-F* key combinations is not consistent amongst all ThinkPads. We are maintaining [[Default meanings of special keys|a table of associated meanings]].
#if there are more than one tool listed, one is sufficient
#'full' means you can completely reassign any action to be triggered by the key, 'additional actions' means you can trigger actions in addition to the standard function of the key, which can not be changed.
#Thanks go to Ryan Barrett for writing the [http://snarfed.org/space/thinkpad+keys+in+firefox little howto] on [http://snarfed.org/space/start his blog].
}}

Tp smapi

2008-01-14T06:35:56Z

Whoopie: /* Model-specific status */ add R52 EC version

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
The <tt>tp_smapi</tt> kernel module exposes some features of the ThinkPad hardware/firmware via a <tt>sysfs</tt> interface. Currently, the main implemented functionality is control of battery charging and extended battery status. It also includes an improved version of the [[HDAPS]] driver. The underlying hardware interfaces are [[SMAPI support for Linux|SMAPI]] and direct access to the embedded controller.

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

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

===Features===
*Battery charge/discharge control
*Battery status information

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

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

:{{cmdroot|tar xzvf tp_smapi-0.34.tgz}}
:{{cmdroot|cd tp_smapi-0.34}}

Then, either compile and load the driver within the current working directory (for testing):
:{{cmdroot|make load}}
OR 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).
Again, either load the driver within the current working directory:
:{{cmdroot|1=make load HDAPS=1}}
OR 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 unstable (sid) or testing (lenny)====
Debian now contains the [http://packages.debian.org/tp-smapi packaged module source] for use with module-assistant.

* {{cmdroot|apt-get install tp-smapi}}
* {{cmdroot|m-a -t a-i tp-smapi}}

====Installation on Ubuntu/Debian====
Installation on Ubuntu or Debian is quite easy, but there are a few things to look after:

To get your system ready for compiling code, install the build-essentials (as root, of course, as all of the following comands; Ubuntu users have to prepend 'sudo' to every line and enter their own password when prompted):
<pre><nowiki>apt-get install build-essential</nowiki></pre>

To get tp_smapi to work, obtain the latest source as mentioned above and unpack it. If you want to use HDAPS, you need to install the kernel source matching te kernel you are running. To do so, issue this:
<pre><nowiki>uname -r</nowiki></pre>
This will give you the version of your current kernel. As Ubuntu adds '-generic' to the kernel-version, the following command works for Debian users only:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users use the kernel-version they got by the command before, e.g. 'linux-source-2.6.20'

Now change to the tp_smapi dir:
<pre><nowiki>cd tp_smapi-X.YY</nowiki></pre> (X.YY being the version-number of [[tp_smapi]])
and make and install tp_smapi as instructed above.

If you get an error that the kernel version isn't matching (or that you need to set KSRC/KBUILD), please check that there is a symlink from the modules dir to the kernel source:
<pre><nowiki>root@localhost:~#ls -l /lib/modules/2.6.20-16-generic
lrwxrwxrwx 1 root root 28 2007-02-02 08:39 source -> /usr/src/linux-source-2.6.20</nowiki></pre>
Create the link if the line above is not existent:
<pre><nowiki>root@localhost:~#ln -s /usr/src/linux-source-2.6.20 /lib/modules/2.6.20-16-generic/source</nowiki></pre>

Now the following will build and install the correct modules to their locations:
<pre><nowiki>make install HDAPS=1</nowiki></pre>
To make sure your system loads the modules at boot time, do this:
<pre><nowiki>echo "tp_smapi" >> /etc/modules
echo "hdaps" >> /etc/modules</nowiki></pre>
and update your initramfs:
<pre><nowiki>update-initramfs -u</nowiki></pre>

To get tp_smapi running now, just load the modules:
<pre><nowiki>modprobe -a tp_smapi hdaps</nowiki></pre>

This description was tested on Kubuntu 'Feisty Fawn' and should work on all Debian-based distros with minor tweaks.

'''EDIT:''' Works on Kubuntu 7.10 ("Gutsy Gibbon"), too

===Battery charge control 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 prevent charging for 17 minutes (regardless of thresholds):
:{{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 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 charging preventation:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}

To force battery discharging (even if connected to AC):
:{{cmdroot|echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge}}
{{HINT|This can be used to choose which battery is discharged when [[How to use UltraBay batteries|using an UltraBay battery]].}}

To cancel forced discharge:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}}

===Battery status features===
To view extended battery status such as charging state, voltage, current, capacity, cycle count and model information:

<pre>
# cat /sys/devices/platform/smapi/BAT0/installed
# cat /sys/devices/platform/smapi/BAT0/state # idle/charging/discharging
# cat /sys/devices/platform/smapi/BAT0/cycle_count
# cat /sys/devices/platform/smapi/BAT0/current_now # instantaneous current
# cat /sys/devices/platform/smapi/BAT0/current_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/power_now # instantaneous power
# cat /sys/devices/platform/smapi/BAT0/power_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/last_full_capacity
# cat /sys/devices/platform/smapi/BAT0/remaining_percent
# cat /sys/devices/platform/smapi/BAT0/remaining_running_time
# cat /sys/devices/platform/smapi/BAT0/remaining_charging_time
# cat /sys/devices/platform/smapi/BAT0/remaining_capacity
# cat /sys/devices/platform/smapi/BAT0/design_capacity
# cat /sys/devices/platform/smapi/BAT0/voltage
# cat /sys/devices/platform/smapi/BAT0/design_voltage
# cat /sys/devices/platform/smapi/BAT0/manufacturer
# cat /sys/devices/platform/smapi/BAT0/model
# cat /sys/devices/platform/smapi/BAT0/barcoding
# cat /sys/devices/platform/smapi/BAT0/chemistry
# cat /sys/devices/platform/smapi/BAT0/serial
# cat /sys/devices/platform/smapi/BAT0/manufacture_date
# cat /sys/devices/platform/smapi/BAT0/first_use_date
# cat /sys/devices/platform/smapi/BAT0/temperature # in milli-Celsius
# cat /sys/devices/platform/smapi/ac_connected
</pre>

The raw status data is also available, including some fields not listed above (in case you can figure them out):

:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/dump}}

In all of the above, replace <tt>BAT0</tt> with <tt>BAT1</tt> to address the 2nd battery.

Note that the battery status readout conflicts with the stock [[HDAPS|hdaps]] driver, so if you use <tt>hdaps</tt> you will need to load <tt>tp_smapi</tt> using {{cmdroot|1=make load HDAPS=1}} (see [[#Bundled hdaps driver|Bundled hdaps driver]] 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]].

====Scripts====
Some scripts can make it easier to grep the information you need from tp_smapi
* [[battery.rb]]

===Other features===

There is also [[sysfs]] attribute for making direct SMAPI requests to the SM BIOS firmware. Don't touch it unless you really know what you're doing. Example:
# echo '211a 100 0 0' > /sys/devices/platform/smapi/smapi_request; cat /sys/devices/platform/smapi/smapi_request
211a 34b b2 0 0 0 'OK'
The "4b" in the 2nd value, converted to decimal, is 75: the current charging stop threshold (stop_charge_thresh).

===Bundled <tt>hdaps</tt> driver===

The tp_smapi package includes a modified version of the <tt>hdaps</tt> Linux kernel driver used by the [[HDAPS]] system. To use <tt>tp_smapi</tt> and <tt>hdaps</tt> concurrently, you '''must''' use the modified version.

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

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

The modified <tt>hdaps</tt> has several changes:
* The <tt>hdaps</tt> driver in mainline kernels conflicts with the extended battery status (they use the same IO ports). The modified <tt>hdaps</tt> coordinates this access through the bundled <tt>thinkpad_ec</tt> driver.
* The modified <tt>hdaps</tt> driver fixes reliability and improves support for recent ThinkPad models (*60 and newer), since unlike the mainline driver, it correctly follows the Embedded Controller communication protocol.
* Several other improvements, such as the ability to control the polling rate.

===Troubleshooting===

If you get "<tt>thinkpad_ec: no ThinkPad embedded controller!</tt>" when trying to load the module on a supported model listed below, you should [[BIOS_Upgrade|upgrade your BIOS]]. Some early BIOS (like 1.x on the X31) don't handle the embedded controller.

===Model-specific status===

<div style="font-size: 92%">
{| border="1" cellspacing="0" cellpadding="2"
|+<tt>tp_smapi</tt> feature support matrix
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====A series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{A22p}} 2629-USG
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{A30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====G series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{G41}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |
=====R series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{R31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || || No SMAPI BIOS
|-
! {{R40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R50}}
| {{Cunk}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R50e}} 1834-JAG
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{R51}} 18*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || 3.22 || || Machine types 1829, 1830, 1831 and 1836
|-
! {{R51}} 28*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || 1.29 || || Machine types 2883, 2887, 2888, 2889, 2894 and 2495
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.29 || 1.06 ||
|-
! {{R60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cno|text=}} 1 || 0.33 || || ||
|-

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

=====T series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T23}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T40p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T41}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T41p}} 2373-AM9
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.20 || v3.04 ||
|-
! {{T42}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T42p}} 2373-KXU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || 3.21 || || Stop charge threshold works in Windows, but dmesg says "__get_real_thresh: cannot get stop_thresh of bat=0: Function is not supported by SMAPI BIOS".
|-
! {{T42p}} 2373-KUU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{T43}} 2686
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.33 || 1.27 || ||
|-
! {{T43p}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes|text=}} 0 || || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.32 || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.34 || || ||
|-
! {{T60p}} 8743-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 1 || 0.32 || || ||
|-
! {{T61}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T61p}} 6457-7XG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 1 || 0.32 || || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====X series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{X20}} 2662-31G
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{X24}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{X30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.34 || 1.09 || ||
|-
! {{X31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{X32}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{X40}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || 2.08 || 1.62 ||
|-
! {{X41}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.32 || || ||
|-
! {{X41_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} (see ref) || 0.32 || || [http://sourceforge.net/mailarchive/message.php?msg_name=4757BD30.8080808%40ugcs.caltech.edu ref] || ||
|-
! {{X60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || || 2.07 || 1.10 || 2.6.20 issue (see discussion)
|-
! {{X60s}} 1704-5UG
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cno|text=}} 3 || 0.34 || 7BETD2WW 2.13 || 7BHT40WW 1.13 ||
|-
! {{X61s}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 / 3 || 0.32 || || || [http://www.slackwiki.org/ThinkPad_X61s ref] says 3 but conflicting report received
|-
! {{X60_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} 3 || || || || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref] {{HELP|Unknown [[List_of_DMI_IDs|DMI ID]].}}
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.32 || || || {{HELP|Unknown [[List_of_DMI_IDs|DMI ID]].}}
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====Z series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{Z60m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || || ||
|-
! {{Z61m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} 0 || 0.32 || || ||
|-
! {{Z61t}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || || [https://bugs.launchpad.net/ubuntu/+source/linux-source-2.6.20/+bug/45014 ref]
|-
! {{Z61p}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || ||
|}
</div>

SMAPI capabilities may depend on the BIOS version as well, so upgrading to the latest version of the BIOS might provide more SMAPI functions (especially true for long-lived BIOS with lots of releases, like the TP-1R).

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

=====HDAPS axis orientation=====
1 The HDAPS axis orientation is set using the <tt>invert</tt> module parameter (at load time) or sysfs attribute (at runtime). The tp_smapi's hdaps driver supports all 8 possible sensor orientations (inversion and swapping). You can use [[HDAPS#Visualisation_of_ThinkPad_orientation|hdaps visualisation]] to check if the settings is correct.

<tt>invert</tt> is an integer between 0 and 7, whose meaning is as follows. Let <tt>X</tt> and <tt>Y</tt> denote the hardware readouts. Let <tt>R</tt> denote the laptop's roll (tilt left/right), and let <tt>P</tt> denote the laptop's pitch (tilt forward/backward). The possible values are as follows:
invert=0: R= X P= Y (same as mainline)
invert=1: R=-X P=-Y (same as mainline)
invert=2: R=-X P= Y (new)
invert=3: R= X P=-Y (new)
invert=4: R= Y P= X (new)
invert=5: R=-Y P=-X (new)
invert=6: R=-Y P= X (new)
invert=7: R= Y P=-X (new)

[[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
* {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module.

HDAPS

2007-12-31T12:17:59Z

Whoopie: /* Kernel patch */ add the link to the errorcheck-fix patch

Tp smapi

2007-12-22T22:02:32Z

Whoopie: /* Model-specific status */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
The <tt>tp_smapi</tt> kernel module exposes some features of the ThinkPad hardware/firmware via a <tt>sysfs</tt> interface. Currently, the main implemented functionality is control of battery charging and extended battery status. It also includes an improved version of the [[HDAPS]] driver. The underlying hardware interfaces are [[SMAPI support for Linux|SMAPI]] and direct access to the embedded controller.

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

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

===Features===
*Battery charge/discharge control
*Battery status information

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

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

:{{cmdroot|tar xzvf tp_smapi-0.33.tgz}}
:{{cmdroot|cd tp_smapi-0.33}}

Then, either compile and load the driver within the current working directory (for testing):
:{{cmdroot|make load}}
OR 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).
Again, either load the driver within the current working directory:
:{{cmdroot|1=make load HDAPS=1}}
OR 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 Ubuntu/Debian====
Installation on Ubuntu or Debian is quite easy, but there are a few things to look after:

To get your system ready for compiling code, install the build-essentials (as root, of course, as all of the following comands; Ubuntu users have to prepend 'sudo' to every line and enter their own password when prompted):
<pre><nowiki>apt-get install build-essential</nowiki></pre>

To get tp_smapi to work, obtain the latest source as mentioned above and unpack it. If you want to use HDAPS, you need to install the kernel source matching te kernel you are running. To do so, issue this:
<pre><nowiki>uname -r</nowiki></pre>
This will give you the version of your current kernel. As Ubuntu adds '-generic' to the kernel-version, the following command works for Debian users only:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users use the kernel-version they got by the command before, e.g. 'linux-source-2.6.20'

Now change to the tp_smapi dir:
<pre><nowiki>cd tp_smapi-X.YY</nowiki></pre> (X.YY being the version-number of [[tp_smapi]])
and make and install tp_smapi as instructed above.

If you get an error that the kernel version isn't matching (or that you need to set KSRC/KBUILD), please check that there is a symlink from the modules dir to the kernel source:
<pre><nowiki>root@localhost:~#ls -l /lib/modules/2.6.20-16-generic
lrwxrwxrwx 1 root root 28 2007-02-02 08:39 source -> /usr/src/linux-source-2.6.20</nowiki></pre>
Create the link if the line above is not existent:
<pre><nowiki>root@localhost:~#ln -s /usr/src/linux-source-2.6.20 /lib/modules/2.6.20-16-generic/source</nowiki></pre>

Now the following will build and install the correct modules to their locations:
<pre><nowiki>make install HDAPS=1</nowiki></pre>
To make sure your system loads the modules at boot time, do this:
<pre><nowiki>echo "tp_smapi" >> /etc/modules
echo "hdaps" >> /etc/modules</nowiki></pre>
and update your initramfs:
<pre><nowiki>update-initramfs -u</nowiki></pre>

To get tp_smapi running now, just load the modules:
<pre><nowiki>modprobe -a tp_smapi hdaps</nowiki></pre>

This description was tested on Kubuntu 'Feisty Fawn' and should work on all Debian-based distros with minor tweaks.

'''EDIT:''' Works on Kubuntu 7.10 ("Gutsy Gibbon"), too

===Battery charge control 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 prevent charging for 17 minutes (regardless of thresholds):
:{{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 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 charging preventation:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}

To force battery discharging (even if connected to AC):
:{{cmdroot|echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge}}
{{HINT|This can be used to choose which battery is discharged when [[How to use UltraBay batteries|using an UltraBay battery]].}}

To cancel forced discharge:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}}

===Battery status features===
To view extended battery status such as charging state, voltage, current, capacity, cycle count and model information:

<pre>
# cat /sys/devices/platform/smapi/BAT0/installed
# cat /sys/devices/platform/smapi/BAT0/state # idle/charging/discharging
# cat /sys/devices/platform/smapi/BAT0/cycle_count
# cat /sys/devices/platform/smapi/BAT0/current_now # instantaneous current
# cat /sys/devices/platform/smapi/BAT0/current_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/power_now # instantaneous power
# cat /sys/devices/platform/smapi/BAT0/power_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/last_full_capacity
# cat /sys/devices/platform/smapi/BAT0/remaining_percent
# cat /sys/devices/platform/smapi/BAT0/remaining_running_time
# cat /sys/devices/platform/smapi/BAT0/remaining_charging_time
# cat /sys/devices/platform/smapi/BAT0/remaining_capacity
# cat /sys/devices/platform/smapi/BAT0/design_capacity
# cat /sys/devices/platform/smapi/BAT0/voltage
# cat /sys/devices/platform/smapi/BAT0/design_voltage
# cat /sys/devices/platform/smapi/BAT0/manufacturer
# cat /sys/devices/platform/smapi/BAT0/model
# cat /sys/devices/platform/smapi/BAT0/barcoding
# cat /sys/devices/platform/smapi/BAT0/chemistry
# cat /sys/devices/platform/smapi/BAT0/serial
# cat /sys/devices/platform/smapi/BAT0/manufacture_date
# cat /sys/devices/platform/smapi/BAT0/first_use_date
# cat /sys/devices/platform/smapi/BAT0/temperature # in milli-Celsius
# cat /sys/devices/platform/smapi/ac_connected
</pre>

The raw status data is also available, including some fields not listed above (in case you can figure them out):

:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/dump}}

In all of the above, replace <tt>BAT0</tt> with <tt>BAT1</tt> to address the 2nd battery.

Note that the battery status readout conflicts with the stock [[HDAPS|hdaps]] driver, so if you use <tt>hdaps</tt> you will need to load <tt>tp_smapi</tt> using {{cmdroot|1=make load HDAPS=1}} (see [[#Bundled hdaps driver|Bundled hdaps driver]] below).

On [[ACPI]]-enabled systems, most of above information is also available through the files under {{path|/proc/acpi/battery}}. However, the ACPI interface does not include the instantaneous power and cycle count readouts, and does not work well when [[How to use UltraBay batteries|hotswapping UltraBay batteries]].

===Other features===

There is also [[sysfs]] attribute for making direct SMAPI requests to the SM BIOS firmware. Don't touch it unless you really know what you're doing. Example:
# echo '211a 100 0 0' > /sys/devices/platform/smapi/smapi_request; cat /sys/devices/platform/smapi/smapi_request
211a 34b b2 0 0 0 'OK'
The "4b" in the 2nd value, converted to decimal, is 75: the current charging stop threshold (stop_charge_thresh).

===Bundled <tt>hdaps</tt> driver===

The tp_smapi package includes a modified version of the <tt>hdaps</tt> Linux kernel driver used by the [[HDAPS]] system. To use <tt>tp_smapi</tt> and <tt>hdaps</tt> concurrently, you '''must''' use the modified version.

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

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

The modified <tt>hdaps</tt> has several changes:
* The <tt>hdaps</tt> driver in mainline kernels conflicts with the extended battery status (they use the same IO ports). The modified <tt>hdaps</tt> coordinates this access through the bundled <tt>thinkpad_ec</tt> driver.
* The modified <tt>hdaps</tt> driver fixes reliability and improves support for recent ThinkPad models (*60 and newer), since unlike the mainline driver, it correctly follows the Embedded Controller communication protocol.
* Several other improvements, such as the ability to control the polling rate.

===Troubleshooting===

If you get "<tt>thinkpad_ec: no ThinkPad embedded controller!</tt>" when trying to load the module on a supported model listed below, you should [[BIOS_Upgrade|upgrade your BIOS]]. Some early BIOS (like 1.x on the X31) don't handle the embedded controller.

===Model-specific status===

<div style="font-size: 92%">
{| border="1" cellspacing="0" cellpadding="2"
|+<tt>tp_smapi</tt> feature support matrix
|-
! colspan=11 style="text-align:center;background:#efefef;" |
=====A series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{A22p}} 2629-USG
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{A30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! colspan=11 style="text-align:center;background:#efefef;" |
=====G series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{G41}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! colspan=11 style="text-align:center;background:#efefef;" |
=====R series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{R31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || No SMAPI BIOS
|-
! {{R40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R50}}
| {{Cunk}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R50e}} 1834-JAG
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R51}} 18*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y || 0.32 || 3.22 || Machine types 1829, 1830, 1831 and 1836
|-
! {{R51}} 28*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || 1.29 || Machine types 2883, 2887, 2888, 2889, 2894 and 2495
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y (invert=0) || 0.33 || 1.29 ||
|-
! {{R60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cunk}} || || ||
|-

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

=====T series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T23}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T40p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T41}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T41p}} 2373-AM9
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=-X, P=-Y || 0.32 || 3.20 || EC v3.04
|-
! {{T42}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T42p}} 2373-KXU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=-X, P=-Y || 0.32 || 3.21 || Stop charge threshold works in Windows, but dmesg says "__get_real_thresh: cannot get stop_thresh of bat=0: Function is not supported by SMAPI BIOS".
|-
! {{T42p}} 2373-KUU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T43}} 2686
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y (invert=0) || 0.33 || 1.27 ||
|-
! {{T43p}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes|text=}} R=X, P=Y || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=Y, P=-X || 0.32 || ||
|-
! {{T60p}} 8743-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=-X, P=-Y || 0.32 || ||
|-
! {{T61}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=-X, P=-Y || 0.32 || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T61p}} 6457-7XG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=-X, P=-Y || 0.32 || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! colspan=11 style="text-align:center;background:#efefef;" |

=====X series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{X20}} 2662-31G
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X24}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X30}}
| {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X32}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X40}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=X, P=-Y || 0.32 || 2.08 || EC v1.62
|-
! {{X41}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=X, P=-Y || 0.32 || ||
|-
! {{X41_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} (see ref) || 0.32 || || [http://sourceforge.net/mailarchive/message.php?msg_name=4757BD30.8080808%40ugcs.caltech.edu ref] ||
|-
! {{X60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=-Y, P=X || || 2.07 || EC v1.10, 2.6.20 issue (see discussion)
|-
! {{X60s}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X61s}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=X, P=-Y || 0.32 || || [http://www.slackwiki.org/ThinkPad_X61s ref]
|-
! {{X60_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || || || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}}R=-Y, P=X || 0.32 || ||
|-
! colspan=11 style="text-align:center;background:#efefef;" |

=====Z series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{Z60m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{Z61m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y || 0.32 || ||
|-
! {{Z61t}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || [https://bugs.launchpad.net/ubuntu/+source/linux-source-2.6.20/+bug/45014 ref]
|}
</div>

SMAPI capabilities may depend on the BIOS version as well, so upgrading to the latest version of the BIOS might provide more SMAPI functions (especially true for long-lived BIOS with lots of releases, like the TP-1R).

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

=====HDAPS axis orientation=====
1 HDAPS axis orientation notation: <tt>X</tt> and <tt>Y</tt> are the hardware readouts. <tt>R</tt> denotes the laptop's roll (tilt left/right), and <tt>P</tt> denotes the laptop's pitch (tilt forward/backward). You can use [[HDAPS#Visualisation_of_ThinkPad_orientation|hdaps visualisation]] to check for correctness.

The tp_smapi's hdaps driver supports all 8 possible sensor orientations (inversion and swapping), using the <tt>invert</tt> module parameter (e.g., <tt>modprobe hdaps invert=1</tt>). You can also change the <tt>invert</tt> sysfs attribute dynamically. The possible values are as follows:
invert=0: R= X P= Y (same as mainline)
invert=1: R=-X P=-Y (same as mainline)
invert=2: R=-X P= Y (new)
invert=3: R= X P=-Y (new)
invert=4: R= Y P= X (new)
invert=5: R=-Y P=-X (new)
invert=6: R=-Y P= X (new)
invert=7: R= Y P=-X (new)

[[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
* {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module.

Tp smapi

2007-12-22T22:00:51Z

Whoopie: /* HDAPS axis orientation */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
The <tt>tp_smapi</tt> kernel module exposes some features of the ThinkPad hardware/firmware via a <tt>sysfs</tt> interface. Currently, the main implemented functionality is control of battery charging and extended battery status. It also includes an improved version of the [[HDAPS]] driver. The underlying hardware interfaces are [[SMAPI support for Linux|SMAPI]] and direct access to the embedded controller.

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

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

===Features===
*Battery charge/discharge control
*Battery status information

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

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

:{{cmdroot|tar xzvf tp_smapi-0.33.tgz}}
:{{cmdroot|cd tp_smapi-0.33}}

Then, either compile and load the driver within the current working directory (for testing):
:{{cmdroot|make load}}
OR 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).
Again, either load the driver within the current working directory:
:{{cmdroot|1=make load HDAPS=1}}
OR 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 Ubuntu/Debian====
Installation on Ubuntu or Debian is quite easy, but there are a few things to look after:

To get your system ready for compiling code, install the build-essentials (as root, of course, as all of the following comands; Ubuntu users have to prepend 'sudo' to every line and enter their own password when prompted):
<pre><nowiki>apt-get install build-essential</nowiki></pre>

To get tp_smapi to work, obtain the latest source as mentioned above and unpack it. If you want to use HDAPS, you need to install the kernel source matching te kernel you are running. To do so, issue this:
<pre><nowiki>uname -r</nowiki></pre>
This will give you the version of your current kernel. As Ubuntu adds '-generic' to the kernel-version, the following command works for Debian users only:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users use the kernel-version they got by the command before, e.g. 'linux-source-2.6.20'

Now change to the tp_smapi dir:
<pre><nowiki>cd tp_smapi-X.YY</nowiki></pre> (X.YY being the version-number of [[tp_smapi]])
and make and install tp_smapi as instructed above.

If you get an error that the kernel version isn't matching (or that you need to set KSRC/KBUILD), please check that there is a symlink from the modules dir to the kernel source:
<pre><nowiki>root@localhost:~#ls -l /lib/modules/2.6.20-16-generic
lrwxrwxrwx 1 root root 28 2007-02-02 08:39 source -> /usr/src/linux-source-2.6.20</nowiki></pre>
Create the link if the line above is not existent:
<pre><nowiki>root@localhost:~#ln -s /usr/src/linux-source-2.6.20 /lib/modules/2.6.20-16-generic/source</nowiki></pre>

Now the following will build and install the correct modules to their locations:
<pre><nowiki>make install HDAPS=1</nowiki></pre>
To make sure your system loads the modules at boot time, do this:
<pre><nowiki>echo "tp_smapi" >> /etc/modules
echo "hdaps" >> /etc/modules</nowiki></pre>
and update your initramfs:
<pre><nowiki>update-initramfs -u</nowiki></pre>

To get tp_smapi running now, just load the modules:
<pre><nowiki>modprobe -a tp_smapi hdaps</nowiki></pre>

This description was tested on Kubuntu 'Feisty Fawn' and should work on all Debian-based distros with minor tweaks.

'''EDIT:''' Works on Kubuntu 7.10 ("Gutsy Gibbon"), too

===Battery charge control 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 prevent charging for 17 minutes (regardless of thresholds):
:{{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 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 charging preventation:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/inhibit_charge_minutes}}

To force battery discharging (even if connected to AC):
:{{cmdroot|echo 1 > /sys/devices/platform/smapi/BAT0/force_discharge}}
{{HINT|This can be used to choose which battery is discharged when [[How to use UltraBay batteries|using an UltraBay battery]].}}

To cancel forced discharge:
:{{cmdroot|echo 0 > /sys/devices/platform/smapi/BAT0/force_discharge}}

===Battery status features===
To view extended battery status such as charging state, voltage, current, capacity, cycle count and model information:

<pre>
# cat /sys/devices/platform/smapi/BAT0/installed
# cat /sys/devices/platform/smapi/BAT0/state # idle/charging/discharging
# cat /sys/devices/platform/smapi/BAT0/cycle_count
# cat /sys/devices/platform/smapi/BAT0/current_now # instantaneous current
# cat /sys/devices/platform/smapi/BAT0/current_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/power_now # instantaneous power
# cat /sys/devices/platform/smapi/BAT0/power_avg # last minute average
# cat /sys/devices/platform/smapi/BAT0/last_full_capacity
# cat /sys/devices/platform/smapi/BAT0/remaining_percent
# cat /sys/devices/platform/smapi/BAT0/remaining_running_time
# cat /sys/devices/platform/smapi/BAT0/remaining_charging_time
# cat /sys/devices/platform/smapi/BAT0/remaining_capacity
# cat /sys/devices/platform/smapi/BAT0/design_capacity
# cat /sys/devices/platform/smapi/BAT0/voltage
# cat /sys/devices/platform/smapi/BAT0/design_voltage
# cat /sys/devices/platform/smapi/BAT0/manufacturer
# cat /sys/devices/platform/smapi/BAT0/model
# cat /sys/devices/platform/smapi/BAT0/barcoding
# cat /sys/devices/platform/smapi/BAT0/chemistry
# cat /sys/devices/platform/smapi/BAT0/serial
# cat /sys/devices/platform/smapi/BAT0/manufacture_date
# cat /sys/devices/platform/smapi/BAT0/first_use_date
# cat /sys/devices/platform/smapi/BAT0/temperature # in milli-Celsius
# cat /sys/devices/platform/smapi/ac_connected
</pre>

The raw status data is also available, including some fields not listed above (in case you can figure them out):

:{{cmdroot|cat /sys/devices/platform/smapi/BAT0/dump}}

In all of the above, replace <tt>BAT0</tt> with <tt>BAT1</tt> to address the 2nd battery.

Note that the battery status readout conflicts with the stock [[HDAPS|hdaps]] driver, so if you use <tt>hdaps</tt> you will need to load <tt>tp_smapi</tt> using {{cmdroot|1=make load HDAPS=1}} (see [[#Bundled hdaps driver|Bundled hdaps driver]] below).

On [[ACPI]]-enabled systems, most of above information is also available through the files under {{path|/proc/acpi/battery}}. However, the ACPI interface does not include the instantaneous power and cycle count readouts, and does not work well when [[How to use UltraBay batteries|hotswapping UltraBay batteries]].

===Other features===

There is also [[sysfs]] attribute for making direct SMAPI requests to the SM BIOS firmware. Don't touch it unless you really know what you're doing. Example:
# echo '211a 100 0 0' > /sys/devices/platform/smapi/smapi_request; cat /sys/devices/platform/smapi/smapi_request
211a 34b b2 0 0 0 'OK'
The "4b" in the 2nd value, converted to decimal, is 75: the current charging stop threshold (stop_charge_thresh).

===Bundled <tt>hdaps</tt> driver===

The tp_smapi package includes a modified version of the <tt>hdaps</tt> Linux kernel driver used by the [[HDAPS]] system. To use <tt>tp_smapi</tt> and <tt>hdaps</tt> concurrently, you '''must''' use the modified version.

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

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

The modified <tt>hdaps</tt> has several changes:
* The <tt>hdaps</tt> driver in mainline kernels conflicts with the extended battery status (they use the same IO ports). The modified <tt>hdaps</tt> coordinates this access through the bundled <tt>thinkpad_ec</tt> driver.
* The modified <tt>hdaps</tt> driver fixes reliability and improves support for recent ThinkPad models (*60 and newer), since unlike the mainline driver, it correctly follows the Embedded Controller communication protocol.
* Several other improvements, such as the ability to control the polling rate.

===Troubleshooting===

If you get "<tt>thinkpad_ec: no ThinkPad embedded controller!</tt>" when trying to load the module on a supported model listed below, you should [[BIOS_Upgrade|upgrade your BIOS]]. Some early BIOS (like 1.x on the X31) don't handle the embedded controller.

===Model-specific status===

<div style="font-size: 92%">
{| border="1" cellspacing="0" cellpadding="2"
|+<tt>tp_smapi</tt> feature support matrix
|-
! colspan=11 style="text-align:center;background:#efefef;" |
=====A series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{A22p}} 2629-USG
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{A30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! colspan=11 style="text-align:center;background:#efefef;" |
=====G series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{G41}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! colspan=11 style="text-align:center;background:#efefef;" |
=====R series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{R31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || No SMAPI BIOS
|-
! {{R40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R50}}
| {{Cunk}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R50e}} 1834-JAG
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R50p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{R51}} 18*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y || 0.32 || 3.22 || Machine types 1829, 1830, 1831 and 1836
|-
! {{R51}} 28*
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || 1.29 || Machine types 2883, 2887, 2888, 2889, 2894 and 2495
|-
! {{R52}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y || 0.32 || 1.29 ||
|-
! {{R60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} ||{{Cyes}} || {{Cunk}} || || ||
|-

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

=====T series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{T20}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T22}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || || Has SMAPI BIOS but no function is supported. EC LPC3 protocol fails.
|-
! {{T23}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T30}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T40}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T40p}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T41}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T41p}} 2373-AM9
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=-X, P=-Y || 0.32 || 3.20 || EC v3.04
|-
! {{T42}}
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T42p}} 2373-KXU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=-X, P=-Y || 0.32 || 3.21 || Stop charge threshold works in Windows, but dmesg says "__get_real_thresh: cannot get stop_thresh of bat=0: Function is not supported by SMAPI BIOS".
|-
! {{T42p}} 2373-KUU
| {{Cyes}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{T43}} 2686
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y (invert=0) || 0.33 || 1.27 ||
|-
! {{T43p}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes|text=}} R=X, P=Y || || ||
|-
! {{T60}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=Y, P=-X || 0.32 || ||
|-
! {{T60p}} 8743-CTO
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=-X, P=-Y || 0.32 || ||
|-
! {{T61}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=-X, P=-Y || 0.32 || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! {{T61p}} 6457-7XG
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=-X, P=-Y || 0.32 || || [http://ubuntuforums.org/showthread.php?p=3146719 ref]
|-
! colspan=11 style="text-align:center;background:#efefef;" |

=====X series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{X20}} 2662-31G
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X24}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X30}}
| {{Cno}} || {{Cno}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X31}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X32}}
| {{Cno}} || {{Cno}} || {{Cno}} || {{Cno}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X40}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=X, P=-Y || 0.32 || 2.08 || EC v1.62
|-
! {{X41}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=X, P=-Y || 0.32 || ||
|-
! {{X41_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} (see ref) || 0.32 || || [http://sourceforge.net/mailarchive/message.php?msg_name=4757BD30.8080808%40ugcs.caltech.edu ref] ||
|-
! {{X60}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=-Y, P=X || || 2.07 || EC v1.10, 2.6.20 issue (see discussion)
|-
! {{X60s}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{X61s}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} R=X, P=-Y || 0.32 || || [http://www.slackwiki.org/ThinkPad_X61s ref]
|-
! {{X60_Tablet}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || || || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}}R=-Y, P=X || 0.32 || ||
|-
! colspan=11 style="text-align:center;background:#efefef;" |

=====Z series=====
|-
{{tp_smapi/model_status_table_header}}
|-
! {{Z60m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{Z60t}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || || ||
|-
! {{Z61m}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes|text=}} R=X, P=Y || 0.32 || ||
|-
! {{Z61t}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || [https://bugs.launchpad.net/ubuntu/+source/linux-source-2.6.20/+bug/45014 ref]
|}
</div>

SMAPI capabilities may depend on the BIOS version as well, so upgrading to the latest version of the BIOS might provide more SMAPI functions (especially true for long-lived BIOS with lots of releases, like the TP-1R).

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

=====HDAPS axis orientation=====
1 HDAPS axis orientation notation: <tt>X</tt> and <tt>Y</tt> are the hardware readouts. <tt>R</tt> denotes the laptop's roll (tilt left/right), and <tt>P</tt> denotes the laptop's pitch (tilt forward/backward). You can use [[HDAPS#Visualisation_of_ThinkPad_orientation|hdaps visualisation]] to check for correctness.

The tp_smapi's hdaps driver supports all 8 possible sensor orientations (inversion and swapping), using the <tt>invert</tt> module parameter (e.g., <tt>modprobe hdaps invert=1</tt>). You can also change the <tt>invert</tt> sysfs attribute dynamically. The possible values are as follows:
invert=0: R= X P= Y (same as mainline)
invert=1: R=-X P=-Y (same as mainline)
invert=2: R=-X P= Y (new)
invert=3: R= X P=-Y (new)
invert=4: R= Y P= X (new)
invert=5: R=-Y P=-X (new)
invert=6: R=-Y P= X (new)
invert=7: R= Y P=-X (new)

[[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
* {{CodeRef|thinkpad-smapi.sh}} - script to display various SMAPI information using tp_smapi module.

How to get special keys to work

2007-11-27T18:49:50Z

Whoopie: /* Redirecting XF86Back/XF86Forward */

==Overview==
The following table gives an overview over the special keys found on ThinkPads and what is needed to make them work.
{| {{prettytable}}
! key !! standard function{{footnote|1}} !! tools supporting key{{footnote|2}} !! configurability{{footnote|3}} !! remarks
|-
| {{key|Fn}} || - || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || on release without completed key combination
|-
| {{key|Fn}}{{key|F1}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F2}} || lock screen || [[#ibm-acpi events|ibm-acpi]] || full || in models from T/X/Z 60 onwards
|-
| {{key|Fn}}{{key|F3}} || blank screen || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F4}} || suspend to ram || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|F5}} || switch bluetooth || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || in models starting from 2002
|-
| {{key|Fn}}{{key|F6}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F7}} || toggle display || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions || [[Sample Fn-F7 script]]
|-
| {{key|Fn}}{{key|F8}} || toggle trackpoint/touchpad || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions ||
|-
| {{key|Fn}}{{key|F9}} || eject from dock || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F10}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F11}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F12}} || hibernate || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || brightness up || [[#ibm-acpi events|ibm-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|End}} || brightness down || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|PageUp}} || toggle thinklight || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|Space}} || toggle zoom || [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{key|Fn}}{{key|Ins}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|Del}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|Backspace}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|NumLock}} || - || [[#xmodmap configuration|xmodmap]] || make working ||
|-
| {{key|Windows}} || - || [[#xmodmap configuration|xmodmap]] || remapping ||
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || help application || [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{ibmkey|Home|#494949}} || open web browser || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Search|#494949}} || open search application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Mail|#494949}} || open mail application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Favorites|#494949}} || open favorites || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Reload|#494949}} || reload web page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Abort|#494949}} || abort loading page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Backward|#494949}} || previous page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Forward|#494949}} || next page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Volume up|#494949}} || volume up || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume down|#494949}} || volume down || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume mute|#494949}} || mute volume || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Play/Pause|#494949}} || start/pause playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Down)
|-
| {{ibmkey|Stop|#494949}} || stop playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Up)
|-
| {{ibmkey|Next|#494949}} || play next || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Right)
|-
| {{ibmkey|Previous|#494949}} || play previous || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Left)
|-
| {{ibmkey|Power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| Display lid || blank screen || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| Ultrabay lid || announce ultrabay change || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| Dock eject || eject from dock || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{ibmkey|Tablet power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| {{ibmkey|Tablet orientation|#494949}} || rotates screen || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet shortcut|#494949}} || shortcut menu || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Esc|#494949}} || esc key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Enter|#494949}} || enter key || [[#mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Up|#494949}} || up key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Down|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|}

==Triggering key events==
===ibm-acpi events===
Some of the following events require a {{cmdroot|echo enable,0xffff >/proc/acpi/ibm/hotkey}} in order to make acpi able to get information on them. These events can be used to [[How to configure acpid|configure acpid]].

{| {{prettytable}}
|+ events triggered by [[ibm-acpi]] for {{path|/etc/acpi/events}} files.
! key !! event
|-
| {{key|Fn}}{{key|F1}} || ibm/hotkey HKEY 00000080 00001001
|-
| {{key|Fn}}{{key|F2}} || ibm/hotkey HKEY 00000080 00001002
|-
| {{key|Fn}}{{key|F3}} || ibm/hotkey HKEY 00000080 00001003
|-
| {{key|Fn}}{{key|F4}} || ibm/hotkey HKEY 00000080 00001004
|-
| {{key|Fn}}{{key|F5}} || ibm/hotkey HKEY 00000080 00001005
|-
| {{key|Fn}}{{key|F6}} || ibm/hotkey HKEY 00000080 00001006
|-
| {{key|Fn}}{{key|F7}} || ibm/hotkey HKEY 00000080 00001007
|-
| {{key|Fn}}{{key|F8}} || ibm/hotkey HKEY 00000080 00001008
|-
| {{key|Fn}}{{key|F9}} || ibm/hotkey HKEY 00000080 00001009
|-
| {{key|Fn}}{{key|F10}} || ibm/hotkey HKEY 00000080 0000100a
|-
| {{key|Fn}}{{key|F11}} || ibm/hotkey HKEY 00000080 0000100b
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c
|-
| {{key|Fn}}{{key|Backspace}} || ibm/hotkey HKEY 00000080 0000100d
|-
| {{key|Fn}}{{key|Ins}} || ibm/hotkey HKEY 00000080 0000100e
|-
| {{key|Fn}}{{key|Del}} || ibm/hotkey HKEY 00000080 0000100f
|-
| {{key|Fn}}{{key|Home}}/{{key|Fn}}{{key|Pos1}} || ibm/hotkey HKEY 00000080 00001010
|-
| {{ibmkey|ThinkVantage|#495988}} ||ibm/hotkey HKEY 00000080 00001018
|-
| {{ibmkey|Power|#494949}} || button/power PWRF 00000080 xxxxxxxx
|-
| Display lid || button/lid LID 00000080 xxxxxxxx
|-
| Ultrabay eject || ibm/bay MSTR 00000003 00000000
|-
| Ultrabay inserted || ibm/bay MSTR 00000001 00000000
|-
| Dock eject || ibm/dock GDCK 00000003 00000001
|-
| Wireless switch || ibm/hotkey HKEY 00000080 00007000
|}

By disassembling and editing the DSDT, more events can be added. HKEY events are triggered by calls to the MKHQ function, e.g. <tt>\_SB.PCI0.LPC.EC.HKEY.MHKQ(0Ã—1007)</tt> will trigger "ibm/hotkey HKEY 00000080 00001007". Most of these can be found in <tt>_Qxx</tt> methods within the DSDT, which are executed on embedded controller events, e.g. _Q10 is triggered by pressing Fn-F7. You can add a call to MKHQ into an existing <tt>_Qxx</tt> method to get it recognized by ibm-acpi as well as creating new <tt>_Qxx</tt> methods, which if you're lucky will correspond to an EC event that IBM never used (e.g. A 770 will send Fn-Home/End/PgUp/PgDn to ibm-acpi if hacked in this fashion). For example, [http://www.wormnet.eu/ibm-g40/morebuttons.dsl this is a modified block of DSDT for a G40].

=== Pure ACPI events ===

A few keys can generate ACPI events of their own on certain ThinkPads, as long as they are masked off in the ibm-acpi hotkey's mask (or the hotkey feature is disabled in ibm-acpi).

If you want the ThinkPad's BIOS and ACPI methods to know about these keys being pressed, you probably want to leave them masked out from ibm-acpi, and use their non-HKEY events listed below, instead.

{| {{prettytable}}
|+ events triggered by ACPI when hotkey is masked out or disabled.
! key !! event
|-
| {{key|Fn}}{{key|F4}} || button/sleep SLPB 00000080 00000001
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c
|}

===tpb configuration===
{| {{prettytable}}
|+ configuration keywords for [[tpb]] (to put in {{path|/etc/tpbrc}})
! key !! config keyword
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || THINKPAD
|-
| {{ibmkey|Home|#494949}} || HOME
|-
| {{ibmkey|Search|#494949}} || SEARCH
|-
| {{ibmkey|Mail|#494949}} || MAIL
|-
| {{ibmkey|Favorites|#494949}} || FAVORITES
|-
| {{ibmkey|Reload|#494949}} || RELOAD
|-
| {{ibmkey|Abort|#494949}} || ABORT
|-
| {{ibmkey|Backward|#494949}} || BACKWARD
|-
| {{ibmkey|Forward|#494949}} || FORWARD
|-
| {{key|Fn}} || FN
|-
| {{key|Fn}}{{key|Space}} || CALLBACK (zoom on/off)
|-
| {{key|Fn}}{{key|PageUp}} || CALLBACK (thinklight on/off)
|-
| {{key|Fn}}{{key|F7}} || CALLBACK (display lcd/crt/both)
|-
| {{key|Fn}}{{key|F8}} || CALLBACK (expand on/off)
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || CALLBACK (brightness <percent>)
|-
| {{key|Fn}}{{key|End}} || CALLBACK (brightness <percent>)
|-
| {{ibmkey|Volume up|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume down|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume mute|#494949}} || CALLBACK (mute on/off)
|}

To all parameter keywords should be assigned the full path to the executables supposed to be started on key press.
The exectable provided for the CALLBACK keyword should take the parameters given in parentheses and act according to them.
If you want to use xmodmap for the HOME, SEARCH, MAIL, FAVORITES, RELOAD, ABORT, BACKWARD, FORWARD and FN keys you should
provide a <tt>XEVENTS OFF</tt> in your {{path|/etc/tpbrc}}.
You can use an appropriate executable to [[How to inject fake keystrokes|inject fake keystrokes]].

For Debian users, tpb is started from {{path|/etc/X11/Xsession.d/90tpb}}.

'''Sound Button configuration'''

''Note: Tested on T60p with Ubuntu 6.06 LTS''

Most Thinkpads have a hardware sound mixer, thus the volumes buttons should work without configuration. However, this change is not reflected in the software mixer. tpb has a switch to enable software mixer support via OSS. The manual recommends this only for devices without a hardware mixer, but it also works for other hadware mixer enabled devices, even with the ALSA system. Just put MIXER ON in your {{path|/etc/tpbrc}} file and you can see the effect immediately in any ALSA mixer (e.g. kmix). For this to work you need write permissions to {{path|/dev/nvram}}.

''Note: Tested on X21 with Ubuntu 6.06 LTS''

On the ThinkPad X21 (and maybe some other older models) ACPI causes problems with tpb. On an X21 using acpi the volume buttons would work occasionally, and the OSD for tpb functions would rarely work. If a volume buttons was pressed too often, sometimes the computer would enter a low power (unplugged state) and would require a reboot. The solution is to use APM instead of ACPI. Instructions can be found in [[How_to_make_APM_work]].

===KMilo configuration===
The programs to be executed by [[KMilo]] are configured via the KDE Control Center (<tt>kcontrol</tt>), under <tt>System Administration --> IBM Thinkpad Laptop</tt>. Note that you can use appropriate commands to [[How to inject fake keystrokes|inject fake keystrokes]].

===xmodmap configuration===
xmodmap enables you to edit the modifier map and keymap tables that are used to translate keycodes into keysyms.
Understood? Well, basically it allows you to give the X server a dictionary for the translation of keycodes like "97" into more human readable synonyms like "Home". This way xmodmap allows you to make the special keys of your keyboard known to X applications.

To discover the keycode that a certain keypress produces, use the tool {{cmduser|xev}}

Usually you should write your keycode-keysym associations into the file {{path|~/.Xmodmap}}. This file is usually read by the X session startup scripts of your system, so that the mappings automatically get included everytime you run the X server.

The {{path|~/.Xmodmap}} lines for our purpose are in the form of
keycode <keycode> = <keysym>

Load the assocation using the command

{{cmduser|xmodmap ~/.Xmodmap}}

(some configurations do this automatically upon X startup).

The following table shows the keycodes generated by the ThinkPad special keys and sensible keysyms to assign them to.
{| {{prettytable}}
|+ keycodes and recommended keysyms
! key !! keycode !! keysym
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || 159 || XF86LaunchA
|-
| {{ibmkey|Backward|#494949}} || 234 || XF86Back or F19
|-
| {{ibmkey|Forward|#494949}} || 233 || XF86Forward or F20
|-
| {{ibmkey|Play/Pause|#494949}} || 162 || XF86AudioPlay
|-
| {{ibmkey|Stop|#494949}} || 164 || XF86AudioStop
|-
| {{ibmkey|Next|#494949}} || 153 || XF86AudioNext
|-
| {{ibmkey|Previous|#494949}} || 144 || XF86AudioPrev
|-

| {{ibmkey|Home|#494949}} || 178 || XF86HomePage
|-
| {{ibmkey|Search|#494949}} || 229 || XF86Search
|-
| {{ibmkey|Mail|#494949}} || 236 || XF86Mail
|-
| {{ibmkey|Favorites|#494949}} || 230 || XF86AddFavorite or XF86Favorites
|-
| {{ibmkey|Reload|#494949}} || 231 || XF86Reload
|-
| {{ibmkey|Abort|#494949}} || 232 || XF86Stop
|-
| {{key|Fn}} || 227 || F35
|}

Note: You can also use xkeycaps (an X tool to display and edit the X keyboard mapping) to generate proper .Xmodmap.

Note: if you are running [[tpb]] you might need to add the line <tt>XEVENTS=off</tt> into your tpbrc to stop it from grabbing the key events and allow them to get through to X instead. See [[http://www.thinkwiki.org/wiki/Tpb]] for more detailed instruction on how to use tpb and xmodmap.

Note: XF86Forward and XF86Back do not work correctly in Firefox. You may want to map them to F19 and F20 instead if you use Firefox.

Note: The "XF86AudioPlay" etc. just works with a few programs. To make it work with more multimedia programs you have map the key to use something like [http://www.kde-apps.org/content/show.php/ReMoot?content=63140 ReMoot]. ReMoot is a command line wrapper that control 18 of the most common multimedia applications.

=====Enabling the Windows and Menu Keys=====
On some systems the Windows and Menu keys may not be recognized. You can enable then by
making the following changes:

keycode 115 = F13
keycode 227 = F35

F13 and F35 are used for the Windows and and Menu keys respectively. Labelling keycpode 227 as "Menu" may conflict with the right-mouse-click event.

=====Using Caps Lock as Super L (Windows key)=====
You can easily use Caps Lock as Win key by adding the following in your ~/.Xmodmap:
! No Caps Lock
clear lock
! Caps Lock as Win key
add mod4 = Caps_Lock
=====NumLock=====
On the ThinkPad {{600}}, {{T20}}, {{T21}}, {{T22}}, {{T30}}, {{X20}}, {{X21}}, {{X31}}, {{X40}}, {{T42p}}, {{T43}}, {{R51}}, {{R52}} and possibly other models, X does not recognize the keycode for {{key|NumLk}} = {{key|Shift}}+{{key|ScrLk}}. To fix this, add the following to {{path|~/.Xmodmap}} in your home directory or {{path|/etc/X11/Xmodmap}} and run <tt>xmodmap</tt>, ex: <tt>xmodmap ~/.Xmodmap</tt>:
keycode 77 = Num_Lock

This configuration also enables the respective LED.

Please note, pressing the {{key|Shift}}+{{key|ScrLk}} key combination, without first following the above configuration, will start an accessibility feature, which will allow the numeric keypad to maneuver the mouse pointer. Starting this accessibility feature and subsequently running xmodmap, as described above, results in the accessibility feature and the numeric lock LED functioning simultaneously. As such, the above configuration should be completed before the accessibility feature is started in order to produce numbers.

===Mapping keys with setkeycodes===
You can use the setkeycodes command to remap certain keys. I.e. you can use {{cmdroot|setkeycodes 6e 109 6d 104 69 28 6b 1}} to map the Tablets Up and Down keys to the standard PageUp and PageDown keys and Tablet Escape and Enter to their respective keys.

The following table shows the keycodes generated by the ThinkPad keys.
{| {{prettytable}}
|+ keycodes
! key !! keycode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x6e
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x68
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6c
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || 0x67
|}

==Example Applications==
===Web Browsers===
====Firefox====

There are various ways to assign actions to the browser keys. The easiest way is to install [http://mozilla.dorando.at/keyconfig.xpi keyconfig.xpi] from http://mozilla.dorando.at, which adds a menu entry Tools->Keyconfig. Then you can assign any action you want to the F19/F20 keys (you still need to create {{path|~/.Xmodmap}} as explained above).

The remaining discussion gives you various more complicated ways to achieve the same thing.
To have firefox make use of the browser keys you need to modify one of its files{{footnote|4}}.
To do this you will first need to extract it from the {{path|browser.jar}} archive. Do...

:{{cmdroot|cd <firefox-directory>/chrome}} 
:{{cmdroot|unzip browser.jar}}

The file of interest is {{path|content/browser/browser.xul}}. Edit it {and don't forget to make a backup copy first}...
:{{cmdroot|vi content/browser/browser.xul}}

Look for the '''<keyset id="mainKeyset">''' section and add the following lines within...
<key id="goBackKb" keycode="VK_F19" command="Browser:Back" />
<key id="goForwardKb" keycode="VK_F20" command="Browser:Forward" />

The Command you need for Next Tab
<key id="goBackTabKb" keycode="VK_F19" oncommand="gBrowser.mTabContainer.advanceSelectedTab(-1)" />
For the Previous Tab
<key id="goForwardTabKb" keycode="VK_F20" oncommand="gBrowser.mTabContainer.advanceSelectedTab(1)" />

Now save the file and repackage the {{path|browser.jar}} archive...
:{{cmdroot|zip -rD0 browser.jar content/browser/}}

That's it.

{{HINT|For Firefox 2.0, just edit <firefox-directory>/chrome/browser/content/browser/browser.xul}}

{{HINT|Outdated: Another interesting Page on Firefox is http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ It uses different key mappings (F19 resp. F20) but a ready [http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/dqdnavkeys-1.2.xpi .xpi] is provided which is pretty comfortable. However, this xpi file does not install on Firefox 1.5. or later.}}

{{HINT|Outdated: You can also use the [http://extensionroom.mozdev.org/more-info/keyconfig keyconfig] extension to configure custom keys. This extension works with Firefox 1.5 but not with Firefox 2.0. The Command you need for Next Tab is gBrowser.mTabContainer.advanceSelectedTab(1,true); For Previous Tab its gBrowser.mTabContainer.advanceSelectedTab(-1,true); }}.

====Konqueror====
KDE allows you set key mappings for KDE applications (Go to KMenu > System > Control Center > Regional & Accessibility > Keyboard Shortcuts). By default (at least in KDE 3.5), XF86Back and XF86Forward are set as alternatives to Alt-Left and Alt-Right, and are mapped to KDE Back and Forward navigation actions.

If you use Konqueror as your only browser, you only need to set up {{path|~/.Xmodmap}} as described [[#xmodmap configuration|above]] to assign ThinkPad back/forward keys to the symbols XF86Back/XF86Forward. This also make these keys work for other KDE applications such as Quanta Plus, KPackage and so on (not all KDE applications honor this setting, e.g. KDE help system doesn't).

If you want to use Firefox, however, the above settings do not work. You will have to map ThinkPad back/forward keys to F19/F20 as described [[#Firefox|above]], and change KDE navigation key settings to use F19/F20 instead of the default.

====Opera====
However this isn't a simple configration file, you can set your browser manually. 
Go to Tool > Settings > Mouse and keyboard > Keyboard settings > Edit > Browser Window. There add F19 - Back and F20 - Forward. Now you can surf using your TP keys ;-)

===Window Managers===
====fvwm====
To get the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fvwmrc}}:
Key XF86Back A A Scroll -100000 0
Key XF86Forward A A Scroll +100000 0
If you use multiple virtual desktops, you could instead use the keys to flip between them by using GotoDesk.

====fluxbox====
To get the keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fluxbox/keys}}:
None F19 :PrevWorkspace
None F20 :NextWorkspace

====pekwm configuration====
You can make the two browser keys switch workspaces in pekwm, by adding the following two lines to the {{path|~/.pekwm/keys}} file:
KeyPress = "Mod1 XF86Back" { Actions = "GoToWorkspace prev" }
KeyPress = "Mod1 XF86Forward" { Actions = "GoToWorkspace next" }

====pwm====
Another example how to use these two keys to switch between pwm tabs. These two lines should be added to {{path|~/.pwm/keys-default.conf}} or {{path|/etc/pwm/keys-default.conf}}:
kbind "Back", "switch_rot", -1
kbind "Forward", "switch_rot", 1

====IceWM====
To make IceWM cycle workspaces using the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys, change these two options in {{path|~/.icewm/preferences}} (Provided you assigned keysyms F19 and F20 with xmodmap):
# "Previous workspace" shortcut
KeySysWorkspacePrev="F19"
# "Next workspace" shortcut
KeySysWorkspaceNext="F20"

==== Gnome/metacity ====

Follow the [https://wiki.ubuntu.com/Keybindings Ubuntu guide].

===Other Uses===
====Console tools configuraton====
To make the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys useful in console, add this to your keymap ({{path|/etc/console/boottime.kmap.gz}} in {{Debian}}):
keycode 158 = Decr_Console
keycode 159 = Incr_Console

Alternatively you can load this script (perhaps on system startup) to enable Backward/Forward button console (VT) switch:

#!/bin/sh
echo keycode 158 = Decr_Console | loadkeys
echo keycode 159 = Incr_Console | loadkeys

It should work with any distro.

====Cycling through tabs====
In Gnome and Xfce4, Ctrl-PageUp/Ctrl-PageDown move to the previous/following open tab in all applications that have tabbed user interfaces (terminal emulator, web browser, ...). To make use of the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys for this task, there're two possibilities.

For both ways, you should map the keycodes 233 and 234 to XF86Back and XF86Forward as described in [[#xmodmap_configuration|xmodmap configuration]].

=====Using xautomation=====
xautomation can be found [http://hoopajoo.net/projects/xautomation.html here].

Create two files with permissions 755:

{{path|/usr/local/bin/tp_back}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Up' 'keyup Page_Up' 'keyup Control_L'
</bash>

{{path|/usr/local/bin/tp_forward}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Down' 'keyup Page_Down' 'keyup Control_L'
</bash>

Use your desktop's keyboard shortcut editor to assign XF86Back as a shortcut for tp_back and XF86Forward as a shortcut for tp_forward.

This should work in all distros and with all window managers (you might have to use other key combinations than Ctrl-PageUp and Ctrl-PageDown).

=====Redirecting XF86Back/XF86Forward=====
Create {{path|/etc/X11/xkb/compat/thinkpad}}:
<pre>
// $XFree86$
// XFree86 special keysyms
default partial xkb_compatibility "basic" {
interpret.repeat= True;

interpret XF86Back {
action = Redirect(Key=<PGUP>, modifiers=Control);
};
interpret XF86Forward {
action = Redirect(Key=<PGDN>, modifiers=Control);
};
};
</pre>

Edit {{path|/etc/X11/xkb/compat/complete}} and add <tt>'''augment "thinkpad"'''</tt> so that it looks similar to the following:
<pre>
// $XKeyboardConfig: xkbdesc/compat/complete,v 1.3 2005/10/17 00:42:11 svu Exp $
// $Xorg: complete,v 1.3 2000/08/17 19:54:34 cpqbld Exp $
default xkb_compatibility "complete" {
include "basic"
augment "iso9995"
augment "mousekeys"
augment "accessx(full)"
augment "misc"
augment "xfree86"
augment "level5"
augment "thinkpad"
};
</pre>

==External Sources==
*[http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-51537 IBMs page on configuring the ThinkPad buttons (ThinkPad, Access IBM, Mail, Search, and Home buttons) under Linux]
*[http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ Rob Mayoffs page on using IBM Keyboard Navigation Keys in Linux Mozilla and Firefox]
*[http://snarfed.org/space/thinkpad+keys+in+firefox Ryan Barretts blog article about using the browser keys in Firefox]
*[http://chaotika.org/~bluesceada/?page=soft&sub=thinkpad#acpibutn DennisG's help to get the ibm-acpi buttons do useful things] on a {{Z61e}} and possibly {{Z61m}}, {{Z61t}} and {{Z61p}}

{{footnotes|
#Note that the associated functionality for Fn-F* key combinations is not consistent amongst all ThinkPads. We are maintaining [[Default meanings of special keys|a table of associated meanings]].
#if there are more than one tool listed, one is sufficient
#'full' means you can completely reassign any action to be triggered by the key, 'additional actions' means you can trigger actions in addition to the standard function of the key, which can not be changed.
#Thanks go to Ryan Barrett for writing the [http://snarfed.org/space/thinkpad+keys+in+firefox little howto] on [http://snarfed.org/space/start his blog].
}}

How to get special keys to work

2007-11-27T18:41:36Z

Whoopie: /* Using xautomation */ use bash highlighting

==Overview==
The following table gives an overview over the special keys found on ThinkPads and what is needed to make them work.
{| {{prettytable}}
! key !! standard function{{footnote|1}} !! tools supporting key{{footnote|2}} !! configurability{{footnote|3}} !! remarks
|-
| {{key|Fn}} || - || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || on release without completed key combination
|-
| {{key|Fn}}{{key|F1}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F2}} || lock screen || [[#ibm-acpi events|ibm-acpi]] || full || in models from T/X/Z 60 onwards
|-
| {{key|Fn}}{{key|F3}} || blank screen || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F4}} || suspend to ram || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|F5}} || switch bluetooth || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || in models starting from 2002
|-
| {{key|Fn}}{{key|F6}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F7}} || toggle display || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions || [[Sample Fn-F7 script]]
|-
| {{key|Fn}}{{key|F8}} || toggle trackpoint/touchpad || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions ||
|-
| {{key|Fn}}{{key|F9}} || eject from dock || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F10}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F11}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F12}} || hibernate || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || brightness up || [[#ibm-acpi events|ibm-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|End}} || brightness down || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|PageUp}} || toggle thinklight || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|Space}} || toggle zoom || [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{key|Fn}}{{key|Ins}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|Del}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|Backspace}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|NumLock}} || - || [[#xmodmap configuration|xmodmap]] || make working ||
|-
| {{key|Windows}} || - || [[#xmodmap configuration|xmodmap]] || remapping ||
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || help application || [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{ibmkey|Home|#494949}} || open web browser || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Search|#494949}} || open search application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Mail|#494949}} || open mail application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Favorites|#494949}} || open favorites || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Reload|#494949}} || reload web page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Abort|#494949}} || abort loading page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Backward|#494949}} || previous page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Forward|#494949}} || next page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Volume up|#494949}} || volume up || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume down|#494949}} || volume down || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume mute|#494949}} || mute volume || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Play/Pause|#494949}} || start/pause playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Down)
|-
| {{ibmkey|Stop|#494949}} || stop playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Up)
|-
| {{ibmkey|Next|#494949}} || play next || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Right)
|-
| {{ibmkey|Previous|#494949}} || play previous || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Left)
|-
| {{ibmkey|Power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| Display lid || blank screen || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| Ultrabay lid || announce ultrabay change || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| Dock eject || eject from dock || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{ibmkey|Tablet power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| {{ibmkey|Tablet orientation|#494949}} || rotates screen || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet shortcut|#494949}} || shortcut menu || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Esc|#494949}} || esc key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Enter|#494949}} || enter key || [[#mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Up|#494949}} || up key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Down|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|}

==Triggering key events==
===ibm-acpi events===
Some of the following events require a {{cmdroot|echo enable,0xffff >/proc/acpi/ibm/hotkey}} in order to make acpi able to get information on them. These events can be used to [[How to configure acpid|configure acpid]].

{| {{prettytable}}
|+ events triggered by [[ibm-acpi]] for {{path|/etc/acpi/events}} files.
! key !! event
|-
| {{key|Fn}}{{key|F1}} || ibm/hotkey HKEY 00000080 00001001
|-
| {{key|Fn}}{{key|F2}} || ibm/hotkey HKEY 00000080 00001002
|-
| {{key|Fn}}{{key|F3}} || ibm/hotkey HKEY 00000080 00001003
|-
| {{key|Fn}}{{key|F4}} || ibm/hotkey HKEY 00000080 00001004
|-
| {{key|Fn}}{{key|F5}} || ibm/hotkey HKEY 00000080 00001005
|-
| {{key|Fn}}{{key|F6}} || ibm/hotkey HKEY 00000080 00001006
|-
| {{key|Fn}}{{key|F7}} || ibm/hotkey HKEY 00000080 00001007
|-
| {{key|Fn}}{{key|F8}} || ibm/hotkey HKEY 00000080 00001008
|-
| {{key|Fn}}{{key|F9}} || ibm/hotkey HKEY 00000080 00001009
|-
| {{key|Fn}}{{key|F10}} || ibm/hotkey HKEY 00000080 0000100a
|-
| {{key|Fn}}{{key|F11}} || ibm/hotkey HKEY 00000080 0000100b
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c
|-
| {{key|Fn}}{{key|Backspace}} || ibm/hotkey HKEY 00000080 0000100d
|-
| {{key|Fn}}{{key|Ins}} || ibm/hotkey HKEY 00000080 0000100e
|-
| {{key|Fn}}{{key|Del}} || ibm/hotkey HKEY 00000080 0000100f
|-
| {{key|Fn}}{{key|Home}}/{{key|Fn}}{{key|Pos1}} || ibm/hotkey HKEY 00000080 00001010
|-
| {{ibmkey|ThinkVantage|#495988}} ||ibm/hotkey HKEY 00000080 00001018
|-
| {{ibmkey|Power|#494949}} || button/power PWRF 00000080 xxxxxxxx
|-
| Display lid || button/lid LID 00000080 xxxxxxxx
|-
| Ultrabay eject || ibm/bay MSTR 00000003 00000000
|-
| Ultrabay inserted || ibm/bay MSTR 00000001 00000000
|-
| Dock eject || ibm/dock GDCK 00000003 00000001
|-
| Wireless switch || ibm/hotkey HKEY 00000080 00007000
|}

By disassembling and editing the DSDT, more events can be added. HKEY events are triggered by calls to the MKHQ function, e.g. <tt>\_SB.PCI0.LPC.EC.HKEY.MHKQ(0Ã—1007)</tt> will trigger "ibm/hotkey HKEY 00000080 00001007". Most of these can be found in <tt>_Qxx</tt> methods within the DSDT, which are executed on embedded controller events, e.g. _Q10 is triggered by pressing Fn-F7. You can add a call to MKHQ into an existing <tt>_Qxx</tt> method to get it recognized by ibm-acpi as well as creating new <tt>_Qxx</tt> methods, which if you're lucky will correspond to an EC event that IBM never used (e.g. A 770 will send Fn-Home/End/PgUp/PgDn to ibm-acpi if hacked in this fashion). For example, [http://www.wormnet.eu/ibm-g40/morebuttons.dsl this is a modified block of DSDT for a G40].

=== Pure ACPI events ===

A few keys can generate ACPI events of their own on certain ThinkPads, as long as they are masked off in the ibm-acpi hotkey's mask (or the hotkey feature is disabled in ibm-acpi).

If you want the ThinkPad's BIOS and ACPI methods to know about these keys being pressed, you probably want to leave them masked out from ibm-acpi, and use their non-HKEY events listed below, instead.

{| {{prettytable}}
|+ events triggered by ACPI when hotkey is masked out or disabled.
! key !! event
|-
| {{key|Fn}}{{key|F4}} || button/sleep SLPB 00000080 00000001
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c
|}

===tpb configuration===
{| {{prettytable}}
|+ configuration keywords for [[tpb]] (to put in {{path|/etc/tpbrc}})
! key !! config keyword
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || THINKPAD
|-
| {{ibmkey|Home|#494949}} || HOME
|-
| {{ibmkey|Search|#494949}} || SEARCH
|-
| {{ibmkey|Mail|#494949}} || MAIL
|-
| {{ibmkey|Favorites|#494949}} || FAVORITES
|-
| {{ibmkey|Reload|#494949}} || RELOAD
|-
| {{ibmkey|Abort|#494949}} || ABORT
|-
| {{ibmkey|Backward|#494949}} || BACKWARD
|-
| {{ibmkey|Forward|#494949}} || FORWARD
|-
| {{key|Fn}} || FN
|-
| {{key|Fn}}{{key|Space}} || CALLBACK (zoom on/off)
|-
| {{key|Fn}}{{key|PageUp}} || CALLBACK (thinklight on/off)
|-
| {{key|Fn}}{{key|F7}} || CALLBACK (display lcd/crt/both)
|-
| {{key|Fn}}{{key|F8}} || CALLBACK (expand on/off)
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || CALLBACK (brightness <percent>)
|-
| {{key|Fn}}{{key|End}} || CALLBACK (brightness <percent>)
|-
| {{ibmkey|Volume up|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume down|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume mute|#494949}} || CALLBACK (mute on/off)
|}

To all parameter keywords should be assigned the full path to the executables supposed to be started on key press.
The exectable provided for the CALLBACK keyword should take the parameters given in parentheses and act according to them.
If you want to use xmodmap for the HOME, SEARCH, MAIL, FAVORITES, RELOAD, ABORT, BACKWARD, FORWARD and FN keys you should
provide a <tt>XEVENTS OFF</tt> in your {{path|/etc/tpbrc}}.
You can use an appropriate executable to [[How to inject fake keystrokes|inject fake keystrokes]].

For Debian users, tpb is started from {{path|/etc/X11/Xsession.d/90tpb}}.

'''Sound Button configuration'''

''Note: Tested on T60p with Ubuntu 6.06 LTS''

Most Thinkpads have a hardware sound mixer, thus the volumes buttons should work without configuration. However, this change is not reflected in the software mixer. tpb has a switch to enable software mixer support via OSS. The manual recommends this only for devices without a hardware mixer, but it also works for other hadware mixer enabled devices, even with the ALSA system. Just put MIXER ON in your {{path|/etc/tpbrc}} file and you can see the effect immediately in any ALSA mixer (e.g. kmix). For this to work you need write permissions to {{path|/dev/nvram}}.

''Note: Tested on X21 with Ubuntu 6.06 LTS''

On the ThinkPad X21 (and maybe some other older models) ACPI causes problems with tpb. On an X21 using acpi the volume buttons would work occasionally, and the OSD for tpb functions would rarely work. If a volume buttons was pressed too often, sometimes the computer would enter a low power (unplugged state) and would require a reboot. The solution is to use APM instead of ACPI. Instructions can be found in [[How_to_make_APM_work]].

===KMilo configuration===
The programs to be executed by [[KMilo]] are configured via the KDE Control Center (<tt>kcontrol</tt>), under <tt>System Administration --> IBM Thinkpad Laptop</tt>. Note that you can use appropriate commands to [[How to inject fake keystrokes|inject fake keystrokes]].

===xmodmap configuration===
xmodmap enables you to edit the modifier map and keymap tables that are used to translate keycodes into keysyms.
Understood? Well, basically it allows you to give the X server a dictionary for the translation of keycodes like "97" into more human readable synonyms like "Home". This way xmodmap allows you to make the special keys of your keyboard known to X applications.

To discover the keycode that a certain keypress produces, use the tool {{cmduser|xev}}

Usually you should write your keycode-keysym associations into the file {{path|~/.Xmodmap}}. This file is usually read by the X session startup scripts of your system, so that the mappings automatically get included everytime you run the X server.

The {{path|~/.Xmodmap}} lines for our purpose are in the form of
keycode <keycode> = <keysym>

Load the assocation using the command

{{cmduser|xmodmap ~/.Xmodmap}}

(some configurations do this automatically upon X startup).

The following table shows the keycodes generated by the ThinkPad special keys and sensible keysyms to assign them to.
{| {{prettytable}}
|+ keycodes and recommended keysyms
! key !! keycode !! keysym
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || 159 || XF86LaunchA
|-
| {{ibmkey|Backward|#494949}} || 234 || XF86Back or F19
|-
| {{ibmkey|Forward|#494949}} || 233 || XF86Forward or F20
|-
| {{ibmkey|Play/Pause|#494949}} || 162 || XF86AudioPlay
|-
| {{ibmkey|Stop|#494949}} || 164 || XF86AudioStop
|-
| {{ibmkey|Next|#494949}} || 153 || XF86AudioNext
|-
| {{ibmkey|Previous|#494949}} || 144 || XF86AudioPrev
|-

| {{ibmkey|Home|#494949}} || 178 || XF86HomePage
|-
| {{ibmkey|Search|#494949}} || 229 || XF86Search
|-
| {{ibmkey|Mail|#494949}} || 236 || XF86Mail
|-
| {{ibmkey|Favorites|#494949}} || 230 || XF86AddFavorite or XF86Favorites
|-
| {{ibmkey|Reload|#494949}} || 231 || XF86Reload
|-
| {{ibmkey|Abort|#494949}} || 232 || XF86Stop
|-
| {{key|Fn}} || 227 || F35
|}

Note: You can also use xkeycaps (an X tool to display and edit the X keyboard mapping) to generate proper .Xmodmap.

Note: if you are running [[tpb]] you might need to add the line <tt>XEVENTS=off</tt> into your tpbrc to stop it from grabbing the key events and allow them to get through to X instead. See [[http://www.thinkwiki.org/wiki/Tpb]] for more detailed instruction on how to use tpb and xmodmap.

Note: XF86Forward and XF86Back do not work correctly in Firefox. You may want to map them to F19 and F20 instead if you use Firefox.

Note: The "XF86AudioPlay" etc. just works with a few programs. To make it work with more multimedia programs you have map the key to use something like [http://www.kde-apps.org/content/show.php/ReMoot?content=63140 ReMoot]. ReMoot is a command line wrapper that control 18 of the most common multimedia applications.

=====Enabling the Windows and Menu Keys=====
On some systems the Windows and Menu keys may not be recognized. You can enable then by
making the following changes:

keycode 115 = F13
keycode 227 = F35

F13 and F35 are used for the Windows and and Menu keys respectively. Labelling keycpode 227 as "Menu" may conflict with the right-mouse-click event.

=====Using Caps Lock as Super L (Windows key)=====
You can easily use Caps Lock as Win key by adding the following in your ~/.Xmodmap:
! No Caps Lock
clear lock
! Caps Lock as Win key
add mod4 = Caps_Lock
=====NumLock=====
On the ThinkPad {{600}}, {{T20}}, {{T21}}, {{T22}}, {{T30}}, {{X20}}, {{X21}}, {{X31}}, {{X40}}, {{T42p}}, {{T43}}, {{R51}}, {{R52}} and possibly other models, X does not recognize the keycode for {{key|NumLk}} = {{key|Shift}}+{{key|ScrLk}}. To fix this, add the following to {{path|~/.Xmodmap}} in your home directory or {{path|/etc/X11/Xmodmap}} and run <tt>xmodmap</tt>, ex: <tt>xmodmap ~/.Xmodmap</tt>:
keycode 77 = Num_Lock

This configuration also enables the respective LED.

Please note, pressing the {{key|Shift}}+{{key|ScrLk}} key combination, without first following the above configuration, will start an accessibility feature, which will allow the numeric keypad to maneuver the mouse pointer. Starting this accessibility feature and subsequently running xmodmap, as described above, results in the accessibility feature and the numeric lock LED functioning simultaneously. As such, the above configuration should be completed before the accessibility feature is started in order to produce numbers.

===Mapping keys with setkeycodes===
You can use the setkeycodes command to remap certain keys. I.e. you can use {{cmdroot|setkeycodes 6e 109 6d 104 69 28 6b 1}} to map the Tablets Up and Down keys to the standard PageUp and PageDown keys and Tablet Escape and Enter to their respective keys.

The following table shows the keycodes generated by the ThinkPad keys.
{| {{prettytable}}
|+ keycodes
! key !! keycode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x6e
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x68
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6c
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || 0x67
|}

==Example Applications==
===Web Browsers===
====Firefox====

There are various ways to assign actions to the browser keys. The easiest way is to install [http://mozilla.dorando.at/keyconfig.xpi keyconfig.xpi] from http://mozilla.dorando.at, which adds a menu entry Tools->Keyconfig. Then you can assign any action you want to the F19/F20 keys (you still need to create {{path|~/.Xmodmap}} as explained above).

The remaining discussion gives you various more complicated ways to achieve the same thing.
To have firefox make use of the browser keys you need to modify one of its files{{footnote|4}}.
To do this you will first need to extract it from the {{path|browser.jar}} archive. Do...

:{{cmdroot|cd <firefox-directory>/chrome}} 
:{{cmdroot|unzip browser.jar}}

The file of interest is {{path|content/browser/browser.xul}}. Edit it {and don't forget to make a backup copy first}...
:{{cmdroot|vi content/browser/browser.xul}}

Look for the '''<keyset id="mainKeyset">''' section and add the following lines within...
<key id="goBackKb" keycode="VK_F19" command="Browser:Back" />
<key id="goForwardKb" keycode="VK_F20" command="Browser:Forward" />

The Command you need for Next Tab
<key id="goBackTabKb" keycode="VK_F19" oncommand="gBrowser.mTabContainer.advanceSelectedTab(-1)" />
For the Previous Tab
<key id="goForwardTabKb" keycode="VK_F20" oncommand="gBrowser.mTabContainer.advanceSelectedTab(1)" />

Now save the file and repackage the {{path|browser.jar}} archive...
:{{cmdroot|zip -rD0 browser.jar content/browser/}}

That's it.

{{HINT|For Firefox 2.0, just edit <firefox-directory>/chrome/browser/content/browser/browser.xul}}

{{HINT|Outdated: Another interesting Page on Firefox is http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ It uses different key mappings (F19 resp. F20) but a ready [http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/dqdnavkeys-1.2.xpi .xpi] is provided which is pretty comfortable. However, this xpi file does not install on Firefox 1.5. or later.}}

{{HINT|Outdated: You can also use the [http://extensionroom.mozdev.org/more-info/keyconfig keyconfig] extension to configure custom keys. This extension works with Firefox 1.5 but not with Firefox 2.0. The Command you need for Next Tab is gBrowser.mTabContainer.advanceSelectedTab(1,true); For Previous Tab its gBrowser.mTabContainer.advanceSelectedTab(-1,true); }}.

====Konqueror====
KDE allows you set key mappings for KDE applications (Go to KMenu > System > Control Center > Regional & Accessibility > Keyboard Shortcuts). By default (at least in KDE 3.5), XF86Back and XF86Forward are set as alternatives to Alt-Left and Alt-Right, and are mapped to KDE Back and Forward navigation actions.

If you use Konqueror as your only browser, you only need to set up {{path|~/.Xmodmap}} as described [[#xmodmap configuration|above]] to assign ThinkPad back/forward keys to the symbols XF86Back/XF86Forward. This also make these keys work for other KDE applications such as Quanta Plus, KPackage and so on (not all KDE applications honor this setting, e.g. KDE help system doesn't).

If you want to use Firefox, however, the above settings do not work. You will have to map ThinkPad back/forward keys to F19/F20 as described [[#Firefox|above]], and change KDE navigation key settings to use F19/F20 instead of the default.

====Opera====
However this isn't a simple configration file, you can set your browser manually. 
Go to Tool > Settings > Mouse and keyboard > Keyboard settings > Edit > Browser Window. There add F19 - Back and F20 - Forward. Now you can surf using your TP keys ;-)

===Window Managers===
====fvwm====
To get the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fvwmrc}}:
Key XF86Back A A Scroll -100000 0
Key XF86Forward A A Scroll +100000 0
If you use multiple virtual desktops, you could instead use the keys to flip between them by using GotoDesk.

====fluxbox====
To get the keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fluxbox/keys}}:
None F19 :PrevWorkspace
None F20 :NextWorkspace

====pekwm configuration====
You can make the two browser keys switch workspaces in pekwm, by adding the following two lines to the {{path|~/.pekwm/keys}} file:
KeyPress = "Mod1 XF86Back" { Actions = "GoToWorkspace prev" }
KeyPress = "Mod1 XF86Forward" { Actions = "GoToWorkspace next" }

====pwm====
Another example how to use these two keys to switch between pwm tabs. These two lines should be added to {{path|~/.pwm/keys-default.conf}} or {{path|/etc/pwm/keys-default.conf}}:
kbind "Back", "switch_rot", -1
kbind "Forward", "switch_rot", 1

====IceWM====
To make IceWM cycle workspaces using the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys, change these two options in {{path|~/.icewm/preferences}} (Provided you assigned keysyms F19 and F20 with xmodmap):
# "Previous workspace" shortcut
KeySysWorkspacePrev="F19"
# "Next workspace" shortcut
KeySysWorkspaceNext="F20"

==== Gnome/metacity ====

Follow the [https://wiki.ubuntu.com/Keybindings Ubuntu guide].

===Other Uses===
====Console tools configuraton====
To make the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys useful in console, add this to your keymap ({{path|/etc/console/boottime.kmap.gz}} in {{Debian}}):
keycode 158 = Decr_Console
keycode 159 = Incr_Console

Alternatively you can load this script (perhaps on system startup) to enable Backward/Forward button console (VT) switch:

#!/bin/sh
echo keycode 158 = Decr_Console | loadkeys
echo keycode 159 = Incr_Console | loadkeys

It should work with any distro.

====Cycling through tabs====
In Gnome and Xfce4, Ctrl-PageUp/Ctrl-PageDown move to the previous/following open tab in all applications that have tabbed user interfaces (terminal emulator, web browser, ...). To make use of the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys for this task, there're two possibilities.

For both ways, you should map the keycodes 233 and 234 to XF86Back and XF86Forward as described in [[#xmodmap_configuration|xmodmap configuration]].

=====Using xautomation=====
xautomation can be found [http://hoopajoo.net/projects/xautomation.html here].

Create two files with permissions 755:

{{path|/usr/local/bin/tp_back}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Up' 'keyup Page_Up' 'keyup Control_L'
</bash>

{{path|/usr/local/bin/tp_forward}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Down' 'keyup Page_Down' 'keyup Control_L'
</bash>

Use your desktop's keyboard shortcut editor to assign XF86Back as a shortcut for tp_back and XF86Forward as a shortcut for tp_forward.

This should work in all distros and with all window managers (you might have to use other key combinations than Ctrl-PageUp and Ctrl-PageDown).

=====Redirecting XF86Back/XF86Forward=====
Create {{path|/etc/X11/xkb/compat/thinkpad}}:
<pre>
// $XFree86$
// XFree86 special keysyms
default partial xkb_compatibility "basic" {
interpret.repeat= True;

interpret XF86Back {
action = Redirect(Key=<PGUP>, modifiers=Control);
};
interpret XF86Forward {
action = Redirect(Key=<PGDN>, modifiers=Control);
};
};
</pre>

Edit {{path|/etc/X11/xkb/compat/complete}} and add 'augment "thinkpad"' so that it looks similar to the following:
<pre>
// $XKeyboardConfig: xkbdesc/compat/complete,v 1.3 2005/10/17 00:42:11 svu Exp $
// $Xorg: complete,v 1.3 2000/08/17 19:54:34 cpqbld Exp $
default xkb_compatibility "complete" {
include "basic"
augment "iso9995"
augment "mousekeys"
augment "accessx(full)"
augment "misc"
augment "xfree86"
augment "level5"
augment "thinkpad"
};
</pre>

==External Sources==
*[http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-51537 IBMs page on configuring the ThinkPad buttons (ThinkPad, Access IBM, Mail, Search, and Home buttons) under Linux]
*[http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ Rob Mayoffs page on using IBM Keyboard Navigation Keys in Linux Mozilla and Firefox]
*[http://snarfed.org/space/thinkpad+keys+in+firefox Ryan Barretts blog article about using the browser keys in Firefox]
*[http://chaotika.org/~bluesceada/?page=soft&sub=thinkpad#acpibutn DennisG's help to get the ibm-acpi buttons do useful things] on a {{Z61e}} and possibly {{Z61m}}, {{Z61t}} and {{Z61p}}

{{footnotes|
#Note that the associated functionality for Fn-F* key combinations is not consistent amongst all ThinkPads. We are maintaining [[Default meanings of special keys|a table of associated meanings]].
#if there are more than one tool listed, one is sufficient
#'full' means you can completely reassign any action to be triggered by the key, 'additional actions' means you can trigger actions in addition to the standard function of the key, which can not be changed.
#Thanks go to Ryan Barrett for writing the [http://snarfed.org/space/thinkpad+keys+in+firefox little howto] on [http://snarfed.org/space/start his blog].
}}

How to get special keys to work

2007-11-27T18:37:43Z

Whoopie: /* Cycling through tabs */ add a second possibility

==Overview==
The following table gives an overview over the special keys found on ThinkPads and what is needed to make them work.
{| {{prettytable}}
! key !! standard function{{footnote|1}} !! tools supporting key{{footnote|2}} !! configurability{{footnote|3}} !! remarks
|-
| {{key|Fn}} || - || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || on release without completed key combination
|-
| {{key|Fn}}{{key|F1}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F2}} || lock screen || [[#ibm-acpi events|ibm-acpi]] || full || in models from T/X/Z 60 onwards
|-
| {{key|Fn}}{{key|F3}} || blank screen || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F4}} || suspend to ram || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|F5}} || switch bluetooth || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || in models starting from 2002
|-
| {{key|Fn}}{{key|F6}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F7}} || toggle display || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions || [[Sample Fn-F7 script]]
|-
| {{key|Fn}}{{key|F8}} || toggle trackpoint/touchpad || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions ||
|-
| {{key|Fn}}{{key|F9}} || eject from dock || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F10}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F11}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|F12}} || hibernate || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the ibm-acpi hotkey mask
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || brightness up || [[#ibm-acpi events|ibm-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|End}} || brightness down || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|PageUp}} || toggle thinklight || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|Space}} || toggle zoom || [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{key|Fn}}{{key|Ins}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|Del}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|Fn}}{{key|Backspace}} || - || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{key|NumLock}} || - || [[#xmodmap configuration|xmodmap]] || make working ||
|-
| {{key|Windows}} || - || [[#xmodmap configuration|xmodmap]] || remapping ||
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || help application || [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{ibmkey|Home|#494949}} || open web browser || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Search|#494949}} || open search application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Mail|#494949}} || open mail application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Favorites|#494949}} || open favorites || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Reload|#494949}} || reload web page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Abort|#494949}} || abort loading page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Backward|#494949}} || previous page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Forward|#494949}} || next page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Volume up|#494949}} || volume up || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume down|#494949}} || volume down || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume mute|#494949}} || mute volume || [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Play/Pause|#494949}} || start/pause playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Down)
|-
| {{ibmkey|Stop|#494949}} || stop playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Up)
|-
| {{ibmkey|Next|#494949}} || play next || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Right)
|-
| {{ibmkey|Previous|#494949}} || play previous || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Left)
|-
| {{ibmkey|Power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| Display lid || blank screen || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| Ultrabay lid || announce ultrabay change || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| Dock eject || eject from dock || [[#ibm-acpi events|ibm-acpi]] || full ||
|-
| {{ibmkey|Tablet power|#494949}} || shutdown || [[#ibm-acpi events|ibm-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| {{ibmkey|Tablet orientation|#494949}} || rotates screen || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet shortcut|#494949}} || shortcut menu || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Esc|#494949}} || esc key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Enter|#494949}} || enter key || [[#mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Up|#494949}} || up key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Down|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|}

==Triggering key events==
===ibm-acpi events===
Some of the following events require a {{cmdroot|echo enable,0xffff >/proc/acpi/ibm/hotkey}} in order to make acpi able to get information on them. These events can be used to [[How to configure acpid|configure acpid]].

{| {{prettytable}}
|+ events triggered by [[ibm-acpi]] for {{path|/etc/acpi/events}} files.
! key !! event
|-
| {{key|Fn}}{{key|F1}} || ibm/hotkey HKEY 00000080 00001001
|-
| {{key|Fn}}{{key|F2}} || ibm/hotkey HKEY 00000080 00001002
|-
| {{key|Fn}}{{key|F3}} || ibm/hotkey HKEY 00000080 00001003
|-
| {{key|Fn}}{{key|F4}} || ibm/hotkey HKEY 00000080 00001004
|-
| {{key|Fn}}{{key|F5}} || ibm/hotkey HKEY 00000080 00001005
|-
| {{key|Fn}}{{key|F6}} || ibm/hotkey HKEY 00000080 00001006
|-
| {{key|Fn}}{{key|F7}} || ibm/hotkey HKEY 00000080 00001007
|-
| {{key|Fn}}{{key|F8}} || ibm/hotkey HKEY 00000080 00001008
|-
| {{key|Fn}}{{key|F9}} || ibm/hotkey HKEY 00000080 00001009
|-
| {{key|Fn}}{{key|F10}} || ibm/hotkey HKEY 00000080 0000100a
|-
| {{key|Fn}}{{key|F11}} || ibm/hotkey HKEY 00000080 0000100b
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c
|-
| {{key|Fn}}{{key|Backspace}} || ibm/hotkey HKEY 00000080 0000100d
|-
| {{key|Fn}}{{key|Ins}} || ibm/hotkey HKEY 00000080 0000100e
|-
| {{key|Fn}}{{key|Del}} || ibm/hotkey HKEY 00000080 0000100f
|-
| {{key|Fn}}{{key|Home}}/{{key|Fn}}{{key|Pos1}} || ibm/hotkey HKEY 00000080 00001010
|-
| {{ibmkey|ThinkVantage|#495988}} ||ibm/hotkey HKEY 00000080 00001018
|-
| {{ibmkey|Power|#494949}} || button/power PWRF 00000080 xxxxxxxx
|-
| Display lid || button/lid LID 00000080 xxxxxxxx
|-
| Ultrabay eject || ibm/bay MSTR 00000003 00000000
|-
| Ultrabay inserted || ibm/bay MSTR 00000001 00000000
|-
| Dock eject || ibm/dock GDCK 00000003 00000001
|-
| Wireless switch || ibm/hotkey HKEY 00000080 00007000
|}

By disassembling and editing the DSDT, more events can be added. HKEY events are triggered by calls to the MKHQ function, e.g. <tt>\_SB.PCI0.LPC.EC.HKEY.MHKQ(0Ã—1007)</tt> will trigger "ibm/hotkey HKEY 00000080 00001007". Most of these can be found in <tt>_Qxx</tt> methods within the DSDT, which are executed on embedded controller events, e.g. _Q10 is triggered by pressing Fn-F7. You can add a call to MKHQ into an existing <tt>_Qxx</tt> method to get it recognized by ibm-acpi as well as creating new <tt>_Qxx</tt> methods, which if you're lucky will correspond to an EC event that IBM never used (e.g. A 770 will send Fn-Home/End/PgUp/PgDn to ibm-acpi if hacked in this fashion). For example, [http://www.wormnet.eu/ibm-g40/morebuttons.dsl this is a modified block of DSDT for a G40].

=== Pure ACPI events ===

A few keys can generate ACPI events of their own on certain ThinkPads, as long as they are masked off in the ibm-acpi hotkey's mask (or the hotkey feature is disabled in ibm-acpi).

If you want the ThinkPad's BIOS and ACPI methods to know about these keys being pressed, you probably want to leave them masked out from ibm-acpi, and use their non-HKEY events listed below, instead.

{| {{prettytable}}
|+ events triggered by ACPI when hotkey is masked out or disabled.
! key !! event
|-
| {{key|Fn}}{{key|F4}} || button/sleep SLPB 00000080 00000001
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c
|}

===tpb configuration===
{| {{prettytable}}
|+ configuration keywords for [[tpb]] (to put in {{path|/etc/tpbrc}})
! key !! config keyword
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || THINKPAD
|-
| {{ibmkey|Home|#494949}} || HOME
|-
| {{ibmkey|Search|#494949}} || SEARCH
|-
| {{ibmkey|Mail|#494949}} || MAIL
|-
| {{ibmkey|Favorites|#494949}} || FAVORITES
|-
| {{ibmkey|Reload|#494949}} || RELOAD
|-
| {{ibmkey|Abort|#494949}} || ABORT
|-
| {{ibmkey|Backward|#494949}} || BACKWARD
|-
| {{ibmkey|Forward|#494949}} || FORWARD
|-
| {{key|Fn}} || FN
|-
| {{key|Fn}}{{key|Space}} || CALLBACK (zoom on/off)
|-
| {{key|Fn}}{{key|PageUp}} || CALLBACK (thinklight on/off)
|-
| {{key|Fn}}{{key|F7}} || CALLBACK (display lcd/crt/both)
|-
| {{key|Fn}}{{key|F8}} || CALLBACK (expand on/off)
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || CALLBACK (brightness <percent>)
|-
| {{key|Fn}}{{key|End}} || CALLBACK (brightness <percent>)
|-
| {{ibmkey|Volume up|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume down|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume mute|#494949}} || CALLBACK (mute on/off)
|}

To all parameter keywords should be assigned the full path to the executables supposed to be started on key press.
The exectable provided for the CALLBACK keyword should take the parameters given in parentheses and act according to them.
If you want to use xmodmap for the HOME, SEARCH, MAIL, FAVORITES, RELOAD, ABORT, BACKWARD, FORWARD and FN keys you should
provide a <tt>XEVENTS OFF</tt> in your {{path|/etc/tpbrc}}.
You can use an appropriate executable to [[How to inject fake keystrokes|inject fake keystrokes]].

For Debian users, tpb is started from {{path|/etc/X11/Xsession.d/90tpb}}.

'''Sound Button configuration'''

''Note: Tested on T60p with Ubuntu 6.06 LTS''

Most Thinkpads have a hardware sound mixer, thus the volumes buttons should work without configuration. However, this change is not reflected in the software mixer. tpb has a switch to enable software mixer support via OSS. The manual recommends this only for devices without a hardware mixer, but it also works for other hadware mixer enabled devices, even with the ALSA system. Just put MIXER ON in your {{path|/etc/tpbrc}} file and you can see the effect immediately in any ALSA mixer (e.g. kmix). For this to work you need write permissions to {{path|/dev/nvram}}.

''Note: Tested on X21 with Ubuntu 6.06 LTS''

On the ThinkPad X21 (and maybe some other older models) ACPI causes problems with tpb. On an X21 using acpi the volume buttons would work occasionally, and the OSD for tpb functions would rarely work. If a volume buttons was pressed too often, sometimes the computer would enter a low power (unplugged state) and would require a reboot. The solution is to use APM instead of ACPI. Instructions can be found in [[How_to_make_APM_work]].

===KMilo configuration===
The programs to be executed by [[KMilo]] are configured via the KDE Control Center (<tt>kcontrol</tt>), under <tt>System Administration --> IBM Thinkpad Laptop</tt>. Note that you can use appropriate commands to [[How to inject fake keystrokes|inject fake keystrokes]].

===xmodmap configuration===
xmodmap enables you to edit the modifier map and keymap tables that are used to translate keycodes into keysyms.
Understood? Well, basically it allows you to give the X server a dictionary for the translation of keycodes like "97" into more human readable synonyms like "Home". This way xmodmap allows you to make the special keys of your keyboard known to X applications.

To discover the keycode that a certain keypress produces, use the tool {{cmduser|xev}}

Usually you should write your keycode-keysym associations into the file {{path|~/.Xmodmap}}. This file is usually read by the X session startup scripts of your system, so that the mappings automatically get included everytime you run the X server.

The {{path|~/.Xmodmap}} lines for our purpose are in the form of
keycode <keycode> = <keysym>

Load the assocation using the command

{{cmduser|xmodmap ~/.Xmodmap}}

(some configurations do this automatically upon X startup).

The following table shows the keycodes generated by the ThinkPad special keys and sensible keysyms to assign them to.
{| {{prettytable}}
|+ keycodes and recommended keysyms
! key !! keycode !! keysym
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || 159 || XF86LaunchA
|-
| {{ibmkey|Backward|#494949}} || 234 || XF86Back or F19
|-
| {{ibmkey|Forward|#494949}} || 233 || XF86Forward or F20
|-
| {{ibmkey|Play/Pause|#494949}} || 162 || XF86AudioPlay
|-
| {{ibmkey|Stop|#494949}} || 164 || XF86AudioStop
|-
| {{ibmkey|Next|#494949}} || 153 || XF86AudioNext
|-
| {{ibmkey|Previous|#494949}} || 144 || XF86AudioPrev
|-

| {{ibmkey|Home|#494949}} || 178 || XF86HomePage
|-
| {{ibmkey|Search|#494949}} || 229 || XF86Search
|-
| {{ibmkey|Mail|#494949}} || 236 || XF86Mail
|-
| {{ibmkey|Favorites|#494949}} || 230 || XF86AddFavorite or XF86Favorites
|-
| {{ibmkey|Reload|#494949}} || 231 || XF86Reload
|-
| {{ibmkey|Abort|#494949}} || 232 || XF86Stop
|-
| {{key|Fn}} || 227 || F35
|}

Note: You can also use xkeycaps (an X tool to display and edit the X keyboard mapping) to generate proper .Xmodmap.

Note: if you are running [[tpb]] you might need to add the line <tt>XEVENTS=off</tt> into your tpbrc to stop it from grabbing the key events and allow them to get through to X instead. See [[http://www.thinkwiki.org/wiki/Tpb]] for more detailed instruction on how to use tpb and xmodmap.

Note: XF86Forward and XF86Back do not work correctly in Firefox. You may want to map them to F19 and F20 instead if you use Firefox.

Note: The "XF86AudioPlay" etc. just works with a few programs. To make it work with more multimedia programs you have map the key to use something like [http://www.kde-apps.org/content/show.php/ReMoot?content=63140 ReMoot]. ReMoot is a command line wrapper that control 18 of the most common multimedia applications.

=====Enabling the Windows and Menu Keys=====
On some systems the Windows and Menu keys may not be recognized. You can enable then by
making the following changes:

keycode 115 = F13
keycode 227 = F35

F13 and F35 are used for the Windows and and Menu keys respectively. Labelling keycpode 227 as "Menu" may conflict with the right-mouse-click event.

=====Using Caps Lock as Super L (Windows key)=====
You can easily use Caps Lock as Win key by adding the following in your ~/.Xmodmap:
! No Caps Lock
clear lock
! Caps Lock as Win key
add mod4 = Caps_Lock
=====NumLock=====
On the ThinkPad {{600}}, {{T20}}, {{T21}}, {{T22}}, {{T30}}, {{X20}}, {{X21}}, {{X31}}, {{X40}}, {{T42p}}, {{T43}}, {{R51}}, {{R52}} and possibly other models, X does not recognize the keycode for {{key|NumLk}} = {{key|Shift}}+{{key|ScrLk}}. To fix this, add the following to {{path|~/.Xmodmap}} in your home directory or {{path|/etc/X11/Xmodmap}} and run <tt>xmodmap</tt>, ex: <tt>xmodmap ~/.Xmodmap</tt>:
keycode 77 = Num_Lock

This configuration also enables the respective LED.

Please note, pressing the {{key|Shift}}+{{key|ScrLk}} key combination, without first following the above configuration, will start an accessibility feature, which will allow the numeric keypad to maneuver the mouse pointer. Starting this accessibility feature and subsequently running xmodmap, as described above, results in the accessibility feature and the numeric lock LED functioning simultaneously. As such, the above configuration should be completed before the accessibility feature is started in order to produce numbers.

===Mapping keys with setkeycodes===
You can use the setkeycodes command to remap certain keys. I.e. you can use {{cmdroot|setkeycodes 6e 109 6d 104 69 28 6b 1}} to map the Tablets Up and Down keys to the standard PageUp and PageDown keys and Tablet Escape and Enter to their respective keys.

The following table shows the keycodes generated by the ThinkPad keys.
{| {{prettytable}}
|+ keycodes
! key !! keycode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x6e
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x68
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6c
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || 0x67
|}

==Example Applications==
===Web Browsers===
====Firefox====

There are various ways to assign actions to the browser keys. The easiest way is to install [http://mozilla.dorando.at/keyconfig.xpi keyconfig.xpi] from http://mozilla.dorando.at, which adds a menu entry Tools->Keyconfig. Then you can assign any action you want to the F19/F20 keys (you still need to create {{path|~/.Xmodmap}} as explained above).

The remaining discussion gives you various more complicated ways to achieve the same thing.
To have firefox make use of the browser keys you need to modify one of its files{{footnote|4}}.
To do this you will first need to extract it from the {{path|browser.jar}} archive. Do...

:{{cmdroot|cd <firefox-directory>/chrome}} 
:{{cmdroot|unzip browser.jar}}

The file of interest is {{path|content/browser/browser.xul}}. Edit it {and don't forget to make a backup copy first}...
:{{cmdroot|vi content/browser/browser.xul}}

Look for the '''<keyset id="mainKeyset">''' section and add the following lines within...
<key id="goBackKb" keycode="VK_F19" command="Browser:Back" />
<key id="goForwardKb" keycode="VK_F20" command="Browser:Forward" />

The Command you need for Next Tab
<key id="goBackTabKb" keycode="VK_F19" oncommand="gBrowser.mTabContainer.advanceSelectedTab(-1)" />
For the Previous Tab
<key id="goForwardTabKb" keycode="VK_F20" oncommand="gBrowser.mTabContainer.advanceSelectedTab(1)" />

Now save the file and repackage the {{path|browser.jar}} archive...
:{{cmdroot|zip -rD0 browser.jar content/browser/}}

That's it.

{{HINT|For Firefox 2.0, just edit <firefox-directory>/chrome/browser/content/browser/browser.xul}}

{{HINT|Outdated: Another interesting Page on Firefox is http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ It uses different key mappings (F19 resp. F20) but a ready [http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/dqdnavkeys-1.2.xpi .xpi] is provided which is pretty comfortable. However, this xpi file does not install on Firefox 1.5. or later.}}

{{HINT|Outdated: You can also use the [http://extensionroom.mozdev.org/more-info/keyconfig keyconfig] extension to configure custom keys. This extension works with Firefox 1.5 but not with Firefox 2.0. The Command you need for Next Tab is gBrowser.mTabContainer.advanceSelectedTab(1,true); For Previous Tab its gBrowser.mTabContainer.advanceSelectedTab(-1,true); }}.

====Konqueror====
KDE allows you set key mappings for KDE applications (Go to KMenu > System > Control Center > Regional & Accessibility > Keyboard Shortcuts). By default (at least in KDE 3.5), XF86Back and XF86Forward are set as alternatives to Alt-Left and Alt-Right, and are mapped to KDE Back and Forward navigation actions.

If you use Konqueror as your only browser, you only need to set up {{path|~/.Xmodmap}} as described [[#xmodmap configuration|above]] to assign ThinkPad back/forward keys to the symbols XF86Back/XF86Forward. This also make these keys work for other KDE applications such as Quanta Plus, KPackage and so on (not all KDE applications honor this setting, e.g. KDE help system doesn't).

If you want to use Firefox, however, the above settings do not work. You will have to map ThinkPad back/forward keys to F19/F20 as described [[#Firefox|above]], and change KDE navigation key settings to use F19/F20 instead of the default.

====Opera====
However this isn't a simple configration file, you can set your browser manually. 
Go to Tool > Settings > Mouse and keyboard > Keyboard settings > Edit > Browser Window. There add F19 - Back and F20 - Forward. Now you can surf using your TP keys ;-)

===Window Managers===
====fvwm====
To get the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fvwmrc}}:
Key XF86Back A A Scroll -100000 0
Key XF86Forward A A Scroll +100000 0
If you use multiple virtual desktops, you could instead use the keys to flip between them by using GotoDesk.

====fluxbox====
To get the keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fluxbox/keys}}:
None F19 :PrevWorkspace
None F20 :NextWorkspace

====pekwm configuration====
You can make the two browser keys switch workspaces in pekwm, by adding the following two lines to the {{path|~/.pekwm/keys}} file:
KeyPress = "Mod1 XF86Back" { Actions = "GoToWorkspace prev" }
KeyPress = "Mod1 XF86Forward" { Actions = "GoToWorkspace next" }

====pwm====
Another example how to use these two keys to switch between pwm tabs. These two lines should be added to {{path|~/.pwm/keys-default.conf}} or {{path|/etc/pwm/keys-default.conf}}:
kbind "Back", "switch_rot", -1
kbind "Forward", "switch_rot", 1

====IceWM====
To make IceWM cycle workspaces using the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys, change these two options in {{path|~/.icewm/preferences}} (Provided you assigned keysyms F19 and F20 with xmodmap):
# "Previous workspace" shortcut
KeySysWorkspacePrev="F19"
# "Next workspace" shortcut
KeySysWorkspaceNext="F20"

==== Gnome/metacity ====

Follow the [https://wiki.ubuntu.com/Keybindings Ubuntu guide].

===Other Uses===
====Console tools configuraton====
To make the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys useful in console, add this to your keymap ({{path|/etc/console/boottime.kmap.gz}} in {{Debian}}):
keycode 158 = Decr_Console
keycode 159 = Incr_Console

Alternatively you can load this script (perhaps on system startup) to enable Backward/Forward button console (VT) switch:

#!/bin/sh
echo keycode 158 = Decr_Console | loadkeys
echo keycode 159 = Incr_Console | loadkeys

It should work with any distro.

====Cycling through tabs====
In Gnome and Xfce4, Ctrl-PageUp/Ctrl-PageDown move to the previous/following open tab in all applications that have tabbed user interfaces (terminal emulator, web browser, ...). To make use of the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys for this task, there're two possibilities.

For both ways, you should map the keycodes 233 and 234 to XF86Back and XF86Forward as described in [[#xmodmap_configuration|xmodmap configuration]].

=====Using xautomation=====
xautomation can be found [http://hoopajoo.net/projects/xautomation.html here].

Create two files with permissions 755:

{{path|/usr/local/bin/tp_back}}:
<pre>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Up' 'keyup Page_Up' 'keyup Control_L'
</pre>

{{path|/usr/local/bin/tp_forward}}:
<pre>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Down' 'keyup Page_Down' 'keyup Control_L'
</pre>

Use your desktop's keyboard shortcut editor to assign XF86Back as a shortcut for tp_back and XF86Forward as a shortcut for tp_forward.

This should work in all distros and with all window managers (you might have to use other key combinations than Ctrl-PageUp and Ctrl-PageDown).

=====Redirecting XF86Back/XF86Forward=====
Create {{path|/etc/X11/xkb/compat/thinkpad}}:
<pre>
// $XFree86$
// XFree86 special keysyms
default partial xkb_compatibility "basic" {
interpret.repeat= True;

interpret XF86Back {
action = Redirect(Key=<PGUP>, modifiers=Control);
};
interpret XF86Forward {
action = Redirect(Key=<PGDN>, modifiers=Control);
};
};
</pre>

Edit {{path|/etc/X11/xkb/compat/complete}} and add 'augment "thinkpad"' so that it looks similar to the following:
<pre>
// $XKeyboardConfig: xkbdesc/compat/complete,v 1.3 2005/10/17 00:42:11 svu Exp $
// $Xorg: complete,v 1.3 2000/08/17 19:54:34 cpqbld Exp $
default xkb_compatibility "complete" {
include "basic"
augment "iso9995"
augment "mousekeys"
augment "accessx(full)"
augment "misc"
augment "xfree86"
augment "level5"
augment "thinkpad"
};
</pre>

==External Sources==
*[http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-51537 IBMs page on configuring the ThinkPad buttons (ThinkPad, Access IBM, Mail, Search, and Home buttons) under Linux]
*[http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ Rob Mayoffs page on using IBM Keyboard Navigation Keys in Linux Mozilla and Firefox]
*[http://snarfed.org/space/thinkpad+keys+in+firefox Ryan Barretts blog article about using the browser keys in Firefox]
*[http://chaotika.org/~bluesceada/?page=soft&sub=thinkpad#acpibutn DennisG's help to get the ibm-acpi buttons do useful things] on a {{Z61e}} and possibly {{Z61m}}, {{Z61t}} and {{Z61p}}

{{footnotes|
#Note that the associated functionality for Fn-F* key combinations is not consistent amongst all ThinkPads. We are maintaining [[Default meanings of special keys|a table of associated meanings]].
#if there are more than one tool listed, one is sufficient
#'full' means you can completely reassign any action to be triggered by the key, 'additional actions' means you can trigger actions in addition to the standard function of the key, which can not be changed.
#Thanks go to Ryan Barrett for writing the [http://snarfed.org/space/thinkpad+keys+in+firefox little howto] on [http://snarfed.org/space/start his blog].
}}

Pentium M undervolting and underclocking

2007-11-24T10:48:44Z

Whoopie: /* Alternative 0: linux-phc */ make the link working

== Background ==

Intel Pentium M processors from the [[Intel Pentium M (Dothan)|Dothan]] and [[Intel Pentium M (Banias)|Banias]] families can be instructed to operate at voltage and clock frequencies lower than the nominal ones recommended by Intel and used by ThinkPads by default. Experience shows that the processor may continue working correctly at lower-than-nominal voltages and frequencies, thereby reducing power consumption, heat and fan noise.

In the Pentium M, speed and voltage are controlled by software (through the MSR registers). It is up to the operating system to choose the right voltage for each frequency. Normally this is done according to tables published by Intel or according to ACPI tables. However, this can be overriden - in the case of Linux, by a kernel patch.

{{WARN|Following this instructions will operate your CPU under conditions it was not designed for. Even if your system seems stable, it may still suffer transient faults leading to arbitrary data corruption. In addition, errors in following these instructions (or changes between processor models) may operate the CPU ''above'' its nominal parameters, which, if taken too far, can cause kernel panics or even possibly hardware damage}}

For an example of what may be achieved, consider these examples: when voltages on one ThinkPad {{T43}} were reduced by 20-30%, stable CPU temperature dropped by 7-10deg under both idle and burn-in conditions. Combined with [[how to control fan speed|fan speed control]], this greatly reduced the [[Problem with fan noise|problem with fan noise]]. On one user's ThinkPad {{R51}}, an undervolt brought the full-load processor temperature down from 87 degrees to 63 degrees while maintaining full stability. The effect was, however, negligible at idle.

{{NOTE|While under''volting'' has a clear measurable effect, it's not clear if under''clocking'' really works. <tt>/proc/cpuinfo</tt> reflects the underclocked frequency, but enabling debug output on <tt>cpufreq</tt> causes it to say things like "<tt>CPU frequency out of sync: cpufreq and timing core thinks of 533000, is 800000 kHz.</tt>" where the former is the chosen underclocked frequency and the latter is the documented minimum frequency. This discrepancy also causes [[Software Suspend 2]] to oops during suspend.}}

There are several methods to control CPU voltage in Linux, and currently all of them require a patched kernel.

==Alternative 0: linux-phc==

Use the [[linux-phc]] kernel patch. '''This is the recommended method, as it is most generic and best supported.'''
* [http://phc.athousandnights.de/ linux-phc home page]

The sysfs interface of linux-phc (version 0.3.0 or newer) requires you to specify VID (Voltage ID) numbers; see the documentation in the source package. For pre-Core Intel CPUs, VID is related to voltage (in mV) as follows: <tt>VID=(voltage-700)/16</tt>.

A typical configuration command would look something like this:

{{cmdroot|echo '27 22 16 10 3' > /sys/devices/system/cpu/cpu0/cpufreq/phc_vids}}

== Alternative 1: patch with hard-coded voltages ==
=== Instructions ===

# Determine the stable voltages for each frequency, using some overclocking/undervolting utility that has specific support for Pentium M ("Centrino") processors. It seems that no such utility exists for Linux. For windows, one good choice is [http://www.pbus-167.com/chc.htm Notebook Hardware Control (NHC)], which conveniently also includes a table of nominal frequencies and voltages (in its help file). Ascertain that at the undervolted settings the CPU actually performs correct computation ([http://www.mersenne.org/freesoft.htm Prime95] in "Tortute Test" mode seems to be a good partial test emphasizing FPU and memory access). Note that beside reducing voltages (undervolting), you can also try to add lower frequencies (underclocking). If you undervolt a particular frequency too much your machine is likely to crash, so try not to have any other programs open.
# Determine the model name string reported by the CPU, e.g., via the "<tt>Model name</tt>" line in {{path|/proc/cpuinfo}}, and likewise the <tt>cpu_family</tt>, <tt>model</tt> and <tt>stepping</tt>.
# Grab a copy of the example patch below and update it to reflect the parameters, frequencies and voltages you found.
# Apply the patch to your kernel (tested with 2.6.13.1 and 2.6.14-rc2).
# To prevent the ACPI table from overriding your table, disable the <tt>CONFIG_X86_SPEEDSTEP_CENTRINO_ACPI</tt> kernel option.
# Compile and install the new kernel.

The changes should be active now. If you want to see debug information attesting to thus, do the following:

# Reboot in <tt>single</tt> mode.
# {{cmdroot|echo 2 > /sys/module/cpufreq/parameters/debug}}
# {{cmdroot|modprobe speedstep-centrino}}
# {{cmdroot|dmesg}} and check for the message "<tt>speedstep-centrino: found "Intel(R) Pentium(R) M processor </tt>..."

If you don't see that message, you got the <tt>cpu_id</tt> or <tt>model_name</tt> parmaeters wrong. If your system crashes, re-test the voltages and adjust accordingly.

Please report your results (including voltages)!

=== Linux kernel patch (example) ===

The following example shows how to undervolt a Pentium M 750 (1.86GHz) on a ThinkPad {{T43}}. As discussed above, the parameters are specific to this one CPU. You will need to experimentally find the correct settings for your own CPU and adjust the patch accordingly.

Note that the Pentium M 750 has a 533MHz FSB (quad-pumped 133MHz), hence the use of <tt>OP133</tt>. If you have a Pentium M with 400MHz FSB (i.e., quad-pumped 100MHz, found in [[Intel Pentium M (Banias)|Banias]] and older [[Intel Pentium M (Dothan)|Dothan]]) then in the voltage table change <tt>OP133</tt> to <tt>OP</tt>.

{{CodeRef|undervolt-pentium-m-2.6.13.1.patch}}

Don't forget to disable <tt>CONFIG_X86_SPEEDSTEP_CENTRINO_ACPI</tt>.

==Alternative 2: patch with user-space control==

If you want to use the Ubuntu 2.6.15 Kernel, please have a look at this thread: http://ubuntuforums.org/showthread.php?t=146366

The [http://fabrice.bellamy.club.fr/bdz.undervolt.2005.10.22.a.patch bdz.undervolt.2005.10.22.a.patch] patch, written by Gentoo-Wiki user "Bdz", allows voltages to be changed without reboot.

It presents a userspace interface, as in the following example:
:{{cmdroot|cat /sys/devices/system/cpu/cpu0/cpufreq/voltage_table}}
:{{cmdresult|1356,1356,1356,1356,1356,1356,1356,1244,1116,988}}
:{{cmdroot|echo "1084,1084,1084,1084,1084,1084,1084,988,908,860" >/sys/devices/system/cpu/cpu0/cpufreq/voltage_table}}

The relevant [http://gentoo-wiki.com/HOWTO_Undervolt_a_Pentium_M_CPU page] on Gentoo-Wiki providues further information and some helpful hints and scripts for voltage adjustment.

When applying this patch be sure to keep the "ACPI tables for decoding frequency pairs" option -- this patch only allows adjustment of the voltages for the normal clock speeds as reported by the ACPI table in the BIOS. On some models (e.g., ThinkPad {{T43}}) this does not include all clock speeds supported by the processor.

=Initscript=
This is a Gentoo initscript for the patch from Gentoo-Wiki user "Bdz".

=== Configuration file ===
<bash>
# /etc/conf.d/undervoltage

# voltage table sysfs interface
VTABLE_SYSFS="/sys/devices/system/cpu/cpu0/cpufreq/voltage_table"

# switch back to DEFAULT_VTABLE if undervoltage is stopped? [yes/no]
SWITCH_BACK="no"

# pentium-m banias 1,7GHz default voltages
DEFAULT_VTABLE="1484,1308,1228,1116,1004,956"
# pentium-m banias 1,7GHz lowered voltages [ -208mV ]
MOD_VTABLE="1276,1100,1020,908,796,748"
</bash>

=== Initscript ===
<bash>
#!/sbin/runscript
# Copyright 1999-2005 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $

sysfs_check() {

if ! [ -e ${VTABLE_SYSFS} ]; then
logger "No sysfs voltage_table present. Modifying vcore voltage failed."
eerror "It seems that the undervolting patch has not been applied to the kernel."
eerror "see http://gentoo-wiki.com/HOWTO_Undervolt_a_Pentium_M_CPU for further information"
return 1
fi
}

start() {
sysfs_check || return 1
ebegin "Switching to modified voltage table [${MOD_VTABLE}]"
echo ${MOD_VTABLE} > ${VTABLE_SYSFS}
eend $?
}

# I think it is not necessary to switch to the default voltage table on shutdown
stop() {
if [ $SWITCH_BACK = "yes" ]; then
ebegin "Switching back to default voltage table [${DEFAULT_VTABLE}]"
echo ${DEFAULT_VTABLE} > ${VTABLE_SYSFS}
eend $?
fi
}
</bash>

==Alternative 3: another patch with user-space control==

The [http://avkrok.net/nw8240/centrino-voltages.diff centrino-voltages.diff] patch, written by Rickard Holmberg, also provides user-space control. See [http://avkrok.net/nw8240/ here] and [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-December/030772.html here] for usage.

==Stress Testing==

This [[Undervolt Stress Testing Script|script]] illustrates a very conservative method to stress test your lowered voltage settings.

==Tested frequencies/voltages==

If you have done excessive testing with user defined frequencies (stable system for over a month).
and no lookups occur when computing primes with mprime http://mersenne.org/ (gentoo: 'emerge gimps')
you can post your frequencies here. But note that this is just a rough indication, since the stable values will differ between individual processors, even in the same model.

{| {{prettytable}}
! CPU Type !! GHz !! Frequency Steps
|-
| Pentium-M Banias || 1.6 || 1212,1084,956,860,796,748
|-
| Pentium-M Banias || 1.7 || 1276,1100,1020,908,796,748
|-
| Pentium-M Dothan || 1.4 || 924,892,860,828,796,764,732,700
|-
| Pentium-M Dothan || 1.86 || 1068,972,876,780,700
|-
| Pentium-M SL6F7 || 1.6 || 1196,1052,956,860,780,732
|-
| Pentium-M Dothan || 1.5 || 924,892,860,828,812,796,764,732,700
|-
| Pentium-M Dothan || 2.0 || 1084,940,844,764,748
|}

Following values were obtained with: (running at the same time)
<bash>
nice -n19 glxgears &
mplayer somedivx.avi &
cd /usr/src/linux && make -j2
</bash>
* note1: for pre-Core Intel CPUs, VID is related to voltage (in mV) as follows: VID=(voltage-700)/16 (or: voltage=(VID*16+700) mV)
* note2: when testing for stability you should pay attention to sound too, occasional distortions which disappear after bumping voltage a notch or two
* note3: if you use phc_vids for your script, then take only second number in each pair
{| {{prettytable}}
! Machine !! CPU Type !! GHz !! phc_controls (fid:vid)
|-
| {{X41T}} || Pentium-M Dothan LV (758) || 1.5 || 15:15 14:13 13:11 12:9 11:7 10:5 9:3 8:2 6:2
|-
| {{X32}} || Pentium-M Dothan (745) || 1.8 || 18:26 16:20 14:15 12:11 10:6 8:2 6:1
|}

[[Category:Patches]]

Fglrx

2007-11-22T06:27:13Z

Whoopie: /* Status */ fglrx 7-11 released

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
== ATI fglrx driver ==
This is a proprietary Linux binary-only driver for ATI graphic chips with support for 3D acceleration.

Also see [[R300|opensource driver]] with 3D support
|}

==Availability / Project Homepage==
Home page: http://ati.amd.com/support/drivers/linux/linux-radeon.html

== Packages ==
The ATI drivers have explicit permission for repackaging and redistribution of the Linux drivers. Many distributions are supported within the installer, and many more repackaged by external developers. Please visit the [http://wiki.cchtml.com/index.php/Category:Distributions Distribution Page at the Unofficial ATI driver Wiki]

*{{Debian}}
** These packages have been added to Debian unstable as <tt>fglrx-driver</tt>, so you can now apt-get them and use module-assistant to install.
** If you are on stable sarge with backport's kernel 2.6.15, download ATI's installer, let it build Debian packages and proceed as usual. There's a [http://jroller.com/page/erAck?entry=lot_day_6_2_fglrx detailed description] available.
** [http://wiki.cchtml.com/index.php/Debian_Installation_Guide Debian Howto]
*{{SUSE}} packages: http://www.suse.de/~sndirsch/ati-installer-HOWTO.html
*{{Gentoo}} {{cmdroot|emerge ati-drivers}}
*{{Fedora}} 4 packages: http://rpm.livna.org
** For stock Fedora kernels: {{cmdroot|yum install kernel-module-fglrx-$(uname -r) ati-fglrx }}
** For custom-compiled kernels: see [[How to build custom packages for fglrx]]
*{{Fedora}} 5 packages: http://rpm.livna.org
** For stock Fedora kernels: {{cmdroot|yum install xorg-x11-drv-fglrx}}
** For custom-compiled kernels: see [[How to build custom packages for fglrx]]
*{{Fedora}} 7 packages: http://rpm.livna.org
** The newest version of the driver (8.39.4) is supposed to work with Fedora 7, and is available from Livna.
*{{Arch Linux}}
:{{cmdroot|pacman -S ati-fglrx}} (kernel module for 2.6.15-ARCH)
:{{cmdroot|pacman -S ati-fglrx-archck}} (kernel module for 2.6.15-archck)
:{{cmdroot|pacman -S ati-fglrx-utils}} (xorg7 stuff and tools)
*{{Ubuntu}}
**[http://wiki.cchtml.com/index.php/Ubuntu_Dapper_Installation_Guide Dapper Drake Howto]
**[http://wiki.cchtml.com/index.php/Ubuntu_Breezy_Installation_Guide Breezy Badger Howto]
**[http://wiki.cchtml.com/index.php/Ubuntu_Edgy_Installation_Guide Edgy Eft Howto]
**[http://wiki.cchtml.com/index.php/Ubuntu_Feisty_Installation_Guide Feisty Fawn Howto]

== Building for Xorg 7.0==
To compile fglrx versions <= 8.24.8 for Xorg 7.0.0, fake Xorg 6.9.0 by
:{{cmdroot|1=export X_VERSION=x690; sh ati-driver-installer-8.24.8-x86.run}}
Next, move the various resulting libraries and modules from /usr/X11R6 to /usr/lib/xorg

In {{path|/usr/src/ATI}} additional sources are installed for fireglcontrol and fgl_glxgears

== Status ==
Current version: 7-11 (8.433) (21st October 2007).
Major changes:
* 7-11: new versioning scheme, kernel 2.6.23 support
* 8.42.3: Composite support added enabling AIGLX and Beryl/Compiz on the desktop. Support for (most?) FireGl cards dropped (should be restored in upcoming versions)
* 8.41.7: increased OpenGL performance on some Radeon Cards, size/position TV-out adjustments work for Radeon X1900 or higher, X crash when connecting external DFP display fixed
* 8.40.4: some new TV out control options in CCC, another (non-exciting) maintenance release (see [http://www.phoronix.com/scan.php?page=article&item=804&num=1 Phoronix])
* 8.39.4: kernel 2.6.22 support, TexturedVideo fix, aticonfig segfault fix (see 8.38.7 hotfix), to get rid of the "AMD Testing use only" logo, use [http://www.phoronix.com/forums/showpost.php?p=10641&postcount=44 this] workaround.
* 8.38.7: hotfix release for "Using aticonfig --initial segfaults destroying xorg.conf file when run in X with Vesa driver.", search for "737-28261" on the ATI website.
* 8.38.6: RedHat Enterprise Linux 5 support, Xserver crashes on moving video window between two monitors fixed, corruption when playing multiple vodeps with textured video fixed
* 8.37.6: Xorg Server 1.3 support, CCC 1.0, crash when logging off from X fixed, Xv cropping bug fixed
* 8.36.5: Kernel 2.6.20 support, CCC Beta 0.9 with localization
* 8.35.5: Beta AMD Catalyst Control Center, X-Server termination from console does not result in a blank screen. Kernel 2.6.20 requires some patching (see [[Problems_with_fglrx#fglrx_8.35.5|fglrx patches section]]).
* 8.34.8: Radeon Xpress 1250 support, X-Video on x86_64 fix, hibernation mode fix. Kernel 2.6.20 requires some patching (see [[Problems_with_fglrx#fglrx_8.34.8|fglrx patches section]]).
* 8.33.6: X.Org 7.2 support, kernel 2.6.19 support, some fixes in the installer, 2 more bugfixes. Resume from suspend works if you make sure you have set "VbetoolPost no" and "EnableVbetool no" in your suspend to ram hibernate conf (/etc/hibernate/ram.conf on ubuntu/debian).
* 8.32.5: support for X1650, X.Org 7.2 RC2 support, bugfixes. Suspend-to-ram is broken with specific cards, *no* 2.6.19 support (see [[Problems_with_fglrx#fglrx_8.32.5|fglrx patches section]]).
* 8.31.5: no new features, only bugfixes. Of note, for some users, this version breaks suspend-to-ram and suspend-to-disk.
* 8.30.3: no new features, only bugfixes
* 8.29.6: Linux 2.6.18 support, dropped support for Radeon 8500/9000/9100/9200/9250 (both, mobile and normal versions)
* 8.28.8: Display Switching Support for ThinkPads, ATI Pairmode support, Retaining display device state between restarts, Support for Radeon Xpress 1200, 1250, and 1300
* 8.27.10: X.org 7.1 support, Fedora Core package support
* 8.26.18: support for dynamically attached DFPs and Thermal Event Power Management (both via daemon), minor bug fixes
* 8.25.18: Xorg 7.0 support, FireGLâ„¢V5xxx/V7xxx support, Dynamic Display Management, fixed a lot of critical bugs.
* 8.24.8: support for X1300, X1400, X1600, X1800 (generic and mobility) and 3D accelerated video playback on Avivo
* 8.23.7: support for X850 and X800, OpenGL 2.0 Enhancement, FSAA for some chips
* 8.22.5: added kernel 2.6.15 support -- patch no longer required
* 8.21.7: initial OpenGL 2.0 support
* 8.20.8: fixed resume issues, fixed compile problems with kernels 2.6.13 and 2.6.14
* 8.19.10: has added suspend / resume and dynamic GPU power management support. Using vbetool no longer required.

== Known problems and solutions ==
See [[Problems with fglrx]].
== User experience ==
=== Speed ===
How much is the speed gain versus the opensource drivers?

Compared to the old drivers, approximately 40% speed gain have been noticed with fglrx. However, there are issues with freezing/garbage after suspend, garbage when resizing desktop (via {{key|ctrl}}{{key|alt}}{{key|plus}}, {{key|ctrl}}{{key|alt}}{{key|minus}}), and garbage while using VMware. The current 8.14.13 has shown 400% improvement over using the open source radeon driver: 1200 FPS for glxgears{{footnote|1}}!

However the situation seems to be changing significantly as time goes on. With recent x11-drm-20060608 driver (gentoo) and thinkpad t42 (ati 9600) the speed is confirmed as 1900fps and stable. As of October 2007 there is dramatic improvement in the open source 3d drivers in speed and stability.

=== 3D acceleration ===

According to [http://xoomer.alice.it/flavio.stanchina/debian/fglrx-installer.html#configure Flavio's page] you need these options:

Section "Module"
...
Load "GLcore"
Load "glx"
Load "dri"
...
EndSection

# Of course you need to activate the driver
Section "Device"
...
Driver "fglrx"
EndSection

Don't forget to load the module <tt>fglrx</tt> (<tt>modprobe fglrx</tt>). Under Debian the module can be placed in <tt>/etc/modules</tt>.

With fglrx drivers prior to 8.42.3 will need to disable composite to enable 3D DRI acceleration. To do this, add an extra Extensions section (if necessary) containing:

Section "Extensions"
Option "Composite" "Disable" #make DRI work with fglrx.
EndSection

If you are unsure whether you have DRI running, issue <tt>glxinfo | grep -i direct</tt> after disabling composite. Note, this

{{NOTE|1=Video overlay acceleration may be disabled when 3D acceleration is enabled. The following comment from the xorg.conf file bundled with the fglrx driver indicates that:
# === OpenGL Overlay ===
# Note: When OpenGL Overlay is enabled, Video Overlay
# will be disabled automatically
Option "OpenGLOverlay" "1"
However, you can use either regular Xv video overlay or make the video an opengl texture and let the OpenGL engine scale your video. This has nothing to do with the acceleration of 2D drawing primitives. Further, your mileage on performance may vary depending on what card you have. The open source drivers don't support newer cards, while the ATI drivers don't support older cards.

You may be able to preserve VideoOverlay acceleration if you explicitly remove the OpenGLOverlay using:

Option "VideoOverlay" "True" and Option "OpenGLOverlay" "False". See [http://xoomer.alice.it/flavio.stanchina/debian/fglrx-installer.html#configure Flavio's page] for detail.}}

=== Power saving ===
Power saving is much better than with the <tt>radeon</tt> driver, but doesn't work in dual-screen configuration (see [[How to make use of Graphics Chips Power Management features]]).

=== Suspending with fglrx ===

On a ThinkPad T42 with Kernel 2.6.19 with Software Suspend 2 and R60 with Kernel 2.6.18-suspend2-r1 (Gentoo) , the following addition to <tt>/etc/hibernate/suspend2.conf</tt> is required:

# For fglrx
ProcSetting extra_pages_allowance 20000

=== Display Switching (Dynamic Display Management) ===

Version 8.25.18 introduces a new feature: Dynamic Display Management. It allows display switching on-the-fly.

To list all connected and enabled monitors:
:{{cmdroot|1=aticonfig --query-monitor}}

To switch displays:
:{{cmdroot|1=aticonfig --enable-monitor=STRING,STRING}}, where STRING can be: none, lvds, crt1, crt2, tv, tdms1, tdms2

Only 2 displays can be enabled at the same time. Any displays that are not on the list will be disabled.

The '''Catalyst Control Center''', which comes with the driver (at least from Livna in Fedora Core 6) can be used to do this switching. It also does various other kinds of display managements. However, the version that comes with 8.39.4 doesn't seem to handle switching into Big Desktop mode, does anyone know how to get this to work? The control center also complains a lot about rebooting, but rebooting doesn't seem to be required. Does anyone have decent documentation for the control center?

== Useful links ==
* [http://www.ati.com/products/catalyst/linux.html ATI Linux Driver FAQ]
* [http://www.rage3d.com/content/articles/atilinuxhowto/ ATI Radeon Linux How-To]
* [http://www.rage3d.com/board/forumdisplay.php?f=61&daysprune=30&order=asc&sort=title Rage3D Linux Discussion Forum]
* [http://www.driverheaven.net/forumdisplay.php?f=103 Radeon Driver Forum at Driverheaven]
* [http://odin.prohosting.com/wedge01/gentoo-radeon-faq.html Gentoo ATI Radeon FAQ]
* [http://forums.gentoo.org/viewtopic-t-374745-highlight-t42+ati+dri.html Gentoo T42 ATI. DRI + xorg driver]
* [http://ati.cchtml.com/ Unofficial community ATI bugzilla] - tracks bugs in the driver. Might be monitored by ATI ([http://www.rage3d.com/board/showpost.php?p=1333438751&postcount=386], [http://www.rage3d.com/board/showpost.php?p=1333439009&postcount=390]).

== ThinkPads that may be supported ==
Supported chips, as found in select IBM ThinkPads:
{{NOTE|fglrx version 8.29.6 discontinued support for Radeon 9200 and earlier.}}
* [[ATI Mobility FireGL 9000]]
** {{T40p}}
* [[ATI Mobility FireGL T2]]
** {{R50p}}
** {{T41p}}, {{T42p}}
* [[ATI Mobility FireGL V3200]]
** {{T43p}}
* [[ATI Mobility Radeon 9000]]
** {{R50}}, {{R51}}
** {{T40}}, {{T41}}, {{T42}}
* [[ATI Mobility Radeon 9600]]
** {{T42}}
* [[ATI Mobility Radeon X300]]
** {{R52}}
** {{T43}}
** {{Z60m}}
* [[ATI Mobility Radeon Xpress 200M]]
** {{R51e}}
* [[ATI Mobility Radeon X600]]
** {{Z60m}}
* [[ATI Mobility Radeon X1400]]
** {{T60}}, {{R60}}, {{Z61m}}
* [[ATI Mobility FireGL V5200]]
** {{T60p}}, {{Z61p}}

== ThinkPads that are NOT supported by fglrx==
Unsupported chips, as found in select IBM ThinkPads:
* [[ATI Mobility Radeon 7500]]
** {{R40}}
** {{T30}}
** {{T42}}

{{footnotes|
#Note that glxgears isn't a benchmark tool, it's so simple that its FPS values is without any meaning... you can only compare glxgears using the same drivers/machine, if you change any of then you can have higher/lower values and in real life programs/games happen to have the opposite effects. Think in terms of a car engines rpms: higher rpms in the same car usually means a faster car, change anything and it's meaningless, ie: gears, truck, wheel size, etc. make it useless.
}}
[[Category:Drivers]]

Template:Industry News

2007-11-22T06:24:18Z

Whoopie: fglrx 7-11 (8.433) released

21. 11. 2007: New [[fglrx]] driver version 7-11 (8.433) [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/catalyst_711_linux.html released].

23. 10. 2007: New [[fglrx]] driver version 8.42.3 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.42.3.html released].

12. 10. 2007: New [http://www.thinkpadreserve.com/ ThinkPad Reserve edition] model officially announced.

12. 9. 2007: New [[fglrx]] driver version 8.41.7 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.41.7.html released].

8. 9. 2007: Lenovo's [http://lenovoblogs.com/insidethebox Inside the Box] blog discusses ThinkPad Linux support

5. 9. 2007: AMD/ATI announces [http://home.businesswire.com/portal/site/google/index.jsp?ndmViewId=news_view&newsId=20070904006432&newsLang=en new HD2k Radeon drivers], pledging composite support and significant performance improvements on modern (2.6.22) kernels.

8. 8. 2007: New [[fglrx]] driver version 8.40.4 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.40.4.html released].

HDAPS

2007-11-18T14:51:27Z

Whoopie: /* Kernel patch */

HDAPS

2007-11-18T13:16:53Z

Whoopie: /* Kernel patch */ updated disk-protect patch for 2.6.23.8

ATI Mobility FireGL 9000

2007-11-08T09:43:47Z

Whoopie: alphabetical order

__NOTOC__
{| width="100%"
|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;">
=== ATI Mobility FireGL 9000 ===
This is an ATI video adapter

=== Features ===
* Chipset: ATI RV250 (M9) - Similar to [[ATI_Mobility_Radeon_9000|Radeon 9000]]
* PCI ID: 1002:4c66
* AGP 4X
* 64 MB DDR-SDRAM video memory
</div>
|style="vertical-align:top" |
|}

=== Linux driver - OpenSource ===
This adapter is supported by recent versions of the 'radeon' driver as found in X.Org and XFree86.

=== External (VGA, DVI, SVideo) ===
??

=== Linux driver - Proprietary ===
The ATI proprietary [[fglrx]] driver also provides 3D acceleration, but you have to use some old stuff:
The ATI Mobility FireGL 9000 is only supported by fglrx drivers up to version 8.28.8 which can be downloaded [http://ati.amd.com/support/drivers/linux/linux-radeon-prer200.html here]. Be aware that this driver only supports Xorg 7.1 and no newer versions!

=== ThinkPads this chip may be found in ===
* {{R51}}
* {{T40p}}

[[Category:Components]]

How to reduce power consumption

2007-10-30T12:23:53Z

Whoopie: /* Useful Patchs */ s/patchs/patches

Reducing system power consumption will extend battery life, reduce system
temperature and (on some models) reduce system fan noise.
Power consumption can be greatly improved from a stock distribution configuration
to a fine tuned system. The general rules are :
* Unload drivers for unused devices (ie. USB 1.1, Yenta/PCMCIA, Wireless, IRDA, Bluetooth, ...)
* Reduce polling on devices (drives, USB subsystem, nvram, use SATA AN, ...)
* Reduce hard drive activity
* Reduce LCD brightness to the minimum you can stand
* Reduce CPU wakeups, so it can stay longer in deep power saving c-states
* Make use of every hardware devices availables power saving features (AHCI ALPM, USB autosuspend, Alsa and Wireless powersaving modes, HPET timers, ...)

==Tools==
Arjan van de Ven's [[PowerTOP]] utility
is a gold mine to improve energy efficiency, but is almost only CPU-oriented. This tool helps to easily detect
the top power offenders, both userland and kernel modules, which prevent the use of CPU power saving mechanisms and sometime suggest
fixes accordingly.
PowerTOP users collected some [http://www.linuxpowertop.org/known.php tips & tricks]
and an informative [http://www.linuxpowertop.org/faq.php faq].

Alternatively (or complementary) to PowerTOP, running <code>strace -p $(pidof yourapp)</code>
for all your favorite or background running applications while they are expected to be
idle, will show the misbehaviors.

Beside CPU wakeups, disks spins are also power angry. To detect what make your disk spinning,

<code>
sysctl vm.block_dump=1
</code>

will list all applications causing disks wakeups on the kernel's dmesg.
Other useful tools for this purpose are blktrace, iostat and lm-profiler
(from laptop-mode-tools suite).

See also [[#Misbehaving Userland]].

==BIOS settings==
Some Thinkpad BIOS (like 2.08 BIOS on {{X40}}) offer two very lame options,
with a very misleading online help (saying "Usually not needed"). That's

<code>
CPU power management: (default disabled)
PCI bus power management: (default disabled)
</code>

You should indeed enable them, else the deepest C3 and C4 ACPI C-states
are disabled.

==CPU==
Look at:
* [[How to make use of Dynamic Frequency Scaling]]
* [[Pentium M undervolting and underclocking]]

A good thing to keep in mind is that every CPU wakeup, even if it's for
a trivial light job, reduce the time the CPU stays on a deep power
saving C-state (like C3 or C4). Therefore you should ensure your applications
stay really idle when they meant to be idle (track shorts select timeouts
in loop, etc. with [[PowerTOP]]).

Also note that manually locking the CPU in the lowest P-state (frequency)
available is '''not''' an efficient way to improve battery lifetime. This will
cause the CPU to stay longer in C0 (power angry C-state) doing hard work when
there is something to do, while it could have done this work faster by augmenting
the CPU freq, and returned back faster to a deeper, economic, C-state and to a
lower frequency (P-state).
The best is to let the kernel select the appropriates CPU frequencies by itself
with the help of in kernel CPU governors.
Have a look at [http://www.bughost.org/pipermail/power/2007-May/000166.html this explanation]
from Intel's kernel developer Arjan van de Ven.

==Kernel settings and patches==

===General settings===
The 2.6.21 kernel brought some very effective changes (like dynticks). If
it's not already on your distribution and you value power efficiency, you
may think about compiling it (or a more recent one) yourself.

Here are a few options (beside the ACPI and APM related one) that matter to
reduce power consumption or to help diagnosing consumers:

<code>
# From PowerTOP's FAQ:
CONFIG_NO_HZ
CONFIG_HIGH_RES_TIMERS
CONFIG_HPET
CONFIG_HPET_TIMER
CONFIG_CPU_FREQ_GOV_ONDEMAND
CONFIG_USB_SUSPEND
CONFIG_SND_AC97_POWER_SAVE
CONFIG_TIMER_STATS
CONFIG_ACPI_BATTERY
CONFIG_CPU_FREQ_STAT
CONFIG_INOTIFY

# Not from the PowerTOP FAQ:
CONFIG_BLK_DEV_IO_TRACE
CONFIG_X86_ACPI_CPUFREQ
CONFIG_X86_SPEEDSTEP_CENTRINO
CONFIG_X86_SPEEDSTEP_ICH
CONFIG_X86_SPEEDSTEP_SMI
CONFIG_CPU_IDLE
CONFIG_CPU_IDLE_GOV_LADDER
CONFIG_CPU_IDLE_GOV_MENU
</code>

Those options are already in Fedora Core 7 and Ubuntu Gutsy (not Feisty) default i686 kernels.
PowerTOP FAQ also suggest to '''disable'''
CONFIG_IRQBALANCE and CONFIG_ACPI_DEBUG.

Also, you need to properly set APM and ACPI. Look at:
* [[Power Management]]
* [[How to make use of Power Management features]]

===Useful Patches===

Thomas Gleixner High Resolution Timers (hrt) patchset brings many improvements,
like the cpuidle work and Udo A. Steinberg and Venki Pallipadi "force
enable HPET" patches (non HPET timers causes about 20-40 CPU wakeups/second, but
HPET is often hidden by the BIOS due to Windows XP deficiencies). Those are
fully merged in 2.6.24-rc1 vanilla kernel.
See http://www.tglx.de/projects/hrtimers/

Kristen Carlson Accardi from Intel has a patchset to turn on "Aggressive
Link Power Management" (ALPM) for the AHCI driver (for SATA bus). See:
http://www.kernel.org/pub/linux/kernel/people/kristen/patches/SATA/alpm/

The [[HDAPS]] disk protection systems can reduce battery life.
Matthew Garrett provides [http://www.linuxpowertop.org/patches/hdaps.patch a patch]
that prevents hdaps kernel module to generate interrupts when
this feature isn't used.

===Useful sysctls===
The meaning of those settings is explained case by case on the relevant
sections of this document. But for convenience sake, we group them here too.

Note that the "ondemand" scaling governor is recommended by Intel developers
for energy efficiency: it's expected to be more efficient than the "powersave"
governor, or than userspace daemons (like cpufreq-utils, cpufreqd, powernowd...).
Look [http://www.bughost.org/pipermail/power/2007-May/000071.html here],
[http://www.bughost.org/pipermail/power/2007-May/000073.html here], or
[http://www.bughost.org/pipermail/power/2007-May/000166.html here] for a
kernel developer explanation about "ondemand" being better on modern Intel CPUs.

The "link_power_management_policy" tunable won't be available unless you
run a 2.6.24-rc2 or more kernel, or applied Kirsten patchset, have an Intel
AHCI compatible chipset, and use SATA drives.

<code>
echo 5 > /proc/sys/vm/laptop_mode
echo 0 > /proc/sys/kernel/nmi_watchdog
echo Y > /sys/module/snd_ac97_codec/parameters/power_save
echo 1 > /sys/devices/system/cpu/sched_mc_power_savings
echo ondemand > /sys/devices/system/cpu/cpu0/cpufreq/scaling_governor
echo 1500 > /proc/sys/vm/dirty_writeback_centisecs
# those sysctl's are only available if you have an AHCI compatible SATA
# controler and use kernel > 2.6.24-rc2 (or use Kristen ALPM patchset) :
echo min_power > /sys/class/scsi_host/host0/link_power_management_policy
echo min_power > /sys/class/scsi_host/host1/link_power_management_policy
</code>

If you're running a kernel older than 2.6.22 do this. Not needed for kernels 2.6.22 onward:

<code>
cd /sys/devices/system/cpu/cpu0/cpufreq
cat ondemand/sampling_rate_max > ondemand/sampling_rate
</code>

==ATA drives==
Hard drives and CDRom drives spinning is very costly. To improve battery
lifetime, you should reduce disks access (or devices polling) the more you
can.

===Hard Drives===
The files access time update, while mandated by POSIX, is causing lots of
disks access; even accessing files on disk cache may wake the ATA or USB
bus. If you don't use this feature, disable it via:

<code>
mount -o remount,noatime / # and so on for all mounted fs
</code>

The laptop_mode reduce disk usage by regrouping writes. You should enable
it, at least while on battery. See [[Laptop-mode]] for more details:

<code>
echo 5 > /proc/sys/vm/laptop_mode
</code>

The default kernel dirty page writeback frequency is very conservative. On
a laptop running on battery, one might find more appropriate to reduce it:

<code>
echo 1500 > /proc/sys/vm/dirty_writeback_centisecs
</code>

Some power saving hard drives features can be activated with hdparm (beware
that "-B 1" may reduce your drive lifetime, if you have lot of intermittent
disk activity causing lots of heads load/unloads: so reduce I/O activity first,
as explained above, in order to get longer disks idling periods).
For more details look at [[How to make use of Power Management features]] :

<code>
hdparm -B 1 -S 12 /dev/sda # and/or any other disk device
</code>

===Optical drive===
The optical drive is reported to consume power even when not accessed. See

* [[How to hotswap UltraBay devices|Eject the UltraBay optical drive]], or just turn off its power supply (i.e., run the appropriate eject script but leave the drive inserted).
* [[How to set optical drive speed|Reduce the spinning speed of the optical drive]].

The hald daemon polling tends to maintain the ATA buses out of power saving
modes, and to wakeup CDROM drive (except if you have a kernel >= 2.6.24, hal >= 0.5.10,
and SATA AN compatible devices). If you have a recent hald version, you
can stop this polling when on battery:

<code>
hal-disable-polling /dev/scd0 # or whatever your CD drive is
</code>

If your hald is not recent enough, consider suspending it when running on battery. Some moderns SATA buses and drivers supports a notification mechanism (SATA AN - Asynchronous Events Notifications) that obsolete the need for polling on modern hardware; support for this feature had been merged in Linux 2.6.24-rc1 and HAL 0.5.10.

==LCD Backlight/Brightness==
The LCD backlight is one of the very major power drain.
Reducing brightness to the lowest readable
level will save a lot of battery lifetime. Also, don't forget to configure
your screen saver to shutdown the screen backlight (rather than displaying some
eye candy), when no activity for a few minutes.

You can also let the system [[automatically reduce brightness]] after a
period of inactivity.

If you're choosing your Thinkpad laptop model, keep in mind that the screen
size affect the battery time greatly: more power needed for larger screens.

==Graphic controllers==
All xorg Thinkpad graphics chipsets drivers (ati, radeon, fglrx, i810) have
the same bug causing very frequent CPU wakeups when DRI is activated, even
when you don't use any 3D application.
This problem is partly fixed on xorg git tree but not released as of xorg
7.2. If you value more battery than 3D, you should disable DRI: put this on
the /etc/X11/xorg.conf "Device" of you graphic controller:

<code>
Option "NoDRI"
</code>

Also be sure that DPMS is working: <code>grep DPMS /var/log/Xorg.0.log</code>
should output "DPMS enabled". If not, put <code>Option "DPMS"</code> in your config.

On recent xrandr/xorg versions, you can disable the TV output when you're
not using it (it's known to consume power) :

<code>
xrandr --output TV -off
</code>

When you don't have an external monitor plugged, disable CRT and DVI output
(for some, this can make a difference in power usage) :
<code>
echo crt_disable > /proc/acpi/ibm/video
echo dvi_disable > /proc/acpi/ibm/video
</code>

Some drivers have specials power saving mode, and/or allows underclocking the GPU. See also:
* [[How to make use of Graphics Chips Power Management features]], or with [[Rovclock]] on ATI.
* [[Problem with high power drain in ACPI sleep]]

==USB Subsystem==
The kernel support an efficient USB 2.0 power saving feature if you enabled
CONFIG_USB_SUSPEND. This may not trigger in when you have an USB device
plugged (and beside, USB devices tends to suck power on their own), so avoid
using such devices when on battery. And you must enable it, either a boot time
by adding this in the kernel boot options (ie. in grub's menu.lst):

<code>
usbcore.autosuspend=1
</code>

or at runtime, per device, with:

<code>
for i in /sys/bus/usb/devices/%s/power/autosuspend; do echo 1 > $i; done
</code>

USB 1.1 is worst. It needs polling the bus frequently, hence can't really go
in a low power mode when you enabled it, even if you don't have any device
plugged. You'd better remove it when you don't use a 1.1 device:

<code>
rmmod uhci_hcd
</code>

If you don't intend to use any device needing USB 1.1 (unfortunately, the built-in bluetooth and fingerprint-reader are USB 1.1 devices), the USB 1.1 support can also be totaly avoided. On Debian and derivatives, just do:

<code>
echo "blacklist uhci_hcd" >> /etc/modprobe.d/blacklist
</code>

==Sound==
ALSA has a power saving feature that should be enabled on your kernel
(CONFIG_SND_AC97_POWER_SAVE). Note that this low power mode won't trigger in
unless you muted all sound inputs (micro, line in etc.). This feature has
to be activated with:

<code>
amixer set Line mute nocap
amixer set Mic mute nocap
echo Y > /sys/module/snd_ac97_codec/parameters/power_save
</code>

More radical: you can unload all sound related modules when you are on
battery, or mute the sound system (echo mute > /proc/acpi/ibm/volume).

Seel also [[How to enable AC97 power saving]].

==Wireless Interface==
Wireless network consume a lot of power.
To save power, you can kill the Wi-Fi radio when it's not in use:

<code>
echo 1 > /sys/bus/pci/devices/*/rf_kill
</code>

If you need Wi-Fi, you can also reduce power consumption (at the price of
performances) by activating the power saving modes:

<code>
iwpriv eth1 set_power 5
</code>

For drivers using the new Wi-Fi kernel framework (mac80211/cfg80211),
the canonical way to do this is now:

<code>
for i in /sys/bus/pci/devices/%s/power_level ; do echo 5 > $i ; done
</code>

Reducing beacon intervals on your Access Point to 1 per second will also
reduce network card interrupts, therefore power savings. This shouldn't have
negatives side effects.

Drivers not using the new mac80211 framework (like ipw2200) use to go in
aggressive scanning mode when the interface is down and they are not associated
with any Access Point (more info about this on Intel's
[http://www.lesswatts.org/tips/wireless.php LessWatts] website).
This behavior consumes a lot of power, even more than when the interface
is plain active and in use, but can disabled at module's load time :

<code>
rmmod ipw2200
modprobe ipw2200 associate=0
</code>

You can fix this setting by placing the following in /etc/modprobe.d/options (Debian/Ubuntu)
or /etc/modprobe.conf (Red Hat/Fedora):

<code>
options ipw2200 associate=0
</code>

See also, to activate power saving on the wireless network card:
* For [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]] and [[Intel PRO/Wireless 2915ABG Mini-PCI Adapter]], see instructions for the [[ipw2200]] driver.
* For [[Intel PRO/Wireless 3945ABG Mini-PCI Express Adapter]], see the [http://ipw3945.sourceforge.net/README.ipw3945 ipw3945 driver README]

==Ethernet Controler==
If you don't use Wake-on-LAN, you should disable it for your network card,
because it sucks a lot of power:

<code>
ethtool -s eth0 wol d
</code>

If you can, try to reduce useless network activity on your ethernet
segment, coming to your NIC (ie. uneeded broadcasts), those cause
interrupts and CPU wakeups.

Forcing 100Mbps full-duplex speed on a gigabit ethernet NIC can also save a lot of power (~1W) on most network workloads. This also reduces components temperature (e.g., [[Thermal Sensors|thermal sensor]] 0xC0 on the {{T43}} cools down by 5 degree between 1000Mbps and 100Mbps, and another 1 degree for 10Mbps).

<code>
ethtool -s eth0 autoneg off speed 100
</code>

==Bluetooth==
When you don't need bluetooth, disable it. Because of its radio,
bluetooth is not power friendly.

<code>
hciconfig hci0 down ; rmmod hci_usb
echo disable > /proc/acpi/ibm/bluetooth
</code>

==Modem==
When was the last time you used your analog modem? If you can't remember, you probably just don't need it. If it is on a separate module in your laptop, simply remove it. Store it in a ESD safe place (like the bag in which your last addon card or hard drive was packed), in case you should need it again. This won't save you a lot of power and weight, but why carry something around you never use.

==System Fans==
Fans consumes power when running, so you may look at the [[ACPI fan control script]].

==Misbehaving Userland==
You should avoid using Beagle, Compiz, Beryl, XMMS, gnome-power-manager
and Evolution while on battery.
Look at the PowerTOP's [http://www.linuxpowertop.org/known.php known problems]
list.

Deactivate desktop animations (blinking cursor on the terms, animated wallpapers, ...): they cause regular X (therefore kernel and CPU) wakeups.

In short, while on battery, you should stop all applications that don't really stay idle when you're not using them. This means applications that:
* Wakes up the CPU too often (by polling something, because of too short select() timeouts, ...)
* Access the disks at regular intervals
* Access an hardware bus (USB, ATA, ...) at regular intervals
To find those offenders run:
* <code>strace -p $(pidof yourapp)</code> # for all your running applications
* <code>powertop</code>
* <code>sysctl vm.block_dump=1</code> # and look at dmesg
* <code>ps aux | awk '{print$10,$11}' | sort -n</code> # will list all running softs sorted by used cpu time
Please, don't forget to fill a bug when you find such a misbehaving software.
{{NOTE|Not all software is evil, buggy or badly written. Some produce regular activity because they have to, in order to provide their intented functionality. Think twice before filling bugs about this.}}

==See Also==
* [[How to measure power consumption]]
* [[Script for monitoring power consumption]]
* Battery [[maintenance]]

==External resources==
* [http://www.free-it.de/archiv/talks_2005/paper-11017/paper-11017.html ''Current trends in Linux Kernel Power Management''], Dominik Brodowski, 2005
* [http://www.linuxpowertop.org PowerTOP] website
* [http://www.gentoo.org/doc/en/power-management-guide.xml Power Management Guide] from the Gentoo Linux documentation
* [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030478.html When/where/what for low power consumption?] (thread on Linux-Thinkpad)
* ''8 hours of battery life on your lap(top)'' ([http://atrey.karlin.mff.cuni.cz/~pavel/swsusp/8hours.odp ODP]/[http://atrey.karlin.mff.cuni.cz/~pavel/swsusp/8hours.pdf PDF]), a presentation by Pavel Machek
* [http://www.lesswatts.org Website dedicated to save energy on Intel systems using Linux]

[[Category:600X]] [[Category:A20m]] [[Category:A20p]] [[Category:A21e]] [[Category:A21m]] [[Category:A21p]] [[Category:A22e]] [[Category:A22m]] [[Category:A22p]] [[Category:A30]] [[Category:A30p]] [[Category:A31]] [[Category:A31p]] [[Category:i1200]] [[Category:i1300]] [[Category:i1620]] [[Category:G40]] [[Category:G41]] [[Category:R30]] [[Category:R31]] [[Category:R32]] [[Category:R40]] [[Category:R40e]] [[Category:R50]] [[Category:R50e]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[Category:R60]] [[Category:R60e]] [[Category:T20]] [[Category:T21]] [[Category:T22]] [[Category:T23]] [[Category:T30]] [[Category:T40]] [[Category:T40p]] [[Category:T41]] [[Category:T41p]] [[Category:T42]] [[Category:T42p]] [[Category:T43]] [[Category:T43p]] [[Category:T60]] [[Category:T60p]] [[Category:T61]] [[Category:X20]] [[Category:X21]] [[Category:X22]] [[Category:X23]] [[Category:X24]] [[Category:X30]] [[Category:X31]] [[Category:X32]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:X60]] [[Category:X60s]] [[Category:Z60m]] [[Category:Z60t]] [[Category:Z61t]] [[Category:Z61e]] [[Category:TransNote]]

Template:Industry News

2007-10-26T05:50:13Z

Whoopie: change the link to the release notes

23. 10. 2007: New [[fglrx]] driver version 8.42.3 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.42.3.html released].

12. 10. 2007: New [http://www.thinkpadreserve.com/ ThinkPad Reserve edition] model officially announced.

12. 9. 2007: New [[fglrx]] driver version 8.41.7 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.41.7.html released].

8. 9. 2007: Lenovo's [http://lenovoblogs.com/insidethebox Inside the Box] blog discusses ThinkPad Linux support

5. 9. 2007: AMD/ATI announces [http://home.businesswire.com/portal/site/google/index.jsp?ndmViewId=news_view&newsId=20070904006432&newsLang=en new HD2k Radeon drivers], pledging composite support and significant performance improvements on modern (2.6.22) kernels.

8. 8. 2007: New [[fglrx]] driver version 8.40.4 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.40.4.html released].

ATI Mobility Radeon X1300

2007-10-22T11:44:42Z

Whoopie: typo

__NOTOC__
{| width="100%"
|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;">
This is an ATI video adapter

=== Features ===
* Chipset: ATI M52
* PCI ID: 1002:7149
* PCI Express x16
* 64MB GDDR1 video memory
</div>
|style="vertical-align:top" |
|}

== Linux X.Org driver ===
Should be supported by the new (as of 2007-10-22) radeonhd driver. A Debian package already exists in the experimental branch. 3d is still under development.

=== ThinkPad LCD ===
Display on the internal LCD works as long as you set the monitor settings correct.

=== External VGA port ===
??

=== SVideo port ===
??

=== DVI port ===
DVI port is enabled in T60.

Using the proprietary driver the Dell 2405FPW works at 1920x1200 pixels via Advanced Mini Dock.

=== Proprietary ATI driver ===
fglrx supports this card since release 8.24.8.

driver by ATI

https://support.ati.com/ics/support/KBAnswer.asp?questionID=18875

=== Linux kernel Framebuffer driver ===
* OS: RHEL4-U3
* Kernel: 2.6.9-34
* X Version: 6.8.2-1
* Result: ''Failure''
** Driver can't find a compatible card

=== ThinkPads this chip may be found in ===
* {{T60}}

[[Category:Components]]

Problems with fglrx

2007-10-22T05:42:12Z

Whoopie:

This page discusses issues with the ATI proprietary [[fglrx]] display driver.

== Known Troubles and Solutions ==

=== X-specific issues ===

==== upgrading xserver-xorg ====
ATI proprietary drivers version 8.21.7 and later work with x.org 6.9.

If you are running an older version (8.20.8) under Debian sid and you upgrade your xserver-xorg, apt will force you to remove any debian-packaged fglrx drivers (package fglrx-driver depends on x.org << 6.8.99). You can just download the driver from the ATI site and install after modifying the Debian packager script to allow dependencies to be satisfied by x.org 6.9, or just download 8.21.7 and install manually. See talk page for step-by-step commands.

After installing the fglrx driver, you can use module-assist to build the appropriate kernel module.

==== new Xorg ID Scheme ====
ATI proprietary drivers <=8.36.5 with xorg >=7.1.0-18 (==1.3.0.0) in Debian Sid and Fedora ([http://www.sidux.com/PNphpBB2-viewtopic-t-3162-postdays-0-postorder-asc.html Debian] and [http://www.phoronix.net/forums/showthread.php?t=2382 Fedora] Forum Entries)

Ubuntu feisty made their own xorg with the standard id of 7.2, to work around this issue.

Xorg has changed its ID Scheme in newer Versions, and fglrx cannot cope with that (Error message saying "[...] X version mismatch - detected X.org 1.3.-1.905, required X.org 7.1.0.0 [...]").

A binary hack solves the Problem [http://rage3d.com/board/showthread.php?s=4638d94143536f6acacbccd8f0443472&t=33889029 (rage3d.com Forum Entry)]. This is a very '''dirty''' solution, and is probably violating the ATI driver license.

Simply using the open source ati driver (or holding back the xorg upgrades) until a new driver is released, is suggested.

As of version 8.37.6, this issue is solved. No more binary hacking needed.

=== Kernel-specific troubles ===

Using ATI drivers <=8.21.7 with kernel >=2.6.15 needs a [http://marc.theaimsgroup.com/?l=linux-kernel&m=113429835515001&w=2 patch]. (see table below for detail.) If you can't compile the driver modules with 2.6.15 or later, you should apply this [http://www.ksp.sk/~rasto/fglrx_with_2.6.15.patch patch] instead.

If you do not use one of these patches, you may experience peculiar lockups of X. Try {{cmduser|fglrxinfo}} - if your shell hangs at the end of this command, you may have an issue and should try the patch or upgrade.

Although unproven, there is a substantial amount of user / developer concern that the above patches prevent hard lockups but do not provide full reliability with 2.6.15 and there are larger / redisgn issues preventing compatibility. These issues have been fixed with later ATI drivers (> 8.21.7) so you can simply upgrade if you are running a more modern kernel.

==== 2.6.23 ====
In 2.6.23 release cycle, config option CONFIG_SUSPEND_SMP got renamed to CONFIG_PM_SLEEP_SMP. fglrx uses this variable for disabling power management on older kernels. As a result, SMP users running 2.6.23 weren't able to resume properly (almost instant lockup in that rare case fglrx managed to show a few usable pixels. A [http://linux.derkeiler.com/Mailing-Lists/Kernel/2007-10/msg03437.html quick patch] is available.

=== No hardware acceleration ===

====Acceleration lost after driver update====
If you lose hardware acceleration after a driver update this can be caused by an old fglrx kernel module being loaded.

Check out {{path|1=/var/log/Xorg.0.log}} for a message like:
:<code>(WW) fglrx(0): Kernel Module version does *not* match driver.</code>
:<code>(EE) fglrx(0): incompatible kernel module detected - HW accelerated OpenGL will not work</code>

You can verify this yourself by looking at the version message some lines above. It should read something not matching the installed version like:
:<code>(II) fglrx(0): Kernel Module Version Information:</code>
:<code>(II) fglrx(0): Name: fglrx</code>
:<code>(II) fglrx(0): Version: 8.10.19</code>

The cause for this trouble might be that there resist multiple versions of the fglrx module within the kernel module search path. 
Go to {{path|1=/lib/modules/<your linux kernel version>/}} and type {{cmdroot|1=grep fglrx modules.dep}}. 
If grep finds multiple lines you nailed down the problem. All you have to do now is to delete any versions of the module (look at the filedate) but the most current one. Then run {{cmdroot|1=depmod}} and you are done.

{{HINT|Newer versions (8.21.7) of the fglrx module seem to be installed in the <code>extra/</code> subdirectory. 
Older versions (8.19.10) used to be located in the <code>kernel/drivers/char/drm/</code> subdirectory.}}

====GCC 3.4====
If the ATI driver works only without the hardware acceleration, take into consideration that {{path|fglrx_dri.so}} was linked against libstdc++.so.5 which may not be present if your system uses gcc-3.4.

To fix this, compile gcc-3.3.5 and copy <tt>libstdc++.so.5*</tt> to {{path|/usr/lib}} and update the dynamic linker cache via {{cmdroot|ldconfig}}.

Or install a compat package for your favorite distro. FC4 users can do:
:{{cmdroot|yum install libstdc++.so.5}}

====radeonfb framebuffer====
Another possible cause for broken hardware acceleration (2D and 3D) is the radeonfb framebuffer: Switching to vesafb or vesafb-tng is reported to solve the problem on some systems. Also it has proven helpful to not perform {{cmdroot|modprobe fglrx}} after boot but to have the module loaded via {{path|/etc/modules.autoload/kernel2.x}} at boottime instead.

====Perpetual Mesa GLX Indirect on Debian====
If you've done everything right and you're still seeing:

:{{cmduser|fglrxinfo}}
:{{cmdresult|display: :0.0 screen: 0}}
:{{cmdresult|OpenGL vendor string: Mesa project: www.mesa3d.org}}
:{{cmdresult|OpenGL renderer string: Mesa GLX Indirect}}
:{{cmdresult|OpenGL version string: 1.2 (1.5 Mesa 6.4.1)}}

try this:

:{{cmdroot|mkdir -p /usr/X11R6/lib/modules/dri}}
:{{cmdroot|ln -s /usr/lib/dri/fglrx_dri.so /usr/X11R6/lib/modules/dri}}

Thanks to Maciej Matysiak for the clear debug [http://lists.debian.org/debian-amd64/2006/02/msg00217.html here] and solution [http://lists.debian.org/debian-amd64/2006/02/msg00311.html here].

More generally, use LIBGL_DEBUG=verbose fglrxinfo, to see what's happening, and whether you get this:
:{{cmduser|<nowiki>LIBGL_DEBUG=verbose</nowiki> fglrxinfo}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.26.18 fglrx (screen 0)}}
:{{cmdresult|libGL: OpenDriver: trying /usr/X11R6/lib/modules/dri/fglrx_dri.so}}
:{{cmdresult|libGL error: dlopen /usr/X11R6/lib/modules/dri/fglrx_dri.so failed (/usr/X11R6/lib/modules/dri/fglrx_dri.so: cannot open shared object file: No such file or directory)}}
:{{cmdresult|libGL error: unable to find driver: fglrx_dri.so}}
:{{cmdresult|display: :0.0 screen: 0}}
:{{cmdresult|OpenGL vendor string: Mesa project: www.mesa3d.org}}
:{{cmdresult|OpenGL renderer string: Mesa GLX Indirect}}
:{{cmdresult|OpenGL version string: 1.2 (1.5 Mesa 6.4.2)}}

instead of that:
:{{cmduser|<nowiki>LIBGL_DEBUG=verbose</nowiki> fglrxinfo}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.26.18 fglrx (screen 0)}}
:{{cmdresult|libGL: OpenDriver: trying /usr/X11R6/lib/modules/dri/fglrx_dri.so}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.26.18 fglrx (screen 0)}}
:{{cmdresult|drmOpenByBusid: busid is PCI:1:0:0}}
:{{cmdresult|drmOpenDevice: minor is 0}}
:{{cmdresult|drmOpenDevice: node name is /dev/dri/card0}}
:{{cmdresult|drmOpenDevice: open result is 4, (OK)}}
:{{cmdresult|drmOpenByBusid: drmOpenMinor returns 4}}
:{{cmdresult|drmOpenByBusid: drmGetBusid reports PCI:1:0:0}}
:{{cmdresult|Can't open configuration file /home/merlin/.drirc: No such file or directory.}}
:{{cmdresult|fglrx: DPD supported.}}
:{{cmdresult|display: :0.0 screen: 0}}
:{{cmdresult|OpenGL vendor string: ATI Technologies Inc.}}
:{{cmdresult|OpenGL renderer string: MOBILITY FIREGL T2 Pentium 4 (SSE2) (FireGL) (GNU_ICD)}}
:{{cmdresult|OpenGL version string: 2.0.5879 (8.26.18)}}

I have contacted ATI to add that info by default, the mesa guys to do that in glxinfo too, as well as the debian packager to fix the debian packaging bug (2006/07/22), so hopefully the situation will improve soon

You may have to run fglrxinfo as root to get this detail rather than a useless message.

==== Where to look for fglrx_dri.so (gentoo and general)====
After installing a new kernel (linux-2.6.20-gentoo-r7) with gentoo I again was not able to get the ATI driver working
correctly. But now I found out what the problem was:

I tried
:{{cmduser|<nowiki>LIBGL_DEBUG=verbose</nowiki> fglrxinfo}}
:{{cmdresult|libGL: XF86DRIGetClientDriverName: 8.35.5 fglrx (screen 0)}}
:{{cmdresult|libGL: OpenDriver: trying /usr/lib32/dri/fglrx_dri.so}}
:{{cmdresult|libGL error: dlopen /usr/lib32/dri/fglrx_dri.so failed (/usr/lib32/dri/fglrx_dri.so: wrong ELF class: ELFCLASS32)}}
:{{cmdresult|libGL error: unable to find driver: fglrx_dri.so}}

The error itself makes sense, because I am running a 64-Bit linux on AMD. The question was, why libGL tries to look
in /usr/lib32 only...

After some digging around I found out, that apparently 8.35.5 version of the driver uses the environment variable
'''LIBGL_DRIVERS_PATH''' to find out where it should look for the "fglrx_dri.so" driver.

Now in my case this environment variable pointed to "/usr/lib32/dri" and that was what caused the problem.
So doing
:{{cmduser|<nowiki>export LIBGL_DRIVERS_PATH='/usr/lib64/dri:/usr/lib32/dri'</nowiki>}}
solved the problem in my case.

As mentioned I use gentoo. After some more digging around I found out, that it is apparently necessary to call
:{{cmduser|env-update}}
after a re-install of the ATI driver. To be more specific, it seems that "eselect opengl set ati" sometimes
does something wrong. "env-update" seems to repair the problem so that afterwards the '''LIBGL_DRIVERS_PATH'''
environment variable is set correctly when you log in.

If you want to check, look in <code>/etc/profile.env</code> and <code>/etc/profile.csh</code>. This is the
place where the '''LIBGL_DRIVERS_PATH''' environment variable gets set.

=== Softlink hell ===
The [[fglrx]] installer replaces the standard X.org OpenGL implementation (Mesa) with its own files, potentially causing collisions with the distribution's file and package management. It is best to install the driver via a package built for your distribution, which will typically include the necessary kludges to make things work. See the [[fglrx]] page for pointers.

====Discussion====
If using {{cmduser|fglrxinfo}} after installing [[fglrx]] indicates that you are still using the mesa indirect software GL renderer, you likely have some misplaced softlinks. It seems like it has to do with an apt-get upgrade that sometimes replaces these links. Anyway, go to
:{{cmdroot|cd /usr/X11R6/lib}}
and list your GL libraries and links
:{{cmdroot|ls -la *GL*}}
You should see something like the following two lines amoung others:
:{{cmdresult|libGL.so -> libGL.so.1.2}}
:{{cmdresult|libGL.so.1 -> libGL.so.1.2}}
If you see a link to a mesa library (something like {{cmdresult|... -> libGL.mesa.1.2}}), then that's your problem! Restore the softlink like this (use your actual library version, though):
:{{cmdroot|ln -s libGL.so.1.2 libGL.so.1}}

For some reason, this link might "break" later, giving you the software rendering once more. Even after renaming the mesa library to something like <tt>mesa.bkup</tt>, the system might still find it and link to it despite the name change. If you have to do this a lot, you could write a restoreGL script.

=====Gentoo=====
{{Gentoo}} has built in tools for managing the OpenGL symlinks.
:{{cmdroot|eselect opengl set ati}}
If <tt>eselect opengl ati</tt> doesn't fix it for you, you should probably tell [http://bugs.gentoo.org Gentoo Bugzilla] (assuming they don't know yet).

If {{cmdroot|ldd /usr/X11R6/bin/glxinfo}} shows that your system still uses the xorg-x11 mesa libs after trying one of the above commands, i.e. a line like this:
:{{cmdresult|1=libGL.so.1 => /usr/lib/opengl/xorg-x11/lib/libGL.so.1 (0x400a8000)}}
you will also need to relink {{path|libGl.so.1.2}}:
:{{cmdroot|cd /usr/lib/opengl/xorg-x11/lib/}}
:{{cmdroot|mv libGL.so.1.2 libGL.so.1.2_backup}}
:{{cmdroot|ln -s /usr/lib/libGL.so.1.2 libGL.so.1.2}}
After another restart of X {{cmduser|fglrxinfo}} should show that it's using the right libs now.

=====Debian=====

:{{cmdroot|rm /usr/lib/libGL.so*}}
:{{cmdroot|rm /usr/X11R6/lib/libGL.so*}}
:{{cmdroot|cd /usr/X11R6/lib}}
:{{cmdroot|cp /usr/lib/fglrx/diversions/lib/libGL.so.1.2 .}}
:{{cmdroot|ln -s libGL.so.1.2 libGL.so.1}}
:{{cmdroot|ldconfig}}

=== Troubles using software suspend ===
When the computer resumes from suspend, X only displays a garbled image and the computer is frozen.
The problem is acknowledged in ATI's release notes and in knowledge base entry <strike>[https://support.ati.com/ics/support/KBResult.asp?searchFor=Search+Words&search.x=0&search.y=0&searchOption=id&questionID=737-218+&task=knowledge&searchTime=-1&productID=&folderID=-1&resultLimit=50 737-218]</strike> [https://support.ati.com/ics/support/KBAnswer.asp?questionID=218 737-218]. Driver version 8.19.10 has "initial support for Suspend and Resume" but is working very nicely for most people (verified on T43, T43p and T42) without vbetool.

If you are using an older version of fglrx, using [http://www.srcf.ucam.org/~mjg59/vbetool/ vbetool] to save/restore the video card state before/after suspend worked for some people. If you use [[Software Suspend 2|Software Suspend 2 (suspend2)]] scripts, you can simply uncomment <tt>EnableVbetool yes</tt> in {{path|/etc/hibernate/hibernate.conf}}. Be aware though that it breaks suspend/resume for drivers beginning with version 8.19.10, so remember to disable it again when upgrading.

{| cellspacing="0" cellpadding="2" border="1"
|+ tested with the following configurations
!model!!distro||kernel!!fglrx!!PM!!success!!comments
|-
|{{T42}}||SUSE 9.3||2.6.11||8.14.13||swsusp||yes||
|-
|{{T41p}}||???||2.6.14||8.19.10||suspend2 2.2-rc9||yes||needs a small [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030381.html patch]
|-
|{{T42p}}||Debian||2.6.10||Debian packaged||suspend2||yes||
|-
|{{T43}}||Debian sid||2.6.14.2||8.19.10||swsusp||yes||works perfectly with 8.19.10 (but not earlier versions!)
|-
|{{T43}}||Debian etch||2.6.14.2||8.19.10||swsusp||yes||works perfectly with 8.19.10 and without vbetool
|-
|{{T43}}||Ubuntu Breezy||2.6.12-10||8.19.10||swsusp||yes||Perfect. (Finally.)
|-
|{{T43}}||FC4||2.6.14.1||8.19.10||suspend2 2.2-rc9||yes||needs a small [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030381.html patch], requires DRI disabled in {{path|xorg.conf}} (hence no 3D acceleration)
|-
|{{T43}}||FC4||2.6.14.2||8.19.10||suspend2 2.2-rc11||yes||requires DRI disabled in {{path|xorg.conf}} (hence no 3D acceleration)
|-
|{{T43}}||FC4||2.6.14.3||8.19.10||suspend2 2.2-rc13||no||DRI enabled
|-
|{{T43}}||FC4||2.6.14.3||8.20.8||suspend2 2.2-rc13||no||DRI enabled
|-
|{{T43p}}||FC6||2.6.20-1.2933||8.34.8||swsusp, STR||yes||DRI enabled, occasionally fails, reason unknown.
|-
|{{R50p}}||???||???||8.19.10||swsusp||yes||
|-
|{{T43p}}||Debian sid||2.6.14||8.19.10||Suspend to RAM||yes||without vbetool or UseDummyXServer, those two ''break'' the resume process here, with DRI enabled
|-
|{{T43p}}||Debian sid||2.6.14.3||8.20.8||Suspend to RAM||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{R52}}||Debian sid||2.6.15-rc5||8.20.8||swsup||yes||both vbetool and UseDummyXServer disabled, DRI enabled, needs [http://marc.theaimsgroup.com/?l=linux-kernel&m=113429835515001&w=2 patch]
|-
|{{T43p}}||Gentoo||[http://packages.gentoo.org/ebuilds/?suspend2-sources-2.6.15-r6 2.6.15]||8.22.5||Suspend to RAM||yes||without vbetool or UseDummyXServer, with DRI enabled - console is garbled until switching back from X
|-
|{{T43p}}||Gentoo||[http://packages.gentoo.org/ebuilds/?suspend2-sources-2.6.15-r6 2.6.15]||8.22.5||suspend2 2.2||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{T43}}||SUSE 10.1||2.6.16||8.25.18||swsusp||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{T43}}||SUSE 10.1||2.6.16||8.25.18||Suspend to RAM||yes||without vbetool or UseDummyXServer, with DRI enabled
|-
|{{T60}}||Gentoo 2006.1||2.6.19-suspend2||8.31.5||Suspend2||yes||Everything works: 3D, suspend-to-disk, suspend-to-ram, suspend in X.org, switching to VT's at any moment. Never needed to unload any modules manually, worked immediately. Fglrx driver 8.32.5 totally broke suspend for me, so i'm sticking with 8.31.5. T60 2008-B62 model.
|-
|{{T60p}}||Kubuntu 6.06||2.6.15||8.25.18||swsusp||no||Switching to VT to suspend: no resume, X restarts; Not switching: suspend works, garbled X display on resume, later X restarts
|-
|{{T60p}}||Kubuntu 6.06 Text Mode||2.6.15||---||swsusp||yes||suspend works in textmode after rmmod fglrx.
|-
|{{T60p}}||Debian/unstable/experimental||2.6.18||8.31.5-1 (from debian experimental)||susptoram hibernate debian packages||yes||suspend and resume works with X, 3D acc., Xv overlay...
|-
|{{T60p}}||Fedora Core 6 x86_64||2.6.20-1.2962_1.fc6.cubbi_suspend2|| 8.38.6||suspend2 hibernate||yes||suspend2 hibernate and resume working with libata driver (ahci not tested). Xv still broken since 8.35.5. Have not needed to set extra_pages_allowance thus far.
|-
|{{Z61m}}||Debian Sid||2.6.20.7||8.35.5-1||Suspend to RAM||yes||works without any problems, justs needs the usual acpi_sleep hacks
|-
|{{Z61m}}||Debian Sid||2.6.20.7||8.35.5-1||Suspend to Disk (Software Suspend)||yes||works without any problems
|-
|{{Z61m}}||Debian Sid||2.6.21||8.35.5-1||Suspend to RAM||yes||fglrx module must not be loaded into the kernel, or it won't resume
|-
|{{Z61m}}||openSUSE 10.2||2.6.21.5||8.37.6||suspend2 2.2.10||yes||/sys/power/suspend2/extra_pages_allowance must be set to 20000
|-
|{{Z61p}}||ARCH Linux||2.6.20||8.35.5-1||Suspend to RAM||yes||works with KDE suspend
|}

=== Troubles with large RAM ===
Version 8.14.13 (and probably earlier versions) of the driver does not seem to be able to cope with large amounts of RAM: with 512 MB it works, with 1.5 GB it crashes the machine as soon as X is started. The problem is present only if the <tt>fglrx</tt> kernel module is loaded, but independently of whether {{kernelconf|CONFIG_HIGHMEM||||||}} is enabled. A workaround is to limit RAM by adding the {{bootparm|mem|864m}} kernel parameter.

Version 8.16.20 fixes the problem.

===Display switching ===
The switching between internal and external display doesn't work with fglrx versions <= 8.24.8, because the driver blocks messing around with the chipset via ACPI. If you want to use this feature (i.e. during presentations), you should use the <tt>vesa</tt> server instead (experienced with a R52, Kernel 2.6.11, xorg 6.8.2, fglrx 8.16.20). Or boot notebook with CRT connected, it will automatically detect it and display on both.

===Composite Support===
ATI has not officially supported composite windowing (alpha channel) enabling hardware accelerated translucent windows (primarily for 'eye candy.') Enabling Composite in KDE and the fglrx driver results in a very pretty desktop but unacceptably slow performance on a T43p with ATI's FireGL T2. It is still unusable in its current state (as of driver 8.25.18).

ATI promises support in the future when composite is officially supported by Xorg. Discussion of current status of drivers can be found in the Rage3d forums' (http://rage3d.com/board) Linux area.

Composite support is, however, supported with recent Mesa and Xorg > 7 with the open source 3d radeon drivers as found in the linux kernel or debian's driver repository. It works with the [[R300]] / FireGL T2 series as found on the T43p extremely well. This has made rapid progress in speed with the latest few releases, and as of kernel 2.6.23 runs perfectly well with an R300 based card.

===Hardlock on X logout===
Up from driver version 8.19.10 you will experience a system hard lock when logging out from X, if the session manager (kdm/gdm) is not properly configured. You have to tell the session manager to restart X.

In the kdm config file (gentoo: {{path|/usr/kde/<VERSION>/share/config/kdm/kdmrc}}) you have to add following to the section <code>[X-:*-Core]</code>:
TerminateServer=true

In the gdm config (/etc/gdm/gdm.conf) file add the following to the daemon-section:
AlwaysRestartServer=true

Information from the ATI bugtracker: http://ati.cchtml.com/show_bug.cgi?id=239

Another reason of hardlock my be using the wrong AGP driver. Make sure that you have proper drivers for your motherboard loaded before fglrx: (gentoo: {{path|/etc/modules.autoload.d/kernel-2.6}}):
intel-agp
fglrx

A common problem seems to be mistakenly using ATI Chipset drivers instead of Intel.

Information from gentoo bugtracker: <s>[http://bugs.gentoo.org/show_bug.cgi?id=113685 113685]</s>. Fixed in 8.25.18

===Cannot switch to VT===

With usplash boot enabled, it may not be possible to switch to a VT from X (Using Alt+Fn). Tested on T60p (Mobility Fire GLV5200) on Ubuntu 6.06 / 6.10 and fglrx 8.25.18 / 8.28.8. Display may become garbled and system might freeze. Solution (testet on Ubuntu 6.10) is to either remove the "splash" kernel boot parameter or add "vga=791" parameter ("vga=794" can be used on 1400x1050 panel).

http://ati.cchtml.com/show_bug.cgi?id=37 
https://launchpad.net/distros/ubuntu/+source/usplash/+bug/63558

===Flickering Display===

Some people have reported problems with their display flickering when using ati-drivers newer than 8.14.13. The problem is unclear
(possibly associated with an incorrect modeline setting) and no known solution exists except to use the open source radeon drivers.
You can follow this problem here: http://ati.cchtml.com/show_bug.cgi?id=248

===Error messages in system log===

If you find something like the following in {{path|/var/log/messages}}:

:{{cmdresult|kernel: mtrr: base(0xc0000000) is not aligned on a size(0x7ff0000) boundary}}
:{{cmdresult|kernel: [fglrx:firegl_addmap] *ERROR* mtrr allocation failed (-22)}}
:{{cmdresult|kernel: [fglrx:firegl_unlock] *ERROR* Process 5132 using kernel context 0}}

try to execute the following line and reload the fglrx module:

:{{cmdroot|1=echo "base=0xd0000000 size=0x8000000 type=write-combining" > /proc/mtrr}}

More detailed instructions can be found [http://ubuntuforums.org/showthread.php?t=115104 here].

===Hang when logging out===

A common problem is that when logging out from X, instead of gettign the KDM or GDM prompt, the system hangs.

This is discussed, including workarounds here: http://ati.cchtml.com/show_bug.cgi?id=239

===No power saving when CRT in use===

When both CRT and LCD are in use, power saving cannot be enabled.

This is reported here: http://ati.cchtml.com/show_bug.cgi?id=304

===WineX / Cedega Installs Software But Errors on Loading Games===

Some users may experience problems with certain FIREGL cards (in my case an ibm t43p laptop with a v3200 ati firegl) whereby projects such as cedega and wine refuse to work with 3d graphics, but native binaries (e.g. quake 4) work fine. A possible workaround is to add the following line in the drivers section of your /etc/X11/xorg.conf

Option "UseFastTLS" "2"

This option used to be configured with the older ati drivers when you ran "fglrxconfig". I have not yet found a way to get it to appear with "aticonfig", hence the manual insertion. This option is good for several linux distros I have tried, fedora core 5, ubuntu dapper and suse 10.1. It does not appear to effect performance on natively run programs.

{{NOTE|This may cause problems on machines with a Linux kernel version of 2.6.20 or higher (observed choppy video and video color inversion on T60p with both 2.6.20 and 2.6.21).}}

===Line Appears Below Mouse Cursor===

Some users have reported seeing a line approximately 1 mouse height below the bottom edge of the cursor, which follows the mouse and appears to change color based on the image below the cursor. This has been seen to happen using fglrx without the kernel module installed (in 2D mode) and additionally on external displays or multiple X servers. To work around the problem, try disabling the DGA extension by making the following changes to your XFree86.conf or xorg.conf file. Replace (or comment-out)
Load "extmod"
with
SubSection "extmod"
Option "omit xfree86-dga"
EndSubSection

===Freeze while using OpenGL Apps===

Some OpenGL applications such as screensavers or games (SecondLife) cause freezes. The cursor still moves, but otherwise the machine is unresponsive. This is the case with Xorg 7.1 and fglrx 8.29.6 using an x1400 and other cards. The solution is to add the following options to the video Device section in xorg.conf:
Option "Capabilities" "0x00000800"
Option "KernelModuleParm" "locked-userpages=0"

===Xv doesn't work correctly with drivers >= 8.36 and Xyyyy-cards===

See [http://ati.cchtml.com/show_bug.cgi?id=677] for further information. It seems as if only Xyyyy-cards are affected. Problem: graphical glitches with mplayer, programs like xine and totem might not start up at all. 8.35 doesn't seem to be affected

===Floating Point Exception with various X apps===

When the X server is left to autodetect the DPI, the fglrx driver may fail to supply the monitor dimensions. Video output switching may contribute to this bug.

Problems were experienced on T42p with Ubuntu 7.04, xorg-driver-fglrx 7.1.0-8.34.8+2.6.20.5-16.29.

This can be observed with xdpyinfo

:{{cmduser|xdpyinfo | grep dimensions}}
:{{cmdresult|dimensions: 1280x1024 pixels (0x0 millimeters)}}

Many applications will use the screen size and attempt to calculate DPI, resulting in a divide by zero operation and a SIGFPE.

A work around is to supply the dimensions in /etc/X11/xorg.conf. Use the DisplaySize parameter within your monitor's configuration. For example:

Section "Monitor"
Identifier "Generic Monitor"
HorizSync 28.0 - 64.0
VertRefresh 43.0 - 60.0
Option "DPMS"
DisplaySize 433 351
EndSection

== Patches ==
The following patches might be needed for certain versions of fglrx. Before you apply any of these, make sure that you really need them, as some distributions include all the necessary patches with the appropriate package (e.g. ati-drivers in gentoo).

===fglrx 8.37.6===
* For kernel 2.6.22 you need this patch from a [http://www.phoronix.com/forums/showthread.php?t=2849 Phoronix thread].

===fglrx 8.35.5===
* [http://whoopie.gmxhome.de/linux/patches/2.6.20/fglrx-8.35.5-for-2.6.20.patch For kernel 2.6.20], part of the Fedora packaging scripts in the ATI installer

===fglrx 8.34.8===
* [http://whoopie.gmxhome.de/linux/patches/2.6.20/fglrx-8.34.8-for-2.6.20.patch For kernel 2.6.20]

===fglrx 8.32.5===
* [http://whoopie.gmxhome.de/linux/patches/2.6.19/fglrx-8.32.5-for-2.6.19.patch For kernel 2.6.19]

===fglrx 8.23.7===
* For kernel 2.6.16: [http://mirror.espri.arizona.edu/gentoo/rsync/x11-drivers/ati-drivers/files/ati-drivers-8.22.5-intermodule.patch <tt>intermodule</tt> patch] and [http://mirror.espri.arizona.edu/gentoo/rsync/x11-drivers/ati-drivers/files/ati-drivers-8.23.7-noiommu.patch <tt>noiommu</tt> patch]

===fglrx 8.21.7===

* [http://www.ksp.sk/~rasto/fglrx_with_2.6.15.patch for kernels >= 2.6.15]

===fglrx 8.20.8===

* [http://marc.theaimsgroup.com/?l=linux-kernel&m=113429835515001&w=2 for kernel 2.6.15]
or
* [http://www.ksp.sk/~rasto/fglrx_with_2.6.15.patch for kernels >= 2.6.15]

===fglrx (problem met at least with version 8.18.8)===
* [http://lkml.org/lkml/2005/9/22/183 for kernel >= 2.6.13 ] Missing verify_area bug

===fglrx 8.8.25 ===
* [http://www.rage3d.com/board/showthread.php?t=33798874 for kernels >= 2.6.10]
* [http://www.gehirn.org.uk/wiki/images/8.8.25-kernel-2.6.11+.patch For kernels >= 2.6.11-rc1]

===Links ===
* [http://gentoo-wiki.com/HOWTO_ATI_Drivers Gentoo HOWTO ATI]

HDAPS

2007-06-07T12:35:33Z

Whoopie: /* Disk head parking */

Fglrx

2007-05-31T21:04:10Z

Whoopie: /* Status */ fglrx 8.37.6

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
== ATI fglrx driver ==
This is a proprietary Linux binary-only driver for ATI graphic chips with support for 3D acceleration.

Also see [[R300|opensource driver]] with 3D support
|}

==Availability / Project Homepage==
Home page: http://ati.amd.com/support/drivers/linux/linux-radeon.html

== Packages ==
The ATI drivers have explicit permission for repackaging and redistribution of the Linux drivers. Many distributions are supported within the installer, and many more repackaged by external developers. Please visit the [http://wiki.cchtml.com/index.php/Category:Distributions Distribution Page at the Unofficial ATI driver Wiki]

*{{Debian}} packages: http://www.stanchina.net/~flavio/debian-official/fglrx-driver.html
** These packages have been added to Debian unstable as <tt>fglrx-driver</tt>, so you can now apt-get them and use module-assistant to install.
** If you are on stable sarge with backport's kernel 2.6.15, download ATI's installer, let it build Debian packages and proceed as usual. There's a [http://jroller.com/page/erAck?entry=lot_day_6_2_fglrx detailed description] available.
*{{SUSE}} packages: http://www.suse.de/~sndirsch/ati-installer-HOWTO.html
*{{Gentoo}} {{cmdroot|emerge ati-drivers}}
*{{Fedora}} 4 packages: http://rpm.livna.org
** For stock Fedora kernels: {{cmdroot|yum install kernel-module-fglrx-$(uname -r) ati-fglrx }}
** For custom-compiled kernels: see [[How to build custom packages for fglrx]]
*{{Fedora}} 5 packages: http://rpm.livna.org
** For stock Fedora kernels: {{cmdroot|yum install xorg-x11-drv-fglrx}}
** For custom-compiled kernels: see [[How to build custom packages for fglrx]]
*{{Arch Linux}}
:{{cmdroot|pacman -S ati-fglrx}} (kernel module for 2.6.15-ARCH)
:{{cmdroot|pacman -S ati-fglrx-archck}} (kernel module for 2.6.15-archck)
:{{cmdroot|pacman -S ati-fglrx-utils}} (xorg7 stuff and tools)
*{{Ubuntu}}
**[http://wiki.cchtml.com/index.php/Ubuntu_Dapper_Installation_Guide Dapper Drake Howto]
**[http://wiki.cchtml.com/index.php/Ubuntu_Breezy_Installation_Guide Breezy Badger Howto]
**[http://wiki.cchtml.com/index.php/Ubuntu_Edgy_Installation_Guide Edgy Eft Howto]
**[http://wiki.cchtml.com/index.php/Ubuntu_Feisty_Installation_Guide Feisty Fawn Howto]

== Building for Xorg 7.0==
To compile fglrx versions <= 8.24.8 for Xorg 7.0.0, fake Xorg 6.9.0 by
:{{cmdroot|1=export X_VERSION=x690; sh ati-driver-installer-8.24.8-x86.run}}
Next, move the various resulting libraries and modules from /usr/X11R6 to /usr/lib/xorg

In {{path|/usr/src/ATI}} additional sources are installed for fireglcontrol and fgl_glxgears

== Status ==
Current version: 8.37.6 (31st May 2007).
Major changes:
* 8.37.6: Xorg Server 1.3 support, CCC 1.0, crash when logging off from X fixed, Xv cropping bug fixed
* 8.36.5: Kernel 2.6.20 support, CCC Beta 0.9 with localization
* 8.35.5: Beta AMD Catalyst Control Center, X-Server termination from console does not result in a blank screen. Kernel 2.6.20 requires some patching (see [[Problems_with_fglrx#fglrx_8.35.5|fglrx patches section]]).
* 8.34.8: Radeon Xpress 1250 support, X-Video on x86_64 fix, hibernation mode fix. Kernel 2.6.20 requires some patching (see [[Problems_with_fglrx#fglrx_8.34.8|fglrx patches section]]).
* 8.33.6: X.Org 7.2 support, kernel 2.6.19 support, some fixes in the installer, 2 more bugfixes. Resume from suspend works if you make sure you have set "VbetoolPost no" and "EnableVbetool no" in your suspend to ram hibernate conf (/etc/hibernate/ram.conf on ubuntu/debian).
* 8.32.5: support for X1650, X.Org 7.2 RC2 support, bugfixes. Suspend-to-ram is broken with specific cards, *no* 2.6.19 support (see [[Problems_with_fglrx#fglrx_8.32.5|fglrx patches section]]).
* 8.31.5: no new features, only bugfixes. Of note, for some users, this version breaks suspend-to-ram and suspend-to-disk.
* 8.30.3: no new features, only bugfixes
* 8.29.6: Linux 2.6.18 support, dropped support for Radeon 8500/9000/9100/9200/9250 (both, mobile and normal versions)
* 8.28.8: Display Switching Support for ThinkPads, ATI Pairmode support, Retaining display device state between restarts, Support for Radeon Xpress 1200, 1250, and 1300
* 8.27.10: X.org 7.1 support, Fedora Core package support
* 8.26.18: support for dynamically attached DFPs and Thermal Event Power Management (both via daemon), minor bug fixes
* 8.25.18: Xorg 7.0 support, FireGLâ„¢V5xxx/V7xxx support, Dynamic Display Management, fixed a lot of critical bugs.
* 8.24.8: support for X1300, X1400, X1600, X1800 (generic and mobility) and 3D accelerated video playback on Avivo
* 8.23.7: support for X850 and X800, OpenGL 2.0 Enhancement, FSAA for some chips
* 8.22.5: added kernel 2.6.15 support -- patch no longer required
* 8.21.7: initial OpenGL 2.0 support
* 8.20.8: fixed resume issues, fixed compile problems with kernels 2.6.13 and 2.6.14
* 8.19.10: has added suspend / resume and dynamic GPU power management support. Using vbetool no longer required.

== Known problems and solutions ==
See [[Problems with fglrx]].
== User experience ==
=== Speed ===
How much is the speed gain versus the opensource drivers?

Compared to the old drivers, approximately 40% speed gain have been noticed with fglrx. However, there are issues with freezing/garbage after suspend, garbage when resizing desktop (via {{key|ctrl}}{{key|alt}}{{key|plus}}, {{key|ctrl}}{{key|alt}}{{key|minus}}), and garbage while using VMware. The current 8.14.13 has shown 400% improvement over using the open source radeon driver: 1200 FPS for glxgears{{footnote|1}}!
However the situation seems to be changing today. With recent x11-drm-20060608 driver (gentoo) and thinkpad t42 (ati 9600) the speed is confirmed as 1900fps without any single crash so far.

=== 3D acceleration ===

According to [http://xoomer.alice.it/flavio.stanchina/debian/fglrx-installer.html#configure Flavio's page] you need these options:

Section "Module"
...
Load "GLcore"
Load "glx"
Load "dri"
...
EndSection

# Of course you need to activate the driver
Section "Device"
...
Driver "fglrx"
EndSection

Don't forget to load the module <tt>fglrx</tt> (<tt>modprobe fglrx</tt>). Under Debian the module can be placed in <tt>/etc/modules</tt>.

With current fglrx drivers (as of 8.29.6) you must disable composite to get 3D DRI acceleration. To do this, add an extra Extensions section (if necessary) containing:

Section "Extensions"
Option "Composite" "Disable" #make DRI work with fglrx.
EndSection

If you are unsure whether you have DRI running, issue <tt>glxinfo | grep -i direct</tt> after disabling composite. Note, this

{{NOTE|1=Video overlay acceleration may be disabled when 3D acceleration is enabled. The following comment from the xorg.conf file bundled with the fglrx driver indicates that:
# === OpenGL Overlay ===
# Note: When OpenGL Overlay is enabled, Video Overlay
# will be disabled automatically
Option "OpenGLOverlay" "1"
However, you can use either regular Xv video overlay or make the video an opengl texture and let the OpenGL engine scale your video. This has nothing to do with the acceleration of 2D drawing primitives. Further, your mileage on performance may vary depending on what card you have. The open source drivers don't support newer cards, while the ATI drivers don't support older cards.

You may be able to preserve VideoOverlay acceleration if you explicitly remove the OpenGLOverlay using:

Option "VideoOverlay" "True" and Option "OpenGLOverlay" "False". See [http://xoomer.alice.it/flavio.stanchina/debian/fglrx-installer.html#configure Flavio's page] for detail.}}

=== Power saving ===
Power saving is much better than with the <tt>radeon</tt> driver, but doesn't work in dual-screen configuration (see [[How to make use of Graphics Chips Power Management features]]).

=== Suspending with fglrx ===

On a ThinkPad T42 with Kernel 2.6.19 with Software Suspend 2 and R60 with Kernel 2.6.18-suspend2-r1 (Gentoo) , the following addition to <tt>/etc/hibernate/suspend2.conf</tt> is required:

# For fglrx
ProcSetting extra_pages_allowance 20000

=== Display Switching (Dynamic Display Management) ===

Version 8.25.18 introduces a new feature: Dynamic Display Management. It allows display switching on-the-fly.

To list all connected and enabled monitors:
:{{cmdroot|1=aticonfig --query-monitor}}

To switch displays:
:{{cmdroot|1=aticonfig --enable-monitor=STRING,STRING}}, where STRING can be: none, lvds, crt1, crt2, tv, tdms1, tdms2

Only 2 displays can be enabled at the same time. Any displays that are not on the list will be disabled.

== Useful links ==
* [http://www.ati.com/products/catalyst/linux.html ATI Linux Driver FAQ]
* [http://www.rage3d.com/content/articles/atilinuxhowto/ ATI Radeon Linux How-To]
* [http://www.rage3d.com/board/forumdisplay.php?f=61&daysprune=30&order=asc&sort=title Rage3D Linux Discussion Forum]
* [http://www.driverheaven.net/forumdisplay.php?f=103 Radeon Driver Forum at Driverheaven]
* [http://odin.prohosting.com/wedge01/gentoo-radeon-faq.html Gentoo ATI Radeon FAQ]
* [http://forums.gentoo.org/viewtopic-t-374745-highlight-t42+ati+dri.html Gentoo T42 ATI. DRI + xorg driver]
* [http://ati.cchtml.com/ Unofficial community ATI bugzilla] - tracks bugs in the driver. Might be monitored by ATI ([http://www.rage3d.com/board/showpost.php?p=1333438751&postcount=386], [http://www.rage3d.com/board/showpost.php?p=1333439009&postcount=390]).

== ThinkPads that may be supported ==
Supported chips, as found in select IBM ThinkPads:
{{NOTE|fglrx version 8.29.6 discontinued support for Radeon 9200 and earlier.}}
* [[ATI Mobility FireGL 9000]]
** {{T40p}}
* [[ATI Mobility FireGL T2]]
** {{R50p}}
** {{T41p}}, {{T42p}}
* [[ATI Mobility FireGL V3200]]
** {{T43p}}
* [[ATI Mobility Radeon 9000]]
** {{R50}}, {{R51}}
** {{T40}}, {{T41}}, {{T42}}
* [[ATI Mobility Radeon 9600]]
** {{T42}}
* [[ATI Mobility Radeon X300]]
** {{R52}}
** {{T43}}
** {{Z60m}}
* [[ATI Mobility Radeon Xpress 200M]]
** {{R51e}}
* [[ATI Mobility Radeon X600]]
** {{Z60m}}
* [[ATI Mobility Radeon X1400]]
** {{T60}}, {{R60}}, {{Z61m}}
* [[ATI Mobility FireGL V5200]]
** {{T60p}}, {{Z61p}}

== ThinkPads that are NOT supported by fglrx==
Unsupported chips, as found in select IBM ThinkPads:
* [[ATI Mobility Radeon 7500]]
** {{R40}}
** {{T30}}
** {{T42}}

{{footnotes|
#Note that glxgears isn't a benchmark tool, it's so simple that its FPS values is without any meaning... you can only compare glxgears using the same drivers/machine, if you change any of then you can have higher/lower values and in real life programs/games happen to have the opposite effects. Think in terms of a car engines rpms: higher rpms in the same car usually means a faster car, change anything and it's meaningless, ie: gears, truck, wheel size, etc. make it useless.
}}
[[Category:Drivers]]

Template:Industry News

2007-05-31T21:01:25Z

Whoopie:

31. 5. 2007: New [[fglrx]] driver version 8.37.6 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.37.6.html released].

18. 4. 2007: New [[fglrx]] driver version 8.36.5 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.36.5.html released]. Now supports 2.6.20 series kernels.

28. 3. 2007: New [[fglrx]] driver version 8.35.5 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.35.5.html released]

1. 3. 2007: New Lenovo [http://www.lenovo.com/batteryprogram battery recall]: FRU 92P1131 (Sanyo 9-cell) may overheat when subject to strong impacts

21. 2. 2007: New [[fglrx]] driver 8.34.8 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.34.8.html#182529 released]

Template:Industry News

2007-05-31T21:01:03Z

Whoopie:

31. 5. 2007: New [[fglrx]] driver version 8.37.6 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.37.6.html].

18. 4. 2007: New [[fglrx]] driver version 8.36.5 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.36.5.html released]. Now supports 2.6.20 series kernels.

28. 3. 2007: New [[fglrx]] driver version 8.35.5 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.35.5.html released]

1. 3. 2007: New Lenovo [http://www.lenovo.com/batteryprogram battery recall]: FRU 92P1131 (Sanyo 9-cell) may overheat when subject to strong impacts

21. 2. 2007: New [[fglrx]] driver 8.34.8 [https://a248.e.akamai.net/f/674/9206/0/www2.ati.com/drivers/linux/linux_8.34.8.html#182529 released]

ThinkWiki talk:Support

2007-05-30T08:33:01Z

Whoopie: does spamming start again?

When returning from PayPal, I'm sent to http://www.thinkwiki.org/ThinkWiki:Thanks?=Return+To+Merchant, which generates a 404.

== ibm-acpi donations ==

[[ibm-acpi]] does not need any donations of funds. ThinkWiki it is a damn great resource and it has far more use for the funding than ibm-acpi, so if you were considering donating money to ibm-acpi, please donate to ThinkWiki instead!

--[[User:Hmh|hmh]] 21:33, 8 January 2007 (CET) (ibm-acpi maintainer)

Category:Debian

2007-05-26T11:01:03Z

Whoopie: fix typo

{| width="100%"
|style="vertical-align:middle;padding-left:20px;padding-right:20px;width:10px;" | [[Image:Debian_logo.png]]
|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;">
=== Debian ===
This page gives an introduction to Debian [http://www.debian.org] and an overview of related articles.
</div>
|}
{| style="margin-left:20px;margin-right:20px;"
|
__NOTOC__
=== What is Debian? ===
Debian is a free operating system (OS) for your computer. An operating system is the set of basic programs and utilities that make your computer run. Debian uses the Linux kernel (the core of an operating system), but most of the basic OS tools come from the GNU project; hence the name GNU/Linux.

Debian GNU/Linux provides more than a pure OS: it comes with more than 15490 packages, precompiled software bundled up in a nice format for easy installation on your machine.

=== Debian Version [http://www.debian.org/releases/] ===
{| border="1" cellspacing="0" cellpadding="2"
|-
! colspan=2 | Version
! colspan=2 | Documentation
! Comments
|- style="text-align:left;vertical-align:top;"
|| <tt>status</tt> || <tt>Name</tt>
|| <tt>Release Information</tt>
|| <tt>Installation Guide</tt>
||
|- style="background-color:#8f8"
|| '''stable''' || ''' ''Etch 4.0'' '''
|| [http://www.debian.org/releases/stable/]
|| [http://www.debian.org/releases/stable/installmanual]
|| The stable version IS the version you should install.
|- style="color:#000; background-color:#dfd"
|| oldstable || ''Sarge 3.1''
|| [http://www.debian.org/releases/sarge/]
|| [http://www.debian.org/releases/sarge/installmanual]
|| The last stable version. You should consider upgrading. (It's still supported)
|- style="color:#333; background-color:#ddd"
|| obsolete || ''Woody 3.0''
|| [http://www.debian.org/releases/woody/]
|| [http://www.debian.org/releases/woody/installmanual]
|| Obsolete stable version. Don't Install it.
|- style="color:#333; background-color:#ddd"
|| obsolete || ''Potato 2.2''
|| [http://www.debian.org/releases/potato/]
|| [http://www.debian.org/releases/potato/installmanual]
|| Obsolete stable version. Don't Install it.
|-
! colspan=5 | Development version
|- style="color:#333; background-color:#ddd"
|| '''testing''' || ''Lenny''
|| [http://www.debian.org/releases/testing/]
|| n.a
|| Development for next stable version. Not for production purpose.
|- style="color:#333; background-color:#ddd"
|| '''unstable''' || ''sid''
|| [http://www.debian.org/releases/unstable/]
|| n.a
|| Early test of package. Not for production purpose.
|-
|}

=== Debian Support [http://www.debian.org/support] ===
* Debian Mailing Lists with archives [http://lists.debian.org/]
** [http://lists.debian.org/debian-laptop/ Debian-Laptop] - Installing, updating and using laptops with Debian.
** [http://lists.debian.org/debian-user/ Debian-User] - Support for Debian users who speak English.
* [http://wiki.debian.org Debian Wiki]
* [http://www.debian.org/support#irc Debian Irc Channel]
* [http://www.debian.org/doc/ Debian Documentation Hub]
|}

[[Category:Distributions]]

Default meanings of special keys

2007-05-20T15:51:48Z

Whoopie: /* R Series */

{| width="100%" columns="2"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" rowspan="2" | __TOC__
|style="vertical-align:top" |

The following table lists the associated functionalities for special keys on ThinkPads.
|}

{| width="100%" {{prettytable}}
! style="background:#ffdead;"| Models
! style="background:#ffdead;"| {{key|Fn}}{{key|F1}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F2}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F3}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F4}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F5}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F6}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F7}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F8}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F9}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F10}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F11}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F12}}
! style="background:#ffdead;"| {{key|Fn}}{{key|Home}}
! style="background:#ffdead;"| {{key|Fn}}{{key|End}}
! style="background:#ffdead;"| {{key|Fn}}{{key|PageUp}}
! style="background:#ffdead;"| {{key|Fn}}{{key|Space}}
! style="background:#ffdead;"| {{key|Fn}}{{key|left}}
! style="background:#ffdead;"| {{key|Fn}}{{key|right}}
! style="background:#ffdead;"| {{key|Fn}}{{key|up}}
! style="background:#ffdead;"| {{key|Fn}}{{key|down}}
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===Numbered===
|-
| {{240}}, {{240X}}, 240Z
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{365C}}, {{365CD}}, {{365CS}}, {{365CSD}}, {{365E}}, {{365ED}}, {{365X}}, {{365XD}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{380}}, {{380D}}, {{380E}}, {{380ED}}, {{385D}}, {{385ED}}, {{380XD}}, {{385XD}}, {{380Z}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{390}}, {{390E}}, {{390X}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{560}}, {{560E}}, {{560X}}, {{560Z}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{570}}, {{570E}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{600}}, {{600E}}, {{600X}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{750}}, {{750CS}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{755C}}, {{755CS}}, {{755CE}}, {{755CSE}}, {{755CD}}, {{755CX}}, {{755CV}}, {{755CDV}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{760C}}, {{760CD}}, {{760L}}, {{760LD}}, {{760E}}, {{760ED}}, {{760EL}}, {{760ELD}}, {{760XD}}, {{765D}}, {{765L}}, {{760XL}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{770}}, {{770E}}, {{770ED}}, {{770X}}, {{770Z}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===i Series===
|-
| {{i1720}}, {{i1721}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===A Series===
|-
| {{A20m}}, {{A20p}}, {{A21e}}, {{A21m}}, {{A21p}}, {{A22e}}, {{A22m}}, {{A22m}}, {{A22p}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{A30}}, {{A30p}}, {{A31}}, {{A31p}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |
===G Series===
|-
| {{G40}}, {{G41}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |
===R Series===
|-
| {{R30}}, {{R31}}, {{R32}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{R40}}, {{R40e}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{R50}}, {{R50e}}, {{R50p}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{R51}}, {{R51e}}, {{R52}}
|
|
| blank screen
| suspend to ram
| switch wireless/bluetooth
|
| switch display
|
|
|
|
| suspend to disk
| brightness increase
| brightness decrease
| thinklight
| zoom
|
|
|
|
|-
| {{R60}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===T Series===
|-
| {{T20}}, {{T21}}, {{T22}}, {{T23}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{T30}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{T40}}, {{T40p}}, {{T41}}, {{T41p}}, {{T42}}, {{T42p}}, {{T43}}, {{T43p}}
|
|
| blank screen
| suspend to ram
| switch wireless
|
| switch display
| zoom(?)
| (un)dock
|
|
| suspend to disk
| brightness increase
| brightness decrease
| thinklight
| zoom
|
|
|
|
|-
| {{T60}}, {{T60p}}
|
| lock screen
| energy manager/ settings
| suspend to ram
| wireless/bluetooth
|
| switch display
| control ultranav
| eject
|
|
| suspend to disk
| brightness up
| brightness down
| thinklight
| zoom
| last track
| next track
| stop
| play / pause
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===X Series===
|-
| {{X20}}, {{X21}}, {{X22}}, {{X23}}, {{X24}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X30}}, {{X31}}, {{X32}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X40}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X41}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X41T}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X60}}, {{X60s}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X60t}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===Z Series===
|-
| {{Z60m}}, {{Z60t}}
|
| lock desktop
| show state of battery
| suspend to ram (sleep)
| toggle bluetooth
|
| switch to external vga-output
| switch between trackpoint and touchpad
| eject dock
|
|
| suspend to disk (hibernate)
| brightness increase
| brightness decrease
| thinklight
|
|
|
|
|
|-
| {{Z61e}}, {{Z61m}}, {{Z61p}}, {{Z61t}}
|
| ?
| ?
| suspend to ram
| switch wireless
|
| switch display
| switch trackpoint / touchpad
| (un)dock
|
|
| suspend to disk
| brightness increase
| brightness decrease
| thinklight
| zoom
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===Other===
|-
| {{TransNote}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|}

[[Category:Tables]]

Default meanings of special keys

2007-05-20T15:50:52Z

Whoopie: /* R Series */ added R52

{| width="100%" columns="2"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" rowspan="2" | __TOC__
|style="vertical-align:top" |

The following table lists the associated functionalities for special keys on ThinkPads.
|}

{| width="100%" {{prettytable}}
! style="background:#ffdead;"| Models
! style="background:#ffdead;"| {{key|Fn}}{{key|F1}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F2}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F3}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F4}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F5}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F6}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F7}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F8}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F9}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F10}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F11}}
! style="background:#ffdead;"| {{key|Fn}}{{key|F12}}
! style="background:#ffdead;"| {{key|Fn}}{{key|Home}}
! style="background:#ffdead;"| {{key|Fn}}{{key|End}}
! style="background:#ffdead;"| {{key|Fn}}{{key|PageUp}}
! style="background:#ffdead;"| {{key|Fn}}{{key|Space}}
! style="background:#ffdead;"| {{key|Fn}}{{key|left}}
! style="background:#ffdead;"| {{key|Fn}}{{key|right}}
! style="background:#ffdead;"| {{key|Fn}}{{key|up}}
! style="background:#ffdead;"| {{key|Fn}}{{key|down}}
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===Numbered===
|-
| {{240}}, {{240X}}, 240Z
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{365C}}, {{365CD}}, {{365CS}}, {{365CSD}}, {{365E}}, {{365ED}}, {{365X}}, {{365XD}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{380}}, {{380D}}, {{380E}}, {{380ED}}, {{385D}}, {{385ED}}, {{380XD}}, {{385XD}}, {{380Z}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{390}}, {{390E}}, {{390X}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{560}}, {{560E}}, {{560X}}, {{560Z}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{570}}, {{570E}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{600}}, {{600E}}, {{600X}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{750}}, {{750CS}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{755C}}, {{755CS}}, {{755CE}}, {{755CSE}}, {{755CD}}, {{755CX}}, {{755CV}}, {{755CDV}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{760C}}, {{760CD}}, {{760L}}, {{760LD}}, {{760E}}, {{760ED}}, {{760EL}}, {{760ELD}}, {{760XD}}, {{765D}}, {{765L}}, {{760XL}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{770}}, {{770E}}, {{770ED}}, {{770X}}, {{770Z}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===i Series===
|-
| {{i1720}}, {{i1721}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===A Series===
|-
| {{A20m}}, {{A20p}}, {{A21e}}, {{A21m}}, {{A21p}}, {{A22e}}, {{A22m}}, {{A22m}}, {{A22p}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{A30}}, {{A30p}}, {{A31}}, {{A31p}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |
===G Series===
|-
| {{G40}}, {{G41}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |
===R Series===
|-
| {{R30}}, {{R31}}, {{R32}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{R40}}, {{R40e}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{R50}}, {{R50e}}, {{R50p}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{R51}}, {{R51e}}, {{R52}}
|
|
| blank screen
| suspend to ram
| switch wireless/bluetooth
|
| switch display
|
|
|
|
| suspend to disk
| brightness increase
| brightness decrease
| thinklight
| zoom
|
|
|
|
|-
| {{T60}}, {{T60p}}
|
| lock screen
| energy manager/ settings
| suspend to ram
| wireless/bluetooth
|
| switch display
| control ultranav
| eject
|
|
| suspend to disk
| brightness up
| brightness down
| thinklight
| zoom
| last track
| next track
| stop
| play / pause
|-
| {{R60}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===T Series===
|-
| {{T20}}, {{T21}}, {{T22}}, {{T23}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{T30}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{T40}}, {{T40p}}, {{T41}}, {{T41p}}, {{T42}}, {{T42p}}, {{T43}}, {{T43p}}
|
|
| blank screen
| suspend to ram
| switch wireless
|
| switch display
| zoom(?)
| (un)dock
|
|
| suspend to disk
| brightness increase
| brightness decrease
| thinklight
| zoom
|
|
|
|
|-
| {{T60}}, {{T60p}}
|
| lock screen
| energy manager/ settings
| suspend to ram
| wireless/bluetooth
|
| switch display
| control ultranav
| eject
|
|
| suspend to disk
| brightness up
| brightness down
| thinklight
| zoom
| last track
| next track
| stop
| play / pause
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===X Series===
|-
| {{X20}}, {{X21}}, {{X22}}, {{X23}}, {{X24}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X30}}, {{X31}}, {{X32}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X40}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X41}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X41T}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X60}}, {{X60s}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
| {{X60t}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===Z Series===
|-
| {{Z60m}}, {{Z60t}}
|
| lock desktop
| show state of battery
| suspend to ram (sleep)
| toggle bluetooth
|
| switch to external vga-output
| switch between trackpoint and touchpad
| eject dock
|
|
| suspend to disk (hibernate)
| brightness increase
| brightness decrease
| thinklight
|
|
|
|
|
|-
| {{Z61e}}, {{Z61m}}, {{Z61p}}, {{Z61t}}
|
| ?
| ?
| suspend to ram
| switch wireless
|
| switch display
| switch trackpoint / touchpad
| (un)dock
|
|
| suspend to disk
| brightness increase
| brightness decrease
| thinklight
| zoom
|
|
|
|-
! colspan=21 style="text-align:center;background:#efefef;" |

===Other===
|-
| {{TransNote}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|}

[[Category:Tables]]

How to hotswap Ultrabay devices

2007-05-19T12:20:00Z

Whoopie: /* Scripts for hotswapping */ give file names more clear names

The following discusses hotswap (AKA "hotplug") of devices in the [[UltraBay]].

==When using the <tt>ide-disk</tt> driver==
The following applies if you use the <tt>ide-disk</tt> driver for the UltraBay device.

Hotswapping is supposed to be supported as well, using either hdparm/[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] or [[lt_hotswap]] to (un)register IDE devices. The latter is the recommended method with kernels from 2.6, since it will leave DMA working. However, for recent models (R52, T43, X41, Z60 and later) no method is known to work while maintaining DMA support; see [[Problems with SATA and Linux]].

Only IDE devices (HDD's, optical drives, zip drives) require special treatment - batteries, floppies and other devices can just be pulled from the bay, provided they are not mounted or in use at the time. However, you should still power them down first using the [[ibm-acpi]] eject function.

The [[ibm-acpi]] kernel module has an eject function ({{cmdroot|echo eject > /proc/acpi/ibm/bay}}). This only manages the ACPI calls to power down the device and the bay. It does not actually unregister the device from the IDE driver. {{cmdroot|cat /proc/acpi/ibm/bay}} shows "unoccupied" unless an IDE device is present, but the eject function still works and should still be used.

To unregister the device, you can either use the [http://packages.debian.org/unstable/admin/hotswap Debian hotswap] package, or [[lt_hotswap]].

[http://packages.debian.org/unstable/admin/hotswap Debian hotswap] also allows the drive to be swapped as a normal user by default, which is useful. You should use <tt>hotswap</tt> to unregister the device and then {{cmdroot|echo eject > /proc/acpi/ibm/bay}}. However, if you use this method on a 2.6 kernel, you will lose DMA support for the reinserted drive. This is due to kernel issues. This method was reported to work on a ThinkPad {{T23}} (kernels 2.6.8.1, 2.6.14.2 and 2.6.15-arch) and {{T42}} (kernel 2.6.13), but fails on a ThinkPad {{T43}} (kernel 2.6.14.3).

[[lt_hotswap]] is now the recommended method to un- and reregister the IDE device. It installs as a kernel module and has support for automatically unregistering (if loaded with the auto_eject=1 option) the device when the eject event is generated by [[ibm-acpi]]. It will leave DMA support intact. It has supported to work on a ThinkPad {{T22}} and {{T40}} and should work with many other models (but not recent models which require the <tt>ata_piix</tt> driver for disk DMA support). With the [[lt_hotswap]] kernel module loaded, run: {{cmdroot|modprobe -r ide_cd && modprobe -r cdrom && echo "MSTR eject" > /proc/acpi/lths}}

===HAL support===

HAL support also can also be configured To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="ide">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_24ca_ide_1_0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>
For more details see HAL section for ata driver.

==When using the <tt>ata_piix</tt> driver==
The following applies when using the <tt>ata_piix</tt> driver, which is necessary for many recent ThinkPad models that use an [[Intel ICH6-M]] controller. See also [[Problems with SATA and Linux]].

Mainline kernels before 2.6.18 cannot reliably recognize newly (re-)inserted UltraBay drives without a reboot. There are experimental hotplug patches against pre-2.6.18 mainline kernels [http://home-tj.org/wiki/index.php/Libata-tj-stable here].

* Available hotplug patches
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.16.16-20060512.tar.bz2 Patch tarball against 2.6.16.16] ([http://lwn.net/Articles/183407/ Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17-20060625-1.tar.bz2 Patch tarball against 2.6.17/2.6.17.1] ([http://article.gmane.org/gmane.linux.ide/11598 Announce])
**[http://home-tj.org/files/libata-tj-stable/libata-tj-2.6.17.4-20060710.tar.bz2 Patch tarball against 2.6.17.4]
**[http://whoopie.gmxhome.de/linux/patches/2.6.17.14-tj/00-libata-tj-2.6.17.4-20060710.patch Patch against 2.6.17.14]

* Confirmed to work on
**ThinkPad {{T30}}
**ThinkPad {{T43}}, {{T43p}}
**ThinkPad {{R52}}

For 2.6.18 kernels, or older kernels that were patched to support <tt>ata_piix</tt> hotplug (don't try it otherwise!), one can issue the following after inserting an UltraBay drive to rescan the port:
{{cmdroot|echo 0 0 0 > /sys/class/scsi_host/host1/scan}}
The inserted drive should now be recognized by the kernel, and appropriate {{path|/dev/*}} entries created automatically (e.g., by <tt>udev</tt>).

You can safely shut down the drive by issuing the following (this works with all recent mainline kernels):
{{cmdroot|echo 1 > /sys/class/scsi_device/1\:0\:0\:0/device/delete}}
{{cmdroot|echo eject > /proc/acpi/ibm/bay}}
The drive can now be ejected.

===Scripts for hotswapping===

The following scripts and [[acpid]] daemon configuration files do the following:
* Automatically unmounts the relevant filesystems and power off the UltraBay when the UltraBay eject lever is released. Screams if some filesystem can't be unmounted.
* Rescans the UltraBay port when then UltraBay eject lever is pushed back in.

They assumes you're using the <tt>ata_piix</tt> driver with an appropriate kernel (see above).

Create {{path|/usr/local/sbin/ultrabay_insert}} with permissions 755:
<pre>
#!/bin/bash
echo 12 > /proc/acpi/ibm/beep
sync
echo 0 0 0 > /sys/class/scsi_host/host1/scan
</pre>

Create {{path|/usr/local/sbin/ultrabay_eject}} with permissions 755:
<pre>
#!/bin/bash
ULTRABAY_SYSDIR='/sys/class/scsi_device/1:0:0:0/device'
shopt -s nullglob

# Umount the filesystem(s) backed by the given major:minor device(s)
unmount_rdev() { perl - "$@" <<'EOPERL' # let's do it in Perl
for $major_minor (@ARGV) {
$major_minor =~ m/^(\d+):(\d+)$/ or die;
push(@tgt_rdevs, ($1<<8)|$2);
}
# Sort by reverse length of mount point, to unmount sub-directories first
open MOUNTS,"</proc/mounts" or die "$!";
@mounts=sort { length($b->[1]) <=> length($a->[1]) } map { [ split ] } <MOUNTS>;
close MOUNTS;
foreach $m (@mounts) {
($dev,$dir)=@$m;
next unless -b $dev; $rdev=(stat($dev))[6];
next unless grep($_==$rdev, @tgt_rdevs);
system("umount","-v","$dir")==0 or $bad=1;
}
exit 1 if $bad;
EOPERL
}

# Get the UltraBay's /dev/foo block device node
ultrabay_dev_node() {
UDEV_PATH="`readlink -e "$ULTRABAY_SYSDIR/block:"*`" || return 1
UDEV_NAME="`udevinfo -q name -p $UDEV_PATH`" || return 1
echo /dev/$UDEV_NAME
}

if [ -d $ULTRABAY_SYSDIR ]; then
sync
# Unmount filesystems backed by this device
unmount_rdev `cat $ULTRABAY_SYSDIR/block\:*/dev \
$ULTRABAY_SYSDIR/block\:*/*/dev` \
|| {
echo 10 > /proc/acpi/ibm/beep; # error tone
exit 1;
}
sync
# Nicely power off the device
DEVNODE=`ultrabay_dev_node` && hdparm -Y $DEVNODE
# Let HAL+KDE notice the unmount and let the disk spin down
sleep 0.5
# Unregister this SCSI device:
sync
echo 1 > $ULTRABAY_SYSDIR/delete
fi
sync
# Turn off power to the UltraBay:
if [ -d /sys/devices/platform/bay.0 ]; then
echo 1 > /sys/devices/platform/bay.0/eject
else
echo eject > /proc/acpi/ibm/bay
fi
# Tell the user we're OK
echo 12 > /proc/acpi/ibm/beep
</pre>

Create {{path|/etc/acpi/events/ultrabay-insert}}:
<pre>
event=ibm/bay MSTR 00000001 00000000
action=/usr/local/sbin/ultrabay_insert
</pre>

Create {{path|/etc/acpi/events/ultrabay-eject}}:
<pre>
event=ibm/bay MSTR 00000003 00000000
action=/usr/local/sbin/ultrabay_eject
</pre>

Restart <tt>acpid</tt>.

===HAL support===

Many programs, KDE included, rely on [[HAL]] to get notifications and information about device hotplugging. You need to tell HAL that devices connected the UltraBay port are hotpluggable. To do so, create the file {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as follows:
<pre>
<?xml version="1.0" encoding="UTF-8"?> 

<deviceinfo version="0.2">
<device>


<match key="storage.bus" string="scsi">
<match key="storage.physical_device" string="/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_scsi_device_lun0">
<merge key="storage.hotpluggable" type="bool">true</merge>
</match>
</match>

</device>
</deviceinfo>
</pre>

====Details====

By default, HAL doesn't know that UltraBay devices are hotpluggable:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
false

After creating {{path|/etc/hal/fdi/information/10-ultrabay.fdi}} as above and re-plugging the device, it will get marked correctly:

# PHYSDEV=/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_scsi_device_lun0
# UDI=`hal-find-by-property --key storage.physical_device --string $PHYSDEV` || echo Failed
# hal-get-property --udi $UDI --key block.device
/dev/sdb
# hal-get-property --udi $UDI --key storage.hotpluggable
true

The string "8086_2653" gives the PCI ID of the [[Intel 82801FBM]] southbridge. If your model has a different southbridge, or the UltraBay is attached to a different port, then you can find the appropriate <tt>storage.physical_device</tt> value by finding out the block device of the currently running UltraBay device (<tt>/dev/sdb</tt> in the following example) and then running:

# DEVICE=/dev/sdb
# UDI=`hal-find-by-property --key block.device --string $DEVICE` || echo Failed
# hal-get-property --udi $UDI --key storage.physical_device
/org/freedesktop/Hal/devices/pci_8086_2653_scsi_host_scsi_device_lun0

If you have a different <tt>storage.physical_device</tt> value, please report your findings.

{| border=1
|+ Known South Bridge PCI IDs
! ID !! ThinkPad model !! South Bridge chip
|-
| 8086_248a || 2366-83U (T30) || Intel 82801CAM IDE U100 (rev 2)
|-
| 8086_2653 || 2525FAG (X41) || Intel 82801FBM
|-
| 8086_24ca || 237358U (T40) || Intel 82801DBM (ICH4-M)
|-
| 8086_27c4 || X60 || Intel 82801GBM (ICH7 Family)
|}

==Other comments==

If you are hot-swapping a hard disk on a disk tray, make sure the disk does not have a password set, otherwise it will not be recognized on reinsertion.

[[Category:Scripts]]

Template talk:Switch

2007-05-16T09:45:04Z

Whoopie:

I won't pretend I understood what this template is for, but right after it got enabled, I get errors on the "Recent changes" page rendering, it looks like this now:

09:38:47 MediaWiki:Sidebar (diff; hist) . . (+&lt;rc-change-size&gt;) . . Akw (Talk | contribs)
N 07:44:22 Template:Switch (diff; hist) . . Akw (Talk | contribs)

Notice the breakage: '''(+&lt;rc-change-size&gt;)'''. All newer changelog entries are also corrupted like that.

The browser is IceWeasel (firefox) 2, under Debian GNU/Linux.

--[[User:Hmh|hmh]] 02:45, 10 May 2007 (CEST)

It seems that this only happens when not logged in.

--[[User:Whoopie|Whoopie]] 11:44, 16 May 2007 (CEST)

Template talk:Switch

2007-05-16T09:44:36Z

Whoopie:

I won't pretend I understood what this template is for, but right after it got enabled, I get errors on the "Recent changes" page rendering, it looks like this now:

09:38:47 MediaWiki:Sidebar (diff; hist) . . (+&lt;rc-change-size&gt;) . . Akw (Talk | contribs)
N 07:44:22 Template:Switch (diff; hist) . . Akw (Talk | contribs)

Notice the breakage: '''(+&lt;rc-change-size&gt;)'''. All newer changelog entries are also corrupted like that.

The browser is IceWeasel (firefox) 2, under Debian GNU/Linux.

--[[User:Hmh|hmh]] 02:45, 10 May 2007 (CEST)

It seems that this only happens when not logged in.
--[[User:Whoopie|Whoopie]] 11:44, 16 May 2007 (CEST)

HDAPS

2007-04-29T10:09:06Z

Whoopie: /* Disk head parking */

1829-3HU

2007-04-13T12:15:04Z

Whoopie: Undo corruption

= IBM ThinkPad {{R50}} 1829-3HU Specifications (Configured to Order) =

== CPU and Memory ==
{|
|[[Processors|Processor]] Manufacturer || Intel
|-
|Processor Class || [[Intel_Pentium_M_%28Banias%29|Pentium M (Banias)]]
|-
|Processor Speed || 1.7 Ghz
|-
|Cache Size || 1 MB L2
|-
|Installed Memory || 2 GB
|-
|Maximum Memory || 2 GB
|-
|[[Memory|Memory Technology]] || [[PC2700]] DDR SDRAM (333Mhz)
|}

== Storage ==
{|
|[[Harddisk_Drives|Hard Disk Model]] || [[Harddisk_Drives#2.5.22_9.5mm_PATA|Hitachi Travelstar HTE726060M9AT00/08K0889]]
|-
|Hard Disk Capacity || 60 GB
|-
|Hard Disk Speed || 7200 rpm
|-
|Included Drives || Matsushita DVD-RAM UJ-811 ([[UltraBay|UltraBay Enhanced]] [[UltraBay Enhanced DVD Multi-Burner| DVD Multi-Burner]])
|-
|Reads || CD-ROM (24x), CD-R (24x), CD-RW (12x), DVD-ROM SL (8x), DVD-ROM DL (6x), DVD-R (8x), DVD+R (?x), DVD-RW (4x), DVD+RW (?x), DVD-RAM 2.6G (1x), DVD-RAM 4.7G/9.4G (2x)
|-
|Writes || CD-R (16x), CD-RW (4x/8x), DVD-R (2x), DVD-RW (1x), DVD-RAM (2x)
|}

== Display and Graphics ==
{|
|Display Size || 15 in
|-
|[[Displays|Display Type]] || [[TFT_display|FlexView IPS LCD (Samsung LTN150P1-L02)]]
|-
|Display Resolution || 1400 Ã— 1050 pixels (SXGA+)
|-
|[[Video Controllers|Graphics Processor]] || [[ATI Mobility Radeon 9000]]
|-
|Graphics Memory || 32 MB DDR SDRAM
|-
|Max. External Resolution || 1600 Ã— 1200 pixels
|}

== Battery ==
{|
|Battery Life || up to 6.9 hours
|-
|[[Batteries|Battery Type]] || 9 cell Extended [[Batteries#LiIon_Battery|Li-Ion battery]]
|-
|Battery Capacity || 4.4 Ah
|-
|Charging Time || Power Off - 4.3 hours, Power On - 5.0 hours
|}

== Communications and Networking ==
{|
|[[Bluetooth_Adapters|Bluetooth]] || [[IBM_Integrated_Bluetooth_II_with_56K_Modem_%28BMDC%29|Actiontec Bluetooth II Adapter]]
|-
|[[Modem_Devices|Modem]] Speed || [[IBM_Integrated_Bluetooth_II_with_56K_Modem_%28BMDC%29|56Kbps V.92 Software Modem(CDC)]]
|-
|[[Ethernet_Controllers|Network Support]] || [[Ethernet_Controllers#Intel_Gigabit_.2810.2F100.2F1000.29|Intel Pro/1000 10/100/1000 MBit Ethernet]]
|-
|[[Wireless Network Adapters|Wireless Network Support]] || [[IBM_11a/b/g_Wireless_LAN_Mini_PCI_Adapter|IBM a/b/g MiniPC Wireless Adapter (IEEE 802.11b/g)]]
|}

== Software ==
{|
|Shipped Operating System || Microsoft Windows XP Professional
|}

== [[Ports,_Connectors & Slots|Connectors]] ==
{|
|[[Audio_Jacks|Audio]] || 1 x microphone - input - mini-phone mono 3.5 mm , 1 x audio - line-out/headphones - mini-phone stereo 3.5 mm
|-
|[[Firewire_Port|FireWire]] || 1 x IEEE 1394a (FireWire 400) - 4 pin FireWire plug
|-
|[[Modem_Port|Modem]] || 1 x modem - phone line - RJ-11
|-
|[[Ethernet Port|Network]] || 1 x network - Ethernet 10Base-T/100Base-TX/1000Base-T - RJ-45
|-
|[[Parallel Port|Parallel Port]] || 1 x parallel - IEEE 1284 (EPP/ECP) - 25 pin D-Sub (DB-25)
|-
|[[PC Card]] || 1 x [[CardBus slot]] Type I/II/III, 16/32 Bit
|-
|[[USB Port|USB]] || 2 x Hi-Speed USB - 4 pin USB Type A
|-
|Video || 1 x [[VGA Port|VGA]] - 15 pin HD D-Sub (HD-15), 1 x [[TV-Out Port|S-Video]] - 4 pin mini Din
|-
|[[Docking Port]] || Yes
|}

== General Product Info ==
{|
|[[Input_Devices|Input Devices]] || 86 key keyboard w/ [[TrackPoint|TrackPoint]] and [[UltraNav|UltraNav Touchpad]], and [[ThinkPad_Button|Access IBM]], volume control, power and Fn keys/buttons
|-
|Infrared Transceiver || [[IrDA|IrDA]] Compatible
|-
|[[Audio|Sound Card]] || [[AD1981B|Analog Devices AD1981B AC97 Soft Audio]]
|-
|Security Chip || [[Embedded_Security_Subsystem|Internal IBM Security Chip (TCPA compliant)]]
|-
|Weight || ??
|-
|Dimensions || 332 mm Ã— 269 mm Ã— 37 - 40 mm (13.1 in Ã— 10.6 in Ã— 1.47 - 1.58 in) (WÃ—DÃ—H)
|-
|Manufacturer Part No. || ??
|-
|}

2668-A1U

2007-04-13T12:14:35Z

Whoopie: Undo corruption

= IBM ThinkPad T43 2668 - A1U Specifications =

== CPU and Memory ==
{|
|Processor Manufacturer || Intel
|-
|Processor Class || (Pentium M Dothan)
|-
|Processor Name || Intel Pentium M 750
|-
|Processor Speed || 1.86 GHz
|-
|Installed Memory || 768 MB
|-
|Maximum Memory || 2 GB
|-
|Memory Technology || DDR2 SDRAM - 533MHz
|-
|Cache Size || 2 MB
|}
== Storage ==
{|
|Hard Drive Model || Hitachi HTS541060G9AT00
|-
|Hard Drive Capacity || 60 GB
|-
|Included Drives || DVD Drive
|}

== Display and Graphics ==
{|
|Display Size || 14.1 in
|-
|Display Type || SXGA+
|-
|Graphics Processor || ATI Mobility Radeon X300
|-
|Graphics Memory || 64 MB
|-
|Included Video Card || Graphics card - PCI Express x16
|-
|Resolution || 1400 x 1050 pixels
|-
|Max. External Resolution || 2048 x 1536 pixels
|}

== Battery ==
{|
|Battery Model || 6 cell
|-
|Battery Life || 3.0 hour(s)
|-
|Battery Type || Lithium ion
|}

== Communications and Networking ==
{|
|Bluetooth || Yes
|-
|Modem Speed || 56 Kbps
|-
|Network LAN || Broadcom BCM5751M Gigabit Ethernet
|-
|Network WLAN || Intel PRO/Wireless 2200BG MiniPCI card
|}

== Software ==
{|
|Shipped Operating System || Microsoft Windows XP Home
|}

== Connectors ==
{|
|Interface Provided ||Parallel Port, S-Video, VGA, Phone line, Headphone, Ethernet 10Base-T/100Base-TX/1000Base-T
|-
|Connectors ||2 x Hi-Speed USB - 4 pin USB Type A, 1 x parallel - IEEE 1284 (EPP/ECP) - 25 pin D-Sub (DB-25), 1 x display / video - VGA - 15 pin HD D-Sub (HD-15), 1 x infrared - IrDA, 1 x modem - phone line - RJ-11, 1 x network - Ethernet 10Base-T/100Base-TX/1000Base-T - RJ-45, 1 x display / video - S-video output - 4 pin mini-DIN, 1 x docking / port replicator, 1 x microphone - input - mini-phone mono 3.5 mm , 1 x audio - line-out/headphones - mini-phone stereo 3.5 mm
|}

== General Product Info ==
{|
|Input Devices || Keyboard, Touchpad, TrackPoint
|-
|Included Sound Card || SoundMAX Integrated Audio
|-
|Weight || 5.4 lbs
|-
|Also known as || ...
|-
|Manufacturer Part No. || 2668A1U
|-
|Dimension || 1.2 in x 12.2 in x 10 in (HxWxD)
|}

[[Category:T43]]

Category:I1250

2007-04-13T09:09:56Z

Whoopie: Undo corruption

{| width="100%"
|style="vertical-align:top" |
[[image:ThinkPadi1200.jpg|ThinkPad i1250]]
|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;">
=== ThinkPad i Series 1250 ===
This page gives an overview of all ThinkPad i Series 1250 related topics

==== Features ====
* [[Intel Mobile Celeron (2)|Intel Mobile Celeron]] 500 MHz CPU
* [[SMI LynxEM|SMI LynxEM4+]] with 4MB
** 12.1" TFT display with 800x600 resolution
* 64MB [[PC-100]] memory standard
* 6GB HDD
* [[CS4299]] AC'97 Audio controller
* CD-ROM (non-removable)
* CDC slot with Lucent 56K AC'97 Modem
* [[CardBus slot]] (Type 3)
</div>
|}
* [ftp://ftp.software.ibm.com/pc/pccbbs/mobiles_pdf/23p0894.pdf ThinkPad 130, 1200, 1300 Hardware Maintenance Manual (October 2001)] (8,380,483 Bytes)
* [ftp://ftp.software.ibm.com/pc/pccbbs/mobiles/04p4963_.pdf ThinkPad 130, 1200, 1300 Setup Guide] (479,231 Bytes)
* [ftp://ftp.software.ibm.com/pc/pccbbs/mobiles/atl-ur.pdf ThinkPad 130, 1200, 1300 User's Reference] (1,524,656 Bytes)

[[Category:I Series]]

Installing openSUSE 10.2 on a ThinkPad X60

2007-04-13T05:48:32Z

Whoopie: Undo corruption

= Lenovo ThinkPad {{X60}} (model 1707-CTO / model 1706-8GG) =
== Hardware Details ==
* Intel Core Duo T2400 (1.83GHz, 2MB L2, 667MHz FSB)
* 2GB RAM (2 NonParity DDR2 SDRAM SoDIMM PC2-5300)
* Intel Graphics Media Accelerator 950
* 12.1 inch XGA (1024x768) (Lenovo LTN121XJ-L07)
* 80GB, 5400rpm Serial ATA (Hitachi HTS541080G9SA00) / 100GB Serial ATA on 1706GG (Toshiba MK1034GSX)
* Intel PRO/1000 Gigabit Ethernet
* Intel PRO/Wireless 3945ABG
* Bluetooth
* Firewire
* SD Card Reader
* 56K V.92 Modem

== Software Details ==
* [http://en.opensuse.org/Released_Version openSUSE 10.2] retail DVD9 iso

== Installation procedure ==
=== Setup ===
Since I didn't get a dock or usb CDROM with this machine, I started the installation procedure using a USB Stick. I followed these [http://en.opensuse.org/Installation_without_CD#Creating_a_bootable_USB_Stick_from_Linux instructions to set up a boot USB key]. This contains GRUB and the loader for the installer. The actual installation media was on an NFS share. To set this up, copy the contents of the CDS/DVD into a directory (or mount the DVD iso image loopback) then share the directory containing CD1 via NFS, is the simplest way. Sharing the DVD as a SMB share works from windows, too.

Using the ultra-bay DVD-drive is straightforward as it is detected at startup and can be booted from. Nothing special about this.

=== Installation ===
Press F12 during POST to get the boot selector menu up, choose the USB Key. This boots into GRUB. Press F4 here to set the installation source to NFS or SMB as needed, and enter the server details. For example, with SMB, enter the server name, the name of the share, and the directory where the first CD's contents are, eg 'CD1'. Now the installer is loaded from the share and proceeds as a usual SUSE install. No special steps are required during the install, but read the documentation about [[ Pre-Installation_steps | preserving or moving the ThinkVantage rescue partition ]] before you commit to the installation.

{{NOTE|After installing the software, the installer reboots into the installed system to configure it, as usual. Note that because it was booted from a USB key, GRUB has been installed onto the key instead of the hard disk. You can correct this after the configuration is completed, but for now, keep the USB key inserted, boot from that again. The GRUB menu boots the installed system from the hard disk, just like the old days with LILO and a boot floppy. Once the installation and you're logged in, start YaST2, go to System, Bootloader, and change the boot loader location to its proper location (I recommend the boot or root partition with the Generic MBR option). Now the laptop can boot on its own. }}

== What works out of the box ==
=== Hardware ===
* Ethernet adaptor
* Intel 3945ABG Wireless ethernet adapter
* GMA950 graphics with 3D acceleration with integral monitor
* Sound playback
* USB
* Bluetooth (with kbluetoothd, gets about 55kB/s with OBEXFTP)
* Trackpoint
* SD card reader

=== Power management etc ===
* Suspend to disk (Fn+F12)
* Suspend to RAM (Fn+F4)
* Turn display dark (Fn+F3)
* CPU speed stepping (required BIOS update to 2.05 though)
* LCD Brightness depending on current power scheme, via KPowersave and HAL

=== Extra keys ===
* Volume control, keyboard light and screen brightness control
* Lid switch (LCD off when lid closed, resume from suspend to RAM when opened)
* Multimedia keys with KMix and Amarok
* Browser back/forward keys with Konqueror

== What had to be configured by hand ==
* Mouse wheel emulation, set "Emulate Mouse wheel with button 2" in SaX2 mouse settings
* Keyboard dead keys for international characters, set "Right Alt is Compose" in SaX2 keyboard settings, then ralt-shift-2, a => Ã¤
* Sound recording, using KMix or other mixer, set the mic as capture source, turn it up, enable and turn up 'Capture' channel.
* FN-F2 initially does nothing. This requires extra tweaking.
* FN-F7 doesn't work either. Even though ibm-acpi module may be loaded, the video-switch facility does not work.
* The finger print reader, a working driver is existing.
* By default the fan runs all the time. If power management on the ipw3945 is enabled, it only runs about 1/3 of the time. Use 'iwpriv eth1 set_power 7' to enable power management - this comes at the cost of increasing latency when using wireless. See [http://ipw3945.sourceforge.net/README.ipw3945 the ipw3495 README] for details. A description how to do this automatically can be found below.

=== Accessing the nvram - device ===
The default permissions of the nvram device prevent the screen sliders for brightness / volume etc. from being displayed for non root users. To circumvent this problem, a modification of an entry should be made within /etc/udev.d/hooks/50-udev-default.rules:

replace
<code>
KERNEL=="nvram", GROUP="kmem", MODE="600"
</code>

by
<code>
KERNEL=="nvram", GROUP="users", MODE="640"
</code>

and every user is able to read from nvram. This ensures that the sliders are displayed when modifying the brightness or the volume.

=== Automatic power switching for ipw3495 ===
This procedure can be automatized:

Create a script switch_wireless_mode in /usr/lib/powersave/scripts and make it executeable:

<code>
#!/bin/bash
###########################################################################
# #
# Powersave Daemon #
# #
# Copyright (C) 2004,2005 SUSE Linux Products GmbH #
# #
# This program is free software; you can redistribute it and/or modify it #
# under the terms of the GNU General Public License as published by the #
# Free Software Foundation; either version 2 of the License, or (at you #
# option) any later version. #
# #
# This program is distributed in the hope that it will be useful, but #
# WITHOUT ANY WARRANTY; without even the implied warranty of #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU #
# General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License along #
# with this program; if not, write to the Free Software Foundation, Inc., #
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #
# #
###########################################################################
#
# change mode for the wireless network card on X60 lenovo laptop
# currently the interface name needs to be set manually.
#
#

IWPRIV="/usr/sbin/iwpriv"
MODEPARAM="set_power"
POWERSCHEME="6"
BATTERYSCHEME="7"
IF="eth1"

. ${0%/*}/helper_functions

if [ $EVENT_TYPE != ACADAPTER ]; then
DEBUG "switch_wireless_mode only makes sense for acadapter events ;-)" WARN
else
if [ "$1" = "acadapter.online" ]; then
${IWPRIV} ${IF} ${MODEPARAM} ${POWERSCHEME}
fi
if [ "$1" = "acadapter.offline" ]; then
${IWPRIV} ${IF} ${MODEPARAM} ${BATTERYSCHEME}
fi
fi
$SCRIPT_RETURN $EV_ID 0 "switch_wireless_mode finished"
EXIT 0
</code>

Finally only two lines have to be modified "on top" of this to make powersaved aware of this script. This ought to happen in /etc/sysconfig/powersave/events:

<code>
## Path: System/Powermanagement/Powersave/Events
## Type: string
EVENT_ACADAPTER_ONLINE="reread_cpu_capabilities switch_wireless_mode"
EVENT_ACADAPTER_OFFLINE="reread_cpu_capabilities switch_wireless_mode"
</code>

"switch_wireless_mode" should be added to the EVENT_ACADAPTER_ONLINE and EVENT_ACADAPTER_OFFLINE as shown above. Given this, the x60 will switch to low power mode when running on battery and back to high power mode when running on mains automatically.

But be warned: if for any reason the device ID of the wireless adapter should differ from eth1 you will have to edit the file switch_wireless_mode accordingly.

Doing a test
<code>
iwpriv eth1 get_power
</code>

should make it clear whether everything works as expected, the return values should differ between mains plugged and mains unplugged.

=== Activating FN-F2 and FN-F7 ===
Both keys FN-F2 and FN-F7 create acpi events. This can be seen easily by
performing a "tail -f /var/log/acpid" and pressing one of those combinations,
however, in the initial state of the installation nothing happens
afterwards. The following description shows how to make both keys do what you
would expect them to.

==== FN-F2: blocking the screen as soon as FN-F2 is pressed ====
Firstly I have to point out that this description is referring to kde - users,
I am highly convinced that there exists a similar program on gnome for locking
the screen but I simply do not know (and did not test). Therefore your mileage
may vary.

Locking the screen may be realized by calling:
/opt/kde3/bin/kdesktop_lock --forcelock
This works from within a kdesktop, however, if you perform this call from a
deamon you do not have access to a X11-screen / a kde session. To circumvent
this, the call is executed as the user that is currently owning the screen
":0" through sudo. See the patch for "dockhandler" below.

==== FN-F7: switching video outputs ====
Every attempt to make
<code>
echo "video_switch" > /proc/acpi/ibm/video
</code>
work failed. Luckily there is a tool available from Ken Mano at
http://www16.plala.or.jp/mano-a-mano/i810switch.html that can be patched to
make video switching work on x60.

The chip i945 on the x60 should be treated like a i855, so the patch that
needs to be applied is:

<code>
--- i810switch-0.6.5/i810switch.c.original 2005-06-12 06:36:36.000000000 +0200
+++ i810switch-0.6.5/i810switch.c 2007-02-28 15:05:49.000000000 +0100
@@ -60,6 +60,7 @@
#define I855STR "8086:3582"
//#define I865STR "8086:2572"
#define I915STR "8086:2592"
+#define I945STR "8086:27a2"
#define MEMSTR "Memory at"
#define NONPRSTR "32-bit, non-prefetchable"

@@ -272,7 +273,8 @@
return p;
}

- i = (p = strstr(*buff_ptr, I855STR)) != NULL;
+ i = (p = strstr(*buff_ptr, I855STR)) != NULL ||
+ (p = strstr(*buff_ptr, I945STR)) != NULL;
if (i)
{
*chiptype = I855;
</code>

After this, the tool should be compiled and installed. I can provide RPM's for
openSUSE 10.2 on request.

What is missing now is the interfacing between FN-F7 and i810switch and
i810rotate. The latter should be used as it rotates from LCD-Only - LCD+CRT -
CRT-Only with every new call.

==== Patching dockhandler ====
I included this in dockutils (/usr/lib/dockutils from dockutils-01), however, there are several optional ways how to
do this. The patch in use is depicted below:

<code>
--- dockhandler 2006-11-06 18:22:37.000000000 +0100
+++ dockhandler 2007-03-02 12:44:53.000000000 +0100
@@ -70,6 +70,12 @@
elif [ "$SER" -eq 4107 ]; then # Fn+F9
ACTION=dock
fi
+ if [ "$SER" -eq 4098 ]; then # Fn+F2
+ ACTION=lockscreen
+ fi
+ if [ "$SER" -eq 4103 ]; then # Fn+F7
+ ACTION=videotoggle
+ fi
elif [ "$EVENT" = "ibm/dock" ]; then
case $VAL in
0) # X32 has strange dock code
@@ -81,7 +87,7 @@
fi
fi

-export MODEL=`hal-get-property --udi /org/freedesktop/Hal/devices/computer --key smbios.system.version`
+export MODEL=`hal-get-property --udi /org/freedesktop/Hal/devices/computer --key smbios.system.version | sed "y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/"`

if [ -n "`echo $MODEL | grep -i thinkpad`" ]; then
HOOKDIR=thinkpad
--- hooks/thinkpad/60x60 2006-11-05 02:35:17.000000000 +0100
+++ hooks/thinkpad/60x60 2007-03-02 12:18:37.000000000 +0100
@@ -6,10 +6,25 @@
#
# This file is released under the GPLv2.
#
+# Modifications by Dr. Ing. Dieter Jurzitza / enhanced features
+#

. common_functions

-[ "$MODEL" == "Thinkpad X60" ] && exit 0;
+[ "$MODEL" = "THINKPAD X60" ] || exit 0;
+
+video_toggle(){
+ echo x60 video_toggle
+ /usr/sbin/i810rotate
+}
+
+lock_screen(){
+ echo x60 lock_screen
+ APPLICATION="/opt/kde3/bin/kdesktop_lock"
+ [ -f ${APPLICATION} ] || exit 0
+ USER=`/usr/bin/who -u | /bin/awk '{if(match($2, ":0")){print $1}}'`
+ sudo -u ${USER} /bin/bash -l -c "export DISPLAY=:0.0; ${APPLICATION} --forcelock &"
+}

if [ "$1" = "dock" ]; then
echo x60 dock
@@ -18,4 +33,12 @@
elif [ "$1" = "undock" ]; then
echo x60 undock
unregister_cdroms
+
+elif [ "$1" = "videotoggle" ]; then
+ echo x60 video toggle
+ video_toggle
+
+elif [ "$1" = "lockscreen" ]; then
+ echo x60 lock screen
+ lock_screen
fi
</code>

This patch does two things: firstly it repairs a bug in dockutils. The
comparison [ "MODEL" == "Thinkpad X60" ] && exit 0; ensures that the file
60x60 is processed for each notebook not named "Thinkpad X60" what is not what
was meant here.

Functionally both the FN-F2 and FN-F7 keys are tested in dockhandler. Events
are assigned that are called "lockscreen" for FN-F2 and "videotoggle" for
FN-F7, correspondingly. The event "lockscreen" in turn triggers the function
call "lock_screen()" from within 60x60, the same holds true for the event
"videotoggle" and the function call to "video_toggle".
Please make sure that the path to i810rotate in "video_toggle()" fits to your
system environment.

After this, both keys FN-F2 and FN-F7 should do what you expect them to
do. FN-F2 is adapted for the usage of kde, so your mileage may vary if you
want to adapt it to gnome or other window managers.

=== Activating the internal modem ===
==== Choosing the right modem driver ====
The internal modem can only be used with the hsfmodem-package that is available from http://www.linuxant.com. The current version is hsfmodem-7.60. I recommend *not* to use the "openSUSE" package but to switch to the "generic" package as the latter one rebuilds the module if the kernel version does not match. My experiments with the slmodem package have failed.

==== Suspend2ram / Suspend2disk issues with the modem driver ====
Installing this module encorporates issues with suspend2disk / suspend2ram. These are twofold. On one hand you have to make sure that the modules are being unloaded before performing a suspend2ram / suspend2disk process. Otherwise you will observe crashed. On the other hand the unloading of the intel sound module that is replaced by the hsf-package does not work as expected if i. e. kmix is running.

But step by step. First of all it must be ensured that the module is unloaded for sure if a susped2disk / suspend2 ram action should be performed. This can be achieved as follows:

This is done by placing a script in /etc/pm/hooks, I have chosen the name "08softmodem" and made it executable:
<code>
#!/bin/bash

. /etc/pm/functions

case "$1" in
hibernate|suspend)
/etc/init.d/hsf stop
;;
thaw|resume)
/etc/init.d/hsf start
;;
*)
;;
esac

exit $?
</code>

Secondly, given you want to unload this you have to make sure that the soundmodule is not bound to kmix any more. Therefore I created a second script called 06kmix located in the same directory to make sure that it is processed before the unloading of the modules is actually being processed:

<code>
#!/bin/bash

. /etc/pm/functions

KMIXPID=`ps ax | awk '{if (match($5, "kmix")){print $1}}'`

case "$1" in
hibernate|suspend)
kill -SIGHUP $KMIXPID
;;
thaw|resume)
;;
*)
;;
esac

exit $?
</code>

If both scripts are in place, suspending and resuming should work, however, kmix will be halted when you get out of the suspend and it will not restart automatically. I had received a suggestion to restard it using an event of kpowersaved did not work for me. But I realized it using a different technique.
I created a script called /home/<username>/.kde/Autostart/restartkmix with the following contents. It should be executeable as well:
<code>
#!/bin/sh
SLEEP=10
while [ 1 ]; do
PROCNUM=`ps ax | awk '{if(match($0," kmix")&&(!match($0,"awk"))){print $1}}'`
if [ "${PROCNUM}" = "" ]; then
kmix -autostart
fi
sleep $SLEEP
done
</code>
This generates a small amount of system load every 10 seconds but I think this is neglible. If kmix is not running it is restarted. This works for perfectly for me.

=== Activating the fingerprint reader ===
There is a description of the fingerprint reader project at another location in this wiki (http://www.thinkwiki.org/wiki/Integrated_Fingerprint_Reader). The package (currently thinkfinger-0.2.2.tar.gz) should be downloaded, untared, built and installed. After that, you will have to do three things in addition:

1.) you need to modify /etc/pam.d/common-auth:
<code>
#%PAM-1.0
#
# This file is autogenerated by pam-config. All changes
# will be overwritten.
#
# Authentication-related modules 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 required pam_env.so
auth sufficient pam_thinkfinger.so
auth required pam_unix2.so
</code>
the line containing pam_thinkfinger.so needs to be added.

2.) you have to add a fingerprint from you. This is precisely described in the documentation of the thinkfinger package.

3.) you should change your default displaymanager to gdm, otherwise you will be able to use the fingerprint-reader only in console applications. This can be achieved by setting
<code>
DISPLAYMANAGER=gdm
</code>
in /etc/sysconfig/displaymanager.

=== openSUSE bug - make irqbalancer work ===
If you installed the "irqbalancer" package you probably realized that it is not running. Calling "/etc/init.d/irq_balancer status" will return "unused". Doing a "cat /proc/interrupts" will show all interrupts on CPU 0, CPU 1 will not process any interrupt. To solve this problem you should edit /etc/init.d/irq_balancer manually. Change the line

<code>
start)
echo -n "Starting irqbalance "
if [ $PHYS -gt 1 ] || [ $PROC -gt 1 -a $PHYS -eq 0 ] ; then
</code>
into
<code>
start)
echo -n "Starting irqbalance "
if [ $PHYS -gt 1 ] || [ $PROC -gt 1 -a $PHYS -eq 1 ] ; then
</code>

$PHYS should be compared to 1, not to 0. After restarting irq_balancer, the interrupts should be shared between cpu 0 and cpu 1 now. The important point is the change from $PHYS -eq 0 to $PHYS -eq 1.

=== PCMCIA - slot ===
There is nothing special to say about the PCMCIA-slot. It just works (for me).

== What doesn't work yet ==
* Xinerama with external LCD
* Dual head with external LCD

== What I haven't tested yet ==
* Firewire
* Embedded Security Subsystem (TCPA)
* Active Protection System (HDAPS)
* Maximum battery life

== lscpi ==
<pre>> lspci
00:00.0 Host bridge: Intel Corporation Mobile 945GM/PM/GMS/940GML and 945GT Express Memory Controller Hub (rev 03)
00:02.0 VGA compatible controller: Intel Corporation Mobile 945GM/GMS/940GML Express Integrated Graphics Controller (rev 03)
00:02.1 Display controller: Intel Corporation Mobile 945GM/GMS/940GML Express Integrated Graphics Controller (rev 03)
00:1b.0 Audio device: Intel Corporation 82801G (ICH7 Family) High Definition Audio Controller (rev 02)
00:1c.0 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 1 (rev 02)
00:1c.1 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 2 (rev 02)
00:1c.2 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 3 (rev 02)
00:1c.3 PCI bridge: Intel Corporation 82801G (ICH7 Family) PCI Express Port 4 (rev 02)
00:1d.0 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #1 (rev 02)
00:1d.1 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #2 (rev 02)
00:1d.2 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #3 (rev 02)
00:1d.3 USB Controller: Intel Corporation 82801G (ICH7 Family) USB UHCI #4 (rev 02)
00:1d.7 USB Controller: Intel Corporation 82801G (ICH7 Family) USB2 EHCI Controller (rev 02)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev e2)
00:1f.0 ISA bridge: Intel Corporation 82801GBM (ICH7-M) LPC Interface Bridge (rev 02)
00:1f.1 IDE interface: Intel Corporation 82801G (ICH7 Family) IDE Controller (rev 02)
00:1f.2 SATA controller: Intel Corporation 82801GBM/GHM (ICH7 Family) Serial ATA Storage Controller AHCI (rev 02)
00:1f.3 SMBus: Intel Corporation 82801G (ICH7 Family) SMBus Controller (rev 02)
02:00.0 Ethernet controller: Intel Corporation 82573L Gigabit Ethernet Controller
03:00.0 Network controller: Intel Corporation PRO/Wireless 3945ABG Network Connection (rev 02)
15:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev b4)
15:00.1 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 09)
15:00.2 Generic system peripheral [Class 0805]: Ricoh Co Ltd R5C822 SD/SDIO/MMC/MS/MSPro Host Adapter (rev 18)
</pre>
[[Category: x60]][[Category: openSUSE]]