ThinkWiki - User contributions [en]

Embedded Security Subsystem

2010-02-18T19:38:31Z

Csawtell: /* External Sources */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;" | [[Image:ESS.jpg|IBM Embedded Security Subsystem]] __NOTOC__
|style="vertical-align:top" |
<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#F8F8FF; align:right;">
=== The Embedded Security Subsystem ===
The Embedded Security Subsystem is a chip on the ThinkPad's mainboard that can take care of certain security related tasks conforming to the TCPA standard. It was first introduced among the T23 models and is now under the name "Embedded Security Subsystem 2.0". It is an integral part of most of the modern ThinkPads. The functions of the chip fall into three main groups:
* Public key functions
* Trusted boot functions
* Initialization and management functions

The purpose of the Embedded Security Subsystem is to keep the user's sensitive data out of range from software based attacks (like viruses, Internet attacks etc.). One way the chip offers to achieve this is by providing storage for keys along with the necessary functions to handle them within itself, so that a for example a private key never has to leave the chip (can't be seen by any piece of software). Besides this, there are more complex topics covered by the functionality of the chip. If you want to find out more about it you can find good documents on the [http://www.research.ibm.com/gsal/tcpa/ IBM Research TCPA resources page].</div>
|}

{{NOTE|Some ThinkPads have the TPM chip integrated into the SuperIO chip, and in a not-so-distant future, the TPM will be integrated into the chipset. Don't let the picture fool you...}}

{{WARN|There's a bug in the latest release of the security chip software. You end up facing a security chip login, and you press Ctrl-alt-delete, and it just sits there. '''Do not''' download the latest patch (Dated 13/06/2006 v 7.00.0017.00) <BR>
Actually, they appear to have removed that patch.<BR>
Ring IBM support (in Australia 131426, 1, 2) and they'll talk you through doing a system restore.}}

==Trusted or Treacherous?==

TC - Trusted Computing - will be the biggest change of the information landscape since decades. Besides positive features like a more secure hardware storage for cryptographic keys, an analysis of the proposed TCG-standards shows some problematic properties. <br />
As ThinkPads of recent generations following the ThinkPad {{T23}} ([[Embedded Security Subsystem#Models featuring this Technology|see the complete list of models]]) are equipped with this disputed TCG-/TCPA-Technology, it can be interesting, which promises of the TCG are fulfilled inside your ThinkPad and which parts of the TCG-specifications still seem to be a privacy issue for every user of digital devices like a MP3-player or a ThinkPad - so please read [[TCPA/TCG - Trusted or Treacherous|this article]] for more details.

==Linux Support==
Two linux drivers are available, a [[tpm|classical one]] and a [[tpmdd|newer one]].
Coverage of functionality of the first is unknown so far, the second is part of a bigger project aiming to provide a usable security framework.

David Stafford (one of the developers of the tpm code at IBM) on March 10, 2005 sent me the most recent version of the tpm-kml code. With his permission, I quote his email:

"I am attaching our latest driver and library.
This version is in the process of kernel mailing list review, and
will hopefully be accepted into the official kernel. It works
much better across various 2.6 kernels. Note that this builds
three modules tpm, tpm_atmel, and tpm_nsc. You modprobe the
tpm_atmel (for all current shipping atmel based systems), or
tpm_nsc (for the coming national based systems).

Also note that there is a conflict with the snd-intel8x0
kernel module (they each try to grab the LPC bus). You can
either: load the tpm modules first (such as in initrd or
rc.sysinit, before sound), or recompile the snd-intel8x0, turning
off the MIDI and JOYSTICK support. The latest 2.6.11 version
of snd-intel8x0 also reportedly fixes things."

Compiling this library was easy. Compiling the driver on my 2.6.8-686 (debian testing) laptop failed. But the library works with the driver I compiled from the tpm-2.0 package IBM made available on its pages (see the links below).

Gijs

The T43 requires a patch posted to the LKML by Kylene Jo Hall: [http://marc.theaimsgroup.com/?l=linux-kernel&m=111884603309146&w=2 LKML posting]. An updated patch for linux 2.6.12 is available [http://shamrock.dyndns.org/~ln/linux/tpm_2.6.12.diff here].

The atmel driver comes with 2.6.12.
----
Now suported in 2.6.15.1 (and maybe others kernels under this number) in:

/device drivers/caracter devices/tpm devices

==Versions & Features==
=== Embedded Security Chip ===
IBM introduced it's TCPA/TCG features with some of the [[:Category:T23|T23]] models. The earlier of them didn't yet have the Embedded Security Subsystem, but a kind of pre 1.0 version called the Embedded Security Chip. This chip had the following capabilities:
*Data communications authentication and encryption
*Storage of encrypted passwords

=== Embedded Security Subsystem (1.0) ===
The original Embedded Security Subsystem (in IBM documents there is no use of the additive version-number 1.0) claims to be compliant with TCG specs, but apparently did not fully implement any specific TCG spec.

The Embedded Security Subsystem has the following features:
*hardware key storage
*multi-factor authentication
*local file encryption
*enhances VPN security

=== Embedded Security Subsystem 2.0 ===
The Embedded Security Subsystem 2.0 conforms to the TCG TPM 1.1b specification, with a TPM manufactured by either Atmel or National Semiconductor, and TCG TPM PC client 1.1 BIOS extensions.

The Embedded Security Subsystem 2.0 has the following features:
*hardware key storage
*multi-factor authentication
*local file encryption
*enhances VPN security
*TCG compliant

National Semiconductor TPMs are likely part of the Winbond SuperIO chip (e.g. in a {{T43}}).

{{NOTE|It is possible that second-generation T60s and the T61/X61/R61 have TPM chips conforming to TCG TPM 1.2. If you own one, please verify if that's true, and update this page}}
{{NOTE|At least the T61p uses an ATMEL TCG TPM 1.2 chip}}

==Clearing/Reseting the Embedded Security Subsystem==

{{WARN|Be sure that there are no active HDD passwords, and that you have uninstalled any IBM/Lenovo security software that might want information stored or encrypted with the help of the TPM chip '''before''' you clear the chip. Any data that is encrypted using information inside the TPM chip will be useless after you clear the TPM chip. It is unknown if clearing the TPM chip can mess with the BIOS HDD password support, but until someone tests it, it is best to play it safe.}}

{{HINT|A password-locked HDD can be made useful again by using a low-level utility capable of issuing the SECURE-ERASE command to it. You will lose all data, but at least the HDD will be usable again, as that also unlocks the HDD.}}

If there is a need to reset and clear the TPM chip, the IBM BIOS has a "Clear Security Chip" option that will work (as long as you did not issue one of the very few "permanently lock the TPM chip in a certain state for life" commands, so '''Do Not Do That!''').

That option is not readily accessible. To unhide it and reset the TPM chip, you have to:

=== Method 1 ===
#Power down the ThinkPad;
#Power up the ThinkPad, with the Fn key pressed (or CTRL in a ThinkCenter);
#When the BIOS screen shows up, release the Fn key;
#Press the required key to enter the BIOS configuration;
#Enter BIOS supervisor password if required;
#Go to the security menu, security chip submenu, and clear the TPM chip.

=== Method 2 ===

#Power down the ThinkPad;
#Power up the ThinkPad;
#Press the ThinkVantage/Access IBM button while the BIOS is still booting;
#Type in the supervisor password if the BIOS asks for it;
#Press ESC a number of times, which will cause the BIOS to switch to maintenance mode and display a number of text screens;
#Power down the ThinkPad as soon as it hits the boot loader of the Operating System (it doesn't matter which O.S.);
#Power on the ThinkPad;
#Enter the BIOS configuration screen (may require supervisor password);
#Go to the security menu, security chip submenu, and clear the TPM chip.

==Using the Embedded Security Subsystem==

=== TPM 1.1b basics ===

The TPM chip is a "secure" brokerer of data signatures and keys, as well as a slow but very good hardware RNG. It has some registers called PCRs that are used for trusted platform attestation. It can sign data using 2048-bit RSA keys. It is '''slow'''. It is not easy to use, either :-)

The current version of the TPM chips found on ThinkPads (TPM 1.1b) isn't secure at all against moderately sophisticated physical attacks, and it is also useless for DRM and other Treacherous Platform corporate ideas.

A Trusted Platform in a context involving a TPM means that the PCRs contains values that they are expected to, because the TPM will allow data that is "sealed" (as opposed to "bound") to it to be accessed ("unsealed") only when the PCRs match the PCRs at sealing time. The interesting magic is, therefore, in the process of updating the contents of the PCRs.

The PCRs start zeroed at TPM reset. As things load (BIOS, bootloader, OS, userspace), they are supposed to verify if the PCRs are at a state they can trust, and if so, to add the checksum of their own code, data, and configuration to the PCRs and load the next stage. Alternatively, they can skip the PCR test and just extend it if they don't care that they are running in an untrusted state.

PCRs cannot be set to a given value. The TPM only allows one to "extend" a PCR, which is an operation where the result is a SHA-1 hash that depends on the previous value of the PCR and on the data you give the TPM to extend the PCR with. It is non-trivial to get the PCR to a desired value based only on its previous contents and the desired target value.

It is obviously a total nightmare to update the system in a trusted platform scenario, as the contents of the PCRs starting from the update point will change. A changed PCR immediately makes any data that was sealed based on its old value impossible to access. This is one of the reasons why nobody is doing remote trusted platform assurance, except in very controlled scenarios right now. New versions of the specifications around the trusted platform support specifications (like TPM 1.2) are trying to address this problem.

Trusted Platform assurance with a TPM 1.1b isn't easy to do, but it is possible (and it is not in any way unbreakable!, but it is a lot better than nothing for many uses).

The ThinkPad BIOS measures the boot loader and stores the relevant data on PCR registers and the TPCA log, so if one adds a trusted boot loader to the system (like trusted-grub), one can load a trusted operating system and from there, trusted userspace applications, etc.

Note that LPC-bus tricks using modchips to trap and modify the data flow to the TPM chip can effectively bust the Trusted Platform assurance completely on any ThinkPads up to the T61/R61/X61. To avoid that, a TPM inside the northbridge is needed. Intel plans to add a TPM 1.2 to their chipsets in 2008, so it is likely that the T62/X62/R62 TPMs won't be as vulnerable to hardware hacks.

=== ThinkPad BIOS TPM basics ===

The TCG TCPA specification also defines PC BIOS behaviour and extensions to deal with the TPM chip and Trusted Platform requirements. The ThinkPad BIOS is compliant to the TCG PC Client specification v1.1 (and, in new ThinkPads, maybe v1.2).

This means that:
*The BIOS can be used to reset the TPM using physical presence (see above for the reset procedure);
*Physical presence is only available to the BIOS (unless you hack the BIOS or the hardware, obviously);
*The BIOS can be configured to log or not (which also means calculate PCRs) the checksum of some of the platform data. If you don't want the ESCD or NVRAM contents to interfere in PCR calculations, you need to disable their logging in the BIOS for example;
*The BIOS touches PCRs 0 to 7, but leaves PCRs 8 to 15 alone (zeroed);
*You can disable the TPM chip in the BIOS, and not worry about someone using it behind your back. But they will be able to know that there is a TPM in the system (the chip can still be found, and will report its version, manufacturer, and disabled state), unless you remove all the kernel TPM support, including tpm_bios;
*The BIOS might use the TPM, so watch out for trouble if you have HDD passwords enabled, etc;

==== PCR registers extended by the BIOS ====

{| width="100%" {{prettytable}}
| style="background:#ffdead;" width="10%" | '''PCR #'''
| style="background:#ffdead;" | '''Description (TCG PC client spec v1.1)'''
| style="background:#ffdead;" | '''Notes'''
|-
! colspan=3 style="text-align:center;background:#efefef;" |

==== T43 26xx BIOS 1.29 ====
|-
| 0
| CRTM, BIOS, and platform extensions
| The BIOS logs many BIOS POST PCR extensions, probably hardware and firmware-related
|-
| 1
| Platform configuration:
*BIOS ROM strings (BIOS version and checksum)
*NVRAM (Asset tag data)
*CMOS configuration (basic, always logged)
*CMOS configuration (extended)
*ESCD platform configuration data (like size of memory modules, etc)
*SMBIOS data (?)
|
*Useful when BIOS ROM logging is enabled, since one has to trust the BIOS and it is best to not let someone update it behind your back. Upgrading the BIOS invalidates data sealed to this PCR, though
*NVRAM logging is useful to seal data to a particular asset tag
|-
| 2
| Option ROM code
| Can be used to detect the addition/subtraction/upgrade of Option ROMs (extra BIOS code from third parties)
|-
| 3
| Option ROM configuration and data
| Not modified except for the event separator on my current T43 config
|-
| 4
| IPL Code (system bootstrap)
* BIOS password used to authorize booting (if any)
* Boot device used
* MBR/boot sector checksum (LILO, Grub stage 1, etc)
|
* The password hash itself of the BIOS user or supervisor password is used to extend this PCR
* When you reboot, if the box doesn't ask for a password, the PCR will have different contents (work around: go into BIOS and exit saving changes, so that you are asked the password again)
* Lets one seal data to a particular boot password and to the fact that the password was typed in the keyboard
* Takes into account the device used to boot, and the bootstrap code checksum
|-
| 5
| IPL Code configuration and data
| This PCR is reserved for the boot loader to extend with its configuration and whatever else it loads
*trusted-grub extends it with stage 1.5 and stage 2 checksums, grub.conf checksum, and kernel and initrd checksum
*Not modified by the BIOS itself, except for the event separator
|-
| 6
| State transitions and wake events
| Logs a WAKE EVENT 0 hash on power up and simple reset (same event)
|-
| 7
| Reserved
| Not modified except for the event separator. Reserved by the TCG for future use.
|-
| 8-15
| User PCRs
|
*Not modified by BIOS or bootstrap
*Still zeroed at end of Linux boot
*Can be used for whatever the user wants
|}

=== Using the TPM in Windows ===

Just install the full IBM Security solution, and let it use the TPM. What good it will do to increase the security of your data is unknown.

=== Using the TPM in Linux ===

This section is very incomplete, but here are some pointers to get you started:

*Compile a 2.6.23 or later kernel with the driver for the tpm chip in your ThinkPad model enabled;
**You need to enable CONFIG_SECURITY to get securityfs, and CONFIG_KEYS to use eCryptfs TPM support;
**You need to enable tpm_bios to access the TCPA log;
*Make sure to mount the securityfs filesystem on /sys/kernel/security to access tpm_bios data (the TCPA log);
*You should use dm-crypt to have an encrypted swap partition with an ephemeral key;
*The TCPA log can be found in the securityfs directory, and it might help you understand how the BIOS and boot loaders are using the PCRs. The first number for each event in the log is the number PCR register that was extended by that event;
*You need an up-to-date version of the TrouSerS software stack to use the TPM for anything other than reading the TPCA log;
*You need an up-to-date eCryptfs userspace (with TPM support compiled in) to use the TPM to store filesystem keys;
*Using the TPM as a PKCS11 token is possible, but I have no idea how safe it is, since that requires a null (well-known) SRK;
*trusted-grub can be used to play with the PCRs before Linux loads, and to checksum the Linux kernel and extend a PCR with that data;
*The PCRs can be read through sysfs, under the /sys/bus/platform/devices/tpm*/pcrs file for the TPM driver for your TPM chip;
*TrouSerS 0.3.1 tpm_getpubek seems not to work too well, it gets the PUBEK attributes wrong from the NSC TPM chip in a T43 (but the key data itself is correct). Compare to sys/bus/platform/devices/tpm*/pubek to check yours.

==Models featuring this Technology==
===IBM Embedded Security Chip===
*ThinkPad {{T23}}
===IBM Embedded Security Subsystem===
*ThinkPad {{A30p}}
*ThinkPad {{R31}}
*ThinkPad {{T23}}, {{T30}}
*ThinkPad {{X22}}, {{X23}}, {{X24}}

===IBM Embedded Security Subsystem 2.0===
*ThinkPad {{R32}}, {{R40}}, {{R50}}, {{R50p}}, {{R51}}, {{R51e}}, {{R52}}, {{R60}}, {{R61}}
*ThinkPad {{T40}}, {{T40p}}, {{T41}}, {{T41p}}, {{T42}}, {{T42p}}, {{T43}}, {{T43p}}, {{T60}}, {{T60p}}, {{T61}}, {{T61p}}
*ThinkPad {{X30}}, {{X31}}, {{X32}}, {{X40}}, {{X41}}, {{X41T}}, {{X60}}, {{X60s}}, {{X61s}}, {{X61_Tablet}}, {{X200}}
*ThinkPad {{Z60m}}, {{Z60t}}

[[Category:Glossary]]
[[Category:Trusted Computing]]

==TCPA/TCG clean models==
*all models produced before 2000
*all i Series models
*ThinkPad [[:Category:240X|240X]]
*ThinkPad [[:Category:A20m|A20m]], [[:Category:A20p|A20p]], [[:Category:A21e|A21e]], [[:Category:A21m|A21m]], [[:Category:A21p|A21p]], [[:Category:A22e|A22e]], [[:Category:A22m|A22m]], [[:Category:A22p|A22p]], [[:Category:A30|A30]]
*ThinkPad [[:Category:R50e|R50e]]
*ThinkPad [[:Category:T20|T20]], [[:Category:T21|T21]], [[:Category:T22|T22]]
*ThinkPad [[:Category:X20|X20]], [[:Category:X21|X21]], [[:Category:X22|X22]]
*ThinkPad [[:Category:TransNote|TransNote]]

==External Sources==
*[http://www.pc.ibm.com/us/think/thinkvantagetech/security.html IBMs ThinkVantage<sup>TM</sup> Technologies Embedded Security Subsystem page]
*[http://www.pc.ibm.com/presentations/us/thinkvantage/56/index.html?shortcut=ess& IBMs ThinkVantage<sup>TM</sup> Technologies Flash presentation - Embedded Security Subsystem]
*[https://www.trustedcomputinggroup.org/specs/PCClient/ TCG PC Client specifications]
*[http://www.research.ibm.com/gsal/tcpa/ IBM Research TCPA resources page]
*[http://sourceforge.net/projects/trustedgrub/ Trusted Grub]
*[https://www.grounation.org/index.php?post/2008/07/04/8-how-to-use-a-tpm-with-linux User-friendly HOWTO on using TPM under Linux]

PowerTOP

2007-09-17T20:41:00Z

Csawtell: /* Intel PowerTOP */

== Intel PowerTOP ==

PowerTOP is a Linux tool that finds the software component(s) that make your laptop use more power than necessary while it is idle. As of Linux kernel version 2.6.21, the kernel no longer has a fixed 1000Hz timer tick. This will (in theory) give a huge power savings because the CPU stays in low power mode for longer periods of time during system idle.

[[Image:powertop_small.png]]
The PowerTOP curses based display
'''Requirements'''

For PowerTOP to work best, use a Linux kernel with the tickless idle (NO_HZ) feature enabled (version 2.6.21 or later). Currently, only 32-bit kernels have support for tickless idle; 64-bit kernels are expected to gain this feature in version 2.6.23.

PowerTOP works best on a laptop computer, or at least a computer with an Intel mobile processor (certain small non-laptop devices also contain a mobile processor). When using PowerTOP on a laptop, do so when running on battery.

[http://www.linuxpowertop.org/powertop.php Link to PowerTOP]

PowerTOP

2007-09-17T20:35:33Z

Csawtell: â†Created page with '== Intel PowerTOP == PowerTOP is a Linux tool that finds the software component(s) that make your laptop use more power than necessary while it is idle. As of Linux kerne...'

== Intel PowerTOP ==

PowerTOP is a Linux tool that finds the software component(s) that make your laptop use more power than necessary while it is idle. As of Linux kernel version 2.6.21, the kernel no longer has a fixed 1000Hz timer tick. This will (in theory) give a huge power savings because the CPU stays in low power mode for longer periods of time during system idle.

[http://www.linuxpowertop.org/powertop.php [[Image:powertop_small.png]]]
The PowerTOP curses based display
'''Requirements'''

For PowerTOP to work best, use a Linux kernel with the tickless idle (NO_HZ) feature enabled (version 2.6.21 or later). Currently, only 32-bit kernels have support for tickless idle; 64-bit kernels are expected to gain this feature in version 2.6.23.

PowerTOP works best on a laptop computer, or at least a computer with an Intel mobile processor (certain small non-laptop devices also contain a mobile processor). When using PowerTOP on a laptop, do so when running on battery.

File:Powertop small.png

2007-09-17T20:20:43Z

Csawtell: Screenshot of PowerTOP

Screenshot of PowerTOP

How to configure acpid

2007-09-02T19:28:07Z

Csawtell: /* Event Script */

__TOC__
==Introduction==
Basically, [[acpid]] just executes scripts residing in {{path|/etc/acpi/actions}}. Which script to launch at which event is configured in several files in {{path|/etc/acpi/events}}. All actions are documented in {{path|/var/log/acpid}}.

==Sources of Information==
*{{cmduser|man acpid}} holds detailed information on how to configure acpid.
*The [[ibm-acpi]] package includes example scripts in the {{path|config}} folder inside the tarball. They are a good starting point to adjust them to your needs.
*You also might want to have a look at the [[Configs#ACPI | ACPI section of the Configs page]] or the [[:Category:Scripts|Scripts]] repository.
*And you can find information about the event strings [[ibm-acpi]] generates for certain keys at the [[How to get special keys to work#ibm-acpi_events | Special Keys HOWTO]].

==Example: go to sleep on lid close==
To make the ThinkPad go to sleep when you close the lid, you need to add
an event handler for the lid event and an action script that takes care
of going to sleep and resuming.

===Event Script===
The event script needs to be created within {{path|/etc/acpi/events}} and can have any name you like.
In this case we call it lid because it will trigger the lid event. Do {{cmdroot|vi /etc/acpi/events/lid}} and make it look like this:
event=button/lid
action=/etc/acpi/actions/sleep.sh %e

The "event" line is a regular expression specifying the events we're
interested in. You can determine what the event strings are from looking at
{{path|/var/log/acpid}} after trying to suspend, close the lid, etc. .
You can find information about the event strings [[ibm-acpi]] generates for certain keys at the [[How to get special keys to work#ibm-acpi_events | Special Keys HOWTO]].

The "action" line is the command to be executed when these events are
dispatched. In this example we call the {{path|sleep.sh}} script residing in {{path|/etc/acpi/actions}} and pass the event description text using the %e placeholder.

For the script you can use the <tt>hibernate</tt> script of [http://www.tuxonice.net/ Tux On Ice] (it is independent of the [[ www.suspend2.net | suspend-to-disk]] functionality), or any of many examples available on the web, such as the one below.

{{NOTE|To make your changes take effect after adding or modifying the events files you must do a <tt>kill -SIGHUP `pidof acpid`</tt>}}

===Action Script===
Our example {{path|/etc/acpi/actions/sleep.sh}} script looks as follows:

#!/bin/sh

# if launched through a lid event and lid is open, do nothing
echo "$1" | grep "button/lid" && grep -q open /proc/acpi/button/lid/LID/state && exit 0

# remove USB 1.1 driver
rmmod uhci_hcd

# sync filesystem and clock
sync
/sbin/hwclock --systohc

# switch to console
FGCONSOLE=`fgconsole`
chvt 6
/usr/sbin/radeontool light off

# go to sleep
sleep 5 && echo -n "mem" > /sys/power/state

# readjust the clock (it might be off a bit after suspend)
/sbin/hwclock --adjust
/sbin/hwclock --hctosys

# reload USB 1.1 driver
modprobe uhci_hcd

# turn on the backlight and switch back to X
radeontool light on
chvt $FGCONSOLE

{{NOTE|This parts of this script are now part of some distributions, like Debian Etch and you probably don't need to add this script. Look into /etc/acpi/lid.sh, for example.}}

====Explanations====
*The lid generates an event for both opening and closing thus requiring that we check its state and only act if it's closed.
*There have been problems encountered with the USB devices not working properly after a resume from suspend. To circumvent those we remove the USB driver prior to suspend and reload it afterwards.
*Note that the {{cmdroot|echo -n "mem" > /sys/power/state}} line does not return until we are revived. So there is only one event generated and there is no need to check the state of anything.
*The console switching code in this script is a special solution for [[Problem with LCD backlight remaining on during ACPI sleep|a problem where the backlight doesn't switch off]] on the {{T30}} and some other models. Before going to sleep, these models switch to console mode which causes the backlight to come back on. So we preemptively switch to console mode and turn off the backlight using [[radeontool]] before going to sleep.

==Screen blanking script==

You might want to be able to switch of the screen using Fn-f3.
This is not completely straightforward.
You will first need to give permission to the script to muck around with your screen

xhost +local:root

/etc/acpi/events/sleepbtn
contains
event=(button[ /]sleep|ibm/hotkey HKEY 00000080 00001004)
action=/etc/acpi/sleepbtn.sh

And /etc/acpi/sleepbtn.sh is

#!/bin/bash

# simple script to turn the display on or off #
# By Mahram Z.Foadi #
# Oct 22 2005 #
# thank you linuxquestions.org #
# #
# the following lines must be present in your "/etc/acpi/events/" files. Some #
# systems already have a file called sample.conf in the mentioned directory #
# rename it to something more meaningful (i.e. acpid.conf) and these lines to #
# the end of it (you don't HAVE to rename it, you can even create a new file #
# and call it /etc/acpi/events/lid.conf with the 2 lines in it. If you intend #
# to put this file anywhere other than /sbin/lidevent, make sure you make the #
# proper changes in the "action" line below. For example if you are going to #
# save this script as /usr/bin/mylid.sh then the action line should be: #
# action=/usr/bin/mylid.sh #
# be sure both files are executable, writable, and owned by root ONLY because #
# the acpid daemon is most likely running as root in your system #
# #
# ---- insert the two lines below in /etc/acpi/events/acpid.conf ---- #
# event=button/lid.* #
# action=/sbin/lidevent #
#-----------------------------------------------------------------------------#

# default display on current host
DISPLAY=:0.0

# find out if DPMS is enabled
STATUS=`xset -display $DISPLAY -q | grep -e 'DPMS is'`

# enable DPMS if disabled
if [ "$STATUS" == " DPMS is Disabled" ]
then
echo "Enabling DPMS ..."
xset -display $DISPLAY +dpms
fi

# find out if monitor is on
STATUS=`xset -display $DISPLAY -q | grep 'Monitor'`

if [ "$STATUS" == " Monitor is On" ]
then
echo "[`date`] Turning display OFF"
xset -display $DISPLAY dpms force off
else
echo "[`date`] Turning display ON" # shows up in log
xset -display $DISPLAY dpms force on # turn monitor on
xset -display $DISPLAY s activate # un-blank monitor
fi

#clean up
unset STATUS

# comment this line out if you're manually running this script from a shell (put a # in front of it)
unset DISPLAY

exit 0

An alternative is to call radeontool (if you have a radeon videocard only of course)

==Troubleshooting==
*If something doesn't work, your first action should be a {{cmdroot|tail /var/log/acpid}}. It will tell you a lot about what is going on. If it has "Permission denied" errors, check the permissions of your {{path|/etc/acpi/actions}} scripts (especially make sure that the executable bit is set). Also check the permissions for other involved files like i.e. device nodes.
*For further problems look at the [[Problems with ACPI suspend-to-ram|Problems with ACPI suspend-to-ram page]].

[[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:Z60t]] [[Category:Z60m]] [[Category:TransNote]]

How to configure acpid

2007-09-02T19:20:14Z

Csawtell: /* Event Script */

__TOC__
==Introduction==
Basically, [[acpid]] just executes scripts residing in {{path|/etc/acpi/actions}}. Which script to launch at which event is configured in several files in {{path|/etc/acpi/events}}. All actions are documented in {{path|/var/log/acpid}}.

==Sources of Information==
*{{cmduser|man acpid}} holds detailed information on how to configure acpid.
*The [[ibm-acpi]] package includes example scripts in the {{path|config}} folder inside the tarball. They are a good starting point to adjust them to your needs.
*You also might want to have a look at the [[Configs#ACPI | ACPI section of the Configs page]] or the [[:Category:Scripts|Scripts]] repository.
*And you can find information about the event strings [[ibm-acpi]] generates for certain keys at the [[How to get special keys to work#ibm-acpi_events | Special Keys HOWTO]].

==Example: go to sleep on lid close==
To make the ThinkPad go to sleep when you close the lid, you need to add
an event handler for the lid event and an action script that takes care
of going to sleep and resuming.

===Event Script===
The event script needs to be created within {{path|/etc/acpi/events}} and can have any name you like.
In this case we call it lid because it will trigger the lid event. Do {{cmdroot|vi /etc/acpi/events/lid}} and make it look like this:
event=button/lid
action=/etc/acpi/actions/sleep.sh %e

The "event" line is a regular expression specifying the events we're
interested in. You can determine what the event strings are from looking at
{{path|/var/log/acpid}} after trying to suspend, close the lid, etc. .
You can find information about the event strings [[ibm-acpi]] generates for certain keys at the [[How to get special keys to work#ibm-acpi_events | Special Keys HOWTO]].

The "action" line is the command to be executed when these events are
dispatched. In this example we call the {{path|sleep.sh}} script residing in {{path|/etc/acpi/actions}} and pass the event description text using the %e placeholder.

For the script you can use the <tt>hibernate</tt> script of [http://www.tuxonice.net/ Tux On Ice] (it is independent of the [[Tux on Ice | suspend-to-disk]] functionality), or any of many examples available on the web, such as the one below.

{{NOTE|To make your changes take effect after adding or modifying the events files you must do a <tt>kill -SIGHUP `pidof acpid`</tt>}}

===Action Script===
Our example {{path|/etc/acpi/actions/sleep.sh}} script looks as follows:

#!/bin/sh

# if launched through a lid event and lid is open, do nothing
echo "$1" | grep "button/lid" && grep -q open /proc/acpi/button/lid/LID/state && exit 0

# remove USB 1.1 driver
rmmod uhci_hcd

# sync filesystem and clock
sync
/sbin/hwclock --systohc

# switch to console
FGCONSOLE=`fgconsole`
chvt 6
/usr/sbin/radeontool light off

# go to sleep
sleep 5 && echo -n "mem" > /sys/power/state

# readjust the clock (it might be off a bit after suspend)
/sbin/hwclock --adjust
/sbin/hwclock --hctosys

# reload USB 1.1 driver
modprobe uhci_hcd

# turn on the backlight and switch back to X
radeontool light on
chvt $FGCONSOLE

{{NOTE|This parts of this script are now part of some distributions, like Debian Etch and you probably don't need to add this script. Look into /etc/acpi/lid.sh, for example.}}

====Explanations====
*The lid generates an event for both opening and closing thus requiring that we check its state and only act if it's closed.
*There have been problems encountered with the USB devices not working properly after a resume from suspend. To circumvent those we remove the USB driver prior to suspend and reload it afterwards.
*Note that the {{cmdroot|echo -n "mem" > /sys/power/state}} line does not return until we are revived. So there is only one event generated and there is no need to check the state of anything.
*The console switching code in this script is a special solution for [[Problem with LCD backlight remaining on during ACPI sleep|a problem where the backlight doesn't switch off]] on the {{T30}} and some other models. Before going to sleep, these models switch to console mode which causes the backlight to come back on. So we preemptively switch to console mode and turn off the backlight using [[radeontool]] before going to sleep.

==Screen blanking script==

You might want to be able to switch of the screen using Fn-f3.
This is not completely straightforward.
You will first need to give permission to the script to muck around with your screen

xhost +local:root

/etc/acpi/events/sleepbtn
contains
event=(button[ /]sleep|ibm/hotkey HKEY 00000080 00001004)
action=/etc/acpi/sleepbtn.sh

And /etc/acpi/sleepbtn.sh is

#!/bin/bash

# simple script to turn the display on or off #
# By Mahram Z.Foadi #
# Oct 22 2005 #
# thank you linuxquestions.org #
# #
# the following lines must be present in your "/etc/acpi/events/" files. Some #
# systems already have a file called sample.conf in the mentioned directory #
# rename it to something more meaningful (i.e. acpid.conf) and these lines to #
# the end of it (you don't HAVE to rename it, you can even create a new file #
# and call it /etc/acpi/events/lid.conf with the 2 lines in it. If you intend #
# to put this file anywhere other than /sbin/lidevent, make sure you make the #
# proper changes in the "action" line below. For example if you are going to #
# save this script as /usr/bin/mylid.sh then the action line should be: #
# action=/usr/bin/mylid.sh #
# be sure both files are executable, writable, and owned by root ONLY because #
# the acpid daemon is most likely running as root in your system #
# #
# ---- insert the two lines below in /etc/acpi/events/acpid.conf ---- #
# event=button/lid.* #
# action=/sbin/lidevent #
#-----------------------------------------------------------------------------#

# default display on current host
DISPLAY=:0.0

# find out if DPMS is enabled
STATUS=`xset -display $DISPLAY -q | grep -e 'DPMS is'`

# enable DPMS if disabled
if [ "$STATUS" == " DPMS is Disabled" ]
then
echo "Enabling DPMS ..."
xset -display $DISPLAY +dpms
fi

# find out if monitor is on
STATUS=`xset -display $DISPLAY -q | grep 'Monitor'`

if [ "$STATUS" == " Monitor is On" ]
then
echo "[`date`] Turning display OFF"
xset -display $DISPLAY dpms force off
else
echo "[`date`] Turning display ON" # shows up in log
xset -display $DISPLAY dpms force on # turn monitor on
xset -display $DISPLAY s activate # un-blank monitor
fi

#clean up
unset STATUS

# comment this line out if you're manually running this script from a shell (put a # in front of it)
unset DISPLAY

exit 0

An alternative is to call radeontool (if you have a radeon videocard only of course)

==Troubleshooting==
*If something doesn't work, your first action should be a {{cmdroot|tail /var/log/acpid}}. It will tell you a lot about what is going on. If it has "Permission denied" errors, check the permissions of your {{path|/etc/acpi/actions}} scripts (especially make sure that the executable bit is set). Also check the permissions for other involved files like i.e. device nodes.
*For further problems look at the [[Problems with ACPI suspend-to-ram|Problems with ACPI suspend-to-ram page]].

[[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:Z60t]] [[Category:Z60m]] [[Category:TransNote]]

TuxOnIce

2007-09-02T09:12:57Z

Csawtell: /* Availability / Project Homepage */

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

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

It also have the following advantages over [[swsusp]] (these features are also provided, in principle, by the not-yet-stable [[uswsusp]]):
* The ability to compress the memory image as it is written to disk, thereby reducing suspend and resume times.
* Control over amount of RAM written to disk -- can (optionally) discard cached disk blocks to reduce suspend and resume times.
* Textual and graphical UI (optional).

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

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

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| Suspend2 Version
! style="background:#efefef;"| Success
! style="background:#efefef;"| Note
|- style="background: white; color:black;"

| {{240}}
| 2609-21G
| Zenwalk 4.2
| 2.6.18.6
| 2.2.9
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T60p}}
|
|
| 2.6.18.1
| 2.2.9
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf, SATA mode set to compatibility in BIOS and the DMA fix from [[Problems with SATA and Linux]]
|- style="background: white; color:black;"
| {{T60}}
| 2007-77G
|
| 2.6.17.14
| 2.2.7.4
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf
|- style="background: white;"
| {{T42}}
|
|
|
|
! style ="color:green;"| Yes
| Might require "ProcSetting full_pageset2 1" in hibernate.conf. Fixed in 2.2.9.3
|- style="background: white; color:black;"
| {{T43}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T21}}
|
|
|
|
! style ="color:green;"| Yes
| need to unload the sound module (<tt>snd-cs46xx</tt>) on suspend. May want to enable UseDummyXServer if running X
|- style="background: white; color:black;"
| {{T21}}
| 2647-4BG
| Ubuntu 6.10 Edgy Eft
| 2.6.17.10
| 2.2.7.6
! style ="color:green;"| Yes
| I used experimental [http://3v1n0.tuxfamily.org/dists/edgy/suspend2/ Trevino's kernel packages]
|- style="background: white; color:black;"
| {{X41T}}
|
| Fedore Core 4
|
|
! style ="color:green;"| Yes
| requires SATA resume patch and the SATA drivers compiled as built-in or in initrd (see [[Problems with SATA and Linux]]) and a {{path|hibernate.conf}} fix (see [[Installing Fedora Core 4 on a ThinkPad X41 Tablet]])
|- style="background: white; color:black;"
| {{X22}}
|
| Ubuntu Breezy
|
|
! style ="color:green;"| Yes
| see [[Installing Ubuntu (Breezy) on a ThinkPad X22]]
|- style="background: white; color:black;"
| {{G41}}
|
|
|
|
! style ="color:green;"| Yes
| see [[Installing Debian on a ThinkPad G41]]
|- style="background: white; color:black;"
| {{R51}}
| 1829
|
| 2.6.19.1-suspend2-2.2.9
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{R51e}}
|
|
| 2.6.16-suspend2-r8
|
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 8000" in hibernate.conf
|- style="background: white; color:black;"
| {{R52}}
|
|
| 2.6.17.1
| 2.2.7
! style ="color:green;"| Yes
| FC5 with kernel [http://mhensler.de/swsusp/download_en.php 2.6.17-1.2145_1.rhfc5.cubbi_suspend2]
|- style="background: white; color:black;"
| {{T23}}
| 2647-9KU
| Debian Etch
| 2.6.17.4
| 2.2.7
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.17.13
| 2.2.8
! style ="color:green;"| Yes
|I use the [http://iphitus.loudas.com/beyond.html beyond] patchset
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-E8G
| Gentoo GNU/Linux
| 2.6.20.1
| 2.2.9
! style ="color:green;"| Yes
| gentoo-sources-2.6.20-r8 with swsusp2 2.2.9 and some other patches. Suspend to disk worked ootb (also I tried 2.6.16 / swsusp2 2.2.5 and 2.6.19 / swsusp 2.2.9), but suspend to ram does not (a resume from hibernate-ram results in a fucked up X - console works). Workaround: Use acpi for suspend to ram: echo mem > /sys/power/state
|
|- style="background: white; color:black;"
|{{Z61m}}
| 9452-CTO
| Kubuntu Edgy
| 2.6.17.10-generic
| 2.2.9 from experimental repository from http://3v1n0.tuxfamily.org/dists/edgy/suspend2/
! style ="color:green;"| Yes
| I have blacklisted these modules: tg3, tp_smapi, hdaps, uhci_hcd (fingerprintreader would not go into suspend), sdhci. More options in the hibernate scripts are "IbmAcpi" and "ProcSetting extra_pages_allowance 15000". SATA mode set to compatibility in BIOS
|
|}

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

===Modifying the initrd generation scripts, and recreate initrd===
If your systems uses an <tt>initrd</tt> file (most do), you'll need to patch or replace your <tt>initrd</tt>-creation script.

*{{Fedora}} 4: in {{path|/sbin/mkinitrd}}, find this line:
echo "echo Mounted /proc filesystem" >> $RCFILE
and add the following immediately afterwards:
echo "echo > /sys/power/suspend2/do_resume" >>$RCFILE
*{{Fedora}} 5: in {{path|/sbin/mkinitrd}}, find this line:
if [ -z "$noresume" -a -n "$swsuspdev" ]; then
and add the following immediately ''before'' the above:
emit "echo 1 > /sys/power/suspend2/do_resume"
You can also use the [http://atrpms.net/dist/fc5/mkinitrd-suspend2/ mkinitrd-suspend2] package from atrpms.
*{{Debian}}: If your system uses mkinitrd to create the initrd, copy [http://dagobah.ucc.asn.au/swsusp/2.0.0.102/swsusp-initrd.sh swsusp-initrd.sh] script to your {{path|/etc/mkinitrd/scripts}} directory before creating initrd image. If you use initramfs-tools, put a similar script into {{path|/etc/initramfs-tools/scripts/local-top/}} (the manpage of initramfs has templates of example "boot scripts")

In any case, make sure you regenerate your <tt>initrd</tt> file by reinstalling the kernel package or explicitly with mkinitrd or mkinitramfs commands.

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

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

==Configuration tips==
=== Crash fix ===
To avoid pages being resaved during suspend use kernel 2.6.19.2 and suspend2 2.2.9.1 (not stable yet)
OR add the following to
{{path|/etc/hibernate/suspend2.conf:}}
ProcSetting full_pageset2 1
===RediSafe-like functionality===
The hibernate functionality on some ThinkPad BIOSes offers the useful "RediSafe" feature, which suspends to both RAM and disk. This way you get quick resumes (directly from RAM), plus the safey of suspend-to-disk in case the battery runs out.

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

===Be aware of possible filesystem corruption scenarios===
Certain usage scenarios can cause filesystem corruption with suspend2. Some details on this are in [http://www.tuxonice.net/HOWTO-4.html#ss4 the project's HOWTO]. None of the workaround configurations fix the problem satisfactorily, so be warned. In particular, with an ext3 root filesystem, if you suspend to swap partition, and then use sysrescCD/Knoppix/some other way to mount the root filesystem read-only, you risk data corruption when you try to resume from the suspended image.

As far as possible, after suspending the system, don't touch the root filesystem unless you are resuming from it :)
[[Category:Patches]] [[Category:Drivers]]

===ACPI Problem===
Also see [[Problems with ACPI suspend-to-ram]]

TuxOnIce

2007-09-02T09:09:43Z

Csawtell: /* Be aware of possible filesystem corruption scenarios */

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

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

It also have the following advantages over [[swsusp]] (these features are also provided, in principle, by the not-yet-stable [[uswsusp]]):
* The ability to compress the memory image as it is written to disk, thereby reducing suspend and resume times.
* Control over amount of RAM written to disk -- can (optionally) discard cached disk blocks to reduce suspend and resume times.
* Textual and graphical UI (optional).

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

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

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| Suspend2 Version
! style="background:#efefef;"| Success
! style="background:#efefef;"| Note
|- style="background: white; color:black;"

| {{240}}
| 2609-21G
| Zenwalk 4.2
| 2.6.18.6
| 2.2.9
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T60p}}
|
|
| 2.6.18.1
| 2.2.9
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf, SATA mode set to compatibility in BIOS and the DMA fix from [[Problems with SATA and Linux]]
|- style="background: white; color:black;"
| {{T60}}
| 2007-77G
|
| 2.6.17.14
| 2.2.7.4
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf
|- style="background: white;"
| {{T42}}
|
|
|
|
! style ="color:green;"| Yes
| Might require "ProcSetting full_pageset2 1" in hibernate.conf. Fixed in 2.2.9.3
|- style="background: white; color:black;"
| {{T43}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T21}}
|
|
|
|
! style ="color:green;"| Yes
| need to unload the sound module (<tt>snd-cs46xx</tt>) on suspend. May want to enable UseDummyXServer if running X
|- style="background: white; color:black;"
| {{T21}}
| 2647-4BG
| Ubuntu 6.10 Edgy Eft
| 2.6.17.10
| 2.2.7.6
! style ="color:green;"| Yes
| I used experimental [http://3v1n0.tuxfamily.org/dists/edgy/suspend2/ Trevino's kernel packages]
|- style="background: white; color:black;"
| {{X41T}}
|
| Fedore Core 4
|
|
! style ="color:green;"| Yes
| requires SATA resume patch and the SATA drivers compiled as built-in or in initrd (see [[Problems with SATA and Linux]]) and a {{path|hibernate.conf}} fix (see [[Installing Fedora Core 4 on a ThinkPad X41 Tablet]])
|- style="background: white; color:black;"
| {{X22}}
|
| Ubuntu Breezy
|
|
! style ="color:green;"| Yes
| see [[Installing Ubuntu (Breezy) on a ThinkPad X22]]
|- style="background: white; color:black;"
| {{G41}}
|
|
|
|
! style ="color:green;"| Yes
| see [[Installing Debian on a ThinkPad G41]]
|- style="background: white; color:black;"
| {{R51}}
| 1829
|
| 2.6.19.1-suspend2-2.2.9
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{R51e}}
|
|
| 2.6.16-suspend2-r8
|
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 8000" in hibernate.conf
|- style="background: white; color:black;"
| {{R52}}
|
|
| 2.6.17.1
| 2.2.7
! style ="color:green;"| Yes
| FC5 with kernel [http://mhensler.de/swsusp/download_en.php 2.6.17-1.2145_1.rhfc5.cubbi_suspend2]
|- style="background: white; color:black;"
| {{T23}}
| 2647-9KU
| Debian Etch
| 2.6.17.4
| 2.2.7
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.17.13
| 2.2.8
! style ="color:green;"| Yes
|I use the [http://iphitus.loudas.com/beyond.html beyond] patchset
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-E8G
| Gentoo GNU/Linux
| 2.6.20.1
| 2.2.9
! style ="color:green;"| Yes
| gentoo-sources-2.6.20-r8 with swsusp2 2.2.9 and some other patches. Suspend to disk worked ootb (also I tried 2.6.16 / swsusp2 2.2.5 and 2.6.19 / swsusp 2.2.9), but suspend to ram does not (a resume from hibernate-ram results in a fucked up X - console works). Workaround: Use acpi for suspend to ram: echo mem > /sys/power/state
|
|- style="background: white; color:black;"
|{{Z61m}}
| 9452-CTO
| Kubuntu Edgy
| 2.6.17.10-generic
| 2.2.9 from experimental repository from http://3v1n0.tuxfamily.org/dists/edgy/suspend2/
! style ="color:green;"| Yes
| I have blacklisted these modules: tg3, tp_smapi, hdaps, uhci_hcd (fingerprintreader would not go into suspend), sdhci. More options in the hibernate scripts are "IbmAcpi" and "ProcSetting extra_pages_allowance 15000". SATA mode set to compatibility in BIOS
|
|}

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

===Modifying the initrd generation scripts, and recreate initrd===
If your systems uses an <tt>initrd</tt> file (most do), you'll need to patch or replace your <tt>initrd</tt>-creation script.

*{{Fedora}} 4: in {{path|/sbin/mkinitrd}}, find this line:
echo "echo Mounted /proc filesystem" >> $RCFILE
and add the following immediately afterwards:
echo "echo > /sys/power/suspend2/do_resume" >>$RCFILE
*{{Fedora}} 5: in {{path|/sbin/mkinitrd}}, find this line:
if [ -z "$noresume" -a -n "$swsuspdev" ]; then
and add the following immediately ''before'' the above:
emit "echo 1 > /sys/power/suspend2/do_resume"
You can also use the [http://atrpms.net/dist/fc5/mkinitrd-suspend2/ mkinitrd-suspend2] package from atrpms.
*{{Debian}}: If your system uses mkinitrd to create the initrd, copy [http://dagobah.ucc.asn.au/swsusp/2.0.0.102/swsusp-initrd.sh swsusp-initrd.sh] script to your {{path|/etc/mkinitrd/scripts}} directory before creating initrd image. If you use initramfs-tools, put a similar script into {{path|/etc/initramfs-tools/scripts/local-top/}} (the manpage of initramfs has templates of example "boot scripts")

In any case, make sure you regenerate your <tt>initrd</tt> file by reinstalling the kernel package or explicitly with mkinitrd or mkinitramfs commands.

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

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

==Configuration tips==
=== Crash fix ===
To avoid pages being resaved during suspend use kernel 2.6.19.2 and suspend2 2.2.9.1 (not stable yet)
OR add the following to
{{path|/etc/hibernate/suspend2.conf:}}
ProcSetting full_pageset2 1
===RediSafe-like functionality===
The hibernate functionality on some ThinkPad BIOSes offers the useful "RediSafe" feature, which suspends to both RAM and disk. This way you get quick resumes (directly from RAM), plus the safey of suspend-to-disk in case the battery runs out.

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

===Be aware of possible filesystem corruption scenarios===
Certain usage scenarios can cause filesystem corruption with suspend2. Some details on this are in [http://www.tuxonice.net/HOWTO-4.html#ss4 the project's HOWTO]. None of the workaround configurations fix the problem satisfactorily, so be warned. In particular, with an ext3 root filesystem, if you suspend to swap partition, and then use sysrescCD/Knoppix/some other way to mount the root filesystem read-only, you risk data corruption when you try to resume from the suspended image.

As far as possible, after suspending the system, don't touch the root filesystem unless you are resuming from it :)
[[Category:Patches]] [[Category:Drivers]]

===ACPI Problem===
Also see [[Problems with ACPI suspend-to-ram]]

TuxOnIce

2007-09-02T09:07:43Z

Csawtell: /* Availability */

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

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

It also have the following advantages over [[swsusp]] (these features are also provided, in principle, by the not-yet-stable [[uswsusp]]):
* The ability to compress the memory image as it is written to disk, thereby reducing suspend and resume times.
* Control over amount of RAM written to disk -- can (optionally) discard cached disk blocks to reduce suspend and resume times.
* Textual and graphical UI (optional).

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

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

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| Suspend2 Version
! style="background:#efefef;"| Success
! style="background:#efefef;"| Note
|- style="background: white; color:black;"

| {{240}}
| 2609-21G
| Zenwalk 4.2
| 2.6.18.6
| 2.2.9
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T60p}}
|
|
| 2.6.18.1
| 2.2.9
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf, SATA mode set to compatibility in BIOS and the DMA fix from [[Problems with SATA and Linux]]
|- style="background: white; color:black;"
| {{T60}}
| 2007-77G
|
| 2.6.17.14
| 2.2.7.4
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf
|- style="background: white;"
| {{T42}}
|
|
|
|
! style ="color:green;"| Yes
| Might require "ProcSetting full_pageset2 1" in hibernate.conf. Fixed in 2.2.9.3
|- style="background: white; color:black;"
| {{T43}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T21}}
|
|
|
|
! style ="color:green;"| Yes
| need to unload the sound module (<tt>snd-cs46xx</tt>) on suspend. May want to enable UseDummyXServer if running X
|- style="background: white; color:black;"
| {{T21}}
| 2647-4BG
| Ubuntu 6.10 Edgy Eft
| 2.6.17.10
| 2.2.7.6
! style ="color:green;"| Yes
| I used experimental [http://3v1n0.tuxfamily.org/dists/edgy/suspend2/ Trevino's kernel packages]
|- style="background: white; color:black;"
| {{X41T}}
|
| Fedore Core 4
|
|
! style ="color:green;"| Yes
| requires SATA resume patch and the SATA drivers compiled as built-in or in initrd (see [[Problems with SATA and Linux]]) and a {{path|hibernate.conf}} fix (see [[Installing Fedora Core 4 on a ThinkPad X41 Tablet]])
|- style="background: white; color:black;"
| {{X22}}
|
| Ubuntu Breezy
|
|
! style ="color:green;"| Yes
| see [[Installing Ubuntu (Breezy) on a ThinkPad X22]]
|- style="background: white; color:black;"
| {{G41}}
|
|
|
|
! style ="color:green;"| Yes
| see [[Installing Debian on a ThinkPad G41]]
|- style="background: white; color:black;"
| {{R51}}
| 1829
|
| 2.6.19.1-suspend2-2.2.9
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{R51e}}
|
|
| 2.6.16-suspend2-r8
|
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 8000" in hibernate.conf
|- style="background: white; color:black;"
| {{R52}}
|
|
| 2.6.17.1
| 2.2.7
! style ="color:green;"| Yes
| FC5 with kernel [http://mhensler.de/swsusp/download_en.php 2.6.17-1.2145_1.rhfc5.cubbi_suspend2]
|- style="background: white; color:black;"
| {{T23}}
| 2647-9KU
| Debian Etch
| 2.6.17.4
| 2.2.7
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.17.13
| 2.2.8
! style ="color:green;"| Yes
|I use the [http://iphitus.loudas.com/beyond.html beyond] patchset
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-E8G
| Gentoo GNU/Linux
| 2.6.20.1
| 2.2.9
! style ="color:green;"| Yes
| gentoo-sources-2.6.20-r8 with swsusp2 2.2.9 and some other patches. Suspend to disk worked ootb (also I tried 2.6.16 / swsusp2 2.2.5 and 2.6.19 / swsusp 2.2.9), but suspend to ram does not (a resume from hibernate-ram results in a fucked up X - console works). Workaround: Use acpi for suspend to ram: echo mem > /sys/power/state
|
|- style="background: white; color:black;"
|{{Z61m}}
| 9452-CTO
| Kubuntu Edgy
| 2.6.17.10-generic
| 2.2.9 from experimental repository from http://3v1n0.tuxfamily.org/dists/edgy/suspend2/
! style ="color:green;"| Yes
| I have blacklisted these modules: tg3, tp_smapi, hdaps, uhci_hcd (fingerprintreader would not go into suspend), sdhci. More options in the hibernate scripts are "IbmAcpi" and "ProcSetting extra_pages_allowance 15000". SATA mode set to compatibility in BIOS
|
|}

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

===Modifying the initrd generation scripts, and recreate initrd===
If your systems uses an <tt>initrd</tt> file (most do), you'll need to patch or replace your <tt>initrd</tt>-creation script.

*{{Fedora}} 4: in {{path|/sbin/mkinitrd}}, find this line:
echo "echo Mounted /proc filesystem" >> $RCFILE
and add the following immediately afterwards:
echo "echo > /sys/power/suspend2/do_resume" >>$RCFILE
*{{Fedora}} 5: in {{path|/sbin/mkinitrd}}, find this line:
if [ -z "$noresume" -a -n "$swsuspdev" ]; then
and add the following immediately ''before'' the above:
emit "echo 1 > /sys/power/suspend2/do_resume"
You can also use the [http://atrpms.net/dist/fc5/mkinitrd-suspend2/ mkinitrd-suspend2] package from atrpms.
*{{Debian}}: If your system uses mkinitrd to create the initrd, copy [http://dagobah.ucc.asn.au/swsusp/2.0.0.102/swsusp-initrd.sh swsusp-initrd.sh] script to your {{path|/etc/mkinitrd/scripts}} directory before creating initrd image. If you use initramfs-tools, put a similar script into {{path|/etc/initramfs-tools/scripts/local-top/}} (the manpage of initramfs has templates of example "boot scripts")

In any case, make sure you regenerate your <tt>initrd</tt> file by reinstalling the kernel package or explicitly with mkinitrd or mkinitramfs commands.

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

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

==Configuration tips==
=== Crash fix ===
To avoid pages being resaved during suspend use kernel 2.6.19.2 and suspend2 2.2.9.1 (not stable yet)
OR add the following to
{{path|/etc/hibernate/suspend2.conf:}}
ProcSetting full_pageset2 1
===RediSafe-like functionality===
The hibernate functionality on some ThinkPad BIOSes offers the useful "RediSafe" feature, which suspends to both RAM and disk. This way you get quick resumes (directly from RAM), plus the safey of suspend-to-disk in case the battery runs out.

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

===Be aware of possible filesystem corruption scenarios===
Certain usage scenarios can cause filesystem corruption with suspend2. Some details on this are in [http://www.suspend2.net/HOWTO-4.html#ss4 the project's HOWTO]. None of the workaround configurations fix the problem satisfactorily, so be warned. In particular, with an ext3 root filesystem, if you suspend to swap partition, and then use sysrescCD/Knoppix/some other way to mount the root filesystem read-only, you risk data corruption when you try to resume from the suspended image.

As far as possible, after suspending the system, don't touch the root filesystem unless you are resuming from it :)
[[Category:Patches]] [[Category:Drivers]]

===ACPI Problem===
Also see [[Problems with ACPI suspend-to-ram]]

TuxOnIce

2007-09-02T09:06:00Z

Csawtell: /* Installation Instructions */

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

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

It also have the following advantages over [[swsusp]] (these features are also provided, in principle, by the not-yet-stable [[uswsusp]]):
* The ability to compress the memory image as it is written to disk, thereby reducing suspend and resume times.
* Control over amount of RAM written to disk -- can (optionally) discard cached disk blocks to reduce suspend and resume times.
* Textual and graphical UI (optional).

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

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

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| Suspend2 Version
! style="background:#efefef;"| Success
! style="background:#efefef;"| Note
|- style="background: white; color:black;"

| {{240}}
| 2609-21G
| Zenwalk 4.2
| 2.6.18.6
| 2.2.9
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T60p}}
|
|
| 2.6.18.1
| 2.2.9
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf, SATA mode set to compatibility in BIOS and the DMA fix from [[Problems with SATA and Linux]]
|- style="background: white; color:black;"
| {{T60}}
| 2007-77G
|
| 2.6.17.14
| 2.2.7.4
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf
|- style="background: white;"
| {{T42}}
|
|
|
|
! style ="color:green;"| Yes
| Might require "ProcSetting full_pageset2 1" in hibernate.conf. Fixed in 2.2.9.3
|- style="background: white; color:black;"
| {{T43}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T21}}
|
|
|
|
! style ="color:green;"| Yes
| need to unload the sound module (<tt>snd-cs46xx</tt>) on suspend. May want to enable UseDummyXServer if running X
|- style="background: white; color:black;"
| {{T21}}
| 2647-4BG
| Ubuntu 6.10 Edgy Eft
| 2.6.17.10
| 2.2.7.6
! style ="color:green;"| Yes
| I used experimental [http://3v1n0.tuxfamily.org/dists/edgy/suspend2/ Trevino's kernel packages]
|- style="background: white; color:black;"
| {{X41T}}
|
| Fedore Core 4
|
|
! style ="color:green;"| Yes
| requires SATA resume patch and the SATA drivers compiled as built-in or in initrd (see [[Problems with SATA and Linux]]) and a {{path|hibernate.conf}} fix (see [[Installing Fedora Core 4 on a ThinkPad X41 Tablet]])
|- style="background: white; color:black;"
| {{X22}}
|
| Ubuntu Breezy
|
|
! style ="color:green;"| Yes
| see [[Installing Ubuntu (Breezy) on a ThinkPad X22]]
|- style="background: white; color:black;"
| {{G41}}
|
|
|
|
! style ="color:green;"| Yes
| see [[Installing Debian on a ThinkPad G41]]
|- style="background: white; color:black;"
| {{R51}}
| 1829
|
| 2.6.19.1-suspend2-2.2.9
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{R51e}}
|
|
| 2.6.16-suspend2-r8
|
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 8000" in hibernate.conf
|- style="background: white; color:black;"
| {{R52}}
|
|
| 2.6.17.1
| 2.2.7
! style ="color:green;"| Yes
| FC5 with kernel [http://mhensler.de/swsusp/download_en.php 2.6.17-1.2145_1.rhfc5.cubbi_suspend2]
|- style="background: white; color:black;"
| {{T23}}
| 2647-9KU
| Debian Etch
| 2.6.17.4
| 2.2.7
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.17.13
| 2.2.8
! style ="color:green;"| Yes
|I use the [http://iphitus.loudas.com/beyond.html beyond] patchset
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-E8G
| Gentoo GNU/Linux
| 2.6.20.1
| 2.2.9
! style ="color:green;"| Yes
| gentoo-sources-2.6.20-r8 with swsusp2 2.2.9 and some other patches. Suspend to disk worked ootb (also I tried 2.6.16 / swsusp2 2.2.5 and 2.6.19 / swsusp 2.2.9), but suspend to ram does not (a resume from hibernate-ram results in a fucked up X - console works). Workaround: Use acpi for suspend to ram: echo mem > /sys/power/state
|
|- style="background: white; color:black;"
|{{Z61m}}
| 9452-CTO
| Kubuntu Edgy
| 2.6.17.10-generic
| 2.2.9 from experimental repository from http://3v1n0.tuxfamily.org/dists/edgy/suspend2/
! style ="color:green;"| Yes
| I have blacklisted these modules: tg3, tp_smapi, hdaps, uhci_hcd (fingerprintreader would not go into suspend), sdhci. More options in the hibernate scripts are "IbmAcpi" and "ProcSetting extra_pages_allowance 15000". SATA mode set to compatibility in BIOS
|
|}

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

===Modifying the initrd generation scripts, and recreate initrd===
If your systems uses an <tt>initrd</tt> file (most do), you'll need to patch or replace your <tt>initrd</tt>-creation script.

*{{Fedora}} 4: in {{path|/sbin/mkinitrd}}, find this line:
echo "echo Mounted /proc filesystem" >> $RCFILE
and add the following immediately afterwards:
echo "echo > /sys/power/suspend2/do_resume" >>$RCFILE
*{{Fedora}} 5: in {{path|/sbin/mkinitrd}}, find this line:
if [ -z "$noresume" -a -n "$swsuspdev" ]; then
and add the following immediately ''before'' the above:
emit "echo 1 > /sys/power/suspend2/do_resume"
You can also use the [http://atrpms.net/dist/fc5/mkinitrd-suspend2/ mkinitrd-suspend2] package from atrpms.
*{{Debian}}: If your system uses mkinitrd to create the initrd, copy [http://dagobah.ucc.asn.au/swsusp/2.0.0.102/swsusp-initrd.sh swsusp-initrd.sh] script to your {{path|/etc/mkinitrd/scripts}} directory before creating initrd image. If you use initramfs-tools, put a similar script into {{path|/etc/initramfs-tools/scripts/local-top/}} (the manpage of initramfs has templates of example "boot scripts")

In any case, make sure you regenerate your <tt>initrd</tt> file by reinstalling the kernel package or explicitly with mkinitrd or mkinitramfs commands.

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

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

==Configuration tips==
=== Crash fix ===
To avoid pages being resaved during suspend use kernel 2.6.19.2 and suspend2 2.2.9.1 (not stable yet)
OR add the following to
{{path|/etc/hibernate/suspend2.conf:}}
ProcSetting full_pageset2 1
===RediSafe-like functionality===
The hibernate functionality on some ThinkPad BIOSes offers the useful "RediSafe" feature, which suspends to both RAM and disk. This way you get quick resumes (directly from RAM), plus the safey of suspend-to-disk in case the battery runs out.

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

===Be aware of possible filesystem corruption scenarios===
Certain usage scenarios can cause filesystem corruption with suspend2. Some details on this are in [http://www.suspend2.net/HOWTO-4.html#ss4 the project's HOWTO]. None of the workaround configurations fix the problem satisfactorily, so be warned. In particular, with an ext3 root filesystem, if you suspend to swap partition, and then use sysrescCD/Knoppix/some other way to mount the root filesystem read-only, you risk data corruption when you try to resume from the suspended image.

As far as possible, after suspending the system, don't touch the root filesystem unless you are resuming from it :)
[[Category:Patches]] [[Category:Drivers]]

===ACPI Problem===
Also see [[Problems with ACPI suspend-to-ram]]

TuxOnIce

2007-09-02T09:03:51Z

Csawtell: /* Installation Instructions */

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

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

It also have the following advantages over [[swsusp]] (these features are also provided, in principle, by the not-yet-stable [[uswsusp]]):
* The ability to compress the memory image as it is written to disk, thereby reducing suspend and resume times.
* Control over amount of RAM written to disk -- can (optionally) discard cached disk blocks to reduce suspend and resume times.
* Textual and graphical UI (optional).

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

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

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| Suspend2 Version
! style="background:#efefef;"| Success
! style="background:#efefef;"| Note
|- style="background: white; color:black;"

| {{240}}
| 2609-21G
| Zenwalk 4.2
| 2.6.18.6
| 2.2.9
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T60p}}
|
|
| 2.6.18.1
| 2.2.9
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf, SATA mode set to compatibility in BIOS and the DMA fix from [[Problems with SATA and Linux]]
|- style="background: white; color:black;"
| {{T60}}
| 2007-77G
|
| 2.6.17.14
| 2.2.7.4
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf
|- style="background: white;"
| {{T42}}
|
|
|
|
! style ="color:green;"| Yes
| Might require "ProcSetting full_pageset2 1" in hibernate.conf. Fixed in 2.2.9.3
|- style="background: white; color:black;"
| {{T43}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T21}}
|
|
|
|
! style ="color:green;"| Yes
| need to unload the sound module (<tt>snd-cs46xx</tt>) on suspend. May want to enable UseDummyXServer if running X
|- style="background: white; color:black;"
| {{T21}}
| 2647-4BG
| Ubuntu 6.10 Edgy Eft
| 2.6.17.10
| 2.2.7.6
! style ="color:green;"| Yes
| I used experimental [http://3v1n0.tuxfamily.org/dists/edgy/suspend2/ Trevino's kernel packages]
|- style="background: white; color:black;"
| {{X41T}}
|
| Fedore Core 4
|
|
! style ="color:green;"| Yes
| requires SATA resume patch and the SATA drivers compiled as built-in or in initrd (see [[Problems with SATA and Linux]]) and a {{path|hibernate.conf}} fix (see [[Installing Fedora Core 4 on a ThinkPad X41 Tablet]])
|- style="background: white; color:black;"
| {{X22}}
|
| Ubuntu Breezy
|
|
! style ="color:green;"| Yes
| see [[Installing Ubuntu (Breezy) on a ThinkPad X22]]
|- style="background: white; color:black;"
| {{G41}}
|
|
|
|
! style ="color:green;"| Yes
| see [[Installing Debian on a ThinkPad G41]]
|- style="background: white; color:black;"
| {{R51}}
| 1829
|
| 2.6.19.1-suspend2-2.2.9
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{R51e}}
|
|
| 2.6.16-suspend2-r8
|
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 8000" in hibernate.conf
|- style="background: white; color:black;"
| {{R52}}
|
|
| 2.6.17.1
| 2.2.7
! style ="color:green;"| Yes
| FC5 with kernel [http://mhensler.de/swsusp/download_en.php 2.6.17-1.2145_1.rhfc5.cubbi_suspend2]
|- style="background: white; color:black;"
| {{T23}}
| 2647-9KU
| Debian Etch
| 2.6.17.4
| 2.2.7
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.17.13
| 2.2.8
! style ="color:green;"| Yes
|I use the [http://iphitus.loudas.com/beyond.html beyond] patchset
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-E8G
| Gentoo GNU/Linux
| 2.6.20.1
| 2.2.9
! style ="color:green;"| Yes
| gentoo-sources-2.6.20-r8 with swsusp2 2.2.9 and some other patches. Suspend to disk worked ootb (also I tried 2.6.16 / swsusp2 2.2.5 and 2.6.19 / swsusp 2.2.9), but suspend to ram does not (a resume from hibernate-ram results in a fucked up X - console works). Workaround: Use acpi for suspend to ram: echo mem > /sys/power/state
|
|- style="background: white; color:black;"
|{{Z61m}}
| 9452-CTO
| Kubuntu Edgy
| 2.6.17.10-generic
| 2.2.9 from experimental repository from http://3v1n0.tuxfamily.org/dists/edgy/suspend2/
! style ="color:green;"| Yes
| I have blacklisted these modules: tg3, tp_smapi, hdaps, uhci_hcd (fingerprintreader would not go into suspend), sdhci. More options in the hibernate scripts are "IbmAcpi" and "ProcSetting extra_pages_allowance 15000". SATA mode set to compatibility in BIOS
|
|}

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

===Modifying the initrd generation scripts, and recreate initrd===
If your systems uses an <tt>initrd</tt> file (most do), you'll need to patch or replace your <tt>initrd</tt>-creation script.

*{{Fedora}} 4: in {{path|/sbin/mkinitrd}}, find this line:
echo "echo Mounted /proc filesystem" >> $RCFILE
and add the following immediately afterwards:
echo "echo > /sys/power/suspend2/do_resume" >>$RCFILE
*{{Fedora}} 5: in {{path|/sbin/mkinitrd}}, find this line:
if [ -z "$noresume" -a -n "$swsuspdev" ]; then
and add the following immediately ''before'' the above:
emit "echo 1 > /sys/power/suspend2/do_resume"
You can also use the [http://atrpms.net/dist/fc5/mkinitrd-suspend2/ mkinitrd-suspend2] package from atrpms.
*{{Debian}}: If your system uses mkinitrd to create the initrd, copy [http://dagobah.ucc.asn.au/swsusp/2.0.0.102/swsusp-initrd.sh swsusp-initrd.sh] script to your {{path|/etc/mkinitrd/scripts}} directory before creating initrd image. If you use initramfs-tools, put a similar script into {{path|/etc/initramfs-tools/scripts/local-top/}} (the manpage of initramfs has templates of example "boot scripts")

In any case, make sure you regenerate your <tt>initrd</tt> file by reinstalling the kernel package or explicitly with mkinitrd or mkinitramfs commands.

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

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

==Configuration tips==
=== Crash fix ===
To avoid pages being resaved during suspend use kernel 2.6.19.2 and suspend2 2.2.9.1 (not stable yet)
OR add the following to
{{path|/etc/hibernate/suspend2.conf:}}
ProcSetting full_pageset2 1
===RediSafe-like functionality===
The hibernate functionality on some ThinkPad BIOSes offers the useful "RediSafe" feature, which suspends to both RAM and disk. This way you get quick resumes (directly from RAM), plus the safey of suspend-to-disk in case the battery runs out.

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

===Be aware of possible filesystem corruption scenarios===
Certain usage scenarios can cause filesystem corruption with suspend2. Some details on this are in [http://www.suspend2.net/HOWTO-4.html#ss4 the project's HOWTO]. None of the workaround configurations fix the problem satisfactorily, so be warned. In particular, with an ext3 root filesystem, if you suspend to swap partition, and then use sysrescCD/Knoppix/some other way to mount the root filesystem read-only, you risk data corruption when you try to resume from the suspended image.

As far as possible, after suspending the system, don't touch the root filesystem unless you are resuming from it :)
[[Category:Patches]] [[Category:Drivers]]

===ACPI Problem===
Also see [[Problems with ACPI suspend-to-ram]]

TuxOnIce

2007-09-02T09:02:01Z

Csawtell: /* Features */

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

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

It also have the following advantages over [[swsusp]] (these features are also provided, in principle, by the not-yet-stable [[uswsusp]]):
* The ability to compress the memory image as it is written to disk, thereby reducing suspend and resume times.
* Control over amount of RAM written to disk -- can (optionally) discard cached disk blocks to reduce suspend and resume times.
* Textual and graphical UI (optional).

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

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

==Model-specific Status==

{| align="center" cellpadding="2" width="100%" style="border:1px; background:grey;"
! style="background:#efefef;"| Thinkpad Model
! style="background:#efefef;"| Type
! style="background:#efefef;"| Operating System
! style="background:#efefef;"| Kernel Version
! style="background:#efefef;"| Suspend2 Version
! style="background:#efefef;"| Success
! style="background:#efefef;"| Note
|- style="background: white; color:black;"

| {{240}}
| 2609-21G
| Zenwalk 4.2
| 2.6.18.6
| 2.2.9
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T60p}}
|
|
| 2.6.18.1
| 2.2.9
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf, SATA mode set to compatibility in BIOS and the DMA fix from [[Problems with SATA and Linux]]
|- style="background: white; color:black;"
| {{T60}}
| 2007-77G
|
| 2.6.17.14
| 2.2.7.4
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 7500" in hibernate.conf
|- style="background: white;"
| {{T42}}
|
|
|
|
! style ="color:green;"| Yes
| Might require "ProcSetting full_pageset2 1" in hibernate.conf. Fixed in 2.2.9.3
|- style="background: white; color:black;"
| {{T43}}
|
|
|
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{T21}}
|
|
|
|
! style ="color:green;"| Yes
| need to unload the sound module (<tt>snd-cs46xx</tt>) on suspend. May want to enable UseDummyXServer if running X
|- style="background: white; color:black;"
| {{T21}}
| 2647-4BG
| Ubuntu 6.10 Edgy Eft
| 2.6.17.10
| 2.2.7.6
! style ="color:green;"| Yes
| I used experimental [http://3v1n0.tuxfamily.org/dists/edgy/suspend2/ Trevino's kernel packages]
|- style="background: white; color:black;"
| {{X41T}}
|
| Fedore Core 4
|
|
! style ="color:green;"| Yes
| requires SATA resume patch and the SATA drivers compiled as built-in or in initrd (see [[Problems with SATA and Linux]]) and a {{path|hibernate.conf}} fix (see [[Installing Fedora Core 4 on a ThinkPad X41 Tablet]])
|- style="background: white; color:black;"
| {{X22}}
|
| Ubuntu Breezy
|
|
! style ="color:green;"| Yes
| see [[Installing Ubuntu (Breezy) on a ThinkPad X22]]
|- style="background: white; color:black;"
| {{G41}}
|
|
|
|
! style ="color:green;"| Yes
| see [[Installing Debian on a ThinkPad G41]]
|- style="background: white; color:black;"
| {{R51}}
| 1829
|
| 2.6.19.1-suspend2-2.2.9
|
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
| {{R51e}}
|
|
| 2.6.16-suspend2-r8
|
! style ="color:green;"| Yes
| Requires "ProcSetting extra_pages_allowance 8000" in hibernate.conf
|- style="background: white; color:black;"
| {{R52}}
|
|
| 2.6.17.1
| 2.2.7
! style ="color:green;"| Yes
| FC5 with kernel [http://mhensler.de/swsusp/download_en.php 2.6.17-1.2145_1.rhfc5.cubbi_suspend2]
|- style="background: white; color:black;"
| {{T23}}
| 2647-9KU
| Debian Etch
| 2.6.17.4
| 2.2.7
! style ="color:green;"| Yes
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-55G
| Arch Linux
| 2.6.17.13
| 2.2.8
! style ="color:green;"| Yes
|I use the [http://iphitus.loudas.com/beyond.html beyond] patchset
|
|- style="background: white; color:black;"
|{{X60s}}
| 1702-E8G
| Gentoo GNU/Linux
| 2.6.20.1
| 2.2.9
! style ="color:green;"| Yes
| gentoo-sources-2.6.20-r8 with swsusp2 2.2.9 and some other patches. Suspend to disk worked ootb (also I tried 2.6.16 / swsusp2 2.2.5 and 2.6.19 / swsusp 2.2.9), but suspend to ram does not (a resume from hibernate-ram results in a fucked up X - console works). Workaround: Use acpi for suspend to ram: echo mem > /sys/power/state
|
|- style="background: white; color:black;"
|{{Z61m}}
| 9452-CTO
| Kubuntu Edgy
| 2.6.17.10-generic
| 2.2.9 from experimental repository from http://3v1n0.tuxfamily.org/dists/edgy/suspend2/
! style ="color:green;"| Yes
| I have blacklisted these modules: tg3, tp_smapi, hdaps, uhci_hcd (fingerprintreader would not go into suspend), sdhci. More options in the hibernate scripts are "IbmAcpi" and "ProcSetting extra_pages_allowance 15000". SATA mode set to compatibility in BIOS
|
|}

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

===Modifying the initrd generation scripts, and recreate initrd===
If your systems uses an <tt>initrd</tt> file (most do), you'll need to patch or replace your <tt>initrd</tt>-creation script.

*{{Fedora}} 4: in {{path|/sbin/mkinitrd}}, find this line:
echo "echo Mounted /proc filesystem" >> $RCFILE
and add the following immediately afterwards:
echo "echo > /sys/power/suspend2/do_resume" >>$RCFILE
*{{Fedora}} 5: in {{path|/sbin/mkinitrd}}, find this line:
if [ -z "$noresume" -a -n "$swsuspdev" ]; then
and add the following immediately ''before'' the above:
emit "echo 1 > /sys/power/suspend2/do_resume"
You can also use the [http://atrpms.net/dist/fc5/mkinitrd-suspend2/ mkinitrd-suspend2] package from atrpms.
*{{Debian}}: If your system uses mkinitrd to create the initrd, copy [http://dagobah.ucc.asn.au/swsusp/2.0.0.102/swsusp-initrd.sh swsusp-initrd.sh] script to your {{path|/etc/mkinitrd/scripts}} directory before creating initrd image. If you use initramfs-tools, put a similar script into {{path|/etc/initramfs-tools/scripts/local-top/}} (the manpage of initramfs has templates of example "boot scripts")

In any case, make sure you regenerate your <tt>initrd</tt> file by reinstalling the kernel package or explicitly with mkinitrd or mkinitramfs commands.

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

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

==Configuration tips==
=== Crash fix ===
To avoid pages being resaved during suspend use kernel 2.6.19.2 and suspend2 2.2.9.1 (not stable yet)
OR add the following to
{{path|/etc/hibernate/suspend2.conf:}}
ProcSetting full_pageset2 1
===RediSafe-like functionality===
The hibernate functionality on some ThinkPad BIOSes offers the useful "RediSafe" feature, which suspends to both RAM and disk. This way you get quick resumes (directly from RAM), plus the safey of suspend-to-disk in case the battery runs out.

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

===Be aware of possible filesystem corruption scenarios===
Certain usage scenarios can cause filesystem corruption with suspend2. Some details on this are in [http://www.suspend2.net/HOWTO-4.html#ss4 the project's HOWTO]. None of the workaround configurations fix the problem satisfactorily, so be warned. In particular, with an ext3 root filesystem, if you suspend to swap partition, and then use sysrescCD/Knoppix/some other way to mount the root filesystem read-only, you risk data corruption when you try to resume from the suspended image.

As far as possible, after suspending the system, don't touch the root filesystem unless you are resuming from it :)
[[Category:Patches]] [[Category:Drivers]]

===ACPI Problem===
Also see [[Problems with ACPI suspend-to-ram]]

How to make use of IrDA

2007-03-31T11:29:27Z

Csawtell: /* {{Gentoo}} kernel config */

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#efefef; align:right;">
The purpose of this document is to get the [[IrDA]] hardware in your ThinkPad operational, setting up communication to other devices is not covered. However, the external links section can prove useful for this.
</div>
|}

== Serial IR (SIR) ==
SIR is limited to serial datarates up to 115.2Kb/s

To use it, run {{cmdroot|irattach /dev/ttyS1 -s; modprobe ircomm-tty}} (on {{Fedora}} 5 just run {{cmdroot|service irda start}}). Then turn on your IrDA-capable device and put it within range, and point your software (e.g., <tt>minicom</tt>) to {{path|/dev/irda0}}.

===Kernel configuration===

Some distributions (e.g., {{Fedora}} 5) already include the equvialent of the following.

==== Linux 2.4 kernel config ====
Edit {{path|/etc/modules.conf}} and add the following lines
alias tty-ldisc-11 irtty
alias char-major-161 ircomm-tty

==== Linux 2.6 kernel config ====
Edit {{path|/etc/modprobe.conf}} and add the following lines
alias tty-ldisc-11 irtty-sir
alias char-major-161 ircomm-tty

== Fast IR (FIR) ==
FIR is the preferred mode of IrDA operation and operates at a bandwidth of 4 Mbps

The chips FIR mode first needs to be activated using the ISA PnP or BIOS method.

{{HINT|Regardless of which method you use, you will still have to set the dongle_id and run setserial as shown further below}}
=== ISA PnP support for nsc-ircc ===

ISA PnP support is '''necessary''' in some cases, as without it the kernel doesn't manage to enable the device by itself in many ThinkPads.

Starting with the 2.6.17-rc1 kernel, the nsc-ircc driver has ISA PnP support. For older kernels you will need patches to allow the loading of the driver without the below BIOS change.

* [http://steffenpingel.de/patches/nsc-ircc-pnp.diff 2.6.10 patch]
* [http://shamrock.dyndns.org/~ln/linux/nsc-ircc-pnp.2.6.12-rc6.diff 2.6.12-rc6 patch]
* [http://shamrock.dyndns.org/~ln/linux/nsc-ircc-pnp.2.6.12.diff 2.6.12 patch (applies cleanly to 2.6.12 through 2.6.15)]

=== NS PC8394T support ===

Thinkpads {{T43}}, {{T43p}} and {{R52}} [http://bugzilla.kernel.org/attachment.cgi?id=8247 needed an extra patch] to detect their [[NS PC8394T]]-based FIR device on kernels before 2.6.18. They also require ISA PnP support in the driver to work, which is available since 2.6.17 (and can be added to 2.6.16 with the patches above).

=== Changing BIOS settings ===
For older kernels (prior to 2.6.17-rc1), the easiest way to activate FIR mode is by entering BIOS setup during boot-up by pressing {{key|F1}} when prompted.
Then, selecting 'Config' followed by 'Infrared' will allow you to control the IrDA operation. Here you will need to select the option to Enable the infra-red port, and ensure the proper resources are set (typically: IO 0x2f8 and IRQ 3). Be sure to save the changes, and then Exit.

{{NOTE|Changing these BIOS settings does not affect Windows 2000 or XP operating systems, but may cause resource issues in older windows versions, or other legacy operating systems.}}

{{WARN|If you change the BIOS settings for IO, IRQ or DMA of the IrDA port, remember to do so accordingly on all examples in this page when applying them to your ThinkPad.}}

===Kernel configuration===
==== Linux 2.4 kernel config ====
Edit {{path|/etc/modules.conf}} and add the following lines

alias irda0 nsc-ircc
options nsc-ircc dongle_id=0x09 io=0x2f8 irq=3 dma=3
pre-install nsc-ircc setserial /dev/ttyS1 uart none port 0 irq 0

==== Linux 2.6 kernel config ====
Edit {{path|/etc/modprobe.conf}} and add the following lines

alias irda0 nsc-ircc
options nsc-ircc dongle_id=0x09 io=0x2f8 irq=3 dma=3
install nsc-ircc /bin/setserial /dev/ttyS1 uart none port 0 irq 0; /sbin/modprobe --ignore-install nsc-ircc

The install line is a work-around for the 8250 serial driver taking over the device, and may not be needed in certain distributions.
Another way to do this is to set this kernel config option:

1. {{kernelconf|CONFIG_SERIAL_8250_RUNTIME_UARTS|(1)|Number of 8250/16550 serial ports to register at runtime|Serial drivers|Character devices|Device Drivers|}}

2. {{kernelconf|CONFIG_SERIAL_8250_NR_UARTS|(4)|Maximum number of 8250/16550 serial ports|Serial drivers|Character devices|Device Drivers|}}

This will prevent the 8250 driver from grabbing any other than the first serial port at boot time or when the module is loaded. You can still add more ports later for example from PC-Card modems, up to CONFIG_SERIAL_8250_NR_UARTS.

==== {{Gentoo}} kernel config ====
Edit / Create {{path|/etc/modules.d/nsc-irrc}} and add the following lines

alias irda0 nsc-ircc
options nsc-ircc dongle_id=0x09 io=0x2f8 irq=3 dma=3

and then run modules-update

Edit {{path|/etc/modules.autoload.d/kernel-2.6}} and add the following lines

nsc-ircc

If you have serial support build in the kernel, switch it to a module and add it after nsc-ircc to advoid io base and irq conflict. For kernel 2.4, same as 2.6 changing the path to modules.autoload.d/kernel-2.4.

==== {{Debian}} Sarge/Etch kernel config ====
Install irda-utils and set it up for serial port emulation. Edit {{path|/etc/modprobe.d/irda-utils}} and add/change the following lines:

alias irda0 nsc-ircc
options nsc-ircc dongle_id=0x09 io=0x2f8 irq=3 dma=3

Edit / create {{path|/etc/modules.conf}} and add the following line before any references to 8250*, if any:

nsc-ircc

Make sure that module-init-tools has a chance to iterate over {{path|/etc/modules.conf}} before udev does the initial pci hotplug (this is a problem at least in Debian Sarge, when using backported udev packages):

{{cmdroot|cp /etc/rcS.d/S20module-init-tools /etc/rcS.d/S03module-init-tools}}

Note that at S03, module-init-tools cannot run depmod for you, so either do it manually before you reboot into a new kernel, or reboot twice to get it to work right. This is also the reason for using cp instead of mv.

If you have the regular serial port drivers as modules, that's it. Otherwise, try adding the install line described in the Linux 2.6 kernel config section, above, or compile them as modules instead of built-in.

== Known problems ==
* If the FIR mode is not activated, attempts to load the <tt>nsc-ircc</tt> module will result in an error in syslog of "Wrong chip version ff".
* After suspend the <tt>nsc-ircc</tt> module needs to be manually reloaded
* If module reloading does not work after a suspend, try reactivating the IrDA port as well:
rmmod nsc_ircc
echo disable > /sys/devices/pnp0/00\:0d/resources
echo activate > /sys/devices/pnp0/00\:0d/resources
modprobe nsc_ircc
:The value <tt>pnp0/00\:0d</tt> can vary - look for a id file containing IBM0071 or PNP0511, or for a resources file containing the appropriate irq/dma/io values, e.g., using {{cmdroot|grep 0x2f8 /sys/devices/pnp*/*/resources}} .
{{NOTE|The power management issues should be resolved starting with the 2.6.17-rc1 kernel.}}

{{NOTE|Don't understand after inserting modules use irattach irda0 -s and after this you can use eg. minicom over /dev/ircomm0 and test link with irdadump with this I get working FIR on A21m with 2.6.18}}
* If you read something like "ttyS1: LSR safety check engaged!" and "irattach: tcgetattr: Input/output error" in the system log, try limiting the FIR max baud rate (echo 57600 > /proc/sys/net/irda/max_baud_rate). This did the trick for me when I was trying to synchronize my Ericsson T39m with my Thinkpad R51 (multisync, evolution-2.8, KDE 3.5.5, openSUSE 10.2).

== Some other things you might want to do with IrDA ==
* add fast PPP support:
:{{cmdroot|modprobe irnet}}
* if needed, limit further the size of the transmit window
:{{cmdroot|echo 1 > /proc/sys/net/irda/max_tx_window}}
* set the connection speed to 4Mbit in FIR mode:
:{{cmdroot|echo 4000000 > /proc/sys/net/irda/max_baud_rate}}

==LIRC and IrDA==
Usually, IrDA ports are not compatible with LIRC, but you may have luck using lirc_sir.

If loading the <tt>lirc_sir</tt> module shows something like the following in {{cmdroot|dmesg}} output, you are lucky and can use LIRC with the IrDA port to remote control your ThinkPad.
lirc_sir: I/O port 0x02f8, IRQ 3.
lirc_sir: Installed.

You might need to force the io and irq settings. For instance, if in your BIOS your Infrared IO is 0x03f8 and IRQ is 4, do the following when inserting the module:

modprobe lirc_sir io=0x03f8 irq=4

If it fails with "Device or resource busy", you may want to install the setserial tool and run it with {{cmdroot|setserial /dev/ttyS0 uart none}} or {{cmdroot|setserial /dev/ttyS1 uart none}}. After that lirc_sir should be loadable.

You might also need to {{cmdroot|modprobe actisys-sir}}, {{cmdroot|modprobe tekram-sir}}, and {{cmdroot|modprobe lirc-sir}} if you are using the SIR on the thinkpad (modules are from kernel 2.6).

Also, do not forget to start the lirc daemon, otherwise no output will be given (you better try running it not as a daemon first, so you can see the output).
lircd -d /dev/lirc0 /etc/lircd.conf --nodaemon
You should see:
lircd: lircd(serial) ready
This means you are good to start {{cmdroot|irrecord}} or {{cmdroot|xmode2}} and check for input.

Once that shows a good output you can configure your remote control.
then use it in applications like mplayer, xine, or KDE's remote controls server.

== External Sources ==
*[http://irda.sourceforge.net/ Linux-IrDA Project] (External)
*[http://pcmcia-cs.sourceforge.net/ Linux PCMCIA Project] (External)
*[http://tpctl.sourceforge.net/ tpctl homepage] (External)
*[http://www.lirc.org/ Linux Infrared Remote Control] (External)