pm.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. /*
  2. * pm.h - Power management interface
  3. *
  4. * Copyright (C) 2000 Andrew Henroid
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19. */
  20. #ifndef _LINUX_PM_H
  21. #define _LINUX_PM_H
  22. #ifdef __KERNEL__
  23. #include <linux/list.h>
  24. #include <asm/atomic.h>
  25. /*
  26. * Power management requests... these are passed to pm_send_all() and friends.
  27. *
  28. * these functions are old and deprecated, see below.
  29. */
  30. typedef int __bitwise pm_request_t;
  31. #define PM_SUSPEND ((__force pm_request_t) 1) /* enter D1-D3 */
  32. #define PM_RESUME ((__force pm_request_t) 2) /* enter D0 */
  33. /*
  34. * Device types... these are passed to pm_register
  35. */
  36. typedef int __bitwise pm_dev_t;
  37. #define PM_UNKNOWN_DEV ((__force pm_dev_t) 0) /* generic */
  38. #define PM_SYS_DEV ((__force pm_dev_t) 1) /* system device (fan, KB controller, ...) */
  39. #define PM_PCI_DEV ((__force pm_dev_t) 2) /* PCI device */
  40. #define PM_USB_DEV ((__force pm_dev_t) 3) /* USB device */
  41. #define PM_SCSI_DEV ((__force pm_dev_t) 4) /* SCSI device */
  42. #define PM_ISA_DEV ((__force pm_dev_t) 5) /* ISA device */
  43. #define PM_MTD_DEV ((__force pm_dev_t) 6) /* Memory Technology Device */
  44. /*
  45. * System device hardware ID (PnP) values
  46. */
  47. enum
  48. {
  49. PM_SYS_UNKNOWN = 0x00000000, /* generic */
  50. PM_SYS_KBC = 0x41d00303, /* keyboard controller */
  51. PM_SYS_COM = 0x41d00500, /* serial port */
  52. PM_SYS_IRDA = 0x41d00510, /* IRDA controller */
  53. PM_SYS_FDC = 0x41d00700, /* floppy controller */
  54. PM_SYS_VGA = 0x41d00900, /* VGA controller */
  55. PM_SYS_PCMCIA = 0x41d00e00, /* PCMCIA controller */
  56. };
  57. /*
  58. * Device identifier
  59. */
  60. #define PM_PCI_ID(dev) ((dev)->bus->number << 16 | (dev)->devfn)
  61. /*
  62. * Request handler callback
  63. */
  64. struct pm_dev;
  65. typedef int (*pm_callback)(struct pm_dev *dev, pm_request_t rqst, void *data);
  66. /*
  67. * Dynamic device information
  68. */
  69. struct pm_dev
  70. {
  71. pm_dev_t type;
  72. unsigned long id;
  73. pm_callback callback;
  74. void *data;
  75. unsigned long flags;
  76. unsigned long state;
  77. unsigned long prev_state;
  78. struct list_head entry;
  79. };
  80. /* Functions above this comment are list-based old-style power
  81. * managment. Please avoid using them. */
  82. /*
  83. * Callbacks for platform drivers to implement.
  84. */
  85. extern void (*pm_idle)(void);
  86. extern void (*pm_power_off)(void);
  87. typedef int __bitwise suspend_state_t;
  88. #define PM_SUSPEND_ON ((__force suspend_state_t) 0)
  89. #define PM_SUSPEND_STANDBY ((__force suspend_state_t) 1)
  90. #ifdef CONFIG_PM_CPU_MODE
  91. #define PM_SUSPEND_CPU_MODE ((__force suspend_state_t) 2)
  92. #endif
  93. #define PM_SUSPEND_MEM ((__force suspend_state_t) 3)
  94. #define PM_SUSPEND_DISK ((__force suspend_state_t) 4)
  95. #define PM_SUSPEND_MAX ((__force suspend_state_t) 5)
  96. typedef int __bitwise suspend_disk_method_t;
  97. #define PM_DISK_FIRMWARE ((__force suspend_disk_method_t) 1)
  98. #define PM_DISK_PLATFORM ((__force suspend_disk_method_t) 2)
  99. #define PM_DISK_SHUTDOWN ((__force suspend_disk_method_t) 3)
  100. #define PM_DISK_REBOOT ((__force suspend_disk_method_t) 4)
  101. #define PM_DISK_TEST ((__force suspend_disk_method_t) 5)
  102. #define PM_DISK_TESTPROC ((__force suspend_disk_method_t) 6)
  103. #define PM_DISK_MAX ((__force suspend_disk_method_t) 7)
  104. /**
  105. * struct pm_ops - Callbacks for managing platform dependent suspend states.
  106. * @valid: Callback to determine whether the given state can be entered.
  107. * If %CONFIG_SOFTWARE_SUSPEND is set then %PM_SUSPEND_DISK is
  108. * always valid and never passed to this call.
  109. * If not assigned, all suspend states are advertised as valid
  110. * in /sys/power/state (but can still be rejected by prepare or enter.)
  111. *
  112. * @prepare: Prepare the platform for the given suspend state. Can return a
  113. * negative error code if necessary.
  114. *
  115. * @enter: Enter the given suspend state, must be assigned. Can return a
  116. * negative error code if necessary.
  117. *
  118. * @finish: Called when the system has left the given state and all devices
  119. * are resumed. The return value is ignored.
  120. *
  121. * @pm_disk_mode: Set to the disk method that the user should be able to
  122. * configure for suspend-to-disk. Since %PM_DISK_SHUTDOWN,
  123. * %PM_DISK_REBOOT, %PM_DISK_TEST and %PM_DISK_TESTPROC
  124. * are always allowed, currently only %PM_DISK_PLATFORM
  125. * makes sense. If the user then choses %PM_DISK_PLATFORM,
  126. * the @prepare call will be called before suspending to disk
  127. * (if present), the @enter call should be present and will
  128. * be called after all state has been saved and the machine
  129. * is ready to be shut down/suspended/..., and the @finish
  130. * callback is called after state has been restored. All
  131. * these calls are called with %PM_SUSPEND_DISK as the state.
  132. */
  133. struct pm_ops {
  134. int (*valid)(suspend_state_t state);
  135. int (*prepare)(suspend_state_t state);
  136. int (*enter)(suspend_state_t state);
  137. int (*finish)(suspend_state_t state);
  138. suspend_disk_method_t pm_disk_mode;
  139. };
  140. /**
  141. * pm_set_ops - set platform dependent power management ops
  142. * @pm_ops: The new power management operations to set.
  143. */
  144. extern void pm_set_ops(struct pm_ops *pm_ops);
  145. extern struct pm_ops *pm_ops;
  146. extern int pm_suspend(suspend_state_t state);
  147. /*
  148. * Device power management
  149. */
  150. struct device;
  151. typedef struct pm_message {
  152. int event;
  153. } pm_message_t;
  154. /*
  155. * Several driver power state transitions are externally visible, affecting
  156. * the state of pending I/O queues and (for drivers that touch hardware)
  157. * interrupts, wakeups, DMA, and other hardware state. There may also be
  158. * internal transitions to various low power modes, which are transparent
  159. * to the rest of the driver stack (such as a driver that's ON gating off
  160. * clocks which are not in active use).
  161. *
  162. * One transition is triggered by resume(), after a suspend() call; the
  163. * message is implicit:
  164. *
  165. * ON Driver starts working again, responding to hardware events
  166. * and software requests. The hardware may have gone through
  167. * a power-off reset, or it may have maintained state from the
  168. * previous suspend() which the driver will rely on while
  169. * resuming. On most platforms, there are no restrictions on
  170. * availability of resources like clocks during resume().
  171. *
  172. * Other transitions are triggered by messages sent using suspend(). All
  173. * these transitions quiesce the driver, so that I/O queues are inactive.
  174. * That commonly entails turning off IRQs and DMA; there may be rules
  175. * about how to quiesce that are specific to the bus or the device's type.
  176. * (For example, network drivers mark the link state.) Other details may
  177. * differ according to the message:
  178. *
  179. * SUSPEND Quiesce, enter a low power device state appropriate for
  180. * the upcoming system state (such as PCI_D3hot), and enable
  181. * wakeup events as appropriate.
  182. *
  183. * FREEZE Quiesce operations so that a consistent image can be saved;
  184. * but do NOT otherwise enter a low power device state, and do
  185. * NOT emit system wakeup events.
  186. *
  187. * PRETHAW Quiesce as if for FREEZE; additionally, prepare for restoring
  188. * the system from a snapshot taken after an earlier FREEZE.
  189. * Some drivers will need to reset their hardware state instead
  190. * of preserving it, to ensure that it's never mistaken for the
  191. * state which that earlier snapshot had set up.
  192. *
  193. * A minimally power-aware driver treats all messages as SUSPEND, fully
  194. * reinitializes its device during resume() -- whether or not it was reset
  195. * during the suspend/resume cycle -- and can't issue wakeup events.
  196. *
  197. * More power-aware drivers may also use low power states at runtime as
  198. * well as during system sleep states like PM_SUSPEND_STANDBY. They may
  199. * be able to use wakeup events to exit from runtime low-power states,
  200. * or from system low-power states such as standby or suspend-to-RAM.
  201. */
  202. #define PM_EVENT_ON 0
  203. #define PM_EVENT_FREEZE 1
  204. #define PM_EVENT_SUSPEND 2
  205. #define PM_EVENT_PRETHAW 3
  206. #define PMSG_FREEZE ((struct pm_message){ .event = PM_EVENT_FREEZE, })
  207. #define PMSG_PRETHAW ((struct pm_message){ .event = PM_EVENT_PRETHAW, })
  208. #define PMSG_SUSPEND ((struct pm_message){ .event = PM_EVENT_SUSPEND, })
  209. #define PMSG_ON ((struct pm_message){ .event = PM_EVENT_ON, })
  210. struct dev_pm_info {
  211. pm_message_t power_state;
  212. unsigned can_wakeup:1;
  213. #ifdef CONFIG_PM
  214. unsigned should_wakeup:1;
  215. pm_message_t prev_state;
  216. void * saved_state;
  217. struct device * pm_parent;
  218. struct list_head entry;
  219. #endif
  220. };
  221. extern void device_pm_set_parent(struct device * dev, struct device * parent);
  222. extern int device_power_down(pm_message_t state);
  223. extern void device_power_up(void);
  224. extern void device_resume(void);
  225. #ifdef CONFIG_PM
  226. extern suspend_disk_method_t pm_disk_mode;
  227. extern int device_suspend(pm_message_t state);
  228. extern int device_prepare_suspend(pm_message_t state);
  229. #define device_set_wakeup_enable(dev,val) \
  230. ((dev)->power.should_wakeup = !!(val))
  231. #define device_may_wakeup(dev) \
  232. (device_can_wakeup(dev) && (dev)->power.should_wakeup)
  233. extern int dpm_runtime_suspend(struct device *, pm_message_t);
  234. extern void dpm_runtime_resume(struct device *);
  235. extern void __suspend_report_result(const char *function, void *fn, int ret);
  236. #define suspend_report_result(fn, ret) \
  237. do { \
  238. __suspend_report_result(__FUNCTION__, fn, ret); \
  239. } while (0)
  240. #else /* !CONFIG_PM */
  241. static inline int device_suspend(pm_message_t state)
  242. {
  243. return 0;
  244. }
  245. #define device_set_wakeup_enable(dev,val) do{}while(0)
  246. #define device_may_wakeup(dev) (0)
  247. static inline int dpm_runtime_suspend(struct device * dev, pm_message_t state)
  248. {
  249. return 0;
  250. }
  251. static inline void dpm_runtime_resume(struct device * dev)
  252. {
  253. }
  254. #define suspend_report_result(fn, ret) do { } while (0)
  255. #endif
  256. /* changes to device_may_wakeup take effect on the next pm state change.
  257. * by default, devices should wakeup if they can.
  258. */
  259. #define device_can_wakeup(dev) \
  260. ((dev)->power.can_wakeup)
  261. #define device_init_wakeup(dev,val) \
  262. do { \
  263. device_can_wakeup(dev) = !!(val); \
  264. device_set_wakeup_enable(dev,val); \
  265. } while(0)
  266. #endif /* __KERNEL__ */
  267. #endif /* _LINUX_PM_H */