JauntySuspendResumeHibernate

Differences between revisions 1 and 17 (spanning 16 versions)
Revision 1 as of 2008-11-24 14:12:45
Size: 2535
Editor: nc-65-40-95-196
Comment:
Revision 17 as of 2008-12-01 17:31:22
Size: 8135
Editor: nc-65-40-95-196
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
 * '''Launchpad Entry''': UbuntuSpec:jaunty-suspend-resume-hibernate  * '''Launchpad Entry''': UbuntuSpec:jaunty-suspend-resume
Line 5: Line 5:
 * '''Contributors''':  * '''Contributors''': ColinKing
Line 8: Line 8:
##TOC
||<tablestyle="float:right; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents>>||
Line 9: Line 12:
TBD
Jaunty should be using just one user space method of Suspend/Resume/Hibernate and sticking to this one method rather than having several different alternative implementations.

Jaunty needs to improve the overall Suspend/Resume/Hibernate experience. Tracking down broken drivers can be a pain. To facilitate this, better troubleshooting assistance is required, ranging from a one-stop-shop trouble shooting Wiki guide, suitable quirk checking tools and well documented trouble debug strategies to help identify and fix buggy suspend/resume/hibernate issues.
 
Line 20: Line 27:
##This should cover the _why_: why is this change being proposed, what justifies it, where we see this justified. === Userland control of suspend/resume/hibernate ===

There needs to be some rationalisation in the way suspend/resume/hibernate is controlled from user space as there are several existing methods available:

 * Writing directly to /sys/power/state (lowest level)
 * Using /etc/acpi/sleep.sh (acpi-support)
 * pm-utils - current solution (as used by hal)
 * !DeviceKit-power which supersedes the power-management functionality of hal and replaces pm-utils.

The acpi-support method of suspend/resume should be removed as it is legacy and should be transitioned into hal-info and pm-utils. Having this method as well as pm-utils seems unjustifiable - it is a different suspend/resume mechanism to pm-utils and the duplication of different suspend/resume functionality is confusing and not helpful.

Either we continue with pm-utils or move to !DeviceKit-power (which is supported by the new gnome-power-manager for GNOME 2.26). Depending on the choice, we should just have one solution for suspend/resume/hibernate instead of many.

=== Diagnosing and Fixing suspend/resume/hiberate ===

Diagnosing and hence fixing broken suspend/resume/hibernate needs to easier. A Community based Wiki tutorial or troubleshooting guide (such as http://people.freedesktop.org/~hughsient/quirk/quirk-suspend-debug.html) needs to be written as the de-facto reference page to help users to:

 * identify known hardware issues
 * step-by-step diagnose problems
 * gather hardware and kernel specific information that can help pin-point and fix problems

Also having a program/script that can test for known quirks and suggest pm-suspend workarounds would be helpful.

Debugging suspend/resume/hibernate issues can be notoriously difficult; being able do dump kernel messages early to a serial console is useful. However modern PCs do not have legacy serial port hardware, so providing a USB serial console driver in initramfs is required.
Line 23: Line 53:

 * A user cannot get their laptop to resume. They visit the trouble shooting guide which lists known hardware issues and pm-suspend workarounds that they can try.
 
 * A user cannot get their laptop to resume. The Wiki trouble shooting guide explains how to run a quirk checking program which can automatically suggest pm-suspend workarounds.

 * A user cannot resume their laptop because they have problems with specific buggy drivers. The Wiki tutorial explains how to turn on the/sys/power/pm_trace "resume-trace" debugging procedure for finding buggy drivers to gather sufficient information to pin-point the relevant broken driver. They can then submit a bug report against this driver.

 * A user cannot hibernate their laptop. The tutorial explains how to make the hibernation core run in a test mode and then run through the 5 different test modes: freezer, devices, platform, processors or core.
 
 * A user wants to attach an early kernel log message to a bug report. By plugging in a USB-serial dongle and enabling the USB serial console driver they can then capture the log on another PC using hardware which does no have a legacy serial port. The tutorial should explain how to enable the driver using kernel boot line options and how to capture the dmesg log on a 2nd PC over serial using tools such as minicom.
Line 34: Line 74:
=== UI Changes === === pm-utils Quirk Checking Scripts ===
Line 36: Line 76:
##Should cover changes required to the UI, or specific UI that is required to implement this The Quirk checking script http://people.freedesktop.org/~hughsient/quirk/quirk-checker.sh perhaps could be included into the disto to help users pin-point suspend/resume quirks.
Line 38: Line 78:
=== Code Changes === === Initramfs Changes ===

To facilitate the debug via USB Serial console, the USB serial console kernel driver needs to be included into initramfs. The user needs to also add in the appropriate USB console boot parameter, e.g.

{{{
console=ttyUSB0,9600 no_console_suspend
}}}

This needs to be appropriately documented in the Wiki page.
Line 42: Line 90:
Line 43: Line 92:

Deprecating /etc/acpi/sleep.sh (et al) requires release note documentation at a minimum and perhaps modifications to the acpi-scripts informing the user that these are now deprecated and should not be used.
Line 58: Line 109:
 * OEM Team
  * What does the OEM Team need from the Kernel/Userspace?
  * What are typical and acceptable cycles? i.e. Suspend/Resume 500 times without failure
  * Other?
== BoF agenda and discussion ==
Line 59: Line 115:
== BoF agenda and discussion == === Userland control of suspend/resume/hibernate ===

 * Deprecating the use of /etc/acpi/sleep.sh et al(acpi-support) - what will this impact?
 * pm-utils vs !DeviceKit-power - risk/benefit of choice

=== Diagnosing and Fixing suspend/resume/hiberate ===

 * Including USB serial console driver(s) into initramfs
 * Including and beefing up http://people.freedesktop.org/~hughsient/quirk/quirk-checker.sh
 * Wiki troubleshooting guide/documentation needs writing
Line 63: Line 128:
== References ==

 * https://wiki.ubuntu.com/DebuggingKernelSuspend
 * https://wiki.ubuntu.com/UnderstandingSuspend
 * https://wiki.ubuntu.com/DebuggingIRQProblems
 * https://wiki.ubuntu.com/DebuggingACPI
 * https://wiki.canonical.com/UbuntuPlatform/Roadmaps/9.04/SuspendHibernate
 * http://people.freedesktop.org/~hughsient/quirk/quirk-suspend-debug.html
 * http://lxr.linux.no/linux/Documentation/power/basic-pm-debugging.txt

Summary

Jaunty should be using just one user space method of Suspend/Resume/Hibernate and sticking to this one method rather than having several different alternative implementations.

Jaunty needs to improve the overall Suspend/Resume/Hibernate experience. Tracking down broken drivers can be a pain. To facilitate this, better troubleshooting assistance is required, ranging from a one-stop-shop trouble shooting Wiki guide, suitable quirk checking tools and well documented trouble debug strategies to help identify and fix buggy suspend/resume/hibernate issues.

Release Note

Rationale

Userland control of suspend/resume/hibernate

There needs to be some rationalisation in the way suspend/resume/hibernate is controlled from user space as there are several existing methods available:

  • Writing directly to /sys/power/state (lowest level)
  • Using /etc/acpi/sleep.sh (acpi-support)
  • pm-utils - current solution (as used by hal)
  • DeviceKit-power which supersedes the power-management functionality of hal and replaces pm-utils.

The acpi-support method of suspend/resume should be removed as it is legacy and should be transitioned into hal-info and pm-utils. Having this method as well as pm-utils seems unjustifiable - it is a different suspend/resume mechanism to pm-utils and the duplication of different suspend/resume functionality is confusing and not helpful.

Either we continue with pm-utils or move to DeviceKit-power (which is supported by the new gnome-power-manager for GNOME 2.26). Depending on the choice, we should just have one solution for suspend/resume/hibernate instead of many.

Diagnosing and Fixing suspend/resume/hiberate

Diagnosing and hence fixing broken suspend/resume/hibernate needs to easier. A Community based Wiki tutorial or troubleshooting guide (such as http://people.freedesktop.org/~hughsient/quirk/quirk-suspend-debug.html) needs to be written as the de-facto reference page to help users to:

  • identify known hardware issues
  • step-by-step diagnose problems
  • gather hardware and kernel specific information that can help pin-point and fix problems

Also having a program/script that can test for known quirks and suggest pm-suspend workarounds would be helpful.

Debugging suspend/resume/hibernate issues can be notoriously difficult; being able do dump kernel messages early to a serial console is useful. However modern PCs do not have legacy serial port hardware, so providing a USB serial console driver in initramfs is required.

Use Cases

  • A user cannot get their laptop to resume. They visit the trouble shooting guide which lists known hardware issues and pm-suspend workarounds that they can try.
  • A user cannot get their laptop to resume. The Wiki trouble shooting guide explains how to run a quirk checking program which can automatically suggest pm-suspend workarounds.
  • A user cannot resume their laptop because they have problems with specific buggy drivers. The Wiki tutorial explains how to turn on the/sys/power/pm_trace "resume-trace" debugging procedure for finding buggy drivers to gather sufficient information to pin-point the relevant broken driver. They can then submit a bug report against this driver.
  • A user cannot hibernate their laptop. The tutorial explains how to make the hibernation core run in a test mode and then run through the 5 different test modes: freezer, devices, platform, processors or core.
  • A user wants to attach an early kernel log message to a bug report. By plugging in a USB-serial dongle and enabling the USB serial console driver they can then capture the log on another PC using hardware which does no have a legacy serial port. The tutorial should explain how to enable the driver using kernel boot line options and how to capture the dmesg log on a 2nd PC over serial using tools such as minicom.

Assumptions

Design

Implementation

pm-utils Quirk Checking Scripts

The Quirk checking script http://people.freedesktop.org/~hughsient/quirk/quirk-checker.sh perhaps could be included into the disto to help users pin-point suspend/resume quirks.

Initramfs Changes

To facilitate the debug via USB Serial console, the USB serial console kernel driver needs to be included into initramfs. The user needs to also add in the appropriate USB console boot parameter, e.g.

console=ttyUSB0,9600 no_console_suspend

This needs to be appropriately documented in the Wiki page.

Migration

Deprecating /etc/acpi/sleep.sh (et al) requires release note documentation at a minimum and perhaps modifications to the acpi-scripts informing the user that these are now deprecated and should not be used.

Test/Demo Plan

Unresolved issues

  • OEM Team
    • What does the OEM Team need from the Kernel/Userspace?
    • What are typical and acceptable cycles? i.e. Suspend/Resume 500 times without failure
    • Other?

BoF agenda and discussion

Userland control of suspend/resume/hibernate

  • Deprecating the use of /etc/acpi/sleep.sh et al(acpi-support) - what will this impact?
  • pm-utils vs DeviceKit-power - risk/benefit of choice

Diagnosing and Fixing suspend/resume/hiberate

References


CategorySpec

KernelTeam/Specs/JauntySuspendResumeHibernate (last edited 2008-12-10 22:17:41 by 98)