2006-08-30 21:38:06 +00:00
|
|
|
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
|
2006-11-03 06:07:19 +00:00
|
|
|
Date: September 2006
|
2006-08-30 21:38:06 +00:00
|
|
|
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.
|
|
|
|
|
|
2006-11-03 06:07:19 +00:00
|
|
|
Additionally, /sys/power/disk can be used to turn on one of the
|
|
|
|
|
two testing modes of the suspend-to-disk mechanism: 'testproc'
|
|
|
|
|
or 'test'. If the suspend-to-disk mechanism is in the
|
|
|
|
|
'testproc' mode, writing 'disk' to /sys/power/state will cause
|
|
|
|
|
the kernel to disable nonboot CPUs and freeze tasks, wait for 5
|
|
|
|
|
seconds, unfreeze tasks and enable nonboot CPUs. If it is in
|
|
|
|
|
the 'test' mode, writing 'disk' to /sys/power/state will cause
|
|
|
|
|
the kernel to disable nonboot CPUs and freeze tasks, shrink
|
|
|
|
|
memory, suspend devices, wait for 5 seconds, resume devices,
|
|
|
|
|
unfreeze tasks and enable nonboot CPUs. Then, we are able to
|
|
|
|
|
look in the log messages and work out, for example, which code
|
|
|
|
|
is being slow and which device drivers are misbehaving.
|
|
|
|
|
|
2006-08-30 21:38:06 +00:00
|
|
|
The suspend-to-disk method may be chosen by writing to this
|
|
|
|
|
file one of the accepted strings:
|
|
|
|
|
|
|
|
|
|
'firmware'
|
|
|
|
|
'platform'
|
|
|
|
|
'shutdown'
|
|
|
|
|
'reboot'
|
2006-11-03 06:07:19 +00:00
|
|
|
'testproc'
|
|
|
|
|
'test'
|
2006-08-30 21:38:06 +00:00
|
|
|
|
|
|
|
|
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'
|
|
|
|
|
|
2010-10-11 22:00:25 +00:00
|
|
|
If you do not get any matches (or they appear to be false
|
|
|
|
|
positives), it is possible that the last PM event point
|
|
|
|
|
referred to a device created by a loadable kernel module. In
|
|
|
|
|
this case cat /sys/power/pm_trace_dev_match (see below) after
|
|
|
|
|
your system is started up and the kernel modules are loaded.
|
|
|
|
|
|
2006-08-30 21:38:06 +00:00
|
|
|
CAUTION: Using it will cause your machine's real-time (CMOS)
|
|
|
|
|
clock to be set to a random invalid time after a resume.
|
2010-01-23 21:25:15 +00:00
|
|
|
|
2010-10-11 22:00:25 +00:00
|
|
|
What; /sys/power/pm_trace_dev_match
|
|
|
|
|
Date: October 2010
|
|
|
|
|
Contact: James Hogan <james@albanarts.com>
|
|
|
|
|
Description:
|
|
|
|
|
The /sys/power/pm_trace_dev_match file contains the name of the
|
|
|
|
|
device associated with the last PM event point saved in the RTC
|
|
|
|
|
across reboots when pm_trace has been used. More precisely it
|
|
|
|
|
contains the list of current devices (including those
|
|
|
|
|
registered by loadable kernel modules since boot) which match
|
|
|
|
|
the device hash in the RTC at boot, with a newline after each
|
|
|
|
|
one.
|
|
|
|
|
|
|
|
|
|
The advantage of this file over the hash matches printed to the
|
|
|
|
|
kernel log (see /sys/power/pm_trace), is that it includes
|
|
|
|
|
devices created after boot by loadable kernel modules.
|
|
|
|
|
|
|
|
|
|
Due to the small hash size necessary to fit in the RTC, it is
|
|
|
|
|
possible that more than one device matches the hash, in which
|
|
|
|
|
case further investigation is required to determine which
|
|
|
|
|
device is causing the problem. Note that genuine RTC clock
|
|
|
|
|
values (such as when pm_trace has not been used), can still
|
|
|
|
|
match a device and output it's name here.
|
|
|
|
|
|
2010-01-23 21:25:15 +00:00
|
|
|
What: /sys/power/pm_async
|
|
|
|
|
Date: January 2009
|
|
|
|
|
Contact: Rafael J. Wysocki <rjw@sisk.pl>
|
|
|
|
|
Description:
|
|
|
|
|
The /sys/power/pm_async file controls the switch allowing the
|
|
|
|
|
user space to enable or disable asynchronous suspend and resume
|
|
|
|
|
of devices. If enabled, this feature will cause some device
|
|
|
|
|
drivers' suspend and resume callbacks to be executed in parallel
|
|
|
|
|
with each other and with the main suspend thread. It is enabled
|
|
|
|
|
if this file contains "1", which is the default. It may be
|
|
|
|
|
disabled by writing "0" to this file, in which case all devices
|
|
|
|
|
will be suspended and resumed synchronously.
|
PM: Make it possible to avoid races between wakeup and system sleep
One of the arguments during the suspend blockers discussion was that
the mainline kernel didn't contain any mechanisms making it possible
to avoid races between wakeup and system suspend.
Generally, there are two problems in that area. First, if a wakeup
event occurs exactly when /sys/power/state is being written to, it
may be delivered to user space right before the freezer kicks in, so
the user space consumer of the event may not be able to process it
before the system is suspended. Second, if a wakeup event occurs
after user space has been frozen, it is not generally guaranteed that
the ongoing transition of the system into a sleep state will be
aborted.
To address these issues introduce a new global sysfs attribute,
/sys/power/wakeup_count, associated with a running counter of wakeup
events and three helper functions, pm_stay_awake(), pm_relax(), and
pm_wakeup_event(), that may be used by kernel subsystems to control
the behavior of this attribute and to request the PM core to abort
system transitions into a sleep state already in progress.
The /sys/power/wakeup_count file may be read from or written to by
user space. Reads will always succeed (unless interrupted by a
signal) and return the current value of the wakeup events counter.
Writes, however, will only succeed if the written number is equal to
the current value of the wakeup events counter. If a write is
successful, it will cause the kernel to save the current value of the
wakeup events counter and to abort the subsequent system transition
into a sleep state if any wakeup events are reported after the write
has returned.
[The assumption is that before writing to /sys/power/state user space
will first read from /sys/power/wakeup_count. Next, user space
consumers of wakeup events will have a chance to acknowledge or
veto the upcoming system transition to a sleep state. Finally, if
the transition is allowed to proceed, /sys/power/wakeup_count will
be written to and if that succeeds, /sys/power/state will be written
to as well. Still, if any wakeup events are reported to the PM core
by kernel subsystems after that point, the transition will be
aborted.]
Additionally, put a wakeup events counter into struct dev_pm_info and
make these per-device wakeup event counters available via sysfs,
so that it's possible to check the activity of various wakeup event
sources within the kernel.
To illustrate how subsystems can use pm_wakeup_event(), make the
low-level PCI runtime PM wakeup-handling code use it.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
Acked-by: Jesse Barnes <jbarnes@virtuousgeek.org>
Acked-by: Greg Kroah-Hartman <gregkh@suse.de>
Acked-by: markgross <markgross@thegnar.org>
Reviewed-by: Alan Stern <stern@rowland.harvard.edu>
2010-07-05 20:43:53 +00:00
|
|
|
|
|
|
|
|
What: /sys/power/wakeup_count
|
|
|
|
|
Date: July 2010
|
|
|
|
|
Contact: Rafael J. Wysocki <rjw@sisk.pl>
|
|
|
|
|
Description:
|
|
|
|
|
The /sys/power/wakeup_count file allows user space to put the
|
|
|
|
|
system into a sleep state while taking into account the
|
|
|
|
|
concurrent arrival of wakeup events. Reading from it returns
|
|
|
|
|
the current number of registered wakeup events and it blocks if
|
|
|
|
|
some wakeup events are being processed at the time the file is
|
|
|
|
|
read from. Writing to it will only succeed if the current
|
|
|
|
|
number of wakeup events is equal to the written value and, if
|
|
|
|
|
successful, will make the kernel abort a subsequent transition
|
|
|
|
|
to a sleep state if any wakeup events are reported after the
|
|
|
|
|
write has returned.
|
2011-05-15 09:38:48 +00:00
|
|
|
|
|
|
|
|
What: /sys/power/reserved_size
|
|
|
|
|
Date: May 2011
|
|
|
|
|
Contact: Rafael J. Wysocki <rjw@sisk.pl>
|
|
|
|
|
Description:
|
|
|
|
|
The /sys/power/reserved_size file allows user space to control
|
|
|
|
|
the amount of memory reserved for allocations made by device
|
|
|
|
|
drivers during the "device freeze" stage of hibernation. It can
|
|
|
|
|
be written a string representing a non-negative integer that
|
|
|
|
|
will be used as the amount of memory to reserve for allocations
|
|
|
|
|
made by device drivers' "freeze" callbacks, in bytes.
|
|
|
|
|
|
|
|
|
|
Reading from this file will display the current value, which is
|
|
|
|
|
set to 1 MB by default.
|