Differences between revisions 1 and 64 (spanning 63 versions)
Revision 1 as of 2005-12-09 01:14:11
Size: 1739
Editor: PaulBrossier
Comment:
Revision 64 as of 2021-02-08 00:06:42
Size: 7481
Comment: Added technique using /etc/systemd/sleep.conf.d/
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## Please edit system and help pages ONLY in the moinmaster wiki! For more
## information, please see MoinMaster:MoinPagesEditorGroup.
##master-page:Unknown-Page
##master-date:Unknown-Date
##acl MoinPagesEditorGroup:read,write,delete,revert All:read
Line 9: Line 4:

This page gathers bits of information about getting software suspend to work in debian. Because software suspend is still experimental, it is not enabled by default on most machines. Depending on your system, a few more steps are needed to get suspend partially or fully working.
This page gathers bits of information about getting software suspend to work in Debian. Because the core system components change rapidly among Debian versions, software suspend works differently on different versions of Debians. This page is divided according to Debian versions from new to old.
Line 14: Line 8:
=== Example === <<TableOfContents()>>
Line 16: Line 10:
The following scripts were needed to get suspend to ram working on a ThinkPad X22 running linux-image 2.6.14-2 and tracking unstable. == Debian Jessie and newer (8 and newer) ==
Line 18: Line 12:
Script '''/etc/acpi/events/custom_sleepbtn''' With systemd, `pm-utils` and its hooks are not used any more, instead there's `systemd-suspend`. To suspend use:
Line 20: Line 15:
event=button/sleep
action=/etc/acpi/actions/custom_sleep.sh
}}}

Script '''/etc/acpi/events/custom_lid'''
{{{
event=button/lid
action=/etc/acpi/actions/custom_sleep.sh
}}}

Script '''/etc/acpi/actions/custom_sleep.sh'''
{{{
# enable xscreensaver
source /proc/`pidof xscreensaver`/environ && xscreensaver-command -lock

## optional: eject all pcmcia devices
#cardctl eject || true

# go to sleep
echo mem > /sys/power/state
systemctl suspend
Line 43: Line 18:
Make sure the files you create in /etc/acpi/actions are executable: === In Gnome ===
One option is to use the Gnome "suspend-button" extension at https://extensions.gnome.org/extension/826/suspend-button/

Another option, under Gnome shell, is to simply press ALT before clicking the shutdown button in the user menu.

=== In KDE Plasma ===
[[KDE]] already has a suspend button in its normal shutdown menu, though it may instead be labelled as "Sleep" in Plasma 5.16 and newer. Cases where it might not appear are if DebianPkg:powerdevil or DebianPkg:upower aren't installed. systemd is used if available, but it's not required.

Note that if power management is suspended by an application, the system may not suspend automatically, even if configured otherwise in your Energy Saving settings. This is often done by media players, for instance, to keep the screen from dimming. The Battery and Brightness item in your system tray will let you know if power management is suspended, and what process is currently suspending it.

=== Disable suspend and hibernation ===

For systems which should never attempt any type of suspension, these targets can be disabled at the systemd level with the following:
{{{
sudo systemctl mask sleep.target suspend.target hibernate.target hybrid-sleep.target
}}}

To re-enable hibernate and suspend use the following command:
{{{
sudo systemctl unmask sleep.target suspend.target hibernate.target hybrid-sleep.target
}}}

A modern '''alternative''' approach for disabling suspend and hibernation is to create `/etc/systemd/sleep.conf.d/nosuspend.conf` as
{{{
[Sleep]
AllowSuspend=no
AllowHibernation=no
AllowSuspendThenHibernate=no
AllowHybridSleep=no
}}}
The above technique works on Debian 10 Buster and newer. See systemd-sleep.conf(5) for details.

If you just want to prevent suspending when the lid is closed you can set the following options in `/etc/systemd/logind.conf`:
Line 46: Line 53:
$ sudo chmod +x /etc/acpi/actions/custom_sleep.sh [Login]
HandleLidSwitch=ignore
HandleLidSwitchDocked=ignore
Line 49: Line 58:
=== Internal Links === Then run `systemctl restart systemd-logind.service` or reboot.
Line 51: Line 60:
 * Self:ACPI
 * Self:OffAndOnAgain
 * Self:Hibernate
More information is available in the manpage: `man logind.conf`
Line 55: Line 62:
=== External Links === == Debian Wheezy (7) ==
A very notable change is that HAL is phased out. If you still have the `hal` package installed, you should remove it or it will interference with `pm-utils` during suspend.
Line 57: Line 65:
 * [http://www.columbia.edu/~ariel/acpi/acpi_howto.html ACPI HowTo]
 * [http://tldp.org/HOWTO/ACPI-HOWTO/ Another ACPI HowTo]
If the suspend / resume works well on your system, you are lucky and no need to read anything on this page. Or else, the first step to debug is to enable debugging for pm-utils, who control the suspend and resume process.

=== Enabling Debugging for pm-utils ===
The log of suspend and resume processes are in file `/var/log/pm-suspend.log`. It contains moderately verbose information by default. More information can be enabled for debugging by inserting line `export PM_DEBUG=true` into the beginning of file `/usr/lib/pm-utils/pm-functions`.

=== Fixing corrupted video on resume ===
A very common issue found after the computer resumes is corrupted video (or black screen, or no LCD backlight). The first step is to check whether the system is still running, which can be simply done by pressing the Capslock button and check whether the Capslock LED is changing accordingly. If the system is still running, in most cases we need to add a video quirk for your video card.

Debian now has kernel mode setting (KMS) enabled by default for most Intel, nVidia and ATI video cards. But pm-utils' video quirk does support KMS yet. So in most cases you should try disabling KMS first. The detail steps for your specific video card can be found on the KernelModesetting page.

After disabled KMS, if the video after resume still corrupts, you can try to suspend the system by using some video quirks. Read the manpage of the `pm-suspend` program for a very detailed explanation of all the quirks available, and try the combinations of them from command-line. If you successfully find one combination of quirks that works for your system, you can add them into `/usr/lib/pm-utils/video-quirks` to make them permanent. At the same time, please help to file a bug against the `pm-utils` package with a patch about your changes so it can benefit the mass.

A common issue found on systems upgrading from old versions of Debian is the enabling of quirk-s3-bios freezes the system during suspend. If your system freezes during suspend, check the pm-suspend.log carefully after enabled debugging and make sure quirk-s3-bios is not used.

== Kernel testing facility ==
The kernel has a Suspend testing facility [[https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=0e7d56e3d9d7e37c79d0e05ffb3994e34beb3bbc|changelog]].

Introduce sysfs attribute /sys/power/pm_test allowing one to test the suspend core code. Namely, writing one of the strings below to this file causes the suspend code to work in one of the test modes defined as
follows:

 freezer :: test the freezing of processes
 devices :: test the freezing of processes and suspending of devices
 platform :: test the freezing of processes, suspending of devices and platform global control methods(*)
 processors :: test the freezing of processes, suspending of devices, platform global control methods and the disabling of nonboot CPUs
 core :: test the freezing of processes, suspending of devices, platform global control methods, the disabling of nonboot CPUs and suspending of platform/system devices
(*) These are ACPI global control methods on ACPI systems

Then, if a suspend is started by normal means, the suspend core will perform its normal operations up to the point indicated by given test level. Next, it will wait for 5 seconds and carry out the resume operations needed to transition
the system back to the fully functional state. Writing "none" to /sys/power/pm_test turns the testing off.

When open for reading, {{{/sys/power/pm_test}}} contains a space-separated list of all available tests (including "none" that represents the normal functionality) in which the current test level is indicated by square brackets.

The actual message (for googlers) are {{{suspend debug: Waiting for 5 seconds}}}.

== Internal Links ==
 * [[ACPI]]
 * OffAndOnAgain
 * [[Hibernation]]
 * ScreenLockingOnSleep
 * ConfigurePowerButton
 * [[PageFragmentLidSuspendSystemd/jessie]]

== External Links ==

 * [[https://wiki.archlinux.org/index.php/Software_suspend|ArchWiki - Uswsusp]]
 * [[https://wiki.gentoo.org/wiki/Suspend_and_hibernate|Gentoo Wiki - Suspend and hibernate]]
 * [[http://live.gnome.org/GnomePowerManager|Home of the Gnome Power Manager]] - The FAQ is interesting
 * [[http://en.opensuse.org/Category:Power_Management|OpenSuse pages on power management]]
 * [[https://01.org/node/3721|Best practice to debug Linux* suspend/hibernate issues]]
----
 CategoryHardware

Help on software suspend

This page gathers bits of information about getting software suspend to work in Debian. Because the core system components change rapidly among Debian versions, software suspend works differently on different versions of Debians. This page is divided according to Debian versions from new to old.

For more reading material, see also the links at the bottom of this page about hibernate and suspend.

Debian Jessie and newer (8 and newer)

With systemd, pm-utils and its hooks are not used any more, instead there's systemd-suspend. To suspend use:

systemctl suspend

In Gnome

One option is to use the Gnome "suspend-button" extension at https://extensions.gnome.org/extension/826/suspend-button/

Another option, under Gnome shell, is to simply press ALT before clicking the shutdown button in the user menu.

In KDE Plasma

KDE already has a suspend button in its normal shutdown menu, though it may instead be labelled as "Sleep" in Plasma 5.16 and newer. Cases where it might not appear are if powerdevil or upower aren't installed. systemd is used if available, but it's not required.

Note that if power management is suspended by an application, the system may not suspend automatically, even if configured otherwise in your Energy Saving settings. This is often done by media players, for instance, to keep the screen from dimming. The Battery and Brightness item in your system tray will let you know if power management is suspended, and what process is currently suspending it.

Disable suspend and hibernation

For systems which should never attempt any type of suspension, these targets can be disabled at the systemd level with the following:

sudo systemctl mask sleep.target suspend.target hibernate.target hybrid-sleep.target

To re-enable hibernate and suspend use the following command:

sudo systemctl unmask sleep.target suspend.target hibernate.target hybrid-sleep.target

A modern alternative approach for disabling suspend and hibernation is to create /etc/systemd/sleep.conf.d/nosuspend.conf as

[Sleep]
AllowSuspend=no
AllowHibernation=no
AllowSuspendThenHibernate=no
AllowHybridSleep=no

The above technique works on Debian 10 Buster and newer. See systemd-sleep.conf(5) for details.

If you just want to prevent suspending when the lid is closed you can set the following options in /etc/systemd/logind.conf:

[Login]
HandleLidSwitch=ignore
HandleLidSwitchDocked=ignore

Then run systemctl restart systemd-logind.service or reboot.

More information is available in the manpage: man logind.conf

Debian Wheezy (7)

A very notable change is that HAL is phased out. If you still have the hal package installed, you should remove it or it will interference with pm-utils during suspend.

If the suspend / resume works well on your system, you are lucky and no need to read anything on this page. Or else, the first step to debug is to enable debugging for pm-utils, who control the suspend and resume process.

Enabling Debugging for pm-utils

The log of suspend and resume processes are in file /var/log/pm-suspend.log. It contains moderately verbose information by default. More information can be enabled for debugging by inserting line export PM_DEBUG=true into the beginning of file /usr/lib/pm-utils/pm-functions.

Fixing corrupted video on resume

A very common issue found after the computer resumes is corrupted video (or black screen, or no LCD backlight). The first step is to check whether the system is still running, which can be simply done by pressing the Capslock button and check whether the Capslock LED is changing accordingly. If the system is still running, in most cases we need to add a video quirk for your video card.

Debian now has kernel mode setting (KMS) enabled by default for most Intel, nVidia and ATI video cards. But pm-utils' video quirk does support KMS yet. So in most cases you should try disabling KMS first. The detail steps for your specific video card can be found on the KernelModesetting page.

After disabled KMS, if the video after resume still corrupts, you can try to suspend the system by using some video quirks. Read the manpage of the pm-suspend program for a very detailed explanation of all the quirks available, and try the combinations of them from command-line. If you successfully find one combination of quirks that works for your system, you can add them into /usr/lib/pm-utils/video-quirks to make them permanent. At the same time, please help to file a bug against the pm-utils package with a patch about your changes so it can benefit the mass.

A common issue found on systems upgrading from old versions of Debian is the enabling of quirk-s3-bios freezes the system during suspend. If your system freezes during suspend, check the pm-suspend.log carefully after enabled debugging and make sure quirk-s3-bios is not used.

Kernel testing facility

The kernel has a Suspend testing facility changelog.

Introduce sysfs attribute /sys/power/pm_test allowing one to test the suspend core code. Namely, writing one of the strings below to this file causes the suspend code to work in one of the test modes defined as follows:

freezer
test the freezing of processes
devices
test the freezing of processes and suspending of devices
platform
test the freezing of processes, suspending of devices and platform global control methods(*)
processors
test the freezing of processes, suspending of devices, platform global control methods and the disabling of nonboot CPUs
core
test the freezing of processes, suspending of devices, platform global control methods, the disabling of nonboot CPUs and suspending of platform/system devices

(*) These are ACPI global control methods on ACPI systems

Then, if a suspend is started by normal means, the suspend core will perform its normal operations up to the point indicated by given test level. Next, it will wait for 5 seconds and carry out the resume operations needed to transition the system back to the fully functional state. Writing "none" to /sys/power/pm_test turns the testing off.

When open for reading, /sys/power/pm_test contains a space-separated list of all available tests (including "none" that represents the normal functionality) in which the current test level is indicated by square brackets.

The actual message (for googlers) are suspend debug: Waiting for 5 seconds.