Blame view

Documentation/power/interface.txt 3.24 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
  Power Management Interface
  
  
  The power management subsystem provides a unified sysfs interface to 
  userspace, regardless of what architecture or platform one is
  running. The interface exists in /sys/power/ directory (assuming sysfs
  is mounted at /sys). 
  
  /sys/power/state controls 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 those strings causes the system to
  transition into that state. Please see the file
  Documentation/power/states.txt for a description of each of those
  states.
  
  
  /sys/power/disk controls the operating mode of the suspend-to-disk
11d77d0c0   Johannes Berg   power management:...
21
22
  mechanism. Suspend-to-disk can be handled in several ways. We have a
  few options for putting the system to sleep - using the platform driver
26398a70e   Rafael J. Wysocki   PM: Rename struct...
23
  (e.g. ACPI or other suspend_ops), powering off the system or rebooting the
11d77d0c0   Johannes Berg   power management:...
24
  system (for testing).
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
25

b918f6e62   Rafael J. Wysocki   [PATCH] swsusp: d...
26
27
28
29
30
31
32
33
34
35
  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.
f0ced9b22   Johannes Berg   power management:...
36
37
38
39
40
41
  Reading from this file will display all supported modes and the currently
  selected one in brackets, for example
  
  	[shutdown] reboot test testproc
  
  Writing to this file will accept one of
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
42

11d77d0c0   Johannes Berg   power management:...
43
         'platform' (only if the platform supports it)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
44
45
         'shutdown'
         'reboot'
b918f6e62   Rafael J. Wysocki   [PATCH] swsusp: d...
46
47
         'testproc'
         'test'
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
48

ca0aec0f7   Rafael J. Wysocki   [PATCH] swsusp: m...
49
50
51
  /sys/power/image_size 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
853609b61   Rafael J. Wysocki   [PATCH] swsusp: u...
52
  limit of the image size, in bytes.  The suspend-to-disk mechanism will
ca0aec0f7   Rafael J. Wysocki   [PATCH] swsusp: m...
53
54
55
56
57
58
  do its best to ensure the image size will not exceed that number.  However,
  if this turns out to be impossible, it 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
ac5c24ec1   Rafael J. Wysocki   PM / Hibernate: M...
59
  is set to 2/5 of available RAM by default.
c5c6ba4e0   Rafael J. Wysocki   [PATCH] PM: Add p...
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  
  /sys/power/pm_trace 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.