ThinkWiki - User contributions [en]

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-23T11:46:31Z

Intrigeri: /* Suspend-to-RAM */ added precisions, fixed formatting

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Out of two slightly different Lenny installations, one had DRI working out of the box, while the other required applying the following instructions; so you first want to check wether direct rendering is already enabled, by installing the <code>mesa-utils</code>, and run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, DRI is already working. Else, read on.

The following instructions probably do far more than enabling DRI, but this combination of random factors does work for me, and I did not bother finding out which ones were really necessary.

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Suspend-to-disk (hibernation) ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon (that uses <code>pm-suspend</code>, hibernate command. The default backend is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

== Suspend-to-RAM ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate radeontool vbetool}}.

=== Various methods of suspending ===

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}

'''FIXME''': are the arguments really needed, or are they guessed by the program?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing, using <code>pm-suspend</code>.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

=== High power drain while sleeping ===

A mean instantaneous power consumption equal to 811mW was measured while sleeping for 10.5h, which is a bit too high (custom Linux kernel 2.6.28, without [[Radeonfb|radeonfb]]).

Not tried the various workarounds described on [[Problem with high power drain in ACPI sleep]] yet.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-23T11:41:41Z

Intrigeri: /* Suspend-to-disk (hibernation) */ precisions

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Out of two slightly different Lenny installations, one had DRI working out of the box, while the other required applying the following instructions; so you first want to check wether direct rendering is already enabled, by installing the <code>mesa-utils</code>, and run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, DRI is already working. Else, read on.

The following instructions probably do far more than enabling DRI, but this combination of random factors does work for me, and I did not bother finding out which ones were really necessary.

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Suspend-to-disk (hibernation) ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon (that uses <code>pm-suspend</code>, hibernate command. The default backend is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

== Suspend-to-RAM ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate radeontool vbetool}}.

=== Various methods of suspending ===

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

=== High power drain while sleeping ===

A mean instantaneous power consumption equal to 811mW was measured while sleeping for 10.5h, which is a bit too high (custom Linux kernel 2.6.28, without [[Radeonfb|radeonfb]]).

Not tried the various workarounds described on [[Problem with high power drain in ACPI sleep]] yet.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-19T15:50:22Z

Intrigeri: /* Direct rendering */ reworked a bit the introduction

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Out of two slightly different Lenny installations, one had DRI working out of the box, while the other required applying the following instructions; so you first want to check wether direct rendering is already enabled, by installing the <code>mesa-utils</code>, and run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, DRI is already working. Else, read on.

The following instructions probably do far more than enabling DRI, but this combination of random factors does work for me, and I did not bother finding out which ones were really necessary.

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Suspend-to-disk (hibernation) ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

== Suspend-to-RAM ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate radeontool vbetool}}.

=== Various methods of suspending ===

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

=== High power drain while sleeping ===

A mean instantaneous power consumption equal to 811mW was measured while sleeping for 10.5h, which is a bit too high (custom Linux kernel 2.6.28, without [[Radeonfb|radeonfb]]).

Not tried the various workarounds described on [[Problem with high power drain in ACPI sleep]] yet.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-19T13:29:52Z

Intrigeri: /* High power drain while sleeping */ this is actually a problem

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Suspend-to-disk (hibernation) ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

== Suspend-to-RAM ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate radeontool vbetool}}.

=== Various methods of suspending ===

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

=== High power drain while sleeping ===

A mean instantaneous power consumption equal to 811mW was measured while sleeping for 10.5h, which is a bit too high (custom Linux kernel 2.6.28, without [[Radeonfb|radeonfb]]).

Not tried the various workarounds described on [[Problem with high power drain in ACPI sleep]] yet.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-19T13:26:55Z

Intrigeri: /* High power drain while sleeping */ precisions

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Suspend-to-disk (hibernation) ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

== Suspend-to-RAM ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate radeontool vbetool}}.

=== Various methods of suspending ===

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

=== High power drain while sleeping ===

A mean instantaneous power consumption equal to 811 mW was measured while sleeping 10.5h, which may be considered as normal or not (custom Linux kernel 2.6.28, without [[Radeonfb|radeonfb]]).

Not tried the various workarounds described on [[Problem with high power drain in ACPI sleep]] yet.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-19T12:40:45Z

Intrigeri: added note about high power drain while sleeping

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Suspend-to-disk (hibernation) ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

== Suspend-to-RAM ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate radeontool vbetool}}.

=== Various methods of suspending ===

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

=== High power drain while sleeping ===

A mean instantaneous power consumption equal to 811 mW was measured while sleeping 10.5h, which may be considered as normal or not (custom Linux kernel 2.6.28).
This possible problem is thoroughly [[Problem_with_high_power_drain_in_ACPI_sleep|discussed on this wiki]].

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:55:48Z

Intrigeri: /* Modem */ error correction

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:47:53Z

Intrigeri: /* Suspend-to-disk (hibernation) */ removed unnecessary instructions

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:38:40Z

Intrigeri: /* SMAPI support */ explain how to have tho module loaded at boot time

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add a line containing <code>tp_smapi</code> to {{path|/etc/modules}}, so that the module is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Tp smapi

2009-02-18T00:37:27Z

Intrigeri: /* Installation on Debian unstable (sid), testing (squeeze) or stable (lenny) */ future-proof instructions

{| 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. The tp_smapi software package 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.

This driver uses undocumented features and direct hardware access, so it may work unreliably or even damage your hardware; but so far no such damage has been reported.
|}

===Features===
*Battery charge/discharge control
*Battery status information
*Modified [[HDAPS]] driver with improved stability, model support and functionality

===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.39.tgz}}
:{{cmdroot|cd tp_smapi-0.39}}

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/package/app-laptop/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:

* Disable the <tt>hdaps</tt> module in your kernel configuration (Device Drivers → Hardware Monitoring Support → IBM Hard Drive Active Protection System)
* Rebuild and install the 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), testing (squeeze) or stable (lenny)====
Debian now contains the [http://packages.debian.org/tp-smapi packaged module source] and prebuilt modules for Debian kernels.

If you use a stock Debian kernel, you can install the tp_smapi modules with:
* {{cmdroot|apt-get install tp-smapi-modules-`uname -r`}}
* in order to make sure the modules package is kept in sync with the kernel one, you may also want to install the <code>tm-smapi-modules-2.6-686</code> or <code>tm-smapi-modules-2.6-amd64</code> package, depending on your architecture

If you use a custom kernel, you can build tp_smapi with module-assistant:
* {{cmdroot|aptitude install tp-smapi-source}}
* {{cmdroot|m-a -t a-i tp-smapi}}

====Installation on Ubuntu Hardy====
Ubuntu ships tp_smapi in their linux-ubuntu-modules Package since Hardy, so you don't have to build it yourself. Please note that they have renamed tp_smapi's modified <tt>hdaps</tt> module to <tt>hdaps_ec</tt>. You should load <tt>hdaps_ec</tt>, not <tt>hdaps</tt>.

Some Ubuntu packages lack the <tt>hdaps_ec</tt> module, as reported [https://bugs.launchpad.net/ubuntu/+source/linux/+bug/297213 here].

====Installation on older 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.
Debian users execute the following:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users execute the following using the kernel-version only (exclude -XX-generic; e.g. 'linux-source-2.6.20'):
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>

Be sure to unpack the source file. The easiest way is to open Nautilus as root:
<pre><nowiki>sudo nautilus</nowiki></pre>
Then browse to /usr/src/ and extract the source file to that directory.

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 build -> /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/build</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===
==== <tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f</tt> ====
The "<tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f!</tt>" error message is printed when loading the <tt>thinkpad_ec</tt> module on some recent ThinkPad models. This occurs because the ACPI BIOS DSDT is reserving ports used by tp_smapi.

As a workaround, add the <tt>force_io=1</tt> module parameter to <tt>thinkpad_ec</tt> in {{path|/etc/modprobe.conf}} (or your distribution's equivalent). For transient testing, load the modules as follows:

: {{cmdroot|1=make load HDAPS=1 FORCE_IO=1}}

Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16).

Models which need this option include:
* ThinkPad {{T400}}
* ThinkPad {{T500}}
* ThinkPad {{X200}}

More information:
* http://bugzilla.kernel.org/show_bug.cgi?id=12221
* http://www.nabble.com/thinkpad_ec-fails-to-load-on-Thinkpad-T500-td19932985.html

==== <tt>thinkpad_ec: no ThinkPad embedded controller!</tt> ====
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}} || || || ||
|-
! {{R50e}} 1834-5US
| {{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 || || ||
|-
! {{R61}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.35-test1 || 7KETA7WW 2.07 || 7KHT24WW 1.08 || Machine type 8918 ||
|-
! {{R61i}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || || || || Machine type 8250 ||
|-
! {{R400}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || 0.37-6 || || || Machine type 7443; added pnpacpi=off to grub boot menu.lst; force_io=yes only supported in tp_smapi v0.40 ||
|-
! 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}} || {{Cno}} || {{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 || || ||
|-
! {{T60}} 1951-24G
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.36 || 1.09a || ||
|-
! {{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]
|-
! {{T400}} and {{T500}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! 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)
|-
! {{X60_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.34 || 7JET25WW (1.10 ) || 7JHT13WW 1.04 || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X60s}} 1704-5UG
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cno|text=}} 3 || 0.34 || 7BETD2WW 2.13 || 7BHT40WW 1.13 ||
|-
! {{X61}} 7673-CTO
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 7NETB9WW (2.19) || {{Cunk}} ||
|-
! {{X61}} 7675-CTO
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} 6 || 0.35-test1 || || ||
|-
! {{X61}} 7675-4KU
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.34 || 7NET30WW (1.11 ) || 7MHT24WW-1.02 ||
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.32 || || ||
|-
! {{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
|-
! {{X200}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 6DET38WW (2.02 ) || 7XHT21WW-1.03 || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! {{X300}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.37 || 7TET25WW (1.02 ) || 7THT15WW-1.00c ||
|-
! 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}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====SL series and IdeaPad=====
|-
! colspan=12 style="text-align:left" |
The ThinkPad SL series and IdeaPad series have firmware that is completely different from other ThinkPad models. Neither [[tp_smapi]] nor [[thinkpad-acpi]] support these models.
|}
</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 <tt>hdaps</tt> driver of tp_smapi 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.

The <tt>invert</tt> parameter is an integer between 0 and 7, whose meaning is defined below. (This is confusing. Most people will find it easier to just try all 8 possibilities.)

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.

Tp smapi

2009-02-18T00:32:31Z

Intrigeri: /* Installation on Debian unstable (sid), testing (squeeze) or stable (lenny) */ newbie-compliancy

{| 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. The tp_smapi software package 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.

This driver uses undocumented features and direct hardware access, so it may work unreliably or even damage your hardware; but so far no such damage has been reported.
|}

===Features===
*Battery charge/discharge control
*Battery status information
*Modified [[HDAPS]] driver with improved stability, model support and functionality

===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.39.tgz}}
:{{cmdroot|cd tp_smapi-0.39}}

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/package/app-laptop/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:

* Disable the <tt>hdaps</tt> module in your kernel configuration (Device Drivers → Hardware Monitoring Support → IBM Hard Drive Active Protection System)
* Rebuild and install the 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), testing (squeeze) or stable (lenny)====
Debian now contains the [http://packages.debian.org/tp-smapi packaged module source] and prebuilt modules for Debian kernels.

If you use a stock Debian kernel, you can install the tp_smapi modules with:
* {{cmdroot|apt-get install tp-smapi-modules-`uname -r`}}

If you use a custom kernel, you can build tp_smapi with module-assistant:
* {{cmdroot|aptitude install tp-smapi-source}}
* {{cmdroot|m-a -t a-i tp-smapi}}

====Installation on Ubuntu Hardy====
Ubuntu ships tp_smapi in their linux-ubuntu-modules Package since Hardy, so you don't have to build it yourself. Please note that they have renamed tp_smapi's modified <tt>hdaps</tt> module to <tt>hdaps_ec</tt>. You should load <tt>hdaps_ec</tt>, not <tt>hdaps</tt>.

Some Ubuntu packages lack the <tt>hdaps_ec</tt> module, as reported [https://bugs.launchpad.net/ubuntu/+source/linux/+bug/297213 here].

====Installation on older 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.
Debian users execute the following:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users execute the following using the kernel-version only (exclude -XX-generic; e.g. 'linux-source-2.6.20'):
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>

Be sure to unpack the source file. The easiest way is to open Nautilus as root:
<pre><nowiki>sudo nautilus</nowiki></pre>
Then browse to /usr/src/ and extract the source file to that directory.

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 build -> /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/build</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===
==== <tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f</tt> ====
The "<tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f!</tt>" error message is printed when loading the <tt>thinkpad_ec</tt> module on some recent ThinkPad models. This occurs because the ACPI BIOS DSDT is reserving ports used by tp_smapi.

As a workaround, add the <tt>force_io=1</tt> module parameter to <tt>thinkpad_ec</tt> in {{path|/etc/modprobe.conf}} (or your distribution's equivalent). For transient testing, load the modules as follows:

: {{cmdroot|1=make load HDAPS=1 FORCE_IO=1}}

Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16).

Models which need this option include:
* ThinkPad {{T400}}
* ThinkPad {{T500}}
* ThinkPad {{X200}}

More information:
* http://bugzilla.kernel.org/show_bug.cgi?id=12221
* http://www.nabble.com/thinkpad_ec-fails-to-load-on-Thinkpad-T500-td19932985.html

==== <tt>thinkpad_ec: no ThinkPad embedded controller!</tt> ====
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}} || || || ||
|-
! {{R50e}} 1834-5US
| {{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 || || ||
|-
! {{R61}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.35-test1 || 7KETA7WW 2.07 || 7KHT24WW 1.08 || Machine type 8918 ||
|-
! {{R61i}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || || || || Machine type 8250 ||
|-
! {{R400}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || 0.37-6 || || || Machine type 7443; added pnpacpi=off to grub boot menu.lst; force_io=yes only supported in tp_smapi v0.40 ||
|-
! 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}} || {{Cno}} || {{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 || || ||
|-
! {{T60}} 1951-24G
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.36 || 1.09a || ||
|-
! {{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]
|-
! {{T400}} and {{T500}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! 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)
|-
! {{X60_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.34 || 7JET25WW (1.10 ) || 7JHT13WW 1.04 || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X60s}} 1704-5UG
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cno|text=}} 3 || 0.34 || 7BETD2WW 2.13 || 7BHT40WW 1.13 ||
|-
! {{X61}} 7673-CTO
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 7NETB9WW (2.19) || {{Cunk}} ||
|-
! {{X61}} 7675-CTO
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} 6 || 0.35-test1 || || ||
|-
! {{X61}} 7675-4KU
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.34 || 7NET30WW (1.11 ) || 7MHT24WW-1.02 ||
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.32 || || ||
|-
! {{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
|-
! {{X200}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 6DET38WW (2.02 ) || 7XHT21WW-1.03 || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! {{X300}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.37 || 7TET25WW (1.02 ) || 7THT15WW-1.00c ||
|-
! 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}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====SL series and IdeaPad=====
|-
! colspan=12 style="text-align:left" |
The ThinkPad SL series and IdeaPad series have firmware that is completely different from other ThinkPad models. Neither [[tp_smapi]] nor [[thinkpad-acpi]] support these models.
|}
</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 <tt>hdaps</tt> driver of tp_smapi 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.

The <tt>invert</tt> parameter is an integer between 0 and 7, whose meaning is defined below. (This is confusing. Most people will find it easier to just try all 8 possibilities.)

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.

Tp smapi

2009-02-18T00:31:42Z

Intrigeri: /* Installation on Debian unstable (sid) or testing (lenny) */ fixed Lenny 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. The tp_smapi software package 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.

This driver uses undocumented features and direct hardware access, so it may work unreliably or even damage your hardware; but so far no such damage has been reported.
|}

===Features===
*Battery charge/discharge control
*Battery status information
*Modified [[HDAPS]] driver with improved stability, model support and functionality

===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.39.tgz}}
:{{cmdroot|cd tp_smapi-0.39}}

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/package/app-laptop/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:

* Disable the <tt>hdaps</tt> module in your kernel configuration (Device Drivers → Hardware Monitoring Support → IBM Hard Drive Active Protection System)
* Rebuild and install the 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), testing (squeeze) or stable (lenny)====
Debian now contains the [http://packages.debian.org/tp-smapi packaged module source] and prebuilt modules for Debian kernels.

If you use a custom kernel, you can build tp_smapi with module-assistant:
* {{cmdroot|aptitude install tp-smapi-source}}
* {{cmdroot|m-a -t a-i tp-smapi}}

If you use a stock Debian kernel, you can install the tp_smapi modules with:
* {{cmdroot|apt-get install tp-smapi-modules-`uname -r`}}

====Installation on Ubuntu Hardy====
Ubuntu ships tp_smapi in their linux-ubuntu-modules Package since Hardy, so you don't have to build it yourself. Please note that they have renamed tp_smapi's modified <tt>hdaps</tt> module to <tt>hdaps_ec</tt>. You should load <tt>hdaps_ec</tt>, not <tt>hdaps</tt>.

Some Ubuntu packages lack the <tt>hdaps_ec</tt> module, as reported [https://bugs.launchpad.net/ubuntu/+source/linux/+bug/297213 here].

====Installation on older 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.
Debian users execute the following:
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>
Ubuntu users execute the following using the kernel-version only (exclude -XX-generic; e.g. 'linux-source-2.6.20'):
<pre><nowiki>apt-get install linux-source-`uname -r`</nowiki></pre>

Be sure to unpack the source file. The easiest way is to open Nautilus as root:
<pre><nowiki>sudo nautilus</nowiki></pre>
Then browse to /usr/src/ and extract the source file to that directory.

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 build -> /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/build</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===
==== <tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f</tt> ====
The "<tt>thinkpad_ec: cannot claim io ports 0x1600-0x161f!</tt>" error message is printed when loading the <tt>thinkpad_ec</tt> module on some recent ThinkPad models. This occurs because the ACPI BIOS DSDT is reserving ports used by tp_smapi.

As a workaround, add the <tt>force_io=1</tt> module parameter to <tt>thinkpad_ec</tt> in {{path|/etc/modprobe.conf}} (or your distribution's equivalent). For transient testing, load the modules as follows:

: {{cmdroot|1=make load HDAPS=1 FORCE_IO=1}}

Note: force_io option was added in tp_smapi v0.40 (released 2008-12-16).

Models which need this option include:
* ThinkPad {{T400}}
* ThinkPad {{T500}}
* ThinkPad {{X200}}

More information:
* http://bugzilla.kernel.org/show_bug.cgi?id=12221
* http://www.nabble.com/thinkpad_ec-fails-to-load-on-Thinkpad-T500-td19932985.html

==== <tt>thinkpad_ec: no ThinkPad embedded controller!</tt> ====
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}} || || || ||
|-
! {{R50e}} 1834-5US
| {{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 || || ||
|-
! {{R61}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cyes}} || {{Cyes|text=}} 1 || 0.35-test1 || 7KETA7WW 2.07 || 7KHT24WW 1.08 || Machine type 8918 ||
|-
! {{R61i}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || || || || Machine type 8250 ||
|-
! {{R400}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} ||{{Cunk}} || {{Cunk}} || 0.37-6 || || || Machine type 7443; added pnpacpi=off to grub boot menu.lst; force_io=yes only supported in tp_smapi v0.40 ||
|-
! 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}} || {{Cno}} || {{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 || || ||
|-
! {{T60}} 1951-24G
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.36 || 1.09a || ||
|-
! {{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]
|-
! {{T400}} and {{T500}}
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} 1 || 0.40 || 1.19 || || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! 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)
|-
! {{X60_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 3 || 0.34 || 7JET25WW (1.10 ) || 7JHT13WW 1.04 || [http://luke.no-ip.org/x60tablet/ ref] [http://rad.bioinfo.ulaval.ca/hardware/x60tablet ref]
|-
! {{X60s}} 1704-5UG
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cno|text=}} 3 || 0.34 || 7BETD2WW 2.13 || 7BHT40WW 1.13 ||
|-
! {{X61}} 7673-CTO
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || 0.37 || 7NETB9WW (2.19) || {{Cunk}} ||
|-
! {{X61}} 7675-CTO
| {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cno|text=}} 6 || 0.35-test1 || || ||
|-
! {{X61}} 7675-4KU
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.34 || 7NET30WW (1.11 ) || 7MHT24WW-1.02 ||
|-
! {{X61_Tablet}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 6 || 0.32 || || ||
|-
! {{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
|-
! {{X200}}
| {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cno|text=}} 7 || 0.40 || 6DET38WW (2.02 ) || 7XHT21WW-1.03 || Requires <tt>force_io=1</tt> parameter to <tt>thinkpad_ec</tt>
|-
! {{X300}}
| {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || 0.37 || 7TET25WW (1.02 ) || 7THT15WW-1.00c ||
|-
! 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}} || {{Cyes}} || {{Cyes}} || {{Cyes}} || {{Cunk}} || || || ||
|-
! colspan=12 style="text-align:center;background:#efefef;" |

=====SL series and IdeaPad=====
|-
! colspan=12 style="text-align:left" |
The ThinkPad SL series and IdeaPad series have firmware that is completely different from other ThinkPad models. Neither [[tp_smapi]] nor [[thinkpad-acpi]] support these models.
|}
</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 <tt>hdaps</tt> driver of tp_smapi 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.

The <tt>invert</tt> parameter is an integer between 0 and 7, whose meaning is defined below. (This is confusing. Most people will find it easier to just try all 8 possibilities.)

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.

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:29:09Z

Intrigeri: /* SMAPI support */ fix broken link

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi|dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:24:48Z

Intrigeri: /* SpeedStep */ formatting

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}} 
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:10:53Z

Intrigeri: /* Integrated wireless */ more details

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, enable the <code>led</code> option for the <code>ipw2200</code> module by adding the following line to {{path|/etc/modprobe.d/local}}, creating this file if needed:
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:06:18Z

Intrigeri: /* Integrated wireless */ style

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed in this notebook. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, add the following line to {{path|/etc/modprobe.d/local}} (creating this file if needed):
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:04:54Z

Intrigeri: /* Integrated wireless */ fix link

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI Adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, add the following line to {{path|/etc/modprobe.d/local}} (creating this file if needed):
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:03:52Z

Intrigeri: /* Introduction notes */ style

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has generally been prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, add the following line to {{path|/etc/modprobe.d/local}} (creating this file if needed):
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installation on ThinkPads without CD-ROM drive

2009-02-18T00:02:00Z

Intrigeri: /* Installation from USB drive */ added link to Debian installation guide

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
Some ThinkPads (e.g. the whole X series) come without a CD-ROM drive by default. Even though there are options to buy a solution like the UltraBase, a full dock or simply an external CD-ROM drive{{footnote|1}}, this is not the cheapest option and might not always be necessary. Also, with some external CD-ROMs the problem might arise that the ThinkPad is not able to boot from them. See our [[Supported Boot Devices|List of supported boot devices]] for various ThinkPads.

So the question arises how to get your system of choice onto that precious piece of hardware. This page should tell you about the possible solutions.

Since in most cases the installation base packages come on CD, you'll need a second computer, equipped with a CD-ROM drive, for all of those solutions.

Many older ThinkPads came with only a floppy drive and cannot boot from any CD drive at all. For those machines, booting from floppy is the only option. Then one can install from CD, over a network, or from the hard drive.
|}

==Installation from USB drive==
{{NOTE|Not all ThinkPads have a BIOS that [[Supported_Boot_Devices|supports USB booting]].}}

This is probably the easiest approach:
#Connect the USB drive{{footnote|2}} to the host and format it.
#Get a bootable system and all needed installation files onto the USB drive, i.e. by copying the complete filesystem from your installation CD-ROM to the USB drive. Of course if your USB drive is not big enough for that you'll have to make more sophisticated choices about what to copy and what to leave behind. Here are [http://wiki.debian.org/BootUsb some instructions] (and [https://help.ubuntu.com/community/Installation/FromUSBStick instructions for ubuntu], [http://debian.org/releases/lenny/i386/ch04s03.html instructions for Debian 5.0 (Lenny)]) for converting a LiveCD ISO image onto a pen drive, and making it bootable.{{footnote|3}}

#Insert the USB drive into the USB port of your ThinkPad.
#Power on the ThinkPad and press F12 to get to the boot menu. For some models (X24 comes to mind) you need to go into the BIOS and change the boot sequence before USB devices are shown in the boot menu.
#Select the USB drive as boot media and boot.
#Follow the normal installation process.

It seems some ThinkPad BIOSes don't use the code on the master boot record (MBR), or at least skip it when it is blank. These systems will need an [http://www.tsden.org/ryutaroh/extipl/ Extended-IPL boot loader]. Putting this Extended-IPL boot loader onto the disk (such as <tt>sda</tt>) goes something like this:

dd if=/dev/zero of=/dev/sda bs=1 count=446
dd if=/usr/lib/extipl/aldebaran.bin of=/dev/sda

==Booting from a PCMCIA device==
Many ThinkPads, even as old as some original Pentium models, can boot from a PCMCIA slot. The device must appear as a normal hard drive for that to work, and it must have boot code on the first block of the device. PCMCIA hard drives and some PCMCIA card readers (compact flash, SD, memory stick, etc.) will work for this purpose.

If your distribution offers an installation image, just copy it to the device and boot from it. Here's a sample that works with Ubuntu 7.10 (Gutsy Gibbon). Insert the card and reader into a laptop running Linux. If the device mounts automatically, unmount it. Run these commands:
wget http://archive.ubuntu.com/ubuntu/dists/gutsy/main/installer-i386/current/images/netboot/boot.img.gz
gunzip boot.img.gz
sudo dd if=boot.img of=/dev/sdb (careful!)
Be '''very''' careful when typing that last line. A typo could erase your hard drive. This image installs over a network, but there are other larger images that install the entire system directly.

Put the card reader and any other needed cards (such as a network card). Get into EZSetup and change the boot order to PCMCIA then HDD-1. Reboot and the installation should start.

==Installation via network boot==
Thinkpads support PXE to boot off another system that is connected via [[Ethernet]]. In this case the ThinkPad acts as a network boot client, the other system as server. The idea is to boot a system on the server that the ThinkPad can boot into then by loading all required data directly from that server.

For this to work you will have to either have both the server and the ThinkPad connected in the same subnet of your LAN, or have them connected directly via a crossed Ethernet cable.

===Using Windows as a server===
To get your Thinkpad to boot over a network, you must set up a DHCP and a TFTP server. For Windows, the freeware program [http://tftpd32.jounin.net TFTPD32] does both. To set up TFTPD32, do the following:
#Create a directory that will contain the PXE boot code.
#Copy the boot code into that directory. (For a Debian Sarge install, for example, you can find code to initiate a network install under <code>debian/dists/sarge/main/installer-i386/current/images/netboot/</code> from a Debian mirror -- copy files to simulate symlinks for <code>pxelinux.0</code> and <code>pxelinux.cfg/</code>)
#Launch the TFTPD32 program.
#"Browse" to set the current directory to the directory containing the PXE boot code (i.e. the directory you created in the first step, above).
#On the DHCP server tab, set:
##<code>IP pool starting address</code> to something appropriate for your network
##<code>Size of pool</code> to a non-zero value (all you really need is 1)
##<code>Boot file</code> to the PXE boot image (for Debian, the filename is <code>pxelinux.0</code>)
##<code>WINS/DNS Server</code> to the DNS server used by your network
##<code>Default router</code> to the IP of your default gateway
##<code>Mask</code> to your network's netmask
##<code>Domain Name</code> to your network's domain
{{NOTE|Do not under any circumstances run the DHCP server if there are other DHCP servers on your network. There must be only one DHCP server on each network segment. You must either disable the other server or move to another network.}}

On your ThinkPad, do the following:
#Boot your Thinkpad, and press {{key|F12}} to select an alternate boot device
#Use "<code>Intel(R) Boot Agent Version 4.0.17</code>" (or similar -- on the Transnote used to make this guide, "<code>Network Boot</code>" did not work while the "<code>Boot Agent</code>" option did)

The TFTPD32 server window should show activity as the ThinkPad downloads files. Once the first stage has installed and the ThinkPad is ready to boot from its own hard drive, shut down TFTPD32 and re-enable your permanent DHCP server.

===Using [[:Category:Knoppix|Knoppix]] as a Terminal Server===
If a server system is available on the network, it can be used to set up a temporary Terminal Server. Follow these steps to set up the Terminal Server using Knoppix:
#Insert the Knoppix CD into the server and boot it up. Make sure to boot with the 2.6 kernel by giving the <code>kernel26</code> boot option.
#Once your KDE desktop is loaded, look in the K-Menu hierarchy for the link to the terminal server setup. Select this menu option.
#Launch the Terminal Server and make it use the appropriate network device.
Back at your ThinkPad, do the following:
#Power on your ThinkPad and press F12 to get to the boot menu.
#Select the ThinkPad's network adapter as the boot media.
#Reboot. The ThinkPad should now boot from the Knoppix Terminal Server directly.

===Using any Linux on the server side===
{{Todo|needs better formating, maybe a list where to find the kernel/initrd images on other distros and a hint to speed up booting}}

# TFTP Server
#* Download and install an tftp Server
#* Configure it to serve {{path|/tftpboot}}
# Get the kernel and initrd image from your distribution
#* For fedora-core they are in {{path|os/images/pxeboot}}
#* Copy both to {{path|/tftpboot/vmlinuz}} resp. {{path|/tftpboot/initrd.img}}
# [http://www.kernel.org/pub/linux/boot/syslinux/ Bootloader]
#* Download the current syslinux-X.YZ.tar.bz2 tarball
#* Copy the included pxelinux.0 to {{path|/tftpboot/pxelinux.0}}
#* Create a directory for the configuration with {{cmdroot|mkdir /tftpboot/pxelinux.cfg}}
#* Create the file {{path|/tftpboot/pxelinux.cfg/default}} with the following contents:
DEFAULT install
PROMPT 1
TIMEOUT 0
LABEL install
kernel vmlinuz
append initrd=initrd.img --
# DHCP Server
#* Download and install an DHCP Server
#* Configure it to for your Thinkpad, the following configuration assumes that the MAC-address of your Thinkpad is DE:AD:BE:EF:00:00 and should use the IP 192.168.0.2 with namesever/router/tftpserver 192.168.0.1
allow booting;
allow bootp;
host thinkpad {
hardware ethernet DE:AD:BE:EF:00:00;
fixed-address 192.168.0.2;
option domain-name-servers 192.168.0.1;
option routers 192.168.0.1;
default-lease-time 28800;
filename "pxelinux.0";
next-server 192.168.0.1;
}
#* Now you can boot your thinkpad via lan

==Installation from the internal harddrive==
The idea here is to have all required files already on the internal harddrive when you power up your ThinkPad for installation, including of course a minimal system to boot up and start the installation process.

Convenient, but how do you get the files there?
*One option is to copy them via network boot (see above).
*Some Linux distributions offer ways to download the installation files from a FTP server and to choose this directory as installation source instead of a CD-ROM.
*A second way, if you already have a 'working' copy of DOS or MS Windows installed, is to start the installer from loadlin or GRUB. This is detailed [http://marc.herbert.free.fr/linux/win2linstall.html here].
*Another one is to remove the harddrive from the ThinkPad and connect it to the other machine. Again, this can be achieved in several ways:
**putting the harddrive into an UltraBay secondary HDD adapter of a second ThinkPad
**putting the harddrive into an external casing and connect it to the second machine via USB, PCMCIA or whatever
**connecting the harddrive via a 2.5" (laptop) to 3.5" (desktop) harddrive adapter

Follow one of the following instructions.

===Installing [[:Category:Windows|Windows]] 2000 or XP===
*Attach the harddrive to the host computer and install a minimal bootable DOS system i.e. by booting a Win98 Emergency Boot Disk and performing the command "SYS X:" (where X = the laptop's harddrive).
*Copy FDISK.EXE to the laptop harddrive.
*Return the harddrive to the laptop and boot to DOS. (If you have Win98 installed by default, you can skip the first two steps and simply reboot in Windows to DOS.)
*Run FDISK and set up your new Windows system partition on this laptop. (If you do not do this on the laptop, after reboot you will receive the infamous "NTLDR IS MISSING" error. This error may still occur if the partition is greater than 7.8gb in size)
*Then return the drive to the host and format the drive as FAT32. (DO NOT format as NTFS.)
*Repeat the "SYS X:" step to make the new partition bootable.
*Copy Himem.sys and Config.sys, too. Otherwise SMARTDRIVE.EXE won't run
*Get SMARTDRV.EXE from the internet and copy it to your Thinkpads harddrive.
*Also, from the Win2K or WinXP CD, copy the I386 folder to the harddrive.
*Return the laptop's harddrive to the Thinkpad one final time and boot to DOS.
*Run SMARTDRV.EXE first, then change directories to I386 and run WINNT.EXE, this will allow the installation to begin.
*During installation, choose NOT to format the destination partition, since it contains the installation files. If you want that filesystem to be NTFS you can convert it after installation from within Windows.

==Installation from Diskette==
===Installing from CD===
Many distributions have software on CD that will make a boot floppy that will allow you to install from an unbootable CD drive.

===Installing over a network===
Some distributions have a set of diskettes that will allow you to boot a machine, enable a network device and start installation over a network. For example, {{Slackware}} supports installing via an NFS mount. An unofficial add-on adds an option to install over FTP.

===Installing from floppy===
Some distributions did allow for a complete installation from diskette. As the size of distributions and the number of required diskettes has grown, and the ubiquity of optical storage increased, support for floppy installation has diminished.

However, there are still some Linux distributions that fit on as few as one diskette - with very limited functionality, of course.

==Installation from an ISO image==
Some distributions offer a way of installing directly from the downloadable ISO image, residing on your harddisk. Examples are VectorLinux 5.1 and {{SUSE}} 10. The individual distributions installation manuals will guide you through the process.

==External Sources==
*[http://www.gentoo.org/doc/en/altinstall.xml Gentoo alternative installation method HOWTO]

{{footnotes|
#External CD-ROM drives typically are connected through USB or [[PCMCIA]]. Be aware that not all of these drives are [[Supported Boot Devices|capable of booting]]. USB connected drives are more likely to be bootable on a ThinkPad than PCMCIA connected ones.
#USB drive here means any kind of USB connected bootable data storage device, including external harddisk drives, memory card readers or pendrives.
#Most USB keys are already bootable. If it won't work, use lilo to write to the USB key's MBR: See the section "Master Boot Record" [http://wiki.debian.org/BootUsb here].
}}

[[Category:TransNote]] [[Category:560]] [[Category:560E]] [[Category:560X]] [[Category:560Z]] [[Category:570]] [[Category:570E]] [[Category:X20]] [[Category:X21]] [[Category:X22]] [[Category:X23]] [[Category:X24]] [[Category:X30]] [[Category:X31]] [[Category:X32]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:Knoppix]]

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-18T00:00:45Z

Intrigeri: /* Prepare the installation media */ fix url

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has been generally prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, add the following line to {{path|/etc/modprobe.d/local}} (creating this file if needed):
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installation instructions for the ThinkPad X32

2009-02-17T23:58:31Z

Intrigeri: /* Distro specific Instructions */ fix Debian version in link, for consistency's sake

Specific installation notes for the ThinkPad {{X32}}.

==General Notes==
If you don't have a CD-ROM solution, please look at [[Installation on ThinkPads without CD-ROM drive]].

==Distro specific Instructions==

* {{Install|SUSE| Professional 9.3|X32}}
* {{Install|Debian| 5.0 (Lenny)|X32}}

==External Sources==

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-17T23:55:12Z

Intrigeri: a bunch of improvements (mainly formatting)

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has been generally prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a [[BIOS Upgrade]] before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html.fr#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed. Ours came with the [[Intel PRO/Wireless 2200BG Mini-PCI adapter]], which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, add the following line to {{path|/etc/modprobe.d/local}} (creating this file if needed):
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver, that supports best the integrated [[ATI Mobility Radeon 7000]] graphics card.

=== Direct rendering ===

Install the mesa-utils package. Then, to see if direct rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually (untested), see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]]. Additional information about multiple displays can be found on [[Xorg RandR 1.2]].

== Bluetooth and IrDA ==

Unless you use them, you can fully disable Bluetooth and [[IrDA]] by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the <code>cpufrequtils</code> Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the <code>laptop-mode-tools</code> package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed packages: {{cmdroot|aptitude install acpi-support uswsusp hibernate}}.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the <code>radeontool</code> and <code>vbetool</code> packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments really needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the needed packages: {{cmdroot|aptitude install sl-modem-source sl-modem-daemon module-assistant}}

Then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': actually test the resulting packages.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-17T23:36:56Z

Intrigeri: enhanced introduction

== Introduction notes ==

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny or hard to find on the web. Linking to other pages on this wiki has been generally prefered to duplicating information.

The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

=== To do ===

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a BIOS upgrade
before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html.fr#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed. Ours came with If you
have the Intel PRO/Wireless 2200BG, which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, add the following line to {{path|/etc/modprobe.d/local}} (creating this file if needed):
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver.

=== Direct rendering ===

First, install the mesa-utils package. Then, to see if direct
rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually, see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]].

== Bluetooth and IrDA ==

One can fully disable these things by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the cpufrequtils Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the laptop-mode-tools package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed acpi-support, uswsusp and hibernate packages.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the radeontool and vbetool packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the sl-modem-source and module-assistant packages, then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': test the resulting packages actually work.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

Installation instructions for the ThinkPad X32

2009-02-17T23:33:24Z

Intrigeri: added new installation guide for Debian Lenny

Installing Debian 5.0 (Lenny) on a ThinkPad X32

2009-02-17T23:30:03Z

Intrigeri: initial version

This wiki has tons of useful tips regarding this laptop, so this document only gathers information that is either specific to {{Debian}} Lenny, or hard to find on the web.
The page dedicated to the {{X32}} is another good starting point to fine-tune your GNU/Linux installation on this notebook.

== FIXME ==

* Document Linux boot options

== Upgrade the BIOS ==

In case your X32 came with Windows installed, enjoy a BIOS upgrade
before installing GNU/Linux.

== Prepare the installation media ==

Running the installation from a USB stick was the chosen method.

* Get the <code>boot.img.gz</code> from the [http://http.us.debian.org/debian/dists/lenny/main/installer-i386/current/images/hd-media/ Debian installer website]
* Prepare a bootable USB stick, following the [http://debian.org/releases/lenny/i386/ch04s03.html.fr#usb-copy-flexible Debian installation guide], as the "easy way" did not work for us.
* In case you need to install using a wireless network, you are quite lucky, as Lenny's installer now supports loading firmwares during the install process; to make use of this feature, follow the [http://debian.org/releases/lenny/i386/ch06s04.html Loading Missing Firmware] section of the installation guide.

== Integrated wireless ==

According to {{X32}}, various mini-PCI wifi cards may be installed. Ours came with If you
have the Intel PRO/Wireless 2200BG, which identifies itself as:

{{cmduser|lspci}} 
{{cmdresult|02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)}}

{{cmduser|lspci -n}} 
{{cmdresult|02:02.0 0280: 8086:4220 (rev 05)}}

To get it working, one must install the firmware (unless it was
loaded during the installation process): {{cmdroot|aptitude install firmware-ipw2x00}}.

For this to work, you may need to include the non-free section from Debian's repositories in {{path|/etc/apt/sources.list}}, in case it is not enabled yet.

To enable the nice wireless led, add the following line to {{path|/etc/modprobe.d/local}} (creating this file if needed):
<pre>options ipw2200 led=1</pre>.

== X.Org ==

First, make sure you're using the radeon driver.

=== Direct rendering ===

First, install the mesa-utils package. Then, to see if direct
rendering is enabled, run: {{cmduser|glxinfo | grep -i direct}}.

If this command outputs {{cmdresult|direct rendering: Yes}}, you don't need to do anything special, as DRI is already working.

Else, read on. These instructions probably do far more than enabling DRI, but at least they work for me :)

Add the following lines to {{path|/etc/modules}} and {{path|/etc/initramfs-tools/modules}}; the goal is to ensure these kernel modules are loaded in good order, before X is started:

<pre>
intel_agp
agpgart
drm
radeon
</pre>

Then add these options to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DRI" "true"
Option "AccelMethod" "EXA"
Option "AGPMode" "4"
Option "AGPFastWrite" "on"
Option "ColorTiling" "on"
Option "EnablePageFlip" "on"
Option "AGPSize" "32"
Option "GARTSize" "32"
Option "XAANoOffscreenPixmaps" "true"
Option "EnableDepthMoves" "true"
</pre>

=== TrackPoint ===

The [[TrackPoint]] page is a good starting point to fine-tune this input device according to your needs and preferences, e.g. scrolling using the middle-mouse-button and the TrackPoint.

=== Power saving ===

To enable dynamic adjusting of the Radeon card frequency rates, add
this option to the Device section in {{path|/etc/X11/xorg.conf}}:

<pre>
Option "DynamicClocks" "on"
</pre>

The rovclock package allows to get/set these frequencies manually, see [[Rovclock]] for more information.

== Special keys ==

Once the acpi-support package is installed, almost all special {{key|Fn}} keys work as expected, at least on a Gnome desktop.

=== Video switch key ===

The video switch key {{key|Fn}}{{key|F7}} is not bound to any action by default.
To have it run a nice RandR user interface, see
[[Sample_Fn-F7_script#Having_Fn-F7_run_a_RandR_GUI]].

== Bluetooth and IrDA ==

One can fully disable these things by adding the following lines to
{{path|/etc/modprobe.d/local}}:

<pre>
# irda-related modules
blacklist irda
blacklist irtty_sir
blacklist nsc_ircc
blacklist sir_dev
# bluetooth
blacklist hci_usb
</pre>

== Power saving ==

=== SpeedStep ===

Install the cpufrequtils Debian package.

{{path|/etc/default/cpufrequtils}} must contain:

<pre>
ENABLE="true"
GOVERNOR="ondemand"
</pre>

{{path|/etc/default/loadcpufreq}} must contain:

<pre>
ENABLE=true
FREQDRIVER=acpi-cpufreq
</pre>

Then run:

{{cmdroot|/etc/init.d/loadcpufreq restart}}
{{cmdroot|/etc/init.d/cpufrequtils restart}}

=== laptop-mode ===

Just install the laptop-mode-tools package.

=== Miscellaneous ===

Adding the following lines to {{path|/etc/modprobe.d/local}} enables
automatic power saving for the sound card and the USB ports, and
prevents the wireless card from monitoring the whole universe unless
told:

<pre>
options snd-ac97-codec power_save=1
options usbcore autosuspend=1
options ipw2200 associate=0
</pre>

== SMAPI support ==

To get various model-specific features, such as advanced battery monitoring, the tp_smapi kernel module must be loaded. ThinkWiki has a nice [[Tp_smapi dedicated page]] explaining how to do so. Make sure you add this module to {{path|/etc/modules}} so that it is loaded at boot time.

== Sleep and suspend ==

First, install the needed acpi-support, uswsusp and hibernate packages.

=== Suspend-to-disk (hibernation) ===

It works OK with all methods: {{key|Fn}}{{key|F12}}, Gnome battery icon and hibernate command. The backend used by default is [[Swsusp]].

Modifying {{path|/etc/hibernate/common.conf}} may be needed to achieve this:

* uncomment <code>UseDummyXServer yes</code> to prevent DRI from being disabled on resume
* uncomment <code>SwitchToTextMode yes</code>
* if using Gnome, uncomment <code>LockGnomeScreenSaver yes</code>

=== Suspend-to-RAM ===

First, install the radeontool and vbetool packages.

==== s2ram ====

Works out of the box.

==== hibernate-ram ====

In {{path|/etc/hibernate/ram.conf}}, uncomment <code>RadeonTool yes</code> and comment <code>TryMethod sysfs-ram.conf</code>. Then the {{cmdroot|hibernate-ram}} command should do the Right Thing.

One can optionnally enable suspend-to-both by uncommenting <code>TryMethod ususpend-both.conf</code> in the same file.

==== pm-suspend ====

Works ok with:
{{cmdroot|pm-suspend --quirk-s3-bios --quirk-s3-mode --quirk-radeon-off}}}

'''FIXME''': are the arguments needed?

==== Gnome ====

The Gnome Power Manager suspend button does the Right Thing.

==== Sleep key (Fn-F4) ====

Works ok in Gnome.

== UltraBase X3 ==

[[UltraBase_X3]] has useful information on this. In short, using the stock Debian kernel, hotswapping the UltraBase is not possible, but it is perfectly recognized if the computer is booted docked.

== Modem ==

Install the sl-modem-source and module-assistant packages, then run:
{{cmduser|m-a a-i sl-modem}} that will build and install the necessary (non-free) kernel module and userspace daemon.

'''FIXME''': test the resulting packages actually work.

== System information ==

=== lspci ===

<pre>
00:00.0 Host bridge: Intel Corporation 82855PM Processor to I/O Controller (rev 03)
00:01.0 PCI bridge: Intel Corporation 82855PM Processor to AGP Controller (rev 03)
00:1d.0 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #1 (rev 01)
00:1d.1 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #2 (rev 01)
00:1d.2 USB Controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) USB UHCI Controller #3 (rev 01)
00:1d.7 USB Controller: Intel Corporation 82801DB/DBM (ICH4/ICH4-M) USB2 EHCI Controller (rev 01)
00:1e.0 PCI bridge: Intel Corporation 82801 Mobile PCI Bridge (rev 81)
00:1f.0 ISA bridge: Intel Corporation 82801DBM (ICH4-M) LPC Interface Bridge (rev 01)
00:1f.1 IDE interface: Intel Corporation 82801DBM (ICH4-M) IDE Controller (rev 01)
00:1f.3 SMBus: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) SMBus Controller (rev 01)
00:1f.5 Multimedia audio controller: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Audio Controller (rev 01)
00:1f.6 Modem: Intel Corporation 82801DB/DBL/DBM (ICH4/ICH4-L/ICH4-M) AC'97 Modem Controller (rev 01)
01:00.0 VGA compatible controller: ATI Technologies Inc Radeon Mobility M6 LY
02:00.0 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.1 CardBus bridge: Ricoh Co Ltd RL5c476 II (rev aa)
02:00.2 FireWire (IEEE 1394): Ricoh Co Ltd R5C552 IEEE 1394 Controller (rev 02)
02:01.0 Ethernet controller: Intel Corporation 82540EP Gigabit Ethernet Controller (Mobile) (rev 03)
02:02.0 Network controller: Intel Corporation PRO/Wireless 2200BG [Calexico2] Network Connection (rev 05)
</pre>

=== lspci -n ===

<pre>
00:00.0 0600: 8086:3340 (rev 03)
00:01.0 0604: 8086:3341 (rev 03)
00:1d.0 0c03: 8086:24c2 (rev 01)
00:1d.1 0c03: 8086:24c4 (rev 01)
00:1d.2 0c03: 8086:24c7 (rev 01)
00:1d.7 0c03: 8086:24cd (rev 01)
00:1e.0 0604: 8086:2448 (rev 81)
00:1f.0 0601: 8086:24cc (rev 01)
00:1f.1 0101: 8086:24ca (rev 01)
00:1f.3 0c05: 8086:24c3 (rev 01)
00:1f.5 0401: 8086:24c5 (rev 01)
00:1f.6 0703: 8086:24c6 (rev 01)
01:00.0 0300: 1002:4c59
02:00.0 0607: 1180:0476 (rev aa)
02:00.1 0607: 1180:0476 (rev aa)
02:00.2 0c00: 1180:0552 (rev 02)
02:01.0 0200: 8086:101e (rev 03)
02:02.0 0280: 8086:4220 (rev 05)
</pre>

=== /proc/cpuinfo ===

<pre>
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 13
model name : Intel(R) Pentium(R) M processor 1.70GHz
stepping : 6
cpu MHz : 600.000
cache size : 2048 KB
fdiv_bug : no
hlt_bug : no
f00f_bug : no
coma_bug : no
fpu : yes
fpu_exception : yes
cpuid level : 2
wp : yes
flags : fpu vme de pse tsc msr mce cx8 sep mtrr pge mca cmov pat clflush dts acpi mmx fxsr sse sse2 ss tm pbe bts est tm2
bogomips : 1198.97
clflush size : 64
power management:
</pre>

How to save memory

2009-02-17T22:04:34Z

Intrigeri: /* Alternative Desktop Environments */ added LXDE

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |This page is meant as a collection of information on how to save memory to make Linux work reasonable on older systems with limited amount of RAM.

Most distributions nowadays don't take much care about it anymore, so there are a lot of things you can do to save memory. To get a smoothly working Linux environment on a low memory machine you will need to consciously choose a lot of aspects of your system, most importantly the graphical environment, desktop environment and applications. This page provides detailed information about these various optimization possibilities.
|}

==Alternative graphical environments==
{{Todo|...}}

==Streamlining the desktop environment==
The common desktop environments GNOME and KDE are focused more on features, integration, and beauty rather than on saving resources. Understandable, but running Linux on an older ThinkPad with limited RAM requires a focus on limiting resource usage. The good thing about Linux is that a lot of things stay adjustable and customizable. So lets see what we can do about desktops.

One of the most important things is to decide for one graphical widget library and stick with that when you are choosing your desktop environment and applications. Having several toolkits in use means more libraries being loaded and hence more memory being used by those. Possibilities are:
* [http://www.fltk.org/ FLTK]
* [http://www.fox-toolkit.org/ FOX toolkit]
* [http://www.gnustep.org GNUstep toolkit]
* [http://www.gtk.org/ GTK] (not recommended, use GTK 2 if possible)
* [http://www.gtk.org/ GTK 2]
* [http://www.lesstif.org/ Lesstif] / [http://www.openmotif.org/ OpenMotif]
* [http://www.trolltech.com/products/qt/index.html QT]
* [http://www.windowmaker.org/development-wings.html WINGs] (kind of a lightweight GNUstep toolkit, provided by the WindowMaker developers)
* [http://www.x.org/ X Toolkit]

Of those, at current state, there are enough applications for the X Toolkit, GTK, GTK 2 and QT to provide you with a solution for every task you should want.

===GNOME===
It's like with humans, the worst feature is in most cases also the best one. For GNOME it is probably the many little parts it consists of. Makes it hard to install, but enables one to customize the installation. So, the first thing you should do to streamline GNOME is not to launch it. Sound stupid? Well, lets have a look.

GNOME is basically a set of libraries built around the GTK+ libs and extending its functionality. Add some nice little applications, a session manager, a panel, beautiful icons, and some other stuff and you have GNOME as you know it. Reversing those additions is what you can do to use GNOME applications on a machine that this desktop environment would normally take your nerves on.

The GNOME panel, the session manager, the desktop manager and the window manager are all parts of GNOME that eat a lot of memory for something that others can do in a maybe little less beautiful but much more resource saving way.
So first off configure your login manager not to launch gnome-session at login. If you are using GDM this is quite straight forward, you just need to add a different session script, launching your favorite window manager. See the list below and pick one, lets say i.e. WindowMaker. WindowMaker uses a desktop menu, a dock and a notification area to provide you with an organized way of launching applications and iconfying running ones. So we don't need a panel anymore. Also, think if you really need icons on your desktop. If you do, think about using something like ROX filer instead of nautilus for that. In any case, tell nautilus not to manage the desktop by default by unchecking the according setting within gconf-editor. To keep GNOME applications happy we would need to have gconf and gnome-settings-manager running at every session start. One way to do this is to either include them in your new session script. They both need to be running to make GNOME applications realize their settings properly.

===KDE===
{{Todo|...}}

===Alternative Desktop Environments===
First of all, it is important to notice that GNOME and KDE are not the only Desktop Environments around.
Other complete (featuring most of: window management, session management, desktop management, file management and panel) desktop environments are:
* [http://xfce.org/ XFCE] <tt>uses GTK 2</tt>
* [http://rox.sourceforge.net ROX Desktop]
* [http://ede.sourceforge.net Equinox Desktop Environment] <tt>uses eFLTK, a modified version of FLTK</tt>
* [http://www.nongnu.org/antiright/ AntiRight Desktop Environment] <tt>uses LessTif / OpenMotif</tt>
* [http://foxdesktop.sourceforge.net/ FOX Desktop Environment] <tt>uses FOX Toolkit</tt>
* [http://www.gnustep.org/ GNUstep] <tt>provides it's own toolkit</tt>
* [[http://www.lxde.org/ LXDE, the Lightweight X11 Desktop Environment]] <tt>uses GTK-2</tt>

But also, some Window Managers exceed the task of managing windows towards providing a functional workbench. See below for a list.

===Building your own Desktop===

====Window Manager====
If you want to build your own customized desktop, a good start is choosing the window manager of your liking. A list of window managers is at [http://xwinman.org].

Here's a list of some of them:
*including basic Desktop Environment functionality
**the [[Wikipedia:NextStep|NextStep]] alike ones
***[http://www.windowmaker.org/ WindowMaker] <tt>(probably the most widespread NextStep like WM)</tt>
***[http://www.afterstep.org/ AfterStep] <tt>(another one of those)</tt>
**the Blackbox-like ones
***[http://blackboxwm.sourceforge.net/ BlackBox]
***[http://fluxbox.sourceforge.net/ FluxBox] <tt>(tabbed windows, lighweight)</tt>
***[http://www.icculus.org/openbox/ OpenBox] <tt>(written from scratch to be fully ICCCM and EWMH compliant, fast and light-weight)</tt>
**others
***[http://www.icewm.org/ IceWM] <tt>(lightweight, widespread)</tt>
***[http://enlightenment.sourceforge.net/ Enlightenment] <tt>(lots of features and eye candy)</tt>
***[http://www.pekwm.org PekWM] <tt>(kind of a one man show, but feature rich and extremely customizable)</tt>
*pure WindowManagers
**[http://golem.sourceforge.net/ Golem]
**[http://home.earthlink.net/~lab1701/larswm/ LarsWM] <tt>(unique tiling Window Manager)</tt>
**[http://www.nongnu.org/ratpoison/ ratpoison] <tt>(modeled after gnu screen)</tt>
**[http://fvwm.org/ fvwm] <tt>(small but powerful)</tt>
**[http://www.jfc.org.uk/software/lwm.html lwm] <tt>(very small, and fast)</tt>
**[http://www.all-day-breakfast.com/wm2/ wm2] <tt>really small Window Manager</tt>
**[http://www.all-day-breakfast.com/wmx/ wmx] <tt>slightly more featureful version of wm2</tt>
**[http://wmii.suckless.org wmii] <tt>keyboard driven approach, very small, dynamic window managing</tt>
**[http://dwm.suckless.org dwm] <tt>keyboard-only driven approach, yet smaller than wmii, dynamic window managing</tt>

====Taskbar/Panel====
Another thing that especially users coming to Linux from the Windows world would probably like is a Panel or Taskbar.

Here's a collection of independant low resource panels:
*[http://www.chatjunkies.org/fspanel/ F***ing Small Panel] <tt>(doesn't use any toolkit)</tt>
*[http://freshmeat.net/projects/hpanel/ HPanel] <tt>(doesn't use any toolkit)</tt>
*[http://fbpanel.sourceforge.net/ fbpanel] <tt>(depends on GTK 2)</tt>
*[http://jodrell.net/projects/perlpanel Perl Panel] <tt>(depends on GTK 2, gnomevfs, perl)</tt>
*[http://www.gkrellm.net/ GKrellM] <tt>(depends on GTK 2, flexible plugin based skinable vertical panel)</tt>

Furthermore most of the windowmanagers allow you to have something like a panel/taskbar configured, and system tray applications like [http://stalonetray.sourceforge.net/ stalonetray] supply support for persistent applications (i.e. those that on quit do not quit but minimize to a tray icon) like Skype.

====Desktop Pinboard====
Then, the next thing you might be looking for is how to get icons onto your desktop. Usually this is done by the file manager who displays the content of a special directory as icons on the desktop. See the File Manager section to follow this approach.

However, you might decide for a really lightwight file manager which doesn't offer this feature. In that case all hope is not lost, for there are also special programs specialized in desktop icon management. Such are:
* [http://idesk.sourceforge.net/ iDesk] <tt>(recent versions need imlib2 only)</tt>

====File Manager====
File Managers are the fourth really important compontent of a desktop environment. There are plenty out their ranging from resource hugs to really lightweight and slim ones.

File Managers come with three distinct general user interface approaches: the two pane gui, the spacial and the browser gui. The browser gui is the one the Windows Explorer starting from Windows 2000 uses as well as earlier versions of Nautilus. The spacial view is the one known from Windows 95 and more recent versions of Nautilus. The two pane view is know to many from Norten Commander, Directory Opus or your favorite FTP client.

The following list provides an overview.
*FLTK
** [http://www.oksid.ch/flfm/ Fast Light File Manager] <tt>(spacial gui)</tt>
* FOX toolkit
** [http://roland65.free.fr/xfe/ X File Explorer] <tt>(browser and two pane gui)</tt>
*GTK
** [http://www.kaisersite.de/dfm/ Desktop File Manager] <tt>(spacial gui, incl. desktop icon management)</tt>
** [http://www.uwyn.com/projects/fm/ FM] <tt>(spacial, MAC OS 9 like gui)</tt>
** [http://radekc.regnet.cz/ Seksi Commander] <tt>(two pane gui)</tt>
*GTK 2
** [http://rox.sourceforge.net/ ROX Filer] <tt>(highly productive spacial gui, incl. panel and desktop icon management)</tt>
** [http://blog.perldude.de/projects/filer/ Filer] <tt>(browser and two pane gui, requires Perl)</tt>
** [http://xffm.sourceforge.net/ XFFM] <tt>(browser and spacial gui, requires some XFCE libs)</tt>
** [http://logicaldesktop.sourceforge.net/ Logical Desktop] <tt>(browser gui, actually a very special approach)</tt>
** [http://tuxcmd.sourceforge.net/ Tux Commander] <tt>(two pane gui)</tt>
** [http://www.nongnu.org/gcmd/index.html Gnome Commander] <tt>(two pane gui)</tt>
** [http://emelfm2.net/emelFM2/ emelFM2] <tt>(two pane gui with full customizable menu and toolbar, the best for power users)</tt>
** [http://thunar.xfce.org/index.xhtml Thunar] <tt>(requires some XFCE libs)</tt>
** [http://pcmanfm.sourceforge.net/ PCMan File Manager] <tt>(An extremly fast and lightweight file manager which features tabbed browsing and user-friendly interface. Requires GTK+ version 2.8.x)</tt>
* OpenMotif
** [http://www.musikwissenschaft.uni-mainz.de/~ag/xplore/xplore.php Xplore] <tt>(browser gui with productive 4 pane concept)</tt>
* QT 2
** [http://www.hi-net.cz/blaza/bfcommander/en/index.html BF-Commander] <tt>(two pane gui)</tt>
*Qt3
** [http://www.beesoft.org/download_bsc.html Beesoft Commander] <tt> (fast & easy two panel file manager, like Norton Commander)</tt>
* Tcl/Tk
** [http://users.tkk.fi/~mkivinie/X-Files/ X-Files] <tt>(two pane gui)</tt>
*X Toolkit
** [http://www.musikwissenschaft.uni-mainz.de/~ag/xfm/ X File Manager] <tt>(spacial gui)</tt>
** [http://www.boomerangsworld.de/worker/ Worker] <tt>(two pane gui, highly productive and configurable)</tt>
** [http://xnc.dubna.su/ X Northern Captain] <tt>(interesting flexible two pane gui)</tt>
*3D Filemanagers
** [http://www.determinate.net/webdata/seg/tdfsb.html TDFSB] <tt>(3D gui, the most impressing 3D file browser so far)</tt>
** [http://www.forchheimer.se/bfm/ Brutal File Manager] <tt>(3D gui more for fun than productivity)</tt>
** [http://turma.sourceforge.net/software/3dfile/ 3DFile] <tt>(3D gui)</tt>
** [http://orbis.sourceforge.net/ Orbis] <tt>(3D gui)</tt>

==Choosing applications==
===Web Browser===
This is highly dependent on the way you use your browser, it's often worth it to try out all and just track general
memory usage. Remember that <tt>top</tt> and <tt>ps</tt> don't report correct memory usage, track totals only.

====Firefox====
Firefox is graphical web browser. One can install features like AdBlock and FlashClicktoplay which will decrease memory and
processor usage by hiding Flash and Java -adverts.

====Opera====
Opera is graphical web browser. You can easily enable/disable plug-ins and java (press F12) and decrease memory usage.
Opera uses QT as toolkit, so you may shave off some Mbytes off memory usage by using dynamically linked version if you use KDE.

====Konqueror====
Konqueror is graphical web browser. It's integrated with KDE and has several advanced features (esp. ca. KDE 3.5).
You may save some megabytes by using it instead of other browsers when using KDE.
It's not necessarily heavy even when used without running KDE.

====Dillo====
Dillo is minimalistic and very small graphical web browser.

====Elinks/Lynx====
elinks/lynx are both text mode web browsers. <tt>elinks</tt> handles tables and formatting much nicer than <tt>lynx</tt>.
Both go very easy on memory footprint.

{{Todo|...}}

==Disabling unneeded system deamons==
Another thing you can do to improve performance is to get rid of unneaded system daemons launched from your init scripts. Disable them by using the according configuration interface of your distro or by deleting links in the according runlevel directories (usually in <code>/etc/rc.d/</code>).

Daemons you usually don't need:
* httpd <tt>(Apache web server)</tt>
* mysqld <tt>(MySQL database server)</tt>
* smbd <tt>(SMB windows filesharing server)</tt>
* pppd <tt>(PPP server for connections through modems and serial lines)</tt>

==Adjusting filesystems==
You can also try to optimize memory usage by making sure that you have as little as possible of your filesystem residing in RAM. To do this make sure that the following mount points are set to reside on your harddisk in {{path|/etc/fstab}}. {{Todo|how?}}
* /dev (not possible if you use udev)
* /tmp

Also make sure that you mount filesystems with extensive usage with noatime parameter (mount -o remount,ro /...), which disabled access time writes every time you access some file. Note that many incremental backups needs atime to work, such backups will then behave like full backup everytime. This depends on backup systems.

==Other tips==
===Disk space===
When using Debian/Ubuntu/other derivative, use <tt>aptitude</tt> as package manager, and use it as soon as possible. Use it and only it to install and remove packages.

One of its most useful features is that it tracks packages you install and marks packages installed via dependency as such, so when you remove a package that is no longer used, or package updates and doesn't use a library anymore, that dependency will get uninstalled.

You can mark packages installed as automatically installed by hitting 'M' (uppercase m), it will be marked for deinstallation if it's not longer required.

You could also install <tt>localepurge</tt>, which will remove all unneeded locales and localized manpages for packages you install.

===System clock===
<tt>ntpd</tt> can occupy around 4MB of memory, which is a substantial proportion of many older systems' total. [http://chrony.sunsite.dk/ <tt>chrony</tt>] is a pair of programs that replace the standard <tt>ntp</tt> and require much less memory.

How to get special keys to work

2009-02-17T21:48:56Z

Intrigeri: /* Gnome/metacity */ cite case that Just Works

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

Tablet buttons vary with model. See [[Tablet Hardware Buttons]].

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

On {{Debian}} Lenny, the acpi-support package automagically enables such events.

{| {{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
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || ibm/hotkey HKEY 00000080 00001018
|-
| 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

The following might work better for you:
keycode 77 = Num_Lock Num_Lock
because you will only get keycode 77 together with Shift (at least on the {{T43}})

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.

=====NumPad (KeyPad) keys access by a key combination=====
The current state is that you have to switch NumLock '''on''' via {{key|Fn}}+{{key|ScrLk}} and then e.g. type {{key|u}} to get a {{key|KP_4}} (NumPad 4). To get back to normal keyboard, you have to type {{key|Fn}}+{{key|ScrLk}} again.

Some people (including me) are missing on recent Thinkpads the option to have Fn as a modifier key to access the NumPad instead, i.e. and e.g. {{key|Fn}}+{{key|u}} gives you {{key|KP_4}}.

There is currently no way to make this work in a simple way (pleeeease correct me if I am wrong!), though there is a work-around. Instead of using {{key|Fn}} for accessing the NumPad, {{key|CapsLock}} can get this function by being mapped as Mode_switch (the {{key|AltGr}} on international keyboards). The {{key|Fn}} can be remapped to be Caps_Lock - while at the same time retaining its function to access the special laptop functions (e.g. {{key|Fn}}+{{key|F4}} for sleep}}, by using .Xmodmap.

So on my {{R60}} running fvwm@{{Slackware}} 12.1 the .Xmodmap would look like this:

! Make the forward and back buttons work
keycode 233 = XF86Forward
keycode 234 = XF86Back
! Make the WIN key to Super modifier
keycode 115 = Super_L
! Set the Caps_Lock physical key to Mode_switch (like AltGr on intl. keyboards)
keycode 66 = Mode_switch
! Set the Fn key to work as Caps_Lock now. The special key combos like Fn-F4 for "sleep" still work then
keycode 227 = Caps_Lock
clear lock
add lock = Caps_Lock
! Now we activate those new keys. Find some free mod slots (xmodmap) and put them there.
clear mod4
clear mod5
add mod4 = Super_L
add mod3 = Mode_switch
! It's time to add the keypad keys to the third position of the key definition (pure shift mode_switch shift+mode_switch)
keycode 16 = 7 ampersand KP_7
keycode 17 = 8 asterisk KP_8
keycode 18 = 9 parenleft KP_9
keycode 19 = 0 parenright KP_Divide
keycode 30 = u U KP_4
keycode 31 = i I KP_5
keycode 32 = o O KP_6
keycode 33 = p P KP_Multiply
keycode 44 = j J KP_1
keycode 45 = k K KP_2
keycode 46 = l L KP_3
keycode 47 = semicolon colon KP_Subtract
keycode 58 = m M KP_0
! ... I have to use the coma key, too, on the keypad...so I set it to be F20 (which is not existing on normal keyboards and thus is free... check for side effects in programmes accepting F12+ keys!)
keycode 59 = comma less F20
keycode 60 = period greater KP_Decimal
keycode 61 = slash question KP_Add

{{WARN|Your keycodes might be different as well as your '''mod''#''''' settings.}}
Use {{cmduser|xmodmap}} and {{cmduser|xmodmap -pke}} to check your ModMap, and the tool {{cmduser|xev}} to obtain your exact key codes.

===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 scancodes generated by the ThinkPad keys. They vary with model - see [[Tablet Hardware Buttons]].
{| {{prettytable}}
|+ scancodes
! key !! scancode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6c
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x68
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6e
|-
| {{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. Use your version so, if you have 3.0.1 or 3.0.2 use /usr/lib/firefox-3.0.1

:{{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>

For Hardy Heron, the xmodmap command is all lowercase. Also, the /etc/X11/Xmodmap file is not being read on boot. I've added the command to my .bashrc to have it called on startup.

====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 ;-)

====Epiphany====
By default, the back/forward keys, when bound to XF86Back/XF86Forward, successfully navigate through the history.

To get them switch through your tabs, you could use the extension from [http://crashman.homelinux.org/~andre/public/epiphany%20extensions/thinkpad%20browserkeys/ here]
You just need to edit your Xmodmap like described for Firefox < 3.0 (bind the keys on F19 and F20)

===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 ====

On {{Debian}} Lenny, using Gnome 2.22.2, once the acpid and acpi-support packages are installed, most Fn keys do the right thing out of the box.

For more advanced configuration, 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

2009-02-17T21:46:09Z

Intrigeri: /* Epiphany */ explain default behaviour

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

Tablet buttons vary with model. See [[Tablet Hardware Buttons]].

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

On {{Debian}} Lenny, the acpi-support package automagically enables such events.

{| {{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
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || ibm/hotkey HKEY 00000080 00001018
|-
| 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

The following might work better for you:
keycode 77 = Num_Lock Num_Lock
because you will only get keycode 77 together with Shift (at least on the {{T43}})

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.

=====NumPad (KeyPad) keys access by a key combination=====
The current state is that you have to switch NumLock '''on''' via {{key|Fn}}+{{key|ScrLk}} and then e.g. type {{key|u}} to get a {{key|KP_4}} (NumPad 4). To get back to normal keyboard, you have to type {{key|Fn}}+{{key|ScrLk}} again.

Some people (including me) are missing on recent Thinkpads the option to have Fn as a modifier key to access the NumPad instead, i.e. and e.g. {{key|Fn}}+{{key|u}} gives you {{key|KP_4}}.

There is currently no way to make this work in a simple way (pleeeease correct me if I am wrong!), though there is a work-around. Instead of using {{key|Fn}} for accessing the NumPad, {{key|CapsLock}} can get this function by being mapped as Mode_switch (the {{key|AltGr}} on international keyboards). The {{key|Fn}} can be remapped to be Caps_Lock - while at the same time retaining its function to access the special laptop functions (e.g. {{key|Fn}}+{{key|F4}} for sleep}}, by using .Xmodmap.

So on my {{R60}} running fvwm@{{Slackware}} 12.1 the .Xmodmap would look like this:

! Make the forward and back buttons work
keycode 233 = XF86Forward
keycode 234 = XF86Back
! Make the WIN key to Super modifier
keycode 115 = Super_L
! Set the Caps_Lock physical key to Mode_switch (like AltGr on intl. keyboards)
keycode 66 = Mode_switch
! Set the Fn key to work as Caps_Lock now. The special key combos like Fn-F4 for "sleep" still work then
keycode 227 = Caps_Lock
clear lock
add lock = Caps_Lock
! Now we activate those new keys. Find some free mod slots (xmodmap) and put them there.
clear mod4
clear mod5
add mod4 = Super_L
add mod3 = Mode_switch
! It's time to add the keypad keys to the third position of the key definition (pure shift mode_switch shift+mode_switch)
keycode 16 = 7 ampersand KP_7
keycode 17 = 8 asterisk KP_8
keycode 18 = 9 parenleft KP_9
keycode 19 = 0 parenright KP_Divide
keycode 30 = u U KP_4
keycode 31 = i I KP_5
keycode 32 = o O KP_6
keycode 33 = p P KP_Multiply
keycode 44 = j J KP_1
keycode 45 = k K KP_2
keycode 46 = l L KP_3
keycode 47 = semicolon colon KP_Subtract
keycode 58 = m M KP_0
! ... I have to use the coma key, too, on the keypad...so I set it to be F20 (which is not existing on normal keyboards and thus is free... check for side effects in programmes accepting F12+ keys!)
keycode 59 = comma less F20
keycode 60 = period greater KP_Decimal
keycode 61 = slash question KP_Add

{{WARN|Your keycodes might be different as well as your '''mod''#''''' settings.}}
Use {{cmduser|xmodmap}} and {{cmduser|xmodmap -pke}} to check your ModMap, and the tool {{cmduser|xev}} to obtain your exact key codes.

===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 scancodes generated by the ThinkPad keys. They vary with model - see [[Tablet Hardware Buttons]].
{| {{prettytable}}
|+ scancodes
! key !! scancode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6c
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x68
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6e
|-
| {{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. Use your version so, if you have 3.0.1 or 3.0.2 use /usr/lib/firefox-3.0.1

:{{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>

For Hardy Heron, the xmodmap command is all lowercase. Also, the /etc/X11/Xmodmap file is not being read on boot. I've added the command to my .bashrc to have it called on startup.

====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 ;-)

====Epiphany====
By default, the back/forward keys, when bound to XF86Back/XF86Forward, successfully navigate through the history.

To get them switch through your tabs, you could use the extension from [http://crashman.homelinux.org/~andre/public/epiphany%20extensions/thinkpad%20browserkeys/ here]
You just need to edit your Xmodmap like described for Firefox < 3.0 (bind the keys on F19 and F20)

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

Category:Debian

2009-02-17T21:34:40Z

Intrigeri: update, as Lenny has been released

{| 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''' || ''' ''Lenny 5.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 || ''Etch 4.0''
|| [http://www.debian.org/releases/etch/]
|| [http://www.debian.org/releases/etch/installmanual]
|| The previous stable version. You should consider upgrading. (It's still supported)
|- style="color:#333; background-color:#ddd"
|| obsolete || ''Sarge 3.1''
|| [http://www.debian.org/releases/sarge/]
|| [http://www.debian.org/releases/sarge/installmanual]
|| Obsolete stable version. Don't Install it.
|- 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''' || ''Squeeze''
|| [http://www.debian.org/releases/squeeze/]
|| [http://www.debian.org/releases/squeeze/installmanual]
|| 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]]

How to get special keys to work

2009-02-17T21:31:30Z

Intrigeri: /* Triggering key events */ note about acpi-support on Debian

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

Tablet buttons vary with model. See [[Tablet Hardware Buttons]].

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

On {{Debian}} Lenny, the acpi-support package automagically enables such events.

{| {{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
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || ibm/hotkey HKEY 00000080 00001018
|-
| 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

The following might work better for you:
keycode 77 = Num_Lock Num_Lock
because you will only get keycode 77 together with Shift (at least on the {{T43}})

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.

=====NumPad (KeyPad) keys access by a key combination=====
The current state is that you have to switch NumLock '''on''' via {{key|Fn}}+{{key|ScrLk}} and then e.g. type {{key|u}} to get a {{key|KP_4}} (NumPad 4). To get back to normal keyboard, you have to type {{key|Fn}}+{{key|ScrLk}} again.

Some people (including me) are missing on recent Thinkpads the option to have Fn as a modifier key to access the NumPad instead, i.e. and e.g. {{key|Fn}}+{{key|u}} gives you {{key|KP_4}}.

There is currently no way to make this work in a simple way (pleeeease correct me if I am wrong!), though there is a work-around. Instead of using {{key|Fn}} for accessing the NumPad, {{key|CapsLock}} can get this function by being mapped as Mode_switch (the {{key|AltGr}} on international keyboards). The {{key|Fn}} can be remapped to be Caps_Lock - while at the same time retaining its function to access the special laptop functions (e.g. {{key|Fn}}+{{key|F4}} for sleep}}, by using .Xmodmap.

So on my {{R60}} running fvwm@{{Slackware}} 12.1 the .Xmodmap would look like this:

! Make the forward and back buttons work
keycode 233 = XF86Forward
keycode 234 = XF86Back
! Make the WIN key to Super modifier
keycode 115 = Super_L
! Set the Caps_Lock physical key to Mode_switch (like AltGr on intl. keyboards)
keycode 66 = Mode_switch
! Set the Fn key to work as Caps_Lock now. The special key combos like Fn-F4 for "sleep" still work then
keycode 227 = Caps_Lock
clear lock
add lock = Caps_Lock
! Now we activate those new keys. Find some free mod slots (xmodmap) and put them there.
clear mod4
clear mod5
add mod4 = Super_L
add mod3 = Mode_switch
! It's time to add the keypad keys to the third position of the key definition (pure shift mode_switch shift+mode_switch)
keycode 16 = 7 ampersand KP_7
keycode 17 = 8 asterisk KP_8
keycode 18 = 9 parenleft KP_9
keycode 19 = 0 parenright KP_Divide
keycode 30 = u U KP_4
keycode 31 = i I KP_5
keycode 32 = o O KP_6
keycode 33 = p P KP_Multiply
keycode 44 = j J KP_1
keycode 45 = k K KP_2
keycode 46 = l L KP_3
keycode 47 = semicolon colon KP_Subtract
keycode 58 = m M KP_0
! ... I have to use the coma key, too, on the keypad...so I set it to be F20 (which is not existing on normal keyboards and thus is free... check for side effects in programmes accepting F12+ keys!)
keycode 59 = comma less F20
keycode 60 = period greater KP_Decimal
keycode 61 = slash question KP_Add

{{WARN|Your keycodes might be different as well as your '''mod''#''''' settings.}}
Use {{cmduser|xmodmap}} and {{cmduser|xmodmap -pke}} to check your ModMap, and the tool {{cmduser|xev}} to obtain your exact key codes.

===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 scancodes generated by the ThinkPad keys. They vary with model - see [[Tablet Hardware Buttons]].
{| {{prettytable}}
|+ scancodes
! key !! scancode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6c
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x68
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6e
|-
| {{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. Use your version so, if you have 3.0.1 or 3.0.2 use /usr/lib/firefox-3.0.1

:{{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>

For Hardy Heron, the xmodmap command is all lowercase. Also, the /etc/X11/Xmodmap file is not being read on boot. I've added the command to my .bashrc to have it called on startup.

====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 ;-)

====Epiphany====
To get the keys work in epiphany, you could use the extension from [http://crashman.homelinux.org/~andre/public/epiphany%20extensions/thinkpad%20browserkeys/ here]
You just need to edit your Xmodmap like described for Firefox < 3.0 (bind the keys on F19 and F20)

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

Thinkpad-acpi

2009-02-17T21:27:07Z

Intrigeri: suggest merge with ibm-acpi

==Thinkpad-specific ACPI driver==
This is a Linux ACPI driver for the IBM ThinkPad laptops written by Borislav Deianov and Henrique de Moraes Holschuh. The driver replaces [[ibm-acpi]] in Linux mainline as of 2.6.22 (March 2007). To confuse matters further, it appears that there was also an older (now abandoned) driver of the same name written by Erik Rigtorp which never made it into the mainline kernel. The current thinkpad-acpi contains essentially the same functionality as [[ibm-acpi]] with some added features. Among which are registering of acpi events to the "thinkvantage" and volume/mute buttons which could previously only be accessed through the use of the [[tpb]] utility.

==Hotkeys==
To view which hotkeys are active you can use "acpi_listen", but that is deprecated. A better way is to use "lsinput" and "input-events" commands to look at the output of the thinkpad-acpi input device(s).

One important difference from ibm-acpi for those who wish to enable all possible hot keys, is that thinkpad-acpi automatically enables them. One should not need to do anything to get the best possible thinkpad-acpi configuration for his ThinkPad (as long as he is using the latest thinkpad-acpi).

In particular, old documentation that tells you to "echo enable,0xffffffff >/proc/acpi/ibm/hotkey", or to give thinkpad-acpi any hotkey= module parameters to enable hot keys by default, is likely incorrect.

The thinkpad-acpi driver has detailed documentation, which is shipped inside the Linux kernel sources, as "Documentation/thinkpad-acpi.txt" or as "Documentation/laptops/thinkpad-acpi.txt". If you feel a need to change the hot key mask manually, it is probably best to look at that documentation first to understand the full side effects of any changes.

==Development==
To help with development and maintenance of the thinkpad-acpi driver, please add your model to the [[List of DMI IDs]].

==Further documentation==
More comprehensive documentation can be found in the kernel source tree under <tt>Documentation/thinkpad-acpi.txt</tt> or <tt>Documentation/laptops/thinkpad-acpi.txt</tt>.

For now, please refer to the [[ibm-acpi]] page, or ask on the linux-thinkpad mailinglist for any other information on the new thinkpad-acpi driver.

=== External links related to thinkpad-acpi ===
* [http://ibm-acpi.sf.net ibm-acpi/thinkpad-acpi main page in Sourceforge]
* [http://acpi.sourceforge.net Linux ACPI main page in Sourceforge], includes DSDT repository
* [http://www.kernel.org kernel.org main archives]
* [http://repo.or.cz/w/linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git thinkpad-acpi development git tree]

[[Category:Drivers]]
[[Category:X32]]
[[Category:X61]]

{{Todo|needs editing}}: consider merging with [[ibm-acpi]]

Ibm-acpi

2009-02-17T21:26:38Z

Intrigeri: added merge suggestion

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
=== ibm-acpi - IBM ThinkPad ACPI Extras Driver ===
This is a Linux ACPI driver for the IBM ThinkPad laptops written by Borislav Deianov, and currently maintained by [[User:hmh|Henrique de Moraes Holschuh]]. It aims to support various features of these laptops which are accessible through the ACPI framework but not otherwise supported by the generic Linux ACPI drivers. As a kernel module, ibm-acpi works as a bridge to deliver information about certain hardware events like key presses or control the state of certain hardware features by software.
{{NOTE|The ibm-acpi driver was renamed to [[thinkpad-acpi]] on Linux kernel 2.6.22}}
|}

=== Features ===
*triggers ACPI Events for
** [[How_to_get_special_keys_to_work | Fn key combinations]] ({{key|Fn}}{{key|F1}}, {{key|Fn}}{{key|F2}}, {{key|Fn}}{{key|F3}}, {{key|Fn}}{{key|F4}}, {{key|Fn}}{{key|F5}}, {{key|Fn}}{{key|F6}}, {{key|Fn}}{{key|F7}}, {{key|Fn}}{{key|F8}}, {{key|Fn}}{{key|F9}}, {{key|Fn}}{{key|F10}}, {{key|Fn}}{{key|F11}}, {{key|Fn}}{{key|F12}})
** [[UltraBay]] device eject (see also [[How to hotswap UltraBay devices]])
** Display lid, Power button, Undock button
*enables control via /proc files of
** Bluetooth
** Video output switching, video expansion control
** Docking and undocking (limited)
** Fan (on most models, only enable/disable; speed control used to need a further [[Patch for controlling fan speed|patch]])
** Volume
** [[LCD Brightness]]
** [[ThinkLight]]
** [[Table_of_ibm-acpi_LEDs| LEDs]]
** [[Error Codes and Beep Codes|Beep]] codes
** Several CMOS states
* can show values of
** [[Thermal Sensors|Sixteen temperature sensors]]
** Embedded Controler registers
** Fan status and speed

Some of these features are available only when the module is loaded with the <tt>experimental=1</tt> option. To enable it, add the following to {{path|/etc/modprobe.conf}} (or your distribution's equivalent):
options ibm_acpi experimental=1

for kernels 2.6.22 and above fan control is enabled with the following in /etc/modprobe.conf:
options thinkpad_acpi fan_control=1

=== Project Homepage / Availability ===
* Homepage: http://ibm-acpi.sourceforge.net/
* Public releases: http://sourceforge.net/project/showfiles.php?group_id=117042
* ibm-acpi is included with the Linux kernel since 2.6.10.
* Mailing list: [[Mailinglists#ibm-acpi_Developers_Mailinglist|ibm-acpi-devel]]
* [[Git]] repository: git://repo.or.cz/linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git ([http://repo.or.cz/w/linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git browse])

=== Status ===
In development, usable, actively maintained. Patches should go to the ibm-acpi-devel [[mailinglists|mailing list]].

On older versions of the driver, even if you have disabled the BIOS setting for automatically dimming at battery power, after using the brightness switch of ibm-acpi, the auto-dimming behavior is enabled. This has been fixed in the latest thinkpad-acpi devel/backport versions and also kernel 2.6.26.

=== Application support===
* [http://www.gkrellm.net GKrellM] supports fan and thermal information
* [http://conky.sourceforge.net/ Conky] Displays the same information as GKrellM but displays it differently
* [http://www.joachim-breitner.de/blog/archives/38-Created-gaim-thinklight.html gaim-thinklight] is a gaim plugin which makes the [[ThinkLight]] blink when a message arrives.
* [http://packages.debian.org/unstable/net/pidgin-blinklight pidgin-thinklight] same as above but for pidgin
* [http://www.chris-lamb.co.uk/code/gaim-lightthink/ gaim-lightthink] is an alternative to gaim-thinklight.
* [http://hunz.org/ rocklight] is a xmms visualization plugin that makes the ThinkLight flash to the beat of your music. The package also includes a standalone stroboscope mode program.
* [http://sensors-applet.sourceforge.net/ GNOME Sensors Applet] is a small gnome panel applet which shows the fan speed and thermal information. In Debian it's the [http://packages.debian.org/search?keywords=sensors-applet&searchon=names&suite=all&section=all sensors-applet] package.
* [[ACPI fan control script|ACPI fan control scripts]] can be used to control the system fan according to system temperatures (overriding the firmware)

=== Interesting links related to this project ===
* [http://ibm-acpi.sf.net ibm-acpi Sourceforge project summary]
* [https://lists.sourceforge.net/lists/listinfo/ibm-acpi-devel ibm-acpi-devel Mailinglist] [http://gmane.org/info.php?group=gmane.linux.acpi.ibm-acpi.devel (List archive on gmane.org)]
* [http://mailman.linux-thinkpad.org/mailman/listinfo/linux-thinkpad Linux-Thinkpad Mailinglist]
* [http://acpi.sourceforge.net acpi.sourceforge.net]
* [http://www.kernel.org www.kernel.org]

[[Category:Drivers]]
[[Category:770X]] [[Category:770Z]] [[Category:A20m]] [[Category:A20p]] [[Category:A20m]] [[Category:A20p]] [[Category:A21e]] [[Category:A21m]] [[Category:A21p]] [[Category:A22e]] [[Category:A22m]] [[Category:A22p]] [[Category:G40]] [[Category:G41]] [[Category:R30]] [[Category:R31]] [[Category:R32]] [[Category:R40]] [[Category:R40e]] [[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[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:X20]] [[Category:X21]] [[Category:X22]] [[Category:X23]] [[Category:X24]] [[Category:X30]] [[Category:X31]] [[Category:X32]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:TransNote]]
[[Category:x60s]] [[Category:X61]]

{{Todo|needs editing}}: consider merging with [[Thinkpad-acpi]]

Thinkpad-acpi

2009-02-17T21:12:10Z

Intrigeri: added category X32

Ibm-acpi

2009-02-17T21:06:47Z

Intrigeri: /* Features */ fan speed control has been merged

Ibm-acpi

2009-02-17T21:01:11Z

Intrigeri: added category X32

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
=== ibm-acpi - IBM ThinkPad ACPI Extras Driver ===
This is a Linux ACPI driver for the IBM ThinkPad laptops written by Borislav Deianov, and currently maintained by [[User:hmh|Henrique de Moraes Holschuh]]. It aims to support various features of these laptops which are accessible through the ACPI framework but not otherwise supported by the generic Linux ACPI drivers. As a kernel module, ibm-acpi works as a bridge to deliver information about certain hardware events like key presses or control the state of certain hardware features by software.
{{NOTE|The ibm-acpi driver was renamed to [[thinkpad-acpi]] on Linux kernel 2.6.22}}
|}

=== Features ===
*triggers ACPI Events for
** [[How_to_get_special_keys_to_work | Fn key combinations]] ({{key|Fn}}{{key|F1}}, {{key|Fn}}{{key|F2}}, {{key|Fn}}{{key|F3}}, {{key|Fn}}{{key|F4}}, {{key|Fn}}{{key|F5}}, {{key|Fn}}{{key|F6}}, {{key|Fn}}{{key|F7}}, {{key|Fn}}{{key|F8}}, {{key|Fn}}{{key|F9}}, {{key|Fn}}{{key|F10}}, {{key|Fn}}{{key|F11}}, {{key|Fn}}{{key|F12}})
** [[UltraBay]] device eject (see also [[How to hotswap UltraBay devices]])
** Display lid, Power button, Undock button
*enables control via /proc files of
** Bluetooth
** Video output switching, video expansion control
** Docking and undocking (limited)
** Fan (on most models, only enable/disable; speed control is added by a further [[Patch for controlling fan speed|patch]])
** Volume
** [[LCD Brightness]]
** [[ThinkLight]]
** [[Table_of_ibm-acpi_LEDs| LEDs]]
** [[Error Codes and Beep Codes|Beep]] codes
** Several CMOS states
* can show values of
** [[Thermal Sensors|Sixteen temperature sensors]]
** Embedded Controler registers
** Fan status and speed

Some of these features are available only when the module is loaded with the <tt>experimental=1</tt> option. To enable it, add the following to {{path|/etc/modprobe.conf}} (or your distribution's equivalent):
options ibm_acpi experimental=1

for kernels 2.6.22 and above fan control is enabled with the following in /etc/modprobe.conf:
options thinkpad_acpi fan_control=1

=== Project Homepage / Availability ===
* Homepage: http://ibm-acpi.sourceforge.net/
* Public releases: http://sourceforge.net/project/showfiles.php?group_id=117042
* ibm-acpi is included with the Linux kernel since 2.6.10.
* Mailing list: [[Mailinglists#ibm-acpi_Developers_Mailinglist|ibm-acpi-devel]]
* [[Git]] repository: git://repo.or.cz/linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git ([http://repo.or.cz/w/linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git browse])

=== Status ===
In development, usable, actively maintained. Patches should go to the ibm-acpi-devel [[mailinglists|mailing list]].

On older versions of the driver, even if you have disabled the BIOS setting for automatically dimming at battery power, after using the brightness switch of ibm-acpi, the auto-dimming behavior is enabled. This has been fixed in the latest thinkpad-acpi devel/backport versions and also kernel 2.6.26.

=== Application support===
* [http://www.gkrellm.net GKrellM] supports fan and thermal information
* [http://conky.sourceforge.net/ Conky] Displays the same information as GKrellM but displays it differently
* [http://www.joachim-breitner.de/blog/archives/38-Created-gaim-thinklight.html gaim-thinklight] is a gaim plugin which makes the [[ThinkLight]] blink when a message arrives.
* [http://packages.debian.org/unstable/net/pidgin-blinklight pidgin-thinklight] same as above but for pidgin
* [http://www.chris-lamb.co.uk/code/gaim-lightthink/ gaim-lightthink] is an alternative to gaim-thinklight.
* [http://hunz.org/ rocklight] is a xmms visualization plugin that makes the ThinkLight flash to the beat of your music. The package also includes a standalone stroboscope mode program.
* [http://sensors-applet.sourceforge.net/ GNOME Sensors Applet] is a small gnome panel applet which shows the fan speed and thermal information. In Debian it's the [http://packages.debian.org/search?keywords=sensors-applet&searchon=names&suite=all&section=all sensors-applet] package.
* [[ACPI fan control script|ACPI fan control scripts]] can be used to control the system fan according to system temperatures (overriding the firmware)

=== Interesting links related to this project ===
* [http://ibm-acpi.sf.net ibm-acpi Sourceforge project summary]
* [https://lists.sourceforge.net/lists/listinfo/ibm-acpi-devel ibm-acpi-devel Mailinglist] [http://gmane.org/info.php?group=gmane.linux.acpi.ibm-acpi.devel (List archive on gmane.org)]
* [http://mailman.linux-thinkpad.org/mailman/listinfo/linux-thinkpad Linux-Thinkpad Mailinglist]
* [http://acpi.sourceforge.net acpi.sourceforge.net]
* [http://www.kernel.org www.kernel.org]

[[Category:Drivers]]
[[Category:770X]] [[Category:770Z]] [[Category:A20m]] [[Category:A20p]] [[Category:A20m]] [[Category:A20p]] [[Category:A21e]] [[Category:A21m]] [[Category:A21p]] [[Category:A22e]] [[Category:A22m]] [[Category:A22p]] [[Category:G40]] [[Category:G41]] [[Category:R30]] [[Category:R31]] [[Category:R32]] [[Category:R40]] [[Category:R40e]] [[Category:R50]] [[Category:R50p]] [[Category:R51]] [[Category:R52]] [[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:X20]] [[Category:X21]] [[Category:X22]] [[Category:X23]] [[Category:X24]] [[Category:X30]] [[Category:X31]] [[Category:X32]] [[Category:X40]] [[Category:X41]] [[Category:X41 Tablet]] [[Category:TransNote]]
[[Category:x60s]] [[Category:X61]]

Swsusp

2009-02-17T20:58:25Z

Intrigeri: /* Model-specific Status */ added X32 on Debian Lenny

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
===Software Suspend - swsusp===
Software Suspend (<tt>swsusp</tt>) is a suspend-to-disk implementation included in the 2.6 kernel series. See [[Software Suspend 2]] for an alternative implementation, which has some advantages.

Note that swsusp is not needed for suspend-to-RAM functionality.
|}

==Kernel configuration==
To enable software suspend change your kernel config as follows:
:{{kernelconf|CONFIG_PM|<*>|Power management support|Power management options|||}}
:{{kernelconf|CONFIG_SOFTWARE_SUSPEND|<*>|Software Suspend|Power management options|||}}
:{{kernelconf|CONFIG_PM_STD_PARTITION|[/dev/resume_partition]|Default resume partition|Power management options|||}}
<tt>/dev/resume_partition</tt> needs to be replaced by the swap partition you want to use for suspending. (Use {{cmdroot|fdisk -l /dev/hda}} if unsure.)

You can override the default resume partition anytime by giving {{bootparm|resume|/dev/resume_partition}} as kernel boot parameter.
Also, in case you suspended, but want to boot up normally (without resuming from the saved image - losing all data that was unsaved at suspend time), you can give the {{bootparm|noresume|}} kernel boot parameter.

{{NOTE|For some people suspending did not work if <tt>resume_partition</tt> was specified in the kernel config. In such case specify the resume partition as a kernel parameter instead.}}

{{NOTE|When using Debian Etch or Sid, you need to use <tt>initramfs-tools</tt> as yaird is currently (2006-05-18) not supporting swsusp. See [http://wiki.debian.org/InitrdReplacementOptions the Debian Wiki] for more details.}}

==Suspending==
To suspend you can either do a simple {{cmdroot|echo disk > /sys/power/state}} (recommended) or use the [http://softwaresuspend.berlios.de/old-site/swsusp/sysvinit-2.76-v2-for_swsusp-v5.tar.gz patched SysVInit] and call {{cmdroot|swsusp}} or {{cmdroot|shutdown -z now}}. As the {{path|/proc/acpi/sleep}} interface becomes deprecated in newer kernels you should NOT use the old {{cmdroot|echo -n 4 > /proc/acpi/sleep}} anymore.

Ideally, you would do this from a script like {{path|/etc/acpi/actions/hibernate.sh}}. It has proven to be a good idea to shutdown the following processes/drivers within the script before you do the actual suspend:
*any running mysql server
*the linuxant driver may require to be stopped as well ({{cmdroot|dldrstop}} does the trick).

Afterwards you might want to enable them again, as well as run a script that does necessary configurations according to the ac power state.
Furthermore, the system clock is not readjusted automatically, so you will probably also want the do that from that script (i.e. by restarting your systemclock bootup script).

If the sound output is silent after resume, the following commands might help to get sound to work again without reloading any modules:
amixer set Master mute >/dev/null 2>&1
amixer set PCM mute >/dev/null 2>&1
amixer set Master unmute >/dev/null 2>&1
amixer set PCM unmute >/dev/null 2>&1

==S5 vs. S4 state==
Finally you should take note that swsusp does not set the ACPI S4 state. Instead it goes to S5. This means that the machine itself doesn't know that it was suspend rather than shutdown. Hence you can i.e. boot a parallel installed other operating system and resume your linux session later, as long as you don't touch the swap partition the image was saved to.

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| swsusp works
! style="background:#efefef;"| Note
|- style="background: white;"

|- style="background: white; color:black;"
|{{X60}}
| 1706-BM7
| [Own Distro]
| 2.6.20
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.20
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.18 with [[User:Profilek | Forest Zhao's AHCI patches]]
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X60s}}
| 1702-5FG
| [[:Category:Debian|Debian Etch]]
| 2.6.19.2
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X31}}
| 2672-BCO
| [[:Category:Debian|Debian Etch]]
| 2.6.20.1
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X32}}
| 2673
| [[:Category:Debian|Debian Lenny]]
| 2.6.26
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|{{R52}}
| 18299MG
| [[:Category:Debian|Debian Sarge]]
| 2.6.17.9
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|{{T30}}
| 2366
| [[:Category:Slackware|Slackware 12 ]]
| 2.6.24.3
! style ="color:green;"| yes
|
|- style="background: white; color:black;"

|{{T43}}
| 2668-74G
| [[:Category:Fedora|Fedora Core 6]]
| 2.6.19
! style ="color:green;"| yes
|

|- style="background: white; color:black;"
|{{T43}}
| 2668-74G
| [[:Category:Gentoo|Gentoo]]
| 2.6.20.7
! style ="color:green;"| yes
|

|- style="background: white; color:black;"
|{{T60}}
| 1953-E7U
| [[:Category:Slackware|Slackware 11]]
| 2.6.20
! style="color:green;" | yes
|
|- style="background: white; color:black;"

|- style="background: white; color:black;"
|{{X40}}
| 2386-H6G
| [[:Category:Ubuntu|Ubuntu]]
| 2.6.20
! style="color:green;" | yes
|
|- style="background: white; color:black;"

Xorg RandR 1.2

2009-02-17T20:42:18Z

Intrigeri: fixed heading

== Overview ==

'''X RandR '''is used to configure which display ports are enabled (e.g. LCD, VGA and DVI), and to configure display modes and properties such as orientation, reflection and DPI.

This is the simplest and most powerful way to get multi-monitor systems working using recent versions of Linux such as {{Ubuntu 7.10}} and Fedora 8 with graphics chipsets such as the Intel 945GM/GMS and ATI Radeon found in Thinkpads.

'''xrandr''' is the command line interface to the RandR X extension. As usual with X, good documentation is hard to find; first try the following commands:

* {{cmduser|xrandr --help}}
* {{cmduser|man xrandr}}

* for Intel graphics: {{cmduser|man intel}}
* for ATI graphics: {{cmduser|man radeon}}

The rest of this page refers to a laptop with a built in 1024x768 pixel screen and an external 1600x1200 VGA monitor. Simply replace the relevant numbers with your own system specifications and all should work fine.

== Supported drivers ==
{{Ubuntu 7.10}} '''Gutsy Gibbon'''
* X.org [[intel]] driver, version ??? (included in Xorg ???) and later. Ubuntu version: [https://launchpad.net/ubuntu/+source/xserver-xorg-video-intel/2:2.1.1-0ubuntu2 2:2.1.1-0ubuntu2] with [https://launchpad.net/ubuntu/gutsy/i386/xrandr/1:1.2.2-0ubuntu1 xrandr 1:1.2.2-0ubuntu1]

* X.org [[radeon]] driver, 6.7.192 and later (in ubuntu [http://packages.ubuntu.com/gutsy/x11/xserver-xorg-video-ati gutsy] and [http://packages.ubuntu.com/hardy/x11/xserver-xorg-video-ati hardy], but they still have [http://bugs.launchpad.net/bugs/148408 very serious issues] for some Thinkpads).

== xorg.conf ==
Recent versions of xorg.conf intended for use with xrandr 1.2 considerably simplify the video section of the configuration. If you upgrading from an earlier version you may find your existing xorg.conf works against the effective deployment of xrandr. So it is best to start with a new Xorg configuration.

'''An updated Xorg.conf should:'''
* omit dual Device/Screen/Monitor sections
* omit MonitorLayout option and Screen lines from the remaining Device section
* omit dual Screen lines from the ServerLayout section
* omit RightOf/LeftOf indication to the remaining Screen line in ServerLayout section
* add a "Virtual 2048 2048" line in SubSection "Display" to create a large virtual screen

To create a new xorg.conf for Ubuntu and other Debian based distributions, connect the external display to the VGA port, turn on that display, and run
{{cmduser|sudo dpkg-reconfigure -phigh xserver-xorg}}

The resulting {{path|/etc/X11/xorg.conf}} should include something like

Section "Device"
Identifier "Intel Corporation Mobile 945GM/GMS, 943/940GML Express Integrated Graphics Controller"
Driver "intel"
BusID "PCI:0:2:0"
'''# ADD THIS IF YOUR LAPTOP DOES NOT HAVE A TV CONNECTOR or DOCKING STATION '''
'''Option "monitor-TV" "TV" '''
EndSection
Section "Monitor"
Identifier "Generic Monitor"
Option "DPMS"
EndSection
'''# ADD THIS IF YOUR LAPTOP DOES NOT HAVE A TV CONNECTOR or DOCKING STATION '''
'''Section "Monitor" '''
'''Identifier "TV" '''
'''Option "Ignore" "True" '''
EndSection '''
Section "Screen"
Identifier "Default Screen"
Device "Intel Corporation Mobile 945GM/GMS, 943/940GML Express Integrated Graphics Controller"
Monitor "Generic Monitor"
DefaultDepth 24

SubSection "Display"
Depth 24
Modes "1600x1200" "1280x1024" "1024x768" "800x600" "640x480"
'''# ADD A VIRTUAL LINE TO PROVIDE FOR THE LARGEST SCREENS YOU WILL HOTPLUG '''
'''Virtual 2048 2048 '''
EndSubSection
EndSection
Section "ServerLayout"
Identifier "Default Layout"
Screen "Default Screen"
InputDevice "Generic Keyboard"
InputDevice "Configured Mouse"
InputDevice "stylus" "SendCoreEvents"
InputDevice "cursor" "SendCoreEvents"
InputDevice "eraser" "SendCoreEvents"
InputDevice "Synaptics Touchpad"
EndSection

Just a hint:
If you want to use TV-out but not VGA for example, you should change these sections:
<pre>
Section "Device"
Identifier "Intel Corporation Mobile 945GM/GMS, 943/940GML Express Integrated Graphics Controller"
Driver "intel"
BusID "PCI:0:2:0"
Option "monitor-VGA" "VGA"
Option "monitor-TV" "TV"
Option "monitor-LVCD" "LVCD"
EndSection

Section "Monitor"
Identifier "VGA"
Option "Ignore" "true"
EndSection

Section "Monitor"
Identifier "LVCD"
Option "DPMS"
EndSection

Section "Monitor"
Identifier "TV"
Option "Ignore" "false"
EndSection
</pre>

After creating a clean {{path|xorg.conf}}, restart X and logon.

You may find you have a display only on the external VGA screen at its default max resolution; do not worry - xrandr can fix this.

== Using {{cmduser|xrandr}} ==

=== First discover what we have ===
Open a terminal window to use the command line: 'Applications:Accessories:Terminal'

{{HINT|First look at the 'help' and 'man' pages. }}

{{cmduser|xrandr --help}}
{{cmduser|man xrandr}}

To find what version of xrandr is running, type the following command:
{{cmduser| xrandr -v}}
Server reports RandR version 1.2

To query what screens are connected, type the following: (The output shown indicates nothing is connected to the VGA port.)
{{cmduser| xrandr -q }}
Screen 0: minimum 320 x 200, current 1024 x 768, maximum 1920 x 1440
VGA disconnected (normal left inverted right)
LVDS connected 1024x768+0+0 (normal left inverted right) 304mm x 228mm
1024x768 60.0*+ 50.0
800x600 60.3
640x480 60.0 59.9
TV disconnected (normal left inverted right)

If you see the 'TV disconnected' line but have neither TV connector nor docking station (eg Thinkpad R60e) then add to the Monitor and Device sections of xorg.conf as noted above. This will prevent the external (VGA) flashing off for a few seconds every time xrandr is used. (Newer versions of the intel driver may fix this.)

The same command as above, but with the VGA monitor plugged in and powered off, should give something like the following output: (The VGA monitor is now shown as 'connected'.)
{{cmduser| xrandr -q }}
Screen 0: minimum 320 x 200, current 1024 x 768, maximum 1920 x 1440
VGA connected (normal left inverted right)
1920x1440@60 60.0
1920x1440 60.0
1600x1200@60 60.0
1600x1200 60.0
1280x960 60.0
640x480@60 60.0
LVDS connected 1024x768+0+0 (normal left inverted right) 304mm x 228mm
1024x768 60.0*+ 50.0
800x600 60.3
640x480 60.0 59.9
TV disconnected (normal left inverted right)

Powering on the VGA monitor and issuing the same command again will give the following output: (The size and position of the VGA output within the virtual screen is now shown.)
{{cmduser| xrandr -q }}
Screen 0: minimum 320 x 200, current 2624 x 1200, maximum 2624 x 2048
VGA connected 1600x1200+1024+0 (normal left inverted right) 367mm x 275mm
1600x1200 60.0*+
1920x1440@60 60.0
1600x1200@60 60.0
640x480@60 60.0
640x480 60.0
LVDS connected 1024x768+0+0 (normal left inverted right) 304mm x 228mm
1024x768 60.0*+ 50.0
800x600 60.3
640x480 60.0 59.9
TV disconnected (normal left inverted right)

For bug reporting and diagnosis use xrandr with the verbose option:
{{cmduser| xrandr --verbose}}

=== Using xrandr to do useful things ===
In general the commands will specify the output name and either --off or --auto. In the examples here the external screen is named ''VGA'', as used by the Intel driver, with an ATI card the name will probably be ''VGA-0''. In general use {{cmduser| xrandr -q}} to discover the appropriate output names for your configuration. The --auto option will select the preferred resolution for each output, this is starred(*) in the {{cmduser| xrandr -q}} listing and is normally the best resolution available. It is also possible to set a particular mode eg --mode 1024x768.

First clone the two screens, (the smaller screen will display the top left portion of the virtual screen)
{{cmduser| xrandr --output LVDS --auto --output VGA --auto --same-as LVDS}}

To turn off the VGA monitor.
{{cmduser| xrandr --output VGA --off }}

To turn the VGA monitor back on, with its viewport to the right of the laptop monitor:
{{cmduser| xrandr --output VGA --auto --right-of LVDS}}
This will probably give an error message similar to:
xrandr: screen cannot be larger than 1600x1600 (desired size 2624x1200)

This can be fixed by editing xorg.conf and changing the ''virtual'' line (see example above) to something like:
Virtual 2624 1200
Note that the maximum supported size of the virtual desktop for the Intel 945GM series of chipset with 3D acceleration enabled, is 2048x2048. The virtual screen can be larger but DRI will be disabled. This may matter if you like games and compiz desktop effects, or if you want Google Earth to display in better than geological time. Obviously the larger the virtual desktop, the more graphics memory is used. So for good performance with a shared graphics system such as Intel the Virtual should be no larger than necessary.

It is possible to set screen locations as ''--left-of'', ''--right-of'', ''--above'' and ''--below''. Assuming displays sizes of 1024x768 and 1200x1600:
{{cmduser| xrandr --output LVDS --auto --output VGA --auto --right-of LVDS}}
and
{{cmduser| xrandr --output LVDS --mode 1024x768 --pos 0x0 --output VGA --mode 1600x1200 --pos 1024x0}}
are equivalent. Both will place the external monitor to the right of the laptop display within the virtual screen.

If the Virtual size is only 2048 wide the above command will fail as the combined width of the two displays exceeds the maximum virtual size. However it is possible to have overlap the display viewports. So to fit within the 2048 limit:
{{cmduser| xrandr --output VGA --mode 1024x768 --pos 0x0 --output VGA --mode 1600x1200 --pos 448x0}}

=== Now automate it on login ===
To configure xrandr automatically during the first login, save this script to your computer as /etc/X11/Xsession.d/45custom_xrandr-settings:
<bash>
# If an external monitor is connected, place it with xrandr

# External output may be "VGA" or "VGA-0" or "DVI-0" or "TMDS-1"
EXTERNAL_OUTPUT="VGA"
INTERNAL_OUTPUT="LVDS"
# EXTERNAL_LOCATION may be one of: left, right, above, or below
EXTERNAL_LOCATION="right"

case "$EXTERNAL_LOCATION" in
left|LEFT)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
right|RIGHT)
EXTERNAL_LOCATION="--right-of $INTERNAL_OUTPUT"
;;
top|TOP|above|ABOVE)
EXTERNAL_LOCATION="--above $INTERNAL_OUTPUT"
;;
bottom|BOTTOM|below|BELOW)
EXTERNAL_LOCATION="--below $INTERNAL_OUTPUT"
;;
*)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
esac

xrandr |grep $EXTERNAL_OUTPUT | grep " connected "
if [ $? -eq 0 ]; then
xrandr --output $INTERNAL_OUTPUT --auto --output $EXTERNAL_OUTPUT --auto $EXTERNAL_LOCATION
else
xrandr --output $INTERNAL_OUTPUT --auto --output $EXTERNAL_OUTPUT --off
fi
</bash>

When X starts, it will be mirrored across both screens until someone logs in. At that point this script will execute and xrandr will position the external monitor.

=== [[Sample Fn-F7 script]] ===
For further examples of the use of xrandr commands, and scripts to switch the display using the Function key Fn-F7 see [[Sample Fn-F7 script]].

=== GUIs ===

Several graphical frontends are available for xrandr (all using GTK):

* [http://gitweb.freedesktop.org/?p=xorg/app/grandr.git Grandr]
* [http://www.albertomilone.com/urandr.html URandR]
* [http://christian.amsuess.com/tools/arandr/ ARandR]
* [http://sourceforge.net/projects/zarfy/ Zarfy] — A GUI to libxrandr. It presents the user with visual representaion of active displays on an interactive map of the screen memory. Features free postioning, configuration saving, scripting for R&R and an alternate gui for switching between monitors.

It is possible to have Fn-F7 run such a GUI, see [[Sample Fn-F7 script#Having Fn-F7 run a RandR GUI]].

== Summing up ==

'''xrandr''' enables dynamic resizing of screens, switching both external and laptop screens on and off, and the applications windows can be dragged from one screen to the other. None of this requires configuring anything special for {{path|/etc/X11/xorg.conf}}.

=== the Virtual screen ===
A Virtual line is needed in the 'Display' SubSection of the of xorg.conf; it determines the size of the frame buffer into which the displays must fit. Without it the maximum virtual size will be limited to the size of the largest display that was connected when X was started. The maximum virtual size cannot be changed once X starts so needs to be large enough to accommodate the largest combination of displays you want to hotplug without having to restart X. If it is greater than 2048x2048 and you are using an Intel 945 (or less) chip then DRI is not possible. Making the Virtual size square makes rotation easy. A bigger Virtual requires more memory.

[[Image:Intel-DualHead.png|monitor windows must fit within the virtual screen]]

=== Output port names ===

'''Intel driver'''
* '''VGA''' - Analog VGA output
* '''LVDS''' - Laptop panel
* '''TV''' - Integrated TV output
* '''TMDS-1''' - First DVI SDVO output
* '''TMDS-2''' - Second DVI SDVO output
The '''SDVO''' and '''DVO TV''' outputs are not supported by the driver at this time.

'''[[radeon]] driver '''
* '''VGA-0''' - Analog VGA output
* '''LVDS''' - Laptop panel
* '''S-video''' - Integrated TV output
* '''DVI-0''' - DVI output

=== Note for Gnome users ===
Gnome places the menu bar on screen 0 and thus with the Intel chip and driver Screen 0 (the external VGA monitor) will always be the default display if it is connected. This applies even if the external monitor is switched off but the cable connected: if you have a blank laptop monitor check if you have anything plugged in to the VGA port. Also beware that desktop icons and windows can disappear into the invisible parts of the virtual display. (see diagram below). If you want the panel(s) to appear by default on a different head, drag it to the head you want it on and GNOME will keep it there.

=== Note for Ubuntu Gutsy users ===
There is a Graphical Configuration Tool, ([https://launchpad.net/ubuntu/+source/displayconfig-gtk/0.2+20070731ubuntu1 displayconfig-gtk]) included with {{Ubuntu 7.10}}. At present [https://bugs.launchpad.net/ubuntu/+source/displayconfig-gtk it dosn't work too well]. It is found in the menu: 'System: Administration: Screens and Graphics'. As using it will wreck your xorg.conf, I recommend removing it.

== Gleanings ==
=== Notes from xserver-xorg-video-intel.readme ===
'''Known Limitations'''
- No support for "zaphod mode" dualhead. This is the mode in which two
Device sections are placed in the config file, and doesn't support DRI or
many other features. Instead, only "MergedFB-style" dualhead is supported.
- No support for X Screens larger than 2048 pixels in either direction
before the 965. This reflects hardware limitations in the x direction on
those older chips, and limits dualhead functionality. It may be possible to
extend the limit vertically on these older chips.
- i855 XV may cause hangs. This was present in the previous release, and no
workaround is known.
- SDVO TV-out cards not supported. This should be fixed in the next
release.
- Gray output with integrated TV-out and PAL TVs.
- EXA support unstable on i845.
- Some GM965 systems, such as the Thinkpad T61, probe the TV as being connected
even when no output connector is available.

'''Common issues not caused by the driver'''
- Font sizes (DPI) are wrong. Some displays incorrectly report their
physical size, which is harmless on most OSes that always assume 96dpi
displays. This can be fixed through quirks for specific monitors in the X
Server, and the output of xrandr --prop along with a physical measurement of
the screen size in a bug report against the server can help get that fixed.
- gnome-panel is located in the middle of the screen. gnome-panel places
itself within head #0's boundaries, which doesn't work well with a second
head covering the same area as head #0 but larger.
- Older resolution-changing applications have poor results in
multihead systems. Previous extensions such as RandR 1.1 exposed only a
single output to client programs, and those requests map poorly to multi-head
systems. Currently, those requests map to just one of the outputs in the
RandR 1.2 environment, and those applications need to be updated to RandR 1.2
API when available for better results.

=== Xorg mailing list ===
[http://lists.freedesktop.org/archives/xorg/2007-June/025469.html FreeDesktop.org 2007-June 025469]
[http://lists.freedesktop.org/archives/xorg/2007-June/025484.html FreeDesktop.org 2007-June 025484]
[http://lists.freedesktop.org/archives/xorg/2007-July/026340.html FreeDesktop.org 2007-July 026340]

the 3D engine has an 11 bit coordinate space at one point making it
impossible to draw to areas beyond 2048x2048. At another point, it has a
stride limit of 8192 bytes, so you can't even draw to a subset of a
larger frame buffer.

One more bit in both of these registers would have solved the problem
for pretty much any supportable monitor configuration (the chip can only
support two single-channel DVI outputs at the most; 1920 is the widest
size supported at single-channel speeds).

For multiple monitors, the driver could allocate multiple frame buffers
and step through them one at a time with appropriate clipping. It would
be icky, but could be made to work.

Of course, the latest hardware (965G/965GM) has plenty of coordinate
space, which does tend to reduce the odds that someone will get excited
enough to go fix the driver for older chips.

The Gnome menu bar lands on Xinerama Screen 0 at this
point, which isn't currently something that you can set through RandR. On Intel the allocation to Screen 0 is determined by CRTC order and LVDS only runs on screen 1.

[http://lists.freedesktop.org/archives/xorg/2007-June/026053.html FreeDesktop.org 2007-June 026053]

[http://lists.freedesktop.org/archives/xorg/2007-August/027616.html Blanking of external screen when using xrandr]

It's checking to see if you have anything connected to the TV output.
To do that, it needs to temporarily unplug the VGA.
You can avoid this by ignoring the TV output
Section "Monitor"
Identifier "TV"
Option "Ignore" "True"
EndSection
Section "Device"
Option "monitor-TV" "TV"
EndSection
If your machine cannot ever have a TV adapter (even with a docking station),
we can add a quirk to the driver to never look at the TV output. That requires
the pci subsystem values (from lspci -n -v) to plug into the quirk table.

[http://lists.freedesktop.org/archives/xorg/2007-August/027632.html default for 'Virtual']
> Version 2.1.1-0ubuntu2 seems to set the default Virtual size (maximum
> screen size) to 1920 x 1920, if there is no entry in xorg.conf. I take
> it the maximum screen size for the i915 chipset family is 2048 x 2048,
> so why not have it at that? This would make dualscreen setups a bit easier.
The default settings is found by taking the largest resolution in either
x or y dimension and making a square from that. This allows for easy
rotation should you want to do so.
I believe you should be able to do dual screen up to 8192x8192, though
only through two monitors (Only two pipes are available for output), but
that 3D acceleration is only supported up to 2048x2048. Thus as soon as
you set your virtual size above 2048x2048, you lose 3D acceleration.
The current driver cannot reallocate the frame buffer, so whatever size
you start with is the maximum the screen can ever become, and that this
amount of physical memory is tied down for the whole X server run.

[http://lists.freedesktop.org/archives/xorg/2007-August/027670.html Primary output for Laptop + external screen]
>the desired behavior of the video
> drivers in typical laptop situations with an internal display and an
> external screen attached (extending the desktop).
>
> Currently for example the intel driver uses the external screen as the
> primary output. It is listed first with xrandr. I'm not sure if this is
> intentional or just coincidence.
It's coincidence -- the laptop hardware has two crtcs, and the LVDS can
only be driven by the second.
Note that RandR doesn't really want the order to be significant; it
would be better if the desktop environment knew about outputs and could
refer to a specific output as 'primary' or 'holds toolbar' or whatever.

[mailto:gekkoman@illimitable.com  ] Uncovered a workaround for black and white TV-out "known limitation" listed above on a intel 945GM chipset running i810-2.1.1 driver and xrandr-1.2.2. Get TV running in black and white. Then run command.

xrandr --output TV --set TV_FORMAT PAL; xrandr --output TV --mode 1024x768

substitute TV_FORMAT and mode as required. Note that the command "xrandr --output TV --set TV_FORMAT PAL" gives an error but appears to work as the subsequent mode change converts screen to colour.

=== Notes for X31, X32, T30 / Radeon 7000, Radeon 7500 users ===
{{X31}} and {{X32}} have an [[ATI Mobility Radeon 7000]] with only 16MB RAM. This is not enough for big screens and DRI. Neither with [[radeon]]-default virtual size of 2048x1200, nor with a customized virtual of 2304x1024 (for one 1024x768 and one 1280x1024 screen). But this only applies for 24-bit color depth. Using only 16-bit and DRI works fine with the big virtual screen.

If you really want 24-bit depth, and do not need a bigger screen as your LCD, try setting Virtual to "1024 768", this will enable DRI in 24-bit too, but you won't be able to extend your screen anymore (well, clone will still work though).

==== Further Note ====
My {{T30}} (Radeon 7500) with the Xorg radeonhd driver version 1.2.1-1 (from Debian unstable) reports the following:<code><pre>
(II) RADEON(0): Detected total video RAM=16384K, accessible=65536K (PCI BAR=131072K)
(--) RADEON(0): Mapped VideoRAM: 16384 kByte (64 bit DDR SDRAM)
(II) RADEON(0): Color tiling enabled by default
(WW) RADEON(0): Requested desktop size exceeds surface limts for tiling, ColorTiling disabled
(II) RADEON(0): Max desktop size set to 2304x1024
</pre></code>
I don't understand exactly what this means, but it '''does''' support the entire large desktop at 24 bit depth, even though the card reports only 16k "total video RAM".

== References ==

* XRandR 1.2
** [http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git;f=randrproto.txt;a=blob RandR 1.2 protocol specifications] - this defines the model and terminology
** [http://wiki.x.org/wiki/XDC2007Notes#head-11895d48723a8d0308571bec8829b7cc3ef87d7b In Xorg Developer Conference 2007]
** [http://burtonini.com/blog/computers/randr-2007-02-06-17-50 tutorial blog post]

* Ubuntu
** Version 7.10 (Gutsy) of Ubuntu includes support for Xorg 7.3 with RandR 1.2 [https://wiki.ubuntu.com/Xorg7.3Integration Xorg 7.3]
** [[Installing Ubuntu on a ThinkPad R60e]] for a revised and more specific version of this page
** [https://launchpad.net/ubuntu/+source/xserver-xorg-video-intel/ Ubuntu source for Intel]
** [https://bugs.launchpad.net/xserver-xorg-driver-ati/+bug/148408 gutsy version of xserver-xorg-ati has some major problems on ATI Radeon] for ([[:Category:X Series]]) and possibly others. The solution is to downgrade to the [https://launchpad.net/ubuntu/feisty/i386/xserver-xorg-video-ati/1:6.6.3-2ubuntu6 feisty version]

* X.org
** [http://lists.freedesktop.org/mailman/listinfo/xorg FreeDesktop.org mailing list]
** [http://lists.freedesktop.org/archives/xorg/ FreeDesktop.org Xorg archive]

* Useful page to supplement the minimal documentation [http://wiki.x.org/wiki/Development/Documentation/HowVideoCardsWork How video cards work]
* [http://wiki.debian.org/XStrikeForce/ReleaseNotes xserver-xorg-core and xserver-xorg-video-intel might cause some trouble but also brings nice features.]
* [http://andrew.mcmillan.net.nz/taxonomy/term/18 Seamless Monitor Hotplugging with X Windows]
* [http://www.intellinuxgraphics.org/ Linux Graphics Drivers from Intel]
* [http://zdzichubg.jogger.pl/2007/05/07/xrandr-1-2-sweetness/ blog post] with xrandr-1.2 commands and photos. Narrative is in polish.

Xorg RandR 1.2

2009-02-17T20:40:33Z

Intrigeri: de-personalized a bit, added X32 info, added link to Fn-F7 => RandR GUI

== Overview ==

'''X RandR '''is used to configure which display ports are enabled (e.g. LCD, VGA and DVI), and to configure display modes and properties such as orientation, reflection and DPI.

This is the simplest and most powerful way to get multi-monitor systems working using recent versions of Linux such as {{Ubuntu 7.10}} and Fedora 8 with graphics chipsets such as the Intel 945GM/GMS and ATI Radeon found in Thinkpads.

'''xrandr''' is the command line interface to the RandR X extension. As usual with X, good documentation is hard to find; first try the following commands:

* {{cmduser|xrandr --help}}
* {{cmduser|man xrandr}}

* for Intel graphics: {{cmduser|man intel}}
* for ATI graphics: {{cmduser|man radeon}}

The rest of this page refers to a laptop with a built in 1024x768 pixel screen and an external 1600x1200 VGA monitor. Simply replace the relevant numbers with your own system specifications and all should work fine.

== Supported drivers ==
{{Ubuntu 7.10}} '''Gutsy Gibbon'''
* X.org [[intel]] driver, version ??? (included in Xorg ???) and later. Ubuntu version: [https://launchpad.net/ubuntu/+source/xserver-xorg-video-intel/2:2.1.1-0ubuntu2 2:2.1.1-0ubuntu2] with [https://launchpad.net/ubuntu/gutsy/i386/xrandr/1:1.2.2-0ubuntu1 xrandr 1:1.2.2-0ubuntu1]

* X.org [[radeon]] driver, 6.7.192 and later (in ubuntu [http://packages.ubuntu.com/gutsy/x11/xserver-xorg-video-ati gutsy] and [http://packages.ubuntu.com/hardy/x11/xserver-xorg-video-ati hardy], but they still have [http://bugs.launchpad.net/bugs/148408 very serious issues] for some Thinkpads).

== xorg.conf ==
Recent versions of xorg.conf intended for use with xrandr 1.2 considerably simplify the video section of the configuration. If you upgrading from an earlier version you may find your existing xorg.conf works against the effective deployment of xrandr. So it is best to start with a new Xorg configuration.

'''An updated Xorg.conf should:'''
* omit dual Device/Screen/Monitor sections
* omit MonitorLayout option and Screen lines from the remaining Device section
* omit dual Screen lines from the ServerLayout section
* omit RightOf/LeftOf indication to the remaining Screen line in ServerLayout section
* add a "Virtual 2048 2048" line in SubSection "Display" to create a large virtual screen

To create a new xorg.conf for Ubuntu and other Debian based distributions, connect the external display to the VGA port, turn on that display, and run
{{cmduser|sudo dpkg-reconfigure -phigh xserver-xorg}}

The resulting {{path|/etc/X11/xorg.conf}} should include something like

Section "Device"
Identifier "Intel Corporation Mobile 945GM/GMS, 943/940GML Express Integrated Graphics Controller"
Driver "intel"
BusID "PCI:0:2:0"
'''# ADD THIS IF YOUR LAPTOP DOES NOT HAVE A TV CONNECTOR or DOCKING STATION '''
'''Option "monitor-TV" "TV" '''
EndSection
Section "Monitor"
Identifier "Generic Monitor"
Option "DPMS"
EndSection
'''# ADD THIS IF YOUR LAPTOP DOES NOT HAVE A TV CONNECTOR or DOCKING STATION '''
'''Section "Monitor" '''
'''Identifier "TV" '''
'''Option "Ignore" "True" '''
EndSection '''
Section "Screen"
Identifier "Default Screen"
Device "Intel Corporation Mobile 945GM/GMS, 943/940GML Express Integrated Graphics Controller"
Monitor "Generic Monitor"
DefaultDepth 24

SubSection "Display"
Depth 24
Modes "1600x1200" "1280x1024" "1024x768" "800x600" "640x480"
'''# ADD A VIRTUAL LINE TO PROVIDE FOR THE LARGEST SCREENS YOU WILL HOTPLUG '''
'''Virtual 2048 2048 '''
EndSubSection
EndSection
Section "ServerLayout"
Identifier "Default Layout"
Screen "Default Screen"
InputDevice "Generic Keyboard"
InputDevice "Configured Mouse"
InputDevice "stylus" "SendCoreEvents"
InputDevice "cursor" "SendCoreEvents"
InputDevice "eraser" "SendCoreEvents"
InputDevice "Synaptics Touchpad"
EndSection

Just a hint:
If you want to use TV-out but not VGA for example, you should change these sections:
<pre>
Section "Device"
Identifier "Intel Corporation Mobile 945GM/GMS, 943/940GML Express Integrated Graphics Controller"
Driver "intel"
BusID "PCI:0:2:0"
Option "monitor-VGA" "VGA"
Option "monitor-TV" "TV"
Option "monitor-LVCD" "LVCD"
EndSection

Section "Monitor"
Identifier "VGA"
Option "Ignore" "true"
EndSection

Section "Monitor"
Identifier "LVCD"
Option "DPMS"
EndSection

Section "Monitor"
Identifier "TV"
Option "Ignore" "false"
EndSection
</pre>

After creating a clean {{path|xorg.conf}}, restart X and logon.

You may find you have a display only on the external VGA screen at its default max resolution; do not worry - xrandr can fix this.

== Using {{cmduser|xrandr}} ==

=== First discover what we have ===
Open a terminal window to use the command line: 'Applications:Accessories:Terminal'

{{HINT|First look at the 'help' and 'man' pages. }}

{{cmduser|xrandr --help}}
{{cmduser|man xrandr}}

To find what version of xrandr is running, type the following command:
{{cmduser| xrandr -v}}
Server reports RandR version 1.2

To query what screens are connected, type the following: (The output shown indicates nothing is connected to the VGA port.)
{{cmduser| xrandr -q }}
Screen 0: minimum 320 x 200, current 1024 x 768, maximum 1920 x 1440
VGA disconnected (normal left inverted right)
LVDS connected 1024x768+0+0 (normal left inverted right) 304mm x 228mm
1024x768 60.0*+ 50.0
800x600 60.3
640x480 60.0 59.9
TV disconnected (normal left inverted right)

If you see the 'TV disconnected' line but have neither TV connector nor docking station (eg Thinkpad R60e) then add to the Monitor and Device sections of xorg.conf as noted above. This will prevent the external (VGA) flashing off for a few seconds every time xrandr is used. (Newer versions of the intel driver may fix this.)

The same command as above, but with the VGA monitor plugged in and powered off, should give something like the following output: (The VGA monitor is now shown as 'connected'.)
{{cmduser| xrandr -q }}
Screen 0: minimum 320 x 200, current 1024 x 768, maximum 1920 x 1440
VGA connected (normal left inverted right)
1920x1440@60 60.0
1920x1440 60.0
1600x1200@60 60.0
1600x1200 60.0
1280x960 60.0
640x480@60 60.0
LVDS connected 1024x768+0+0 (normal left inverted right) 304mm x 228mm
1024x768 60.0*+ 50.0
800x600 60.3
640x480 60.0 59.9
TV disconnected (normal left inverted right)

Powering on the VGA monitor and issuing the same command again will give the following output: (The size and position of the VGA output within the virtual screen is now shown.)
{{cmduser| xrandr -q }}
Screen 0: minimum 320 x 200, current 2624 x 1200, maximum 2624 x 2048
VGA connected 1600x1200+1024+0 (normal left inverted right) 367mm x 275mm
1600x1200 60.0*+
1920x1440@60 60.0
1600x1200@60 60.0
640x480@60 60.0
640x480 60.0
LVDS connected 1024x768+0+0 (normal left inverted right) 304mm x 228mm
1024x768 60.0*+ 50.0
800x600 60.3
640x480 60.0 59.9
TV disconnected (normal left inverted right)

For bug reporting and diagnosis use xrandr with the verbose option:
{{cmduser| xrandr --verbose}}

=== Using xrandr to do useful things ===
In general the commands will specify the output name and either --off or --auto. In the examples here the external screen is named ''VGA'', as used by the Intel driver, with an ATI card the name will probably be ''VGA-0''. In general use {{cmduser| xrandr -q}} to discover the appropriate output names for your configuration. The --auto option will select the preferred resolution for each output, this is starred(*) in the {{cmduser| xrandr -q}} listing and is normally the best resolution available. It is also possible to set a particular mode eg --mode 1024x768.

First clone the two screens, (the smaller screen will display the top left portion of the virtual screen)
{{cmduser| xrandr --output LVDS --auto --output VGA --auto --same-as LVDS}}

To turn off the VGA monitor.
{{cmduser| xrandr --output VGA --off }}

To turn the VGA monitor back on, with its viewport to the right of the laptop monitor:
{{cmduser| xrandr --output VGA --auto --right-of LVDS}}
This will probably give an error message similar to:
xrandr: screen cannot be larger than 1600x1600 (desired size 2624x1200)

This can be fixed by editing xorg.conf and changing the ''virtual'' line (see example above) to something like:
Virtual 2624 1200
Note that the maximum supported size of the virtual desktop for the Intel 945GM series of chipset with 3D acceleration enabled, is 2048x2048. The virtual screen can be larger but DRI will be disabled. This may matter if you like games and compiz desktop effects, or if you want Google Earth to display in better than geological time. Obviously the larger the virtual desktop, the more graphics memory is used. So for good performance with a shared graphics system such as Intel the Virtual should be no larger than necessary.

It is possible to set screen locations as ''--left-of'', ''--right-of'', ''--above'' and ''--below''. Assuming displays sizes of 1024x768 and 1200x1600:
{{cmduser| xrandr --output LVDS --auto --output VGA --auto --right-of LVDS}}
and
{{cmduser| xrandr --output LVDS --mode 1024x768 --pos 0x0 --output VGA --mode 1600x1200 --pos 1024x0}}
are equivalent. Both will place the external monitor to the right of the laptop display within the virtual screen.

If the Virtual size is only 2048 wide the above command will fail as the combined width of the two displays exceeds the maximum virtual size. However it is possible to have overlap the display viewports. So to fit within the 2048 limit:
{{cmduser| xrandr --output VGA --mode 1024x768 --pos 0x0 --output VGA --mode 1600x1200 --pos 448x0}}

=== Now automate it on login ===
To configure xrandr automatically during the first login, save this script to your computer as /etc/X11/Xsession.d/45custom_xrandr-settings:
<bash>
# If an external monitor is connected, place it with xrandr

# External output may be "VGA" or "VGA-0" or "DVI-0" or "TMDS-1"
EXTERNAL_OUTPUT="VGA"
INTERNAL_OUTPUT="LVDS"
# EXTERNAL_LOCATION may be one of: left, right, above, or below
EXTERNAL_LOCATION="right"

case "$EXTERNAL_LOCATION" in
left|LEFT)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
right|RIGHT)
EXTERNAL_LOCATION="--right-of $INTERNAL_OUTPUT"
;;
top|TOP|above|ABOVE)
EXTERNAL_LOCATION="--above $INTERNAL_OUTPUT"
;;
bottom|BOTTOM|below|BELOW)
EXTERNAL_LOCATION="--below $INTERNAL_OUTPUT"
;;
*)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
esac

xrandr |grep $EXTERNAL_OUTPUT | grep " connected "
if [ $? -eq 0 ]; then
xrandr --output $INTERNAL_OUTPUT --auto --output $EXTERNAL_OUTPUT --auto $EXTERNAL_LOCATION
else
xrandr --output $INTERNAL_OUTPUT --auto --output $EXTERNAL_OUTPUT --off
fi
</bash>

When X starts, it will be mirrored across both screens until someone logs in. At that point this script will execute and xrandr will position the external monitor.

=== [[Sample Fn-F7 script]] ===
For further examples of the use of xrandr commands, and scripts to switch the display using the Function key Fn-F7 see [[Sample Fn-F7 script]].

=== GUIs ===

Several graphical frontends are available for xrandr (all using GTK):

* [http://gitweb.freedesktop.org/?p=xorg/app/grandr.git Grandr]
* [http://www.albertomilone.com/urandr.html URandR]
* [http://christian.amsuess.com/tools/arandr/ ARandR]
* [http://sourceforge.net/projects/zarfy/ Zarfy] — A GUI to libxrandr. It presents the user with visual representaion of active displays on an interactive map of the screen memory. Features free postioning, configuration saving, scripting for R&R and an alternate gui for switching between monitors.

It is possible to have Fn-F7 run such a GUI, see [[Sample Fn-F7 script#Having Fn-F7 run a RandR GUI]].

== Summing up ==

'''xrandr''' enables dynamic resizing of screens, switching both external and laptop screens on and off, and the applications windows can be dragged from one screen to the other. None of this requires configuring anything special for {{path|/etc/X11/xorg.conf}}.

=== the Virtual screen ===
A Virtual line is needed in the 'Display' SubSection of the of xorg.conf; it determines the size of the frame buffer into which the displays must fit. Without it the maximum virtual size will be limited to the size of the largest display that was connected when X was started. The maximum virtual size cannot be changed once X starts so needs to be large enough to accommodate the largest combination of displays you want to hotplug without having to restart X. If it is greater than 2048x2048 and you are using an Intel 945 (or less) chip then DRI is not possible. Making the Virtual size square makes rotation easy. A bigger Virtual requires more memory.

[[Image:Intel-DualHead.png|monitor windows must fit within the virtual screen]]

=== Output port names ===

'''Intel driver'''
* '''VGA''' - Analog VGA output
* '''LVDS''' - Laptop panel
* '''TV''' - Integrated TV output
* '''TMDS-1''' - First DVI SDVO output
* '''TMDS-2''' - Second DVI SDVO output
The '''SDVO''' and '''DVO TV''' outputs are not supported by the driver at this time.

'''[[radeon]] driver '''
* '''VGA-0''' - Analog VGA output
* '''LVDS''' - Laptop panel
* '''S-video''' - Integrated TV output
* '''DVI-0''' - DVI output

=== Note for Gnome users ===
Gnome places the menu bar on screen 0 and thus with the Intel chip and driver Screen 0 (the external VGA monitor) will always be the default display if it is connected. This applies even if the external monitor is switched off but the cable connected: if you have a blank laptop monitor check if you have anything plugged in to the VGA port. Also beware that desktop icons and windows can disappear into the invisible parts of the virtual display. (see diagram below). If you want the panel(s) to appear by default on a different head, drag it to the head you want it on and GNOME will keep it there.

=== Note for Ubuntu Gutsy users ===
There is a Graphical Configuration Tool, ([https://launchpad.net/ubuntu/+source/displayconfig-gtk/0.2+20070731ubuntu1 displayconfig-gtk]) included with {{Ubuntu 7.10}}. At present [https://bugs.launchpad.net/ubuntu/+source/displayconfig-gtk it dosn't work too well]. It is found in the menu: 'System: Administration: Screens and Graphics'. As using it will wreck your xorg.conf, I recommend removing it.

== Gleanings ==
=== Notes from xserver-xorg-video-intel.readme ===
'''Known Limitations'''
- No support for "zaphod mode" dualhead. This is the mode in which two
Device sections are placed in the config file, and doesn't support DRI or
many other features. Instead, only "MergedFB-style" dualhead is supported.
- No support for X Screens larger than 2048 pixels in either direction
before the 965. This reflects hardware limitations in the x direction on
those older chips, and limits dualhead functionality. It may be possible to
extend the limit vertically on these older chips.
- i855 XV may cause hangs. This was present in the previous release, and no
workaround is known.
- SDVO TV-out cards not supported. This should be fixed in the next
release.
- Gray output with integrated TV-out and PAL TVs.
- EXA support unstable on i845.
- Some GM965 systems, such as the Thinkpad T61, probe the TV as being connected
even when no output connector is available.

'''Common issues not caused by the driver'''
- Font sizes (DPI) are wrong. Some displays incorrectly report their
physical size, which is harmless on most OSes that always assume 96dpi
displays. This can be fixed through quirks for specific monitors in the X
Server, and the output of xrandr --prop along with a physical measurement of
the screen size in a bug report against the server can help get that fixed.
- gnome-panel is located in the middle of the screen. gnome-panel places
itself within head #0's boundaries, which doesn't work well with a second
head covering the same area as head #0 but larger.
- Older resolution-changing applications have poor results in
multihead systems. Previous extensions such as RandR 1.1 exposed only a
single output to client programs, and those requests map poorly to multi-head
systems. Currently, those requests map to just one of the outputs in the
RandR 1.2 environment, and those applications need to be updated to RandR 1.2
API when available for better results.

=== Xorg mailing list ===
[http://lists.freedesktop.org/archives/xorg/2007-June/025469.html FreeDesktop.org 2007-June 025469]
[http://lists.freedesktop.org/archives/xorg/2007-June/025484.html FreeDesktop.org 2007-June 025484]
[http://lists.freedesktop.org/archives/xorg/2007-July/026340.html FreeDesktop.org 2007-July 026340]

the 3D engine has an 11 bit coordinate space at one point making it
impossible to draw to areas beyond 2048x2048. At another point, it has a
stride limit of 8192 bytes, so you can't even draw to a subset of a
larger frame buffer.

One more bit in both of these registers would have solved the problem
for pretty much any supportable monitor configuration (the chip can only
support two single-channel DVI outputs at the most; 1920 is the widest
size supported at single-channel speeds).

For multiple monitors, the driver could allocate multiple frame buffers
and step through them one at a time with appropriate clipping. It would
be icky, but could be made to work.

Of course, the latest hardware (965G/965GM) has plenty of coordinate
space, which does tend to reduce the odds that someone will get excited
enough to go fix the driver for older chips.

The Gnome menu bar lands on Xinerama Screen 0 at this
point, which isn't currently something that you can set through RandR. On Intel the allocation to Screen 0 is determined by CRTC order and LVDS only runs on screen 1.

[http://lists.freedesktop.org/archives/xorg/2007-June/026053.html FreeDesktop.org 2007-June 026053]

[http://lists.freedesktop.org/archives/xorg/2007-August/027616.html Blanking of external screen when using xrandr]

It's checking to see if you have anything connected to the TV output.
To do that, it needs to temporarily unplug the VGA.
You can avoid this by ignoring the TV output
Section "Monitor"
Identifier "TV"
Option "Ignore" "True"
EndSection
Section "Device"
Option "monitor-TV" "TV"
EndSection
If your machine cannot ever have a TV adapter (even with a docking station),
we can add a quirk to the driver to never look at the TV output. That requires
the pci subsystem values (from lspci -n -v) to plug into the quirk table.

[http://lists.freedesktop.org/archives/xorg/2007-August/027632.html default for 'Virtual']
> Version 2.1.1-0ubuntu2 seems to set the default Virtual size (maximum
> screen size) to 1920 x 1920, if there is no entry in xorg.conf. I take
> it the maximum screen size for the i915 chipset family is 2048 x 2048,
> so why not have it at that? This would make dualscreen setups a bit easier.
The default settings is found by taking the largest resolution in either
x or y dimension and making a square from that. This allows for easy
rotation should you want to do so.
I believe you should be able to do dual screen up to 8192x8192, though
only through two monitors (Only two pipes are available for output), but
that 3D acceleration is only supported up to 2048x2048. Thus as soon as
you set your virtual size above 2048x2048, you lose 3D acceleration.
The current driver cannot reallocate the frame buffer, so whatever size
you start with is the maximum the screen can ever become, and that this
amount of physical memory is tied down for the whole X server run.

[http://lists.freedesktop.org/archives/xorg/2007-August/027670.html Primary output for Laptop + external screen]
>the desired behavior of the video
> drivers in typical laptop situations with an internal display and an
> external screen attached (extending the desktop).
>
> Currently for example the intel driver uses the external screen as the
> primary output. It is listed first with xrandr. I'm not sure if this is
> intentional or just coincidence.
It's coincidence -- the laptop hardware has two crtcs, and the LVDS can
only be driven by the second.
Note that RandR doesn't really want the order to be significant; it
would be better if the desktop environment knew about outputs and could
refer to a specific output as 'primary' or 'holds toolbar' or whatever.

[mailto:gekkoman@illimitable.com  ] Uncovered a workaround for black and white TV-out "known limitation" listed above on a intel 945GM chipset running i810-2.1.1 driver and xrandr-1.2.2. Get TV running in black and white. Then run command.

xrandr --output TV --set TV_FORMAT PAL; xrandr --output TV --mode 1024x768

substitute TV_FORMAT and mode as required. Note that the command "xrandr --output TV --set TV_FORMAT PAL" gives an error but appears to work as the subsequent mode change converts screen to colour.

=== Notes for X31,T30 / Radeon 7000,Radeon 7500 users ===
{{X31}} and {{X32}} have an [[ATI Mobility Radeon 7000]] with only 16MB RAM. This is not enough for big screens and DRI. Neither with [[radeon]]-default virtual size of 2048x1200, nor with a customized virtual of 2304x1024 (for one 1024x768 and one 1280x1024 screen). But this only applies for 24-bit color depth. Using only 16-bit and DRI works fine with the big virtual screen.

If you really want 24-bit depth, and do not need a bigger screen as your LCD, try setting Virtual to "1024 768", this will enable DRI in 24-bit too, but you won't be able to extend your screen anymore (well, clone will still work though).

==== Further Note ====
My {{T30}} (Radeon 7500) with the Xorg radeonhd driver version 1.2.1-1 (from Debian unstable) reports the following:<code><pre>
(II) RADEON(0): Detected total video RAM=16384K, accessible=65536K (PCI BAR=131072K)
(--) RADEON(0): Mapped VideoRAM: 16384 kByte (64 bit DDR SDRAM)
(II) RADEON(0): Color tiling enabled by default
(WW) RADEON(0): Requested desktop size exceeds surface limts for tiling, ColorTiling disabled
(II) RADEON(0): Max desktop size set to 2304x1024
</pre></code>
I don't understand exactly what this means, but it '''does''' support the entire large desktop at 24 bit depth, even though the card reports only 16k "total video RAM".

== References ==

* XRandR 1.2
** [http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git;f=randrproto.txt;a=blob RandR 1.2 protocol specifications] - this defines the model and terminology
** [http://wiki.x.org/wiki/XDC2007Notes#head-11895d48723a8d0308571bec8829b7cc3ef87d7b In Xorg Developer Conference 2007]
** [http://burtonini.com/blog/computers/randr-2007-02-06-17-50 tutorial blog post]

* Ubuntu
** Version 7.10 (Gutsy) of Ubuntu includes support for Xorg 7.3 with RandR 1.2 [https://wiki.ubuntu.com/Xorg7.3Integration Xorg 7.3]
** [[Installing Ubuntu on a ThinkPad R60e]] for a revised and more specific version of this page
** [https://launchpad.net/ubuntu/+source/xserver-xorg-video-intel/ Ubuntu source for Intel]
** [https://bugs.launchpad.net/xserver-xorg-driver-ati/+bug/148408 gutsy version of xserver-xorg-ati has some major problems on ATI Radeon] for ([[:Category:X Series]]) and possibly others. The solution is to downgrade to the [https://launchpad.net/ubuntu/feisty/i386/xserver-xorg-video-ati/1:6.6.3-2ubuntu6 feisty version]

* X.org
** [http://lists.freedesktop.org/mailman/listinfo/xorg FreeDesktop.org mailing list]
** [http://lists.freedesktop.org/archives/xorg/ FreeDesktop.org Xorg archive]

* Useful page to supplement the minimal documentation [http://wiki.x.org/wiki/Development/Documentation/HowVideoCardsWork How video cards work]
* [http://wiki.debian.org/XStrikeForce/ReleaseNotes xserver-xorg-core and xserver-xorg-video-intel might cause some trouble but also brings nice features.]
* [http://andrew.mcmillan.net.nz/taxonomy/term/18 Seamless Monitor Hotplugging with X Windows]
* [http://www.intellinuxgraphics.org/ Linux Graphics Drivers from Intel]
* [http://zdzichubg.jogger.pl/2007/05/07/xrandr-1-2-sweetness/ blog post] with xrandr-1.2 commands and photos. Narrative is in polish.

Sample Fn-F7 script

2009-02-17T20:32:29Z

Intrigeri: how to run a RandR GUI using Fn-F7

This guide will help you configure Fn-F7 key combination to toggle between internal, mirror, external, or both screens. This was tested on ThinkPad X60s running Fedora 8, please comment if it works or does not work for you.

Works like a charm on X61s with Xubuntu 7.10.
Working with R60e with some modifications noted below.

The script does not work when using [[fglrx]] or a version of XRandR < 1.2, because there is no dynamic display switching support then. When fglrx is used, aticonfig can be used for the switching in this [[Script for Dynamic Display Management with fglrx]].

==configuring the virtual screen size==
Add a "Virtual" statement to your /etc/X11/xorg.conf, the total resolution should be large enough to fit all your screens in the configuration you want, for example if you have 1600x1200 monitor to the left of your internal 1024x768 monitor, your total max resolution is 2624x1200 (See [[Xorg RandR 1.2]] for more details):

Section "Screen"
Identifier "Screen0"
Device "Videocard0"
DefaultDepth 24
SubSection "Display"
Viewport 0 0
Depth 24
Virtual 2624 1200
EndSubSection
EndSection

Restart X server at this point (i.e. logout and login).

== configuring acpi ==
Create /etc/acpi/events/thinkpad.conf:

<bash>
event=ibm/hotkey HKEY 00000080 00001007
action=/usr/local/sbin/thinkpad-fn-f7
</bash>

or you may (eg Ubuntu 7.10) already have /etc/acpi/events/ibm-videobtn
<bash>
# /etc/acpi/events/ibm-videobtn
# This is called when the user presses the video button. It is currently
# a placeholder.
event=ibm/hotkey HKEY 00000080 00001007
action=/bin/true
</bash>
in which case modify the line 'action=/bin/true' to run the script as above.

It may also be necessary to enable acpi events as per [[How to get special keys to work]] with (in root terminal)
{{cmdroot|echo enable,0x084e > /proc/acpi/ibm/hotkey}}
Note this command isn't persistent. so you will also need to add the line to /etc/rc.local to enable hotkeys at boot, and to re-enable the hotkeys after suspend to disk or RAM, create the file
/etc/acpi/resume.d/91-ibm-hotkey-enable.sh consisting of

<bash>
#!/bin/bash
# enable ibm-hotkeys (specifically Fn2, Fn7)
# 12 bit mask, little end is F1 default 0x080c = F12+F4+F3
echo enable,0x084e > /proc/acpi/ibm/hotkey
</bash>

ref: [[http://tilmanfrosch.de/wp/index.php/2007/05/05/howto-make-a-ubuntu-linux-on-an-ibm-t41-thinkpad-work-with-an-external-widescreen-wxga-display/ frosch.org.uk]] and [[http://ibm-acpi.sourceforge.net/README ibm-acpi.sourceforge]]

==identify output devices==
Note the names of your output devices as you will have to change EXTERNAL_OUTPUT and INTERNAL_OUTPUT to what xrandr shows, for example VGA and LVDS in this case:

$ xrandr -q
'''VGA''' connected 1600x1200+0+0 (normal left inverted right x axis y axis) 432mm x 324mm
...
'''LVDS''' connected (normal left inverted right x axis y axis)

==The bash script==
Create /usr/local/sbin/thinkpad-fn-f7, you can set EXTERNAL_LOCATION to one of: left, right, above, or below.
<bash>
#!/bin/bash

# External output may be "VGA" or "VGA-0" or "DVI-0" or "TMDS-1"
EXTERNAL_OUTPUT="VGA"
INTERNAL_OUTPUT="LVDS"
EXTERNAL_LOCATION="left"

# Figure out which user and X11 display to work on
# TODO there has to be a better way to do this?
X_USER=$(w -h -s | grep ":[0-9]\W" | head -1 | awk '{print $1}')
export DISPLAY=$(w -h -s | grep ":[0-9]\W" | head -1 | awk '{print $3}')

# Switch to X user if necessary
if [ "$X_USER" != "$USER" ]; then
SU="su $X_USER -c"
else
SU="sh -c"
fi

case "$EXTERNAL_LOCATION" in
left|LEFT)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
right|RIGHT)
EXTERNAL_LOCATION="--right-of $INTERNAL_OUTPUT"
;;
top|TOP|above|ABOVE)
EXTERNAL_LOCATION="--above $INTERNAL_OUTPUT"
;;
bottom|BOTTOM|below|BELOW)
EXTERNAL_LOCATION="--below $INTERNAL_OUTPUT"
;;
*)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
esac

# Figure out current state
INTERNAL_STATE=$($SU xrandr | grep ^$INTERNAL_OUTPUT | grep " con" | sed "s/.*connected//" | sed "s/ //" | sed "s/ .*//g")
EXTERNAL_STATE=$($SU xrandr | grep ^$EXTERNAL_OUTPUT | grep " con" | sed "s/.*connected//" | sed "s/ //" | sed "s/ .*//g")

if [ -z "$INTERNAL_STATE" ]; then
STATE="external"
elif [ -z "$EXTERNAL_STATE" ]; then
STATE="internal"
else
INTERNAL_STATE=$(echo $INTERNAL_STATE | sed "s/[0-9]*x[0-9]*//")
EXTERNAL_STATE=$(echo $EXTERNAL_STATE | sed "s/[0-9]*x[0-9]*//")
if [ "$INTERNAL_STATE" = "$EXTERNAL_STATE" ]; then
STATE="mirror"
else
STATE="both"
fi
fi

function screen_external(){
$SU "xrandr --output $INTERNAL_OUTPUT --off"
$SU "xrandr --output $EXTERNAL_OUTPUT --auto"
}

function screen_internal(){
$SU "xrandr --output $EXTERNAL_OUTPUT --off"
$SU "xrandr --output $INTERNAL_OUTPUT --auto"
}

function screen_mirror(){
$SU "xrandr --output $INTERNAL_OUTPUT --auto"
$SU "xrandr --output $EXTERNAL_OUTPUT --auto --same-as $INTERNAL_OUTPUT"
}

function screen_both(){
$SU "xrandr --output $INTERNAL_OUTPUT --auto"
$SU "xrandr --output $EXTERNAL_OUTPUT --auto $EXTERNAL_LOCATION"
}

function screen_toggle(){
case "$STATE" in
internal)
screen_mirror
;;
mirror)
screen_external
;;
external)
screen_both
;;
both)
screen_internal
;;
*)
screen_internal
;;
esac
}

# What should we do?
DO="$1"
if [ -z "$DO" ]; then
if [ $(basename $0) = "thinkpad-fn-f7" ]; then
DO="toggle"
fi
fi

case "$DO" in
toggle)
screen_toggle
;;
internal)
screen_internal
;;
external)
screen_external
;;
mirror)
screen_mirror
;;
both)
screen_both
;;
status)
echo "Current Fn-F7 state is: $STATE"
echo
echo "Attached monitors:"
$SU xrandr | grep "\Wconnected" | sed "s/^/ /"
;;
*)
echo "usage: $0 <command>" >&2
echo >&2
echo " commands:" >&2
echo " status" >&2
echo " internal" >&2
echo " external" >&2
echo " mirror" >&2
echo " both" >&2
echo " toggle" >&2
echo >&2
;;
esac
</bash>

== set permissions and restart acpi ==
As root, or using sudo run the following commands,

{{cmduser|sudo chmod 755 /usr/local/sbin/thinkpad-fn-f7}}
{{cmduser|sudo service acpid restart}}
OR
{{cmduser|sudo /etc/init.d/acpid restart}}

You should be ready to go, just press Fn-F7 to try.

==Alternative script using .Xauthority rather than su ==
On systems where the previous script has trouble with the "su" command (I was getting "Can't open display -" errors in /var/log/acpid on Ubuntu 8.04), you can try getting the magic cookie out of the .Xauthority file.

Each user has an ~/.Xauthority file with one line for each X display containing a 'magic cookie' (Run {{cmduser| xauth list}} to see the contents). The Xserver reads the record in ~/.Xauthority matching its display. When an X client application starts it also looks for that record and passes the magic cookie to the server. If it matches, the connection to the Xserver is allowed. Use the following script as an alternative
action=/usr/local/sbin/toggle-display.sh
for /etc/acpi/events/ibm-videobtn

<bash>
#!/bin/bash
# From: http://www.thinkwiki.org/wiki/Sample_Fn-F7_script
#
# External output may be "VGA" or "VGA-0" or "DVI-0" or "TMDS-1"
EXTERNAL_OUTPUT="VGA"
INTERNAL_OUTPUT="LVDS"
# EXTERNAL_LOCATION may be one of: left, right, above, or below
EXTERNAL_LOCATION="right"

case "$EXTERNAL_LOCATION" in
left|LEFT)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
right|RIGHT)
EXTERNAL_LOCATION="--right-of $INTERNAL_OUTPUT"
;;
top|TOP|above|ABOVE)
EXTERNAL_LOCATION="--above $INTERNAL_OUTPUT"
;;
bottom|BOTTOM|below|BELOW)
EXTERNAL_LOCATION="--below $INTERNAL_OUTPUT"
;;
*)
EXTERNAL_LOCATION="--left-of $INTERNAL_OUTPUT"
;;
esac

function screen_external(){
xrandr --output $INTERNAL_OUTPUT --off
xrandr --output $EXTERNAL_OUTPUT --auto
}

function screen_internal(){
xrandr --output $EXTERNAL_OUTPUT --off
xrandr --output $INTERNAL_OUTPUT --auto
}

function screen_mirror(){
xrandr --output $INTERNAL_OUTPUT --auto
xrandr --output $EXTERNAL_OUTPUT --auto --same-as $INTERNAL_OUTPUT
}

function screen_both(){
xrandr --output $INTERNAL_OUTPUT --auto
xrandr --output $EXTERNAL_OUTPUT --auto $EXTERNAL_LOCATION
}

function screen_toggle(){
# Figure out current state
INTERNAL_STATE=$(xrandr | grep ^$INTERNAL_OUTPUT | grep con | sed "s/.*connected //" | sed "s/(.*//")
EXTERNAL_STATE=$(xrandr | grep ^$EXTERNAL_OUTPUT | grep con | sed "s/.*connected //" | sed "s/(.*//")

if [ -z "$INTERNAL_STATE" ]; then
STATE="external"
elif [ -z "$EXTERNAL_STATE" ]; then
STATE="internal"
else
INTERNAL_STATE=$(echo $INTERNAL_STATE | sed "s/[0-9]*x[0-9]*//")
EXTERNAL_STATE=$(echo $EXTERNAL_STATE | sed "s/[0-9]*x[0-9]*//")
if [ "$INTERNAL_STATE" = "$EXTERNAL_STATE" ]; then
STATE="mirror"
else
STATE="both"
fi
fi

case "$STATE" in
internal)
screen_mirror
;;
mirror)
screen_external
;;
external)
screen_both
;;
both)
screen_internal
;;
*)
screen_internal
;;
esac
}

# based on /etc/acpi/screenblank.sh (Ubuntu 7.10)
# . /usr/share/acpi-support/power-funcs # for getXuser
getXuser() {
user=`finger| grep -m1 ":$displaynum " | awk '{print $1}'`
if [ x"$user" = x"" ]; then
user=`finger| grep -m1 ":$displaynum" | awk '{print $1}'`
fi
if [ x"$user" != x"" ]; then
userhome=`getent passwd $user | cut -d: -f6`
export XAUTHORITY=$userhome/.Xauthority
else
export XAUTHORITY=""
fi
}
# end of getXuser from /usr/share/acpi-support/power-funcs
#
for x in /tmp/.X11-unix/*; do
displaynum=`echo $x | sed s#/tmp/.X11-unix/X##`
getXuser;
if [ x"$XAUTHORITY" != x"" ]; then
export DISPLAY=":$displaynum"
screen_toggle
fi
done
</bash>

== A Python Toggle script ==
This is a somewhat over-elaborate script which could be cut down when run by the /usr/local/sbin/toggle-display.sh script above. It was written to explore all the possibilities rather than economy of execution. The functions 'toggle_full', 'position', 'toggle_limited' and the OptionParser in 'main' may be omitted with suitable changes to function7. The appropriate outputs can be specified on the command line and it is not necessary to call it via acpi.
eg you can run it as {{cmduser|/usr/local/bin/toggle.py --help}}

<python>
#! /usr/bin/python
# -*- coding: utf-8 -*-
#
# stinkpad(a)blueyonder.co.uk 2007-11-26
"""Toggle internal and external displays (equivalent to ThinkPad Fn7)
Simple; cloned: on+off, on+on, off+on.
Full; as simple plus xinerama: right, below, left, above.
Limited; as full but display will overlap if virtual screen is too small.
Use 'xrandr -q' to determine output names.
Further information: http://www.thinkwiki.org/wiki/Xorg_RandR_1.2
"""
__usage__ = "usage: %prog [--help]|[[-i internal][-e external][-d displays]]"
__version__ = "toggle [djclark.eu 2007-11-26]"
#
# Output names; Intel: LVDS VGA TV TMDS-1 TMDS-2
# ATI: LVDS VGA-0 S-video DVI-0
LAPTOP = 'LVDS'
MONITOR = 'VGA'
SEQUENCE = 'simple'
#
import sys
import os
import re

# "LVDS connected 1024x768+0+0 (normal left inverted right) 304mm x 228mm"
REGEX_OUTPUT = re.compile(r"""
(?x) # ignore whitespace
^ # start of string
(?P<output>[A-Za-z0-9\-]*)[ ] # LVDS VGA etc
(?P<connect>(dis)?connected)[ ] # dis/connected
(( # a group
(?P<width>\d+)x # either 1024x768+0+0
(?P<height>\d+)[+]
(?P<horizontal>\d+)[+]
(?P<vertical>\d+)
)|[\D]) # or not a digit
.* # ignore rest of line
""")

# "Screen 0: minimum 320 x 200, current 1024 x 768, maximum 2624 x 1968"
REGEX_SCREEN = re.compile(r"""
(?x) # ignore whitespace
^ # start of string
Screen[ ]
(?P<screen>\d)[: ]+
minimum[ ]
(?P<minWidth>\d+)[ x]+
(?P<minHeight>\d+)[, ]+
current[ ]+
(?P<curWidth>\d+)[ x]+
(?P<curHeight>\d+)[, ]+
maximum[ ]+
(?P<maxWidth>\d+)[ x]+
(?P<maxHeight>\d+)
""")

def toggle_simple(d0, d1):
"""Toggle display states: on+off, on+on, off+on"""
if d1['connect'] == 'disconnected': # external unplugged
return ('auto','off',"") # switch off external
if d1['width'] is 0: # external off
return ('auto','auto',"") # both on
if d0['width'] is 0: # laptop off
return ('auto','off',"") # laptop on
return ('off','auto',"") # both on, laptop off

def toggle_full(d0, d1):
"""Toggle display states: 1+0, 1+1, 0+1, 1+E, 1+S, 1+W, 1+N"""
if d1['connect'] == 'disconnected': # external unplugged
return ('auto','off',"") # switch off external
place = '--%s ' + d0['output']
if d1['width'] == 0: # external off
return ('auto','auto',place%'same-as') # external on
if d0['width'] == 0: # laptop off
return ('auto','off',"") # laptop on
if d1['horizontal'] > 0: # external to right
return ('auto','auto',place%'below') # make below
if d1['vertical'] > 0: # external below
return ('auto','auto',place%'left-of') # make left
if d0['horizontal'] > 0: # external left
return ('auto','auto',place%'above') # make above
if d0['vertical'] > 0: # external above
return ('off','auto',"") # laptop off
return ('auto','auto',place%'right-of') # is same, make right

def position(orientation, da, db, screen):
"""Calculate offset position of second display"""
p = 'auto --pos %sx%s'
if orientation == 'V':
if (da['height'] + db['height']) <= screen['maxHeight']:
return p%(0, da['height'])
return p%(0, screen['maxHeight'] - db['height'])
else:
if (da['width'] + db['width']) <= screen['maxWidth']:
return p%(da['width'],0)
return p%(screen['maxWidth'] - db['width'],0)

def toggle_limited(d0, d1, sz):
"""Toggle display states (overlapped): 1+0,1+1,0+1,1+E,1+S,1+W,1+N"""
if d1['connect'] == 'disconnected': # external unplugged
return ('auto','off') # switch off external
if d1['width'] == 0: # external off
return ('auto --pos 0x0','auto --pos 0x0') # both on
if d0['width'] == 0: # laptop off
return ('auto --pos 0x0','off') # laptop on
if d1['horizontal'] > 0: # external to right
return ('auto --pos 0x0',position('V',d0,d1,sz)) # put *below
if d1['vertical'] > 0: # external below
return (position('H',d1,d0,sz),'auto --pos 0x0') # put *left
if d0['horizontal'] > 0: # external left
return (position('V',d1,d0,sz),'auto --pos 0x0') # put *above
if d0['vertical'] > 0: # external above
return ('off','auto --pos 0x0') # laptop off
return ('auto --pos 0x0',position('H',d0,d1,sz)) # both, put*right

class DisplayNameError(UnboundLocalError):
"""Internal or External Display Name not found by xrandr -q """

def function7(disp0=LAPTOP, disp1=MONITOR, seq=SEQUENCE):
"""Use xrandr to read current display state and change state"""
for line in os.popen('xrandr -q').read().splitlines():
if line.startswith(disp0,0) :
d0_state = REGEX_OUTPUT.match(line).groupdict()
elif line.startswith(disp1,0):
d1_state = REGEX_OUTPUT.match(line).groupdict()
elif line.startswith('Screen',0):
screen_size = REGEX_SCREEN.match(line).groupdict()
else:
pass
for i in ('width','height','horizontal','vertical'):
try:
d0_state[i] = int(d0_state[i])
except TypeError:
d0_state[i] = 0
except UnboundLocalError:
raise DisplayNameError, 'Internal Display: %s not found'% disp0
try:
d1_state[i] = int(d1_state[i])
except TypeError:
d1_state[i] = 0
except UnboundLocalError:
raise DisplayNameError, 'External Display: %s not found'% disp1
for i in screen_size.keys():
try:
screen_size[i] = int(screen_size[i])
except TypeError:
screen_size[i] = 0
#
toggle = toggle_simple
xrandr ='xrandr --output '+disp0+' --%s --output '+disp1+' --%s %s'
if seq == 'full':
toggle = toggle_full
if seq == 'limited':
toggle = toggle_limited
xrandr ='xrandr --output '+disp0+' --%s --output '+disp1+' --%s'
os.popen(xrandr % toggle(d0_state, d1_state, screen_size))
else:
os.popen(xrandr % toggle(d0_state, d1_state))

def main():
""" Command line options """
global LAPTOP,MONITOR,SEQUENCE
from optparse import OptionParser
p = OptionParser(usage=__usage__, version=__version__, description=__doc__)
p.set_defaults(internal=LAPTOP, external=MONITOR, displays=SEQUENCE)
p.add_option('-i','--internal', dest="internal", metavar=LAPTOP,
help="internal display")
p.add_option('-e','--external', dest="external", metavar=MONITOR,
help="external display")
p.add_option('-d','--displays', dest="displays", action="store",
choices=('simple', 'limited', 'full'), metavar=SEQUENCE,
help='simple/limited/full')
(opt, args) = p.parse_args()
try:
function7(opt.internal, opt.external, opt.displays)
except DisplayNameError, err:
print '\n'+str(err)+'\n'
print os.popen('xrandr -q').read()
#
if __name__ == '__main__': #only when run from cmd line
main()
</python>

This modified thinkpad-fn-f7 calls the toggle python script:

<bash>
#!/bin/bash
# usr/local/sbin/toggle-display.sh
# based on /etc/acpi/screenblank.sh (Ubuntu 7.10)
#
# . /usr/share/acpi-support/power-funcs # for getXuser
umask 022;
PATH="$PATH:/usr/bin/X11"
getXuser() {
user=`finger| grep -m1 ":$displaynum " | awk '{print $1}'`
if [ x"$user" = x"" ]; then
user=`finger| grep -m1 ":$displaynum" | awk '{print $1}'`
fi
if [ x"$user" != x"" ]; then
userhome=`getent passwd $user | cut -d: -f6`
export XAUTHORITY=$userhome/.Xauthority
else
export XAUTHORITY=""
fi
}
# end of getXuser from /usr/share/acpi-support/power-funcs
#
for x in /tmp/.X11-unix/*; do
displaynum=`echo $x | sed s#/tmp/.X11-unix/X##`
getXuser;
if [ x"$XAUTHORITY" != x"" ]; then
export DISPLAY=":$displaynum"
## . /usr/share/acpi-support/screenblank.sh
/usr/local/bin/toggle.py
fi
done
</bash>

===Python XRandR===
[[http://www.glatzor.de/blog/blog-details/article/initial-release-of-python-xrandr Python XRandR]] is a set of python bindings to xrandr. The code is currently in development and the following code though much simpler than the python code above may not work reliably.

from xrandr import xrandr
def toggle_simple():
"""Toggle display states: on+off, off+on, on+on off+off"""
screen = xrandr.get_current_screen()
outputs = screen.get_outputs()
for o in outputs:
if o.is_connected():
if o.is_active():
o.disable()
print 'disable %s'% o.name
else:
o.set_to_preferred_mode()
print 'set to preferred mode %s'% o.name
break
screen.apply_output_config()

== Having Fn-F7 run a RandR GUI ==
Instead of using it to toggle various screen(s) configurations, one may want to have it run a RandR GUI, such as grandr.

The following Debian wishlist bugs against the acpi-support package have patches attached that implement this behaviour using acpid; these patches are not Debian-specific, and actually provide example configuration for anyone interested into this:

* http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=515794
* http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=515796

== References ==
[[http://gitweb.freedesktop.org/?p=xorg/app/grandr.git grandr]] graphical interface to xrandr using GTK+ libraries.

[[https://edge.launchpad.net/python-xrandr python-xrandr]] Python bindings to xrandr which should enable a less clunky version of the python script above. Under development.

[[Category:Scripts]]