Power Management Guide Dennis Nienhüser Power Management is the key to extend battery run time on mobile systems like laptops. This guide assists you setting it up on your laptop. 1.25 2005-10-02 Introduction
Why Power Management?

Capacity and lifetime of laptop batteries have improved much in the last years. Nevertheless modern processors consume much more energy than older ones and each laptop generation introduces more devices hungry for energy. That's why Power Management is more important than ever. Increasing battery run time doesn't necessarily mean buying another battery. Much can be achieved applying intelligent Power Management policies.

A quick overview

Please notice that this guide describes Power Management for laptops. While some sections might also suite for servers, others do not and may even cause harm. Please do not apply anything from this guide to a server unless you really know what you are doing.

As this guide has become rather long, here's a short overview helping you to find your way through it.

The Prerequisites chapter talks about some requirements that should be met before any of the following device individual sections will work. This includes BIOS settings, kernel configuration and some simplifications in user land. The following three chapters focus on devices that typically consume most energy - processor, display and hard drive. Each can be configured seperately. CPU Power Management shows how to adjust the processor's frequency to save a maximum of energy whithout losing too much performance. A few different tricks prevent your hard drive from working unnecessarily often in Disk Power Management (decreasing noise level as a nice side effect). Some notes on graphics cards, Wireless LAN and USB finish the device section in Power Management for other devices while another chapter is dedicated to the (rather experimental) sleep states. Last not least Troubleshooting lists common pitfalls.

Power Budget for each component

Nearly every component can operate in different states - off, sleep, idle, active to name a few - consuming a different amount of energy. Major parts are consumed by the LCD display, CPU, chipset and hard drives. Often one is able to activate OS-independent Power Management in the BIOS, but an intelligent setup in the operating system adapting to different situations can achieve much more.

Prerequisites
What has to be done first

Before going into the details on making individual devices Power Management aware, make sure certain requirements are met. After controlling the BIOS settings, some kernel options want to be enabled - these are in short ACPI, sleep states and CPU frequency scaling. As power saving most of the time comes along with performance loss or increased latency, it should only be enabled when running on batteries. That's where a new runlevel battery comes in handy.

The BIOS part

First have a look into your BIOS Power Management settings. The best way is to combine BIOS and operating system policies, but for the moment it's better to disable most of the BIOS part. This makes sure it doesn't interfere with your policies. Don't forget to re-check BIOS settings after you configured everything else.

Configuring the kernel

ACPI (Advanced Configuration and Power Interface) support in the kernel is still work in progress. Using a recent kernel will make sure you'll get the most out of it.

There are different kernel sources in Portage. I'd recommend using gentoo-sources or suspend2-sources. The latter contains patches for Software Suspend 2, see the chapter about sleep states for details. When configuring the kernel, activate at least these options:

Power Management Options --->
  [*] Power Management Support
  [ ] Software Suspend

  ACPI( Advanced Configuration and Power Interface ) Support --->
    [*] ACPI Support
    [ ]   Sleep States
    [ ]     /proc/acpi/sleep (deprecated)
    [*]   AC Adapter
    [*]   Battery
    <M>   Button
    <M>   Video
    [ ]   Generic Hotkey
    <M>   Fan
    <M>   Processor
    <M>     Thermal Zone
    < >   ASUS/Medion Laptop Extras
    < >   IBM ThinkPad Laptop Extras
    < >   Toshiba Laptop Extras
    (0)   Disable ACPI for systems before Jan 1st this year
    [ ]   Debug Statements
    [*]   Power Management Timer Support
    < >   ACPI0004,PNP0A05 and PNP0A06 Container Driver (EXPERIMENTAL)
    
  CPU Frequency Scaling --->
    [*] CPU Frequency scaling
    [ ]   Enable CPUfreq debugging
    < >   CPU frequency translation statistics
    [ ]     CPU frequency translation statistics details
          Default CPUFreq governor (userspace)
    <*>   'performance' governor
    <*>   'powersave' governor
    <*>   'ondemand' cpufreq policy governor
    <*>   'conservative' cpufreq governor
    <*>   CPU frequency table helpers
    <M> ACPI Processor P-States driver
    <*> CPUFreq driver for your processor

Decide yourself whether you want to enable Software Suspend, and Sleep States (see below). If you own an ASUS, Medion, IBM Thinkpad or Toshiba laptop, enable the appropriate section.

The kernel has to know how to enable CPU frequency scaling on your processor. As each type of CPU has a different interface, you've got to choose the right driver for your processor. Be careful here - enabling Intel Pentium 4 clock modulation on a Pentium M system will lead to strange results for example. Consult the kernel documentation if you're unsure which one to take.

Compile your kernel, make sure the right modules get loaded at startup and boot into your new ACPI-enabled kernel. Next run emerge sys-power/acpid to get the acpi daemon. This one informs you about events like switching from AC to battery or closing the lid. Make sure the modules are loaded if you didn't compile them into the kernel and start acpid by executing /etc/init.d/acpid start. Run rc-update add acpid default to load it on startup. You'll soon see how to use it.

# emerge sys-power/acpid
# /etc/init.d/acpid start
# rc-update add acpid default
Creating a "battery" runlevel

The default policy will be to enable Power Management only when needed - running on batteries. To make the switch between AC and battery convenient, create a runlevel battery that holds all the scripts starting and stopping Power Management.

You can safely skip this section if you don't like the idea of having another runlevel. However, skipping this step will make the rest a bit trickier to set up. The next sections assume a runlevel battery exists.
# cd /etc/runlevels
# cp -a default battery

Finished. Your new runlevel battery contains everything like default, but there is no automatic switch between both yet. Time to change it.

Reacting on ACPI events

Typical ACPI events are closing the lid, changing the power source or pressing the sleep button. An important event is changing the power source, which should cause a runlevel switch. A small script will take care of it.

First you need a script which changes the runlevel to default respectively battery depending on the power source. The script uses the on_ac_power command from sys-power/powermgmt-base - make sure the package is installed on your system.

# emerge powermgmt-base

You are now able to determine the power source by executing on_ac_power && echo AC available || echo Running on batteries in a shell. The script below is responsible for changing runlevels. Save it as /etc/acpi/actions/pmg_switch_runlevel.sh.

#!/bin/bash

# BEGIN configuration
RUNLEVEL_AC="default"
RUNLEVEL_BATTERY="battery"
# END configuration


if [ ! -d "/etc/runlevels/${RUNLEVEL_AC}" ]
then
        logger "${0}: Runlevel ${RUNLEVEL_AC} does not exist. Aborting."
        exit 1
fi

if [ ! -d "/etc/runlevels/${RUNLEVEL_BATTERY}" ]
then
        logger "${0}: Runlevel ${RUNLEVEL_BATTERY} does not exist. Aborting."
        exit 1
fi

if on_ac_power
then
    if [[ "$(cat /var/lib/init.d/softlevel)" != "${RUNLEVEL_AC}" ]]
  then
            logger "Switching to ${RUNLEVEL_AC} runlevel"
            /sbin/rc ${RUNLEVEL_AC}
        fi
elif [[ "$(cat /var/lib/init.d/softlevel)" != "${RUNLEVEL_BATTERY}" ]]
then
        logger "Switching to ${RUNLEVEL_BATTERY} runlevel"
        /sbin/rc ${RUNLEVEL_BATTERY}
fi

Dont forget to run chmod +x /etc/acpi/actions/pmg_switch_runlevel.sh to make the script executable. The last thing that needs to be done is calling the script whenever the power source changes. That's done by catching ACPI events with the help of acpid. First you need to know which events are generated when the power source changes. The events are called ac_adapter and battery on most laptops, but it might be different on yours.

# tail -f /var/log/acpid | grep "received event"

Run the command above and pull the power cable. You should see something like this:

[Tue Sep 20 17:39:06 2005] received event "ac_adapter AC 00000080 00000000"
[Tue Sep 20 17:39:06 2005] received event "battery BAT0 00000080 00000001"

The interesting part is the quoted string after received event. It will be matched by the event line in the files you are going to create below. Don't worry if your system generates multiple events or always the same. As long as any event is generated, runlevel changing will work.

# replace "ac_adapter" below with the event generated on your laptop
# For example, ac_adapter.* will match ac_adapter AC 00000080 00000000
event=ac_adapter.*
action=/etc/acpi/actions/pmg_switch_runlevel.sh %e
# replace "battery" below with the event generated on your laptop
# For example, battery.* will match battery BAT0 00000080 00000001
event=battery.*
action=/etc/acpi/actions/pmg_switch_runlevel.sh %e

Finally acpid has to be restarted to recognize the changes.

# /etc/init.d/acpid restart

Give it a try: Plug AC in and out and watch syslog for the "Switching to AC mode" or "Switching to battery mode" messages. See the Troubleshooting section if the script is not able to detect the power source correctly.

Due to the nature of the event mechanism, your laptop will boot into runlevel default regardless of the AC/battery state. This is fine when running from AC, but we'd like to boot into the battery runlevel otherwise. One solution would be to add another entry to the boot loader with the parameter softlevel=battery, but it's likely to forget choosing it. A better way is faking an ACPI event in the end of the boot process and letting pmg_switch_runlevel.sh script decide whether a runlevel change is necessary. Open /etc/conf.d/local.start in your favourite editor and add these lines:

# Fake acpi event to switch runlevel if running on batteries
/etc/acpi/actions/pmg_switch_runlevel.sh "battery/battery"

Prepared like this you can activate Power Management policies for individual devices.

CPU Power Management
Some technical terms

CPU frequency scaling brings up some technical terms that might be unknown to you. Here's a quick introduction.

First of all, the kernel has to be able to change the processor's frequency. The CPUfreq processor driver knows the commands to do it on your CPU. Thus it's important to choose the right one in your kernel. You should already have done it above. Once the kernel knows how to change frequencies, it has to know which frequency it should set. This is done according to the policy which consists of a CPUfreq policy and a governor. A CPUfreq policy are just two numbers which define a range the frequency has to stay between - minimal and maximal frequency. The governor now decides which of the available frequencies in between minimal and maximal frequency to choose. For example, the powersave governor always chooses the lowest frequency available, the performance governor the highest one. The userspace governor makes no decision but chooses whatever the user (or a program in userspace) wants - which means it reads the frequency from /sys/devices/system/cpu/cpu0/cpufreq/scaling_setspeed.

This doesn't sound like dynamic frequency changes yet and in fact it isn't. Dynamics however can be accomplished with various approaches. For example, the ondemand governor makes its decisions depending on the current CPU load. The same is done by various userland tools like cpudyn, cpufreqd, powernowd and many more. ACPI events can be used to enable or disable dynamic frequency changes depending on power source.

Setting the frequency manually

Decreasing CPU speed and voltage has two advantages: On the one hand less energy is consumed, on the other hand there is thermal improvement as your system doesn't get as hot as running on full speed. The main disadvantage is obviously the loss of performance. Decreasing processor speed is a trade off between performance loss and energy saving.

Not every laptop supports frequency scaling. If unsure, have a look at the list of supported processors in the Troubleshooting section to verify your's is supported.

It's time to test whether CPU frequency changing works. Let's install another tool which is very handy for debugging purposes: sys-power/cpufrequtils

# emerge cpufrequtils
# cpufreq-info

Here is an example output:

cpufrequtils 0.3: cpufreq-info (C) Dominik Brodowski 2004
Report errors and bugs to linux@brodo.de, please.
analyzing CPU 0:
  driver: centrino
  CPUs which need to switch frequency at the same time: 0
  hardware limits: 600 MHz - 1.40 GHz
  available frequency steps: 600 MHz, 800 MHz, 1000 MHz, 1.20 GHz, 1.40 GHz
  available cpufreq governors: conservative, ondemand, powersave, userspace, performance
  current policy: frequency should be within 924 MHz and 1.40 GHz.
    The governor "performance" may decide which speed to use
    within this range.
  current CPU frequency is 1.40 GHz.

Now play around with cpufreq-set to make sure frequency switching works. Run cpufreq-set -g ondemand for example to activate the ondemand governor and verify the change with cpufreq-info. If it doesn't work as expected, you might find help in the Troubleshooting section in the end of this guide.

Automated frequency adaption

The above is quite nice, but not doable in daily life. Better let your system set the appropriate frequency automatically. There are many different approaches to do this. The following table gives a quick overview to help you decide on one of them. It's roughly seperated in three categories kernel for approaches that only need kernel support, daemon for programs that run in the background and graphical for programs that provide a GUI for easy configuration and changes.

'ondemand' governorKernelCPU loadN.A.N.A. Chooses maximal frequency on CPU load and slowly steps down when the CPU is idle. Further tuning through files in /sys/devices/system/cpu/cpu0/cpufreq/ondemand/. Still requires userland tools (programs, scripts) if governor switching or similar is desired. 'conservative' governorKernelCPU loadN.A.N.A. Unlike the ondemand governor, conversative doesn't jump to maximum frequency when CPU load is high, but increases the frequency step by step. Further tuning through files in /sys/devices/system/cpu/cpu0/cpufreq/ondemand/. Still requires userland tools (programs, scripts) if governor switching or similar is desired. cpudynDaemonCPU loadPerformance, powersaveDynamic Also supports disk standby - notice however that laptop mode in most cases will do a better job. cpufreqdDaemonBattery state, CPU load, temperature, running programsAll availableNone Sophisticated (but also complicated) setup. powernowd DaemonCPU loadNonePassive, sine, aggressive Supports SMP. ncpufreqd DaemonTemperatureNonePowersave, performance Toggles the used governor between performance and powersave depending on system temperature. Very useful on laptops with notorious heat problems. speedfreqDaemonCPU loadNoneDynamic, powersave, performance, fixed speed Easy to configure with a nice client/server interface. Requires a 2.6 kernel. Unmaintained, broken and thus removed from Portage. Please switch to cpufreqd if you're still using it. gtk-cpuspeedyGraphicalNoneNoneNone Gnome application, a graphical tool to set CPU frequency manually. It does not offer any automation. klaptopdaemonGraphicalBattery stateAll availableNone KDE only, 'ondemand' governor required for dynamic frequency scaling.
Name Category Switch decision Kernel governors Further governors Comments

While adjusting the frequency to the current load looks simple at a first glance, it's not such a trivial task. A bad algorithm can cause switching between two frequencies all the time or wasting energy when setting frequency to an unnecessary high level.

Which one to choose? If you have no idea about it, try cpufreqd:

# emerge cpufreqd

cpufreqd can be configured by editing /etc/cpufreqd.conf. The default one that ships with cpufreqd may look a bit confusing. I recommend replacing it with the one from Gentoo developer Henrik Brix Andersen (see below).

[General]
pidfile=/var/run/cpufreqd.pid
poll_interval=2
pm_type=acpi
verbosity=5

[Profile]
name=ondemand
minfreq=0%
maxfreq=100%
policy=ondemand

[Profile]
name=conservative
minfreq=0%
maxfreq=100%
policy=conservative

[Profile]
name=powersave
minfreq=0%
maxfreq=100%
policy=powersave

[Profile]
name=performance
minfreq=0%
maxfreq=100%
policy=performance

[Rule]
name=battery
ac=off
profile=conservative

[Rule]
name=battery_low
ac=off
battery_interval=0-10
profile=powersave

[Rule]
name=ac
ac=on
profile=ondemand

Now you can start the cpufreqd daemon. Add it to the default and battery runlevel as well.

# rc-update add cpufreqd default battery
# rc
Do not run more than one of the above programs at the same time. It may cause confusion like switching between two frequencies all the time.
Verifying the result

The last thing to check is that your new policies do a good job. An easy way to do so is monitoring CPU speed while working with your laptop:

# watch grep \"cpu MHz\" /proc/cpuinfo

If /proc/cpuinfo doesn't get updated (see Troubleshooting), monitor the CPU frequency with:

# watch x86info -mhz

Depending on your setup, CPU speed should increase on heavy load, decrease on no activity or just stay at the same level. When using cpufreqd and verbosity set to 5 or higher in cpufreqd.conf you'll get additional information about what's happening reported to syslog.

LCD Power Management
Energy consumer no. 1

As you can see in figure 1.1, the LCD display consumes the biggest part of energy (might not be the case for non-mobile CPU's). Thus it's quite important not only to shut the display off when not needed, but also to reduce it's backlight if possible. Most laptops offer the possibility to control the backlight dimming.

First thing to check is the standby/suspend/off timings of the display. As this depends heavily on your windowmanager, I'll let you figure it out yourself. Just two common places: Blanking the terminal can be done with setterm -blank <number-of-minutesM>, setterm -powersave on and setterm -powerdown <number-of-minutesM>. For X.org, modify /etc/X11/xorg.conf similar to this:

Section "ServerLayout"
  Identifier  [...]
  [...]
  Option  "BlankTime"  "5"  # Blank the screen after 5 minutes (Fake)
  Option  "StandbyTime"  "10"  # Turn off screen after 10 minutes (DPMS)
  Option  "SuspendTime"  "20"  # Full suspend after 20 minutes
  Option  "OffTime"  "30"  # Turn off after half an hour
  [...]
EndSection

[...]

Section "Monitor"
  Identifier  [...]
  Option  "DPMS"  "true"
  [...]
EndSection

This is the same for XFree86 and /etc/X11/XF86Config.

Probably more important is the backlight dimming. If you have access to the dimming settings via a tool, write a small script that dims the backlight in battery mode and place it in your battery runlevel. The following script should work on most IBM Thinkpads. It needs the app-laptop/ibm-acpi package or the appropriate option in your kernel has to be enabled.

Support for setting brightness is marked experimental in ibm-acpi. It accesses hardware directly and may cause severe harm to your system. Please read the ibm-acpi website

To be able to set the brightness level, the ibm_acpi module has to be loaded with the experimental parameter.

(Please read the warnings above before doing this!)
# emerge ibm-acpi
# echo "options ibm_acpi experimental=1" >> /etc/modules.d/ibm_acpi
# /sbin/modules-update
# echo ibm_acpi >> /etc/modules.autoload.d/kernel-2.6
# modprobe ibm_acpi

This should work without error messages and a file /proc/acpi/ibm/brightness should be created after loading the module. An init script will take care of choosing the brightness according to the power source.

# See /proc/acpi/ibm/brightness for available values
# Please read /usr/share/doc/ibm-acpi-*/README.gz

# brigthness level in ac mode. Default is 7.
BRIGHTNESS_AC=7

# brightness level in battery mode. Default is 4.
BRIGHTNESS_BATTERY=4
#!/sbin/runscript

set_brightness() {
    if on_ac_power
    then
        LEVEL=${BRIGHTNESS_AC:-7}
    else
        LEVEL=${BRIGHTNESS_BATTERY:-4}
    fi

    if [ -f /proc/acpi/ibm/brightness ]
    then
        ebegin "Setting LCD brightness"
        echo "level ${LEVEL}" > /proc/acpi/ibm/brightness
        eend $?
    else
        ewarn "Setting LCD brightness is not supported."
        ewarn "Check that ibm_acpi is loaded into the kernel"
    fi
}

start() {
    set_brightness
}

stop () {
    set_brightness
}

When done, make sure brightness is adjusted automatically by adding it to the battery runlevel.

# chmod +x /etc/init.d/lcd-brightness
# rc-update add lcd-brightness battery
# rc
Disk Power Management
Sleep when idle

Let's bring the hard disk to sleep as early as possible whenever it is not needed. I'll show you two possibilities to do it. First cpudyn supports Disk Power Management. Uncomment the lines in the "Disk Options" section in /etc/conf.d/cpudyn. To put your first disk to sleep after 60 seconds of no activity, you would modify it like this:

################################################
# DISK OPTIONS
# (disabled by default)
################################################

#
# Timeout to put the disk in standby mode if there was no
# io during that period (in seconds)
#

TIMEOUT=60

#
# Specified disks to spindown (comma separated devices)
#

DISKS=/dev/hda

The second possibility is using a small script and hdparm. Create /etc/init.d/pm.hda like this:

#!/sbin/runscript

depend() {
  after hdparm
}

start() {
  ebegin "Activating Power Management for Hard Drives"
  hdparm -q -S12 /dev/hda
  eend $?
}

stop () {
  ebegin "Deactivating Power Management for Hard Drives"
  hdparm -q -S253 /dev/hda
  eend $?
}

See man hdparm for the options. If your script is ready, add it to the battery runlevel.

# chmod +x /etc/init.d/pm.hda
# /sbin/depscan.sh
# rc-update add pm.hda battery
Be careful with sleep/spin down settings of your hard drive. Setting it to small values might wear out your drive and lose warranty.
Increasing idle time - laptop-mode

Recent kernels (2.6.6 and greater, recent 2.4 ones and others with patches) include the so-called laptop-mode. When activated, dirty buffers are written to disk on read calls or after 10 minutes (instead of 30 seconds). This minimizes the time the hard disk needs to be spun up.

# emerge laptop-mode-tools

laptop-mode-tools has it's configuration file in /etc/laptop-mode/laptop-mode.conf. Adjust it the way you like it, it's well commented. Run rc-update add laptop_mode battery to start it automatically.

Other tricks

Besides putting your disk to sleep state as early as possible, it is a good idea to minimize disk accesses. Have a look at processes that write to your disk frequently - the syslogd is a good candidate. You probably don't want to shut it down completely, but it's possible to modify the config file so that "unnecessary" things don't get logged and thus don't create disk traffic. Cups writes to disk periodically, so consider shutting it down and only enable it manually when needed.

# rc-update del cupsd battery

Another possibility is to deactivate swap in battery mode. Before writing a swapon/swapoff switcher, make sure there is enough RAM and swap isn't used heavily, otherwise you'll be in big problems.

If you don't want to use laptop-mode, it's still possible to minimize disk access by mounting certain directories as tmpfs - write accesses are not stored on a disk, but in main memory and get lost with unmounting. Often it's useful to mount /tmp like this - you don't have to pay special attention as it gets cleared on every reboot regardless whether it was mounted on disk or in RAM. Just make sure you have enough RAM and no program (like a download client or compress utility) needs extraordinary much space in /tmp. To activate this, enable tmpfs support in your kernel and add a line to /etc/fstab like this:

none  /tmp  tmpfs  size=32m  0 0
Pay attention to the size parameter and modify it for your system. If you're unsure, don't try this at all, it can become a perfomance bottleneck easily. In case you want to mount /var/log like this, make sure to merge the log files to disk before unmounting. They are essential. Don't attempt to mount /var/tmp like this. Portage uses it for compiling...
Power Management for other devices
Graphics cards

In case you own an ATI graphics card supporting PowerPlay (dynamic clock scaling for the the graphics processing unit GPU), you can activate this feature in X.org. Open /etc/X11/xorg.conf and add (or enable) the DynamicClocks option in the Device section. Please notice that this feature will lead to crashes on some systems.

Section "Device"
[...]
Option      "DynamicClocks" "on"
EndSection
Wireless Power Management

Wireless LAN cards consume quite a few energy. Put them in Power Management mode in analogy to the pm.hda script.

#!/sbin/runscript
start() {
  ebegin "Activating Power Management for Wireless LAN"
  iwconfig wlan0 power on power max period 3
  eend $?
}

stop () {
  ebegin "Deactivating Power Management for Wireless LAN"
  iwconfig wlan0 power off
  eend $?
}

Starting this script will put wlan0 in Power Management mode, going to sleep at the latest three seconds after no traffic. Save it as /etc/init.d/pm.wlan0 and add it to the battery runlevel like the disk script above. See man iwconfig for details and more options. If your driver and access point support changing the beacon time, this is a good starting point to save even more energy.

# chmod +x /etc/init.d/pm.wlan0
# /sbin/depscan.sh
# rc-update add pm.wlan0 battery
USB Power Management

There are two problems with USB devices regarding energy consumption: First, devices like USB mice, digital cameras or USB sticks consume energy while plugged in. You cannot avoid this (nevertheless remove them in case they're not needed). Second, when there are USB devices plugged in, the USB host controller periodically accesses the bus which in turn prevents the CPU from going into sleep mode. The kernel offers an experimental option to enable suspension of USB devices through driver calls or one of the power/state files in /sys.

Device Drivers
  USB support
    [*]   Support for Host-side USB
      [*]   USB suspend/resume (EXPERIMENTAL)
Sleep states: sleep, standby, suspend to disk
Overview

ACPI defines different sleep states. The more important ones are

  • S1 aka Standby
  • S3 aka Suspend to RAM aka Sleep
  • S4 aka Suspend to Disk aka Hibernate

They can be called whenever the system is not in use, but a shutdown is not wanted due to the long boot time.

Sleep (S3)

The ACPI support for these sleep states is marked experimental for good reason. APM sleep states seem to be more stable, however you can't use APM and ACPI together.

  Power Management Options --->
    [*]  Power Management support
      ACPI (Advanced Configuration and Power Interface) Support --->
        [*]  ACPI Support
          [*]   Sleep States

Once your kernel is prepared like above, you can use the hibernate-script to activate suspend or sleep mode. Let's install that first.

# emerge hibernate-script

Some configuration has to be done in /etc/hibernate The default package introduces two configuration files hibernate.conf and ram.conf.

To configure sleep, edit ram.conf in /etc/hibernate. UseSysfsPowerState mem is already setup correctly, but you have to go through the rest of the configuration file and set it up for your system. The comments and option names will guide you. If you use nfs or samba shares over the network, make sure to shutdown the appropriate init scripts to avoid timeouts.

Ready? Now is the last chance to backup any data you want to keep after executing the next command. Notice that you probably have to hit a special key like Fn to resume from sleep.

# hibernate-ram

If you're still reading, it seems to work. You can also setup standby (S1) in a similar way by copying ram.conf to standby.conf and creating a symlink /usr/sbin/hibernate-standby pointing to /usr/sbin/hibernate. S3 and S4 are the more interesting sleep states due to greater energy savings however.

Hibernate (S4)

This section introduces hibernation, where a snapshot of the running system is written to disk before powering off. On resume, the snapshot is loaded and you can go on working at exactly the point you called hibernate before.

Don't exchange non hot-pluggable hardware when suspended. Don't attempt to load a snapshot with a different kernel image than the one it was created with. Shutdown any NFS or samba server/client before hibernating.

There are two different implementations for S4. The original one is swsusp, then there is the newer suspend2 with a nicer interface (including fbsplash support). A feature comparison is available at the suspend2 Homepage. There used to be Suspend-to-Disk (pmdisk), a fork of swsusp, but it has been merged back.

Suspend2 is not included in the mainline kernel yet, therefore you either have to patch your kernel sources with the patches provided by suspend2.net or use sys-kernel/suspend2-sources.

The kernel part for both swusp and suspend2 is as follows:

Power Management Options --->
  (hibernate with swsusp)
  [*] Software Suspend
      (replace /dev/SWAP with your swap partition)
      (/dev/SWAP)      Default resume partition
  
  (hibernate with suspend2)
  Software Suspend 2
    --- Image Storage (you need at least one writer)
    [*]     File Writer
    [*]    Swap Writer
    ---   General Options
    [*]    LZF image compression
    (replace /dev/SWAP with your swap partition)
    (swap:/dev/SWAP)   Default resume device name
    [ ]     Allow Keep Image Mode

The configuration for swsusp is rather easy. If you didn't store the location of your swap partition in the kernel config, you can also pass it as a parameter with the resume=/dev/SWAP directive. If booting is not possible due to a broken image, use the noresume kernel parameter. The hibernate-cleanup init script invalidates swsusp images during the boot process.

# rc-update add hibernate-cleanup boot

To activate hibernate with swsusp, use the hibernate script and set UseSysfsPowerState disk in /etc/hibernate/hibernate.conf.

Backup your data before doing this. Run sync before executing one of the commands to have cached data written to disk. First try it outside of X, then with X running, but not logged in.

If you experience kernel panics due to uhci or similar, try to compile USB support as module and unload the modules before sending your laptop to sleep mode. There are configuration options for this in hibernate.conf

# nano -w /etc/hibernate.conf
(Make sure you have a backup of your data)
# hibernate

The following section discusses the setup of suspend2 including fbsplash support for a nice graphical progress bar during suspend and resume.

The first part of the configuration is similar to the configuration of swsusp. In case you didn't store the location of your swap partition in the kernel config, you have to pass it as a kernel parameter with the resume2=swap:/dev/SWAP directive. If booting is not possible due to a broken image, append the noresume2 parameter. Additionally, the hibernate-cleanup init script invalidates suspend2 images during the boot process.

# rc-update add hibernate-cleanup boot

Now edit /etc/hibernate/hibernate.conf, enable the suspend2 section and comment everything in the sysfs_power_state and acpi_sleep sections. Do not enable the fbsplash part in global options yet.

# nano -w /etc/hibernate.conf
(Make sure you have a backup of your data)
# hibernate

Please configure fbsplash now if you didn't do already. To enable fbsplash support during hibernation, the sys-apps/suspend2-userui package is needed. Additionally, you've got to enable the fbsplash USE flag.

# mkdir -p /etc/portage
# echo sys-apps/suspend2-userui fbsplash >> /etc/portage/package.use
# emerge suspend2-userui

The ebuild tells you to make a symlink to the theme you want to use. For example, to use the livecd-2005.1 theme, run the following command:

# ln -sfn /etc/splash/livecd-2005.1 /etc/splash/suspend2

If you don't want a black screen in the first part of the resume process, you have to add the suspend2ui_fbsplash tool to your initrd image. Assuming you created the initrd image with splash_geninitramfs and saved it as /boot/fbsplash-emergence-1024x768, here's how to do that.

# mount /boot
# mkdir ~/initrd.d
# cp /boot/fbsplash-emergence-1024x768 ~/initrd.d/
# cd ~/initrd.d
# gunzip -c fbsplash-emergence-1024x768 | cpio -idm --quiet -H newc
# rm fbsplash-emergence-1024x768
# cp /usr/sbin/suspend2ui_fbsplash sbin/
# find . | cpio --quiet --dereference -o -H newc | gzip -9 > /boot/fbsplash-suspend2-emergence-1024x768

Afterwards adjust grub.conf respectively lilo.conf so that your suspend2 kernel uses /boot/fbsplash-suspend2-emergence-1024x768 as initrd image. You can now test a dry run to see if everything is setup correctly.

# suspend2ui_fbsplash -t

Afterwards open /etc/hibernate/hibernate.conf again and activate the fbsplash options. Execute hibernate and enjoy.

Troubleshooting
If things go wrong...

Q: I'm trying to change the CPU frequency, but /sys/devices/system/cpu/cpu0/cpufreq/scaling_governor does not exist.

A: Make sure your processor supports CPU frequency scaling and you chose the right CPUFreq driver for your processor. Here is a list of processors that are supported by cpufreq (kernel 2.6.7): ARM Integrator, ARM-SA1100, ARM-SA1110, AMD Elan - SC400, SC410, AMD mobile K6-2+, AMD mobile K6-3+, AMD mobile Duron, AMD mobile Athlon, AMD Opteron, AMD Athlon 64, Cyrix Media GXm, Intel mobile PIII and Intel mobile PIII-M on certain chipsets, Intel Pentium 4, Intel Xeon, Intel Pentium M (Centrino), National Semiconductors Geode GX, Transmeta Crusoe, VIA Cyrix 3 / C3, UltraSPARC-III, SuperH SH-3, SH-4, several "PowerBook" and "iBook2" and various processors on some ACPI 2.0-compatible systems (only if "ACPI Processor Performance States" are available to the ACPI/BIOS interface).

Q: My laptop supports frequency scaling, but /sys/devices/system/cpu/cpu0/cpufreq/ is empty.

A: Look for ACPI related error messages with dmesg | grep ACPI. Try to update the BIOS, especially if a broken DSDT is reported. You can also try to fix it yourself (which is beyond the scope of this guide).

Q: My laptop supports frequency scaling, but according to /proc/cpuinfo the speed never changes.

A: Probably you have activated symmetric multiprocessing support (CONFIG_SMP) in your kernel. Deactivate it and it should work. Some older kernels had a bug causing this. In that case, run emerge x86info, update your kernel as asked and check the current frequency with x86info -mhz.

Q: I can change the CPU frequency, but the range is not as wide as in another OS.

A: You can combine frequency scaling with ACPI throttling to get a lower minimum frequency. Notice that throttling doesn't save much energy and is mainly used for thermal management (keeping your laptop cool and quiet). You can read the current throttling state with cat /proc/acpi/processor/CPU/throttling and change it with echo -n "0:x" > /proc/acpi/processor/CPU/limit, where x is one of the Tx states listed in /proc/acpi/processor/CPU/throttling.

Q: When configuring the kernel, powersave, performance and userspace governors show up, but that ondemand thing is missing. Where do I get it?

A: The ondemand governor is only included in recent kernel sources. Try updating them.

Q: Battery life time seems to be worse than before.

A: Check your BIOS settings. Maybe you forgot to re-enable some of the settings.

Q: My battery is charged, but KDE reports there would be 0% left and immediately shuts down.

A: Check that battery support is compiled into your kernel. If you use it as a module, make sure the module is loaded.

Q: I have a Dell Inspiron 51XX and I don't get any ACPI events.

A: This seems to be a kernel bug. Read on here.

Q: I activated the DynamicClocks option in xorg.conf and now X.org crashes / the screen stays black / my laptop doesn't shutdown properly.

A: This happens on some systems. You have to disable DynamicClocks.

Q: I want to use suspend2, but it tells me my swap partition is too small. Resizing is not an option.

A: If there is enough free space on your system, you can use the filewriter instead of the swapwriter. The hibernate-script supports it as well. More information can be found in /usr/src/linux/Documentation/power/suspend2.txt.

Q: I just bought a brand new battery, but it only lasts for some minutes! What am I doing wrong?

A: First follow your manufacturer's advice on how to charge the battery correctly.

Q: The above didn't help. What should I do then?

A: Some batteries sold as "new" are in fact old ones. Try the following:

$ grep capacity /proc/acpi/battery/BAT0/info
design capacity:     47520 mWh
last full capacity:  41830 mWh

If the "last full capacity" differs significantly from the design capacity, your battery is probably broken. Try to claim your warranty.

Q: My problem is not listed above. Where should I go next?

A: Don't fear to contact me, Dennis Nienhüser, directly.