pm.h 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  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. #include <asm/errno.h>
  26. /*
  27. * Power management requests... these are passed to pm_send_all() and friends.
  28. *
  29. * these functions are old and deprecated, see below.
  30. */
  31. typedef int __bitwise pm_request_t;
  32. #define PM_SUSPEND ((__force pm_request_t) 1) /* enter D1-D3 */
  33. #define PM_RESUME ((__force pm_request_t) 2) /* enter D0 */
  34. /*
  35. * Device types... these are passed to pm_register
  36. */
  37. typedef int __bitwise pm_dev_t;
  38. #define PM_UNKNOWN_DEV ((__force pm_dev_t) 0) /* generic */
  39. #define PM_SYS_DEV ((__force pm_dev_t) 1) /* system device (fan, KB controller, ...) */
  40. #define PM_PCI_DEV ((__force pm_dev_t) 2) /* PCI device */
  41. #define PM_USB_DEV ((__force pm_dev_t) 3) /* USB device */
  42. #define PM_SCSI_DEV ((__force pm_dev_t) 4) /* SCSI device */
  43. #define PM_ISA_DEV ((__force pm_dev_t) 5) /* ISA device */
  44. #define PM_MTD_DEV ((__force pm_dev_t) 6) /* Memory Technology Device */
  45. /*
  46. * System device hardware ID (PnP) values
  47. */
  48. enum
  49. {
  50. PM_SYS_UNKNOWN = 0x00000000, /* generic */
  51. PM_SYS_KBC = 0x41d00303, /* keyboard controller */
  52. PM_SYS_COM = 0x41d00500, /* serial port */
  53. PM_SYS_IRDA = 0x41d00510, /* IRDA controller */
  54. PM_SYS_FDC = 0x41d00700, /* floppy controller */
  55. PM_SYS_VGA = 0x41d00900, /* VGA controller */
  56. PM_SYS_PCMCIA = 0x41d00e00, /* PCMCIA controller */
  57. };
  58. /*
  59. * Device identifier
  60. */
  61. #define PM_PCI_ID(dev) ((dev)->bus->number << 16 | (dev)->devfn)
  62. /*
  63. * Request handler callback
  64. */
  65. struct pm_dev;
  66. typedef int (*pm_callback)(struct pm_dev *dev, pm_request_t rqst, void *data);
  67. /*
  68. * Dynamic device information
  69. */
  70. struct pm_dev
  71. {
  72. pm_dev_t type;
  73. unsigned long id;
  74. pm_callback callback;
  75. void *data;
  76. unsigned long flags;
  77. unsigned long state;
  78. unsigned long prev_state;
  79. struct list_head entry;
  80. };
  81. /* Functions above this comment are list-based old-style power
  82. * management. Please avoid using them. */
  83. /*
  84. * Callbacks for platform drivers to implement.
  85. */
  86. extern void (*pm_idle)(void);
  87. extern void (*pm_power_off)(void);
  88. extern void (*pm_power_off_prepare)(void);
  89. /*
  90. * Device power management
  91. */
  92. struct device;
  93. typedef struct pm_message {
  94. int event;
  95. } pm_message_t;
  96. /*
  97. * Several driver power state transitions are externally visible, affecting
  98. * the state of pending I/O queues and (for drivers that touch hardware)
  99. * interrupts, wakeups, DMA, and other hardware state. There may also be
  100. * internal transitions to various low power modes, which are transparent
  101. * to the rest of the driver stack (such as a driver that's ON gating off
  102. * clocks which are not in active use).
  103. *
  104. * One transition is triggered by resume(), after a suspend() call; the
  105. * message is implicit:
  106. *
  107. * ON Driver starts working again, responding to hardware events
  108. * and software requests. The hardware may have gone through
  109. * a power-off reset, or it may have maintained state from the
  110. * previous suspend() which the driver will rely on while
  111. * resuming. On most platforms, there are no restrictions on
  112. * availability of resources like clocks during resume().
  113. *
  114. * Other transitions are triggered by messages sent using suspend(). All
  115. * these transitions quiesce the driver, so that I/O queues are inactive.
  116. * That commonly entails turning off IRQs and DMA; there may be rules
  117. * about how to quiesce that are specific to the bus or the device's type.
  118. * (For example, network drivers mark the link state.) Other details may
  119. * differ according to the message:
  120. *
  121. * SUSPEND Quiesce, enter a low power device state appropriate for
  122. * the upcoming system state (such as PCI_D3hot), and enable
  123. * wakeup events as appropriate.
  124. *
  125. * HIBERNATE Enter a low power device state appropriate for the hibernation
  126. * state (eg. ACPI S4) and enable wakeup events as appropriate.
  127. *
  128. * FREEZE Quiesce operations so that a consistent image can be saved;
  129. * but do NOT otherwise enter a low power device state, and do
  130. * NOT emit system wakeup events.
  131. *
  132. * PRETHAW Quiesce as if for FREEZE; additionally, prepare for restoring
  133. * the system from a snapshot taken after an earlier FREEZE.
  134. * Some drivers will need to reset their hardware state instead
  135. * of preserving it, to ensure that it's never mistaken for the
  136. * state which that earlier snapshot had set up.
  137. *
  138. * A minimally power-aware driver treats all messages as SUSPEND, fully
  139. * reinitializes its device during resume() -- whether or not it was reset
  140. * during the suspend/resume cycle -- and can't issue wakeup events.
  141. *
  142. * More power-aware drivers may also use low power states at runtime as
  143. * well as during system sleep states like PM_SUSPEND_STANDBY. They may
  144. * be able to use wakeup events to exit from runtime low-power states,
  145. * or from system low-power states such as standby or suspend-to-RAM.
  146. */
  147. #define PM_EVENT_ON 0
  148. #define PM_EVENT_FREEZE 1
  149. #define PM_EVENT_SUSPEND 2
  150. #define PM_EVENT_HIBERNATE 4
  151. #define PM_EVENT_PRETHAW 8
  152. #define PM_EVENT_SLEEP (PM_EVENT_SUSPEND | PM_EVENT_HIBERNATE)
  153. #define PMSG_FREEZE ((struct pm_message){ .event = PM_EVENT_FREEZE, })
  154. #define PMSG_PRETHAW ((struct pm_message){ .event = PM_EVENT_PRETHAW, })
  155. #define PMSG_SUSPEND ((struct pm_message){ .event = PM_EVENT_SUSPEND, })
  156. #define PMSG_HIBERNATE ((struct pm_message){ .event = PM_EVENT_HIBERNATE, })
  157. #define PMSG_ON ((struct pm_message){ .event = PM_EVENT_ON, })
  158. struct dev_pm_info {
  159. pm_message_t power_state;
  160. unsigned can_wakeup:1;
  161. unsigned should_wakeup:1;
  162. bool sleeping:1; /* Owned by the PM core */
  163. #ifdef CONFIG_PM_SLEEP
  164. struct list_head entry;
  165. #endif
  166. };
  167. extern int device_power_down(pm_message_t state);
  168. extern void device_power_up(void);
  169. extern void device_resume(void);
  170. #ifdef CONFIG_PM_SLEEP
  171. extern int device_suspend(pm_message_t state);
  172. extern int device_prepare_suspend(pm_message_t state);
  173. extern void __suspend_report_result(const char *function, void *fn, int ret);
  174. #define suspend_report_result(fn, ret) \
  175. do { \
  176. __suspend_report_result(__FUNCTION__, fn, ret); \
  177. } while (0)
  178. #else /* !CONFIG_PM_SLEEP */
  179. static inline int device_suspend(pm_message_t state)
  180. {
  181. return 0;
  182. }
  183. #define suspend_report_result(fn, ret) do {} while (0)
  184. #endif /* !CONFIG_PM_SLEEP */
  185. /*
  186. * Global Power Management flags
  187. * Used to keep APM and ACPI from both being active
  188. */
  189. extern unsigned int pm_flags;
  190. #define PM_APM 1
  191. #define PM_ACPI 2
  192. #endif /* __KERNEL__ */
  193. #endif /* _LINUX_PM_H */