ThinkWiki - User contributions [en]

Problems with SATA and Linux

2007-08-21T18:29:37Z

Mist: /* Models using a SATA disk interface */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
Some ThinkPad models use an [[Intel ICH6-M]] SATA/PATA controller for the system hard disk. This causes several complications for Linux installation. The following lists these problems and known workarounds. Note that the details are often version- and distribution-specific.

===Models using a SATA disk interface===
Models using a SATA controller and a SATA system disk:
*ThinkPad {{R60}}, {{R60e}}
*ThinkPad {{T60}}, {{T60p}}, {{T61}}
*ThinkPad {{X60}}, {{X60s}}
*ThinkPad {{Z60t}}, {{Z60m}}
*ThinkPad {{Z61e}}, {{Z61t}}, {{Z61m}}, {{Z61p}}
Models using a SATA controller and a PATA (IDE) system disk with a SATA-to-PATA bridge:
*ThinkPad {{T43}}, {{T43p}}
*ThinkPad {{R52}}
*ThinkPad {{X41}}, {{X41T}}

{{NOTE|Some of these problems (namely SMART support, power management and disk information) are solved in Linux 2.6.15 with the inclusion of libata pass-through. See the SATA driver [http://linux-ata.org/features.html features], [http://linux-ata.org/software-status.html software status] and [http://linux-ata.org/driver-status.html hardware status].}}
|}

==Hang on resume from suspend to RAM==

Linux kernels prior to 2.6.16 (ata_piix) and 2.6.19 (ahci) do not support suspend and resume for SATA devices. As a result, the machine hangs upon the first disk access after resume. A kernel patch ([http://lkml.org/lkml/2005/5/2/46 LKML posting]) fixes this by adding SATA power management support.

Kernel 2.6.16 and later fixes this problem for most systems. The Thinkpad T60 and X60s still need some patches to get resume working using 2.6.16, see [[Talk:Problems with SATA and Linux#Patch against SATA-resume problem with T60|here]]. The T60p resumes properly with 2.6.17-rc6, the T60 and X60 should also. You need to enable ata_piix and disable AHCI in the bios. The latest fedora (FC5) 2.6.17 kernel seems to have fixed the resume problem on the T60p, still need to disable AHCI though. Applying [http://cvs.fedora.redhat.com/viewcvs/rpms/kernel/FC-5/linux-2.6-console-suspend.patch this FC5 patch] makes suspend-to-ram work with AHCI enabled.

===Patches===
* [http://shamrock.dyndns.org/~ln/linux/sata_pm.2.6.12.diff Patch for kernel 2.6.12]
* [http://shamrock.dyndns.org/~ln/linux/sata_pm.2.6.13-rc5.diff Patch for kernel 2.6.13-rc5]
* [http://lkml.org/lkml/2005/9/23/97 Patch for kernel 2.6.14]
* [http://www.xenotime.net/linux/SATA/2.6.15-rc/libata_suspend.patch Patch for kernel 2.6.15-rc4]
* [http://tpctl.sourceforge.net/tmp/sata_pm.2.6.15-rc6.patch Patch for kernels 2.6.15-rc6 through 2.6.15]

Some distributions already include this patch (e.g., {{Ubuntu}} Breezy, {{Gentoo}}'s gentoo-sources 2.6.15-r1), but some don't (e.g., {{Fedora}} 4). If your distribution doesn't include the patch, you will need to compile your own kernel with this patch included.

===Links===
* RedHat Bugzilla [https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=169201 bug 169201: "SATA drives fail on laptop suspend"]
* [http://lkml.org/lkml/2005/11/15/385 Fix to libata.h recommended on LKML] in case you get "ata: abnormal state 0x80 on port 0x1F7"
* RedHat Bugzilla [https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=183138 bug 183138": "SATA failure after pm-suspend/resume ata1: handling error/timeout"]

==Failed resume from suspend to disk==

Suspend to disk (using [[swsusp]] or [[Software Suspend 2]]) needs to load the memory image from the SATA disk. For this to work, you either need an initrd with all the necessary SATA modules, or the SATA drivers compiled into the kernel.

==DVD drive not recognized==

The <tt>ata_piix</tt> SATA driver grabs ownership over the IDE ports when it is loaded, but (by default) does not support PATA ATAPI devices such as the Ultrabay optical drives. Thus, if the <tt>ide</tt> driver is compiled as a module and loaded after <tt>ata_piix</tt>, the DVD drive will not be recognized by either driver.

Either of the following configurations will work:
* For kernel 2.6.14 and newer: enable ATAPI support in the SATA system using {{bootparm|libata.atapi_enabled|1}} (see below; this is experimental).
* Compile IDE into the kernel (non-module).
* Compile both IDE and SATA as modules and make sure IDE is loaded first (the module is called 'ide_generic').

Note that the optical drive must be in the Ultrabay during system boot (Ultrabay device swapping is currently unsupported).

==No DMA on DVD drive==

Using the IDE driver, DMA support cannot be enabled on an Ultrabay optical drive:

# hdparm -d1 /dev/hdc

/dev/hdc:
setting using_dma to 1 (on)
HDIO_SET_DMA failed: Operation not permitted
using_dma = 0 (off)

As a result, the optical drive is slow, and in particular, too slow to play video DVDs.

One workaround is to use the <tt>ata_piix</tt> driver (instead of the IDE driver) for the optical drive. This requires enabling the ATAPI support of the <tt>ata_piix</tt> driver, which is under active development and not yet stable. You must also make sure that the IDE driver (<tt>ide-generic</tt>) does not grab the devices before <tt>ata_piix</tt>.
Using this will probably devour all your data and go on to eat all the food in your fridge. But if you have full backups and an empty fridge, do the following:

* Grab the latest kernel (must be 2.6.14 or newer; the relevant code is under active development).
* Do one of the following:
** Enable the <tt>ata_piix</tt> and <tt>libata</tt> drivers as built-in, and add {{bootparm|libata.atapi_enabled|1}} to your kernel command line (e.g., in {{path|/boot/grub/menu.lst}} or {{path|/etc/lilo.conf}}. Don't forget to run lilo after changes).
** Enable <tt>ata_piix</tt> and <tt>libata</tt> as modules (this is often the default) and add "<tt>options libata atapi_enabled=1</tt>" to your {{path|/etc/modprobe.conf}} (or the equivalent in your distribution).
* Do one of the following:
** Disable the IDE system.
** Build the IDE driver as built-in (this is often the default) and add the {{bootparm|hdc|noprobe}} kernel argument (e.g., in in {{path|/boot/grub/menu.lst}} or {{path|/etc/lilo.conf}}. Don't forget to run lilo after changes).
** Build the IDE driver as module and add "<tt>options ide hdc=noprobe</tt>" to your {{path|/etc/modprobe.conf}} (or the equivalent in your distribution).
* If you chose to use modules above, regenerate your <tt>initrd</tt> file.

Note : If you are using a ''Debian Sid'' system, and want to use Debian precompiled kernels, then type the following command in a ''root'' shell (This creates a new <tt>initrd</tt> with enabled ATAPI support of <tt>ata_piix</tt> and loads <tt>ata_piix</tt> before the IDE driver):
'''# echo options libata atapi_enabled=1>/etc/modprobe.d/atapienable && update-initramfs -u'''
Note : If your work was successful, your CD-ROM drive will no longer be accesiible through /dev/hdc, but /dev/scd0.

If this all doesn't work, use {{cmd|lspci -vn|}} to check whether one of the following chipsets is used in the Thinkpad:
{| border="1" cellspacing="0" cellpadding="2"
|-
!PCI ID
!Name
|-
|8086:7111
|Intel 82371AB/EB/MB PIIX4 IDE
|-
|8086:24db
|Intel 82801EB/ER (ICH5/ICH5R) IDE Controller
|-
|8086:25a2
|Intel 6300ESB PATA Storage Controller
|}
If yes, enable support for these chipsets has to be enabled by setting
#define ATA_ENABLE_PATA
in {{path|include/linux/libata.h}} (and report your ThinkPad model in the discussion page).

There have been reports that DVD burning doesn't work under this configuration, but it seems to work with kernel 2.6.14 and later (tested on a ThinkPad {{T43}} and {{T43p}} with a [[UltraBay Slim DVD Multi-Burner Plus]]).

===Problem with kernel 2.6.16 kernel and suspend2 2.2.1===
DVD access fails with kernel 2.6.16.* and [[Software Suspend 2|suspend2]] 2.2.1. Thia is fixed by later versions of suspend2, or by deleting the 4000-libata-rollup-2616-rc3.patch (see
[http://lists.suspend2.net/lurker/message/20060322.082452.873dc526.en.html this post notice] by Alexander E. Patrakov).

===Links===
* RedHat Bugzilla [https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=163418 bug 163418: "can't enable DMA on DVD drive"]
* Enabling DMA on a SATA DVD drive, kernel 2.6.18 [http://thomer.com/howtos/dma_on_sata_dvd.html]

==No DMA on system hard disk==

In recent Linux kernels, there are two modules capable of handling the ICH6 disk controller:
* <tt>ata_piix</tt>: the disk shows as {{path|/dev/sda}} and DMA is enabled.
* Generic IDE driver (<tt>ide-disk</tt>): the disk shows as {{path|/dev/hda}} and DMA is disabled.

The simplest way to enable DMA is to force the IDE driver to ignore the system hard disk by passing the {{bootparm|hda|noprobe}} and {{bootparm|hda|none}} kernel argument. The driver will then be handled by the <tt>ata_piix</tt> driver. Note that this will change its device name to {{path|/dev/sda}} (which may require changes in {{path|/etc/fstab}} and the boot loader) and may cause other problems as listed above.

(Observed on a ThinkPad T43 with Fedora Core kernel 2.6.13-1.1526_FC4.)
(Observed on a ThinkPad X40 with Debian kernel 2.6.18-4-686.) [[User:Hendry|Hendry]] 20:05, 11 June 2007 (UTC)

==No SMART support==

Prior to kernel 2.6.15, the Linux SATA system did not support SMART commands (e.g., via smartctl).

The necessary capability is "libata pass-through", which was incorporated into Linux 2.6.15-rc1 and later. A patch is available for older kernels:
* Kernel 2.6.12: http://rtr.ca/dell_i9300/kernel/kernel-2.6.12/03_libata_passthru.patch
* Kernel 2.6.13: http://rtr.ca/dell_i9300/kernel/kernel-2.6.13/02_libata_passthru.patch
* Kernel 2.6.14: http://www.foo.fh-furtwangen.de/~koenigr/02_libata_passthru.fixed.again.patch
* Kernel 2.6.14 with the above suspend-to-RAM patch: http://linux.spiney.org/system/files?file=02_libata_passthru.fixed.patch

After applying the patch, run smartctl with the "-d ata" parameter:
:{{cmdroot|smartctl -d ata -a /dev/sda}}

From smartmontools version 5.37 "-d sat" is preferred to "-d ata". The smartctl command will auto-detect SATA disks so:
:{{cmdroot|smartctl -a /dev/sda}}
should just work. The smartd daemon still requires "-d sat" in /etc/smartd.conf .

==No disk power management==

Prior to kernel 2.6.15, the Linux SATA system did not support power management commands on these models.

The above patches for SMART support resolves this, and in particular enables the following commands:
* {{cmdroot|hdparm -y}} (spin down)
* {{cmdroot|hdparm -S num}} (automatic spin down timeout)
* {{cmdroot|hdparm -B num}} (advanced power management level)
Note that this command is still rejected:
* {{cmdroot|hdparm -M num}} (acoustic management)
(Tested with patched kernels 2.6.13.1 and 2.6.12-4 and a 60GB 7200RPM disk model HTS726060M9AT00.)

Refer to [[How to make use of Harddisk Power Management features]] for details about using
HD power management. Refer to [[Laptop-mode]] if you are interested into spinning down your HD.

==No disk information==

Prior to kernel 2.6.15, on these models the disk information could not be read by the standard commands such as:
*{{cmdroot|hdparm -i /dev/sda}}
*{{cmdroot|hdparm -I /dev/sda}}
The latter is fixed by the above patch for SMART support.

==No swapping of UltraBay device==

The <tt>ata_piix</tt> driver in mainline Linux kernels supports hot-swapping and warm-swapping of PATA and SATA devices. This requires kernel 2.6.18 or newer (with older kernels, you must power off the laptop before swapping such devices). See [[How_to_hotswap_UltraBay_devices#When_using_the_ata_piix_driver|How_to_hotswap_UltraBay_devices]] for further information.

Swapping of the [[UltraBay Slim Battery]] works out-of-the box.

==BIOS error 2010 on user-installed hard disk==

While not a Linux issue, note that there is an issue with installing alternative PATA (IDE) hard disks as the system drive. Unless the disk is one of the few approved disks listed inside the BIOS, you will get an BIOS error 2010 during system boot, and the disk may operate unreliably. See [[Problem with non-ThinkPad hard disks]].

==RHEL3.0 Update 7 on T60p==

RHEL3.0 Update 7 will install on a {{T60p}}, but you need to make an adjustment. Both uni-processor and SMP kernels get installed, with the SMP kerrnel the default. However, the SMP kernel can't seem to find the disk drive. You can work around this by use "e" at the GRUB kernel prompt, then on the "kernel" line appending " noapic". After the system boots, you'll want to edit /boot/grub/grub.conf to add the " noapic" option to the kernel line as well.

==Mandriva 2006 on T60==

Mandriva 2006.0 has a problem with SATA on a {{T60}}, to fix this you need to make an adjustment. The install procedure can't seem to find the SATA disk drive, you can work around this by adding the "noapic" kernel option during CD/DVD boot. You *might* need to add this to lilo or GRUB for normal operations, after install completes. The problem with not using apic during normal operations is that you might have problems with power management, please see article on [[Software Suspend 2]]

==Problem burning CD/DVD==

To a CD/DVD problem, try to burn a CD/DVD as "root"-user on command-line with the option "-dummy" and "-v" enabled, do not use K3B or similar. Doing so you will get more informations and waste less CD/DVD's.

Experiment with the parameters "burnfree" and "dev". With cdrecord on debian etch, burnfree seems not work, disable it. With wodim on debian etch: try parameter "dev=/dev/scd0", the default "dev=1,0,0" seems not to work.

==Spurious NCQ completions==

The HDD firmware support for NCQ appears to be buggy ([http://lkml.org/lkml/2007/6/6/15 LKML posting] and [http://lkml.org/lkml/2007/6/6/195 LKML posting]).

How to get special keys to work

2007-08-20T10:04:57Z

Mist: /* Overview */ thinkvantage added

==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}} || switch display || [[#ibm-acpi events|ibm-acpi]], [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions ||
|-
| {{key|Fn}}{{key|F8}} || toggle display expansion || [[#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|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 using xkeycaps(a tool graphically 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}}, {{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

===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}}<br />
:{{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.<br />
Go to <i>Tool > Settings > Mouse and keyboard > Keyboard settings > Edit > Browser Window</i>. 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.

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