public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Greg KH <greg@kroah.com>
To: linux-kernel@vger.kernel.org
Cc: Andrew Morton <akpm@osdl.org>, Greg Kroah-Hartman <gregkh@suse.de>
Subject: [PATCH 23/47] PM: add /sys/power documentation to Documentation/ABI
Date: Mon, 25 Sep 2006 22:37:43 -0700	[thread overview]
Message-ID: <11592491581007-git-send-email-greg@kroah.com> (raw)
In-Reply-To: <11592491551919-git-send-email-greg@kroah.com>

From: Rafael J. Wysocki <rjw@sisk.pl>

The file sysfs-power that documents the interface in the /sys/power/ directory
is added to Documentation/ABI/testing.

Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
Acked-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
---
 Documentation/ABI/testing/sysfs-power |   88 +++++++++++++++++++++++++++++++++
 1 files changed, 88 insertions(+), 0 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-power b/Documentation/ABI/testing/sysfs-power
new file mode 100644
index 0000000..d882f80
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-power
@@ -0,0 +1,88 @@
+What:		/sys/power/
+Date:		August 2006
+Contact:	Rafael J. Wysocki <rjw@sisk.pl>
+Description:
+		The /sys/power directory will contain files that will
+		provide a unified interface to the power management
+		subsystem.
+
+What:		/sys/power/state
+Date:		August 2006
+Contact:	Rafael J. Wysocki <rjw@sisk.pl>
+Description:
+		The /sys/power/state file controls the system power state.
+		Reading from this file returns what states are supported,
+		which is hard-coded to 'standby' (Power-On Suspend), 'mem'
+		(Suspend-to-RAM), and 'disk' (Suspend-to-Disk).
+
+		Writing to this file one of these strings causes the system to
+		transition into that state. Please see the file
+		Documentation/power/states.txt for a description of each of
+		these states.
+
+What:		/sys/power/disk
+Date:		August 2006
+Contact:	Rafael J. Wysocki <rjw@sisk.pl>
+Description:
+		The /sys/power/disk file controls the operating mode of the
+		suspend-to-disk mechanism.  Reading from this file returns
+		the name of the method by which the system will be put to
+		sleep on the next suspend.  There are four methods supported:
+		'firmware' - means that the memory image will be saved to disk
+		by some firmware, in which case we also assume that the
+		firmware will handle the system suspend.
+		'platform' - the memory image will be saved by the kernel and
+		the system will be put to sleep by the platform driver (e.g.
+		ACPI or other PM registers).
+		'shutdown' - the memory image will be saved by the kernel and
+		the system will be powered off.
+		'reboot' - the memory image will be saved by the kernel and
+		the system will be rebooted.
+
+		The suspend-to-disk method may be chosen by writing to this
+		file one of the accepted strings:
+
+		'firmware'
+		'platform'
+		'shutdown'
+		'reboot'
+
+		It will only change to 'firmware' or 'platform' if the system
+		supports that.
+
+What:		/sys/power/image_size
+Date:		August 2006
+Contact:	Rafael J. Wysocki <rjw@sisk.pl>
+Description:
+		The /sys/power/image_size file controls the size of the image
+		created by the suspend-to-disk mechanism.  It can be written a
+		string representing a non-negative integer that will be used
+		as an upper limit of the image size, in bytes.  The kernel's
+		suspend-to-disk code will do its best to ensure the image size
+		will not exceed this number.  However, if it turns out to be
+		impossible, the kernel will try to suspend anyway using the
+		smallest image possible.  In particular, if "0" is written to
+		this file, the suspend image will be as small as possible.
+
+		Reading from this file will display the current image size
+		limit, which is set to 500 MB by default.
+
+What:		/sys/power/pm_trace
+Date:		August 2006
+Contact:	Rafael J. Wysocki <rjw@sisk.pl>
+Description:
+		The /sys/power/pm_trace file controls the code which saves the
+		last PM event point in the RTC across reboots, so that you can
+		debug a machine that just hangs during suspend (or more
+		commonly, during resume).  Namely, the RTC is only used to save
+		the last PM event point if this file contains '1'.  Initially
+		it contains '0' which may be changed to '1' by writing a
+		string representing a nonzero integer into it.
+
+		To use this debugging feature you should attempt to suspend
+		the machine, then reboot it and run
+
+		dmesg -s 1000000 | grep 'hash matches'
+
+		CAUTION: Using it will cause your machine's real-time (CMOS)
+		clock to be set to a random invalid time after a resume.
-- 
1.4.2.1


  reply	other threads:[~2006-09-26  5:49 UTC|newest]

Thread overview: 72+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-09-26  5:37 [GIT PATCH] Driver Core patches for 2.6.18 Greg KH
2006-09-26  5:37 ` [PATCH 1/47] Documentation/ABI: devfs is not obsolete, but removed! Greg KH
2006-09-26  5:37   ` [PATCH 2/47] deprecate PHYSDEV* keys Greg KH
2006-09-26  5:37     ` [PATCH 3/47] class_device_create(): make fmt argument 'const char *' Greg KH
2006-09-26  5:37       ` [PATCH 4/47] device_create(): " Greg KH
2006-09-26  5:37         ` [PATCH 5/47] Driver core: add const to class_create Greg KH
2006-09-26  5:37           ` [PATCH 6/47] sysfs: Make poll behaviour consistent Greg KH
2006-09-26  5:37             ` [PATCH 7/47] Debugfs: kernel-doc fixes for debugfs Greg KH
2006-09-26  5:37               ` [PATCH 8/47] SYSFS: allow sysfs_create_link to create symlinks in the root of sysfs Greg KH
2006-09-26  5:37                 ` [PATCH 9/47] Suspend infrastructure cleanup and extension Greg KH
2006-09-26  5:37                   ` [PATCH 10/47] Suspend changes for PCI core Greg KH
2006-09-26  5:37                     ` [PATCH 11/47] make suspend quieter Greg KH
2006-09-26  5:37                       ` [PATCH 12/47] fix broken/dubious driver suspend() methods Greg KH
2006-09-26  5:37                         ` [PATCH 13/47] PM: define PM_EVENT_PRETHAW Greg KH
2006-09-26  5:37                           ` [PATCH 14/47] PM: PCI and IDE handle PM_EVENT_PRETHAW Greg KH
2006-09-26  5:37                             ` [PATCH 15/47] PM: video drivers and PM_EVENT_PRETHAW Greg KH
2006-09-26  5:37                               ` [PATCH 16/47] PM: USB HCDs use PM_EVENT_PRETHAW Greg KH
2006-09-26  5:37                                 ` [PATCH 17/47] PM: issue PM_EVENT_PRETHAW Greg KH
2006-09-26  5:37                                   ` [PATCH 18/47] updated Documentation/power/devices.txt Greg KH
2006-09-26  5:37                                     ` [PATCH 19/47] PM: update docs for writing .../power/state Greg KH
2006-09-26  5:37                                       ` [PATCH 20/47] PM: add kconfig option for deprecated .../power/state files Greg KH
2006-09-26  5:37                                         ` [PATCH 21/47] PM: schedule /sys/devices/.../power/state for removal Greg KH
2006-09-26  5:37                                           ` [PATCH 22/47] PM: no suspend_prepare() phase Greg KH
2006-09-26  5:37                                             ` Greg KH [this message]
2006-09-26  5:37                                               ` [PATCH 24/47] PM: device_suspend/resume may sleep Greg KH
2006-09-26  5:37                                                 ` [PATCH 25/47] PM: platform_bus and late_suspend/early_resume Greg KH
2006-09-26  5:37                                                   ` [PATCH 26/47] Driver core: add groups support to struct device Greg KH
2006-09-26  5:37                                                     ` [PATCH 27/47] Driver core: allow devices in classes to have no parent Greg KH
2006-09-26  5:37                                                       ` [PATCH 28/47] Driver core: add ability for classes to handle devices properly Greg KH
2006-09-26  5:37                                                         ` [PATCH 29/47] Driver core: add device_rename function Greg KH
2006-09-26  5:37                                                           ` [PATCH 30/47] Driver core: create devices/virtual/ tree Greg KH
2006-09-26  5:37                                                             ` [PATCH 31/47] Class: add support for class interfaces for devices Greg KH
2006-09-26  5:37                                                               ` [PATCH 32/47] Driver core: add ability for devices to create and remove bin files Greg KH
2006-09-26  5:37                                                                 ` [PATCH 33/47] kobject: must_check fixes Greg KH
2006-09-26  5:37                                                                   ` [PATCH 34/47] sysfs_remove_bin_file: no return value, dump_stack on error Greg KH
2006-09-26  5:37                                                                     ` [PATCH 35/47] Driver core: fix comments in drivers/base/power/resume.c Greg KH
2006-09-26  5:37                                                                       ` [PATCH 36/47] Driver core: fixed add_bind_files() definition Greg KH
2006-09-26  5:37                                                                         ` [PATCH 37/47] add __must_check to device management code Greg KH
2006-09-26  5:37                                                                           ` [PATCH 38/47] add CONFIG_ENABLE_MUST_CHECK Greg KH
2006-09-26  5:37                                                                             ` [PATCH 39/47] v4l-dev2: handle __must_check Greg KH
2006-09-26  5:38                                                                               ` [PATCH 40/47] drivers/base: Platform notify needs to occur before drivers attach to the device Greg KH
2006-09-26  5:38                                                                                 ` [PATCH 41/47] drivers/base: check errors Greg KH
2006-09-26  5:38                                                                                   ` [PATCH 42/47] sysfs: add proper sysfs_init() prototype Greg KH
2006-09-26  5:38                                                                                     ` [PATCH 43/47] Driver Core: add ability for drivers to do a threaded probe Greg KH
2006-09-26  5:38                                                                                       ` [PATCH 44/47] PCI: enable driver multi-threaded probe Greg KH
2006-09-26  5:38                                                                                         ` [PATCH 45/47] Driver core: Fix potential deadlock in driver core Greg KH
2006-09-26  5:38                                                                                           ` [PATCH 46/47] Driver core: Remove unneeded routines from " Greg KH
2006-09-26  5:38                                                                                             ` [PATCH 47/47] Driver core: Don't call put methods while holding a spinlock Greg KH
2006-09-27 18:51                                                                                         ` [PATCH 44/47] PCI: enable driver multi-threaded probe Olaf Hering
2006-09-29 23:32                                                                                           ` Greg KH
2006-09-30  6:07                                                                                             ` Olaf Hering
2006-09-26 17:23                                                                                   ` [PATCH 41/47] drivers/base: check errors Dmitry Torokhov
2006-09-27  4:33                                                                                     ` Greg KH
2006-09-26 13:24                                                             ` [PATCH 30/47] Driver core: create devices/virtual/ tree Dmitry Torokhov
2006-09-26 13:41                                                               ` Greg KH
2006-09-26 13:51                                                                 ` Dmitry Torokhov
2006-09-26 14:26                                                                   ` Greg KH
2006-09-26 17:15                                                                     ` Dmitry Torokhov
2006-09-26 13:20                                                     ` [PATCH 26/47] Driver core: add groups support to struct device Dmitry Torokhov
2006-09-26 13:46                                                       ` Greg KH
2006-09-26 14:01                                                         ` Dmitry Torokhov
2006-09-26 14:23                                                           ` Greg KH
2006-09-26 17:10                                                             ` Dmitry Torokhov
2006-09-27 14:40                                                             ` Pavel Machek
2006-09-26 15:18                                                         ` Marcel Holtmann
2006-09-26 12:34 ` [GIT PATCH] Driver Core patches for 2.6.18 Mike Galbraith
2006-09-26 20:39   ` Greg KH
2006-09-27  8:47     ` Mike Galbraith
2006-09-27  6:58       ` Rafael J. Wysocki
2006-09-27 10:48         ` Mike Galbraith
2006-09-27 13:03           ` Mike Galbraith
2006-09-27 11:42             ` Rafael J. Wysocki

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11592491581007-git-send-email-greg@kroah.com \
    --to=greg@kroah.com \
    --cc=akpm@osdl.org \
    --cc=gregkh@suse.de \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox