summaryrefslogtreecommitdiffstats
path: root/Documentation/power
diff options
context:
space:
mode:
authorRafael J. Wysocki <rafael.j.wysocki@intel.com>2017-08-20 12:06:04 -0400
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>2017-08-28 18:16:06 -0400
commit7aa7a0360a6632beca86229db9369fd289fcc6bf (patch)
tree444b02e75970eed280c82ad61fe2d21a56ca0a27 /Documentation/power
parentcba630b6f5cf6bb468f5c2da77f3dee2125bd0c1 (diff)
PM: docs: Delete the obsolete states.txt document
The Documentation/power/states.txt document is now redundant and sonewhat outdated, so delete it. Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Diffstat (limited to 'Documentation/power')
-rw-r--r--Documentation/power/states.txt127
1 files changed, 0 insertions, 127 deletions
diff --git a/Documentation/power/states.txt b/Documentation/power/states.txt
deleted file mode 100644
index 205e45ad7c65..000000000000
--- a/Documentation/power/states.txt
+++ /dev/null
@@ -1,127 +0,0 @@
1System Power Management Sleep States
2
3(C) 2014 Intel Corp., Rafael J. Wysocki <rafael.j.wysocki@intel.com>
4
5The kernel supports up to four system sleep states generically, although three
6of them depend on the platform support code to implement the low-level details
7for each state.
8
9The states are represented by strings that can be read or written to the
10/sys/power/state file. Those strings may be "mem", "standby", "freeze" and
11"disk", where the last three always represent Power-On Suspend (if supported),
12Suspend-To-Idle and hibernation (Suspend-To-Disk), respectively.
13
14The meaning of the "mem" string is controlled by the /sys/power/mem_sleep file.
15It contains strings representing the available modes of system suspend that may
16be triggered by writing "mem" to /sys/power/state. These modes are "s2idle"
17(Suspend-To-Idle), "shallow" (Power-On Suspend) and "deep" (Suspend-To-RAM).
18The "s2idle" mode is always available, while the other ones are only available
19if supported by the platform (if not supported, the strings representing them
20are not present in /sys/power/mem_sleep). The string representing the suspend
21mode to be used subsequently is enclosed in square brackets. Writing one of
22the other strings present in /sys/power/mem_sleep to it causes the suspend mode
23to be used subsequently to change to the one represented by that string.
24
25Consequently, there are two ways to cause the system to go into the
26Suspend-To-Idle sleep state. The first one is to write "freeze" directly to
27/sys/power/state. The second one is to write "s2idle" to /sys/power/mem_sleep
28and then to write "mem" to /sys/power/state. Similarly, there are two ways
29to cause the system to go into the Power-On Suspend sleep state (the strings to
30write to the control files in that case are "standby" or "shallow" and "mem",
31respectively) if that state is supported by the platform. In turn, there is
32only one way to cause the system to go into the Suspend-To-RAM state (write
33"deep" into /sys/power/mem_sleep and "mem" into /sys/power/state).
34
35The default suspend mode (ie. the one to be used without writing anything into
36/sys/power/mem_sleep) is either "deep" (if Suspend-To-RAM is supported) or
37"s2idle", but it can be overridden by the value of the "mem_sleep_default"
38parameter in the kernel command line. On some ACPI-based systems, depending on
39the information in the FADT, the default may be "s2idle" even if Suspend-To-RAM
40is supported.
41
42The properties of all of the sleep states are described below.
43
44
45State: Suspend-To-Idle
46ACPI state: S0
47Label: "s2idle" ("freeze")
48
49This state is a generic, pure software, light-weight, system sleep state.
50It allows more energy to be saved relative to runtime idle by freezing user
51space and putting all I/O devices into low-power states (possibly
52lower-power than available at run time), such that the processors can
53spend more time in their idle states.
54
55This state can be used for platforms without Power-On Suspend/Suspend-to-RAM
56support, or it can be used in addition to Suspend-to-RAM to provide reduced
57resume latency. It is always supported.
58
59
60State: Standby / Power-On Suspend
61ACPI State: S1
62Label: "shallow" ("standby")
63
64This state, if supported, offers moderate, though real, power savings, while
65providing a relatively low-latency transition back to a working system. No
66operating state is lost (the CPU retains power), so the system easily starts up
67again where it left off.
68
69In addition to freezing user space and putting all I/O devices into low-power
70states, which is done for Suspend-To-Idle too, nonboot CPUs are taken offline
71and all low-level system functions are suspended during transitions into this
72state. For this reason, it should allow more energy to be saved relative to
73Suspend-To-Idle, but the resume latency will generally be greater than for that
74state.
75
76
77State: Suspend-to-RAM
78ACPI State: S3
79Label: "deep"
80
81This state, if supported, offers significant power savings as everything in the
82system is put into a low-power state, except for memory, which should be placed
83into the self-refresh mode to retain its contents. All of the steps carried out
84when entering Power-On Suspend are also carried out during transitions to STR.
85Additional operations may take place depending on the platform capabilities. In
86particular, on ACPI systems the kernel passes control to the BIOS (platform
87firmware) as the last step during STR transitions and that usually results in
88powering down some more low-level components that aren't directly controlled by
89the kernel.
90
91System and device state is saved and kept in memory. All devices are suspended
92and put into low-power states. In many cases, all peripheral buses lose power
93when entering STR, so devices must be able to handle the transition back to the
94"on" state.
95
96For at least ACPI, STR requires some minimal boot-strapping code to resume the
97system from it. This may be the case on other platforms too.
98
99
100State: Suspend-to-disk
101ACPI State: S4
102Label: "disk"
103
104This state offers the greatest power savings, and can be used even in
105the absence of low-level platform support for power management. This
106state operates similarly to Suspend-to-RAM, but includes a final step
107of writing memory contents to disk. On resume, this is read and memory
108is restored to its pre-suspend state.
109
110STD can be handled by the firmware or the kernel. If it is handled by
111the firmware, it usually requires a dedicated partition that must be
112setup via another operating system for it to use. Despite the
113inconvenience, this method requires minimal work by the kernel, since
114the firmware will also handle restoring memory contents on resume.
115
116For suspend-to-disk, a mechanism called 'swsusp' (Swap Suspend) is used
117to write memory contents to free swap space. swsusp has some restrictive
118requirements, but should work in most cases. Some, albeit outdated,
119documentation can be found in Documentation/power/swsusp.txt.
120Alternatively, userspace can do most of the actual suspend to disk work,
121see userland-swsusp.txt.
122
123Once memory state is written to disk, the system may either enter a
124low-power state (like ACPI S4), or it may simply power down. Powering
125down offers greater savings, and allows this mechanism to work on any
126system. However, entering a real low-power state allows the user to
127trigger wake up events (e.g. pressing a key or opening a laptop lid).