include/linux/pm.h

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