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/config.h> 27 #include <linux/list.h> 28 #include <asm/atomic.h> 29 30 /* 31 * Power management requests... these are passed to pm_send_all() and friends. 32 * 33 * these functions are old and deprecated, see below. 34 */ 35 typedef int __bitwise pm_request_t; 36 37 #define PM_SUSPEND ((__force pm_request_t) 1) /* enter D1-D3 */ 38 #define PM_RESUME ((__force pm_request_t) 2) /* enter D0 */ 39 40 41 /* 42 * Device types... these are passed to pm_register 43 */ 44 typedef int __bitwise pm_dev_t; 45 46 #define PM_UNKNOWN_DEV ((__force pm_dev_t) 0) /* generic */ 47 #define PM_SYS_DEV ((__force pm_dev_t) 1) /* system device (fan, KB controller, ...) */ 48 #define PM_PCI_DEV ((__force pm_dev_t) 2) /* PCI device */ 49 #define PM_USB_DEV ((__force pm_dev_t) 3) /* USB device */ 50 #define PM_SCSI_DEV ((__force pm_dev_t) 4) /* SCSI device */ 51 #define PM_ISA_DEV ((__force pm_dev_t) 5) /* ISA device */ 52 #define PM_MTD_DEV ((__force pm_dev_t) 6) /* Memory Technology Device */ 53 54 /* 55 * System device hardware ID (PnP) values 56 */ 57 enum 58 { 59 PM_SYS_UNKNOWN = 0x00000000, /* generic */ 60 PM_SYS_KBC = 0x41d00303, /* keyboard controller */ 61 PM_SYS_COM = 0x41d00500, /* serial port */ 62 PM_SYS_IRDA = 0x41d00510, /* IRDA controller */ 63 PM_SYS_FDC = 0x41d00700, /* floppy controller */ 64 PM_SYS_VGA = 0x41d00900, /* VGA controller */ 65 PM_SYS_PCMCIA = 0x41d00e00, /* PCMCIA controller */ 66 }; 67 68 /* 69 * Device identifier 70 */ 71 #define PM_PCI_ID(dev) ((dev)->bus->number << 16 | (dev)->devfn) 72 73 /* 74 * Request handler callback 75 */ 76 struct pm_dev; 77 78 typedef int (*pm_callback)(struct pm_dev *dev, pm_request_t rqst, void *data); 79 80 /* 81 * Dynamic device information 82 */ 83 struct pm_dev 84 { 85 pm_dev_t type; 86 unsigned long id; 87 pm_callback callback; 88 void *data; 89 90 unsigned long flags; 91 unsigned long state; 92 unsigned long prev_state; 93 94 struct list_head entry; 95 }; 96 97 /* Functions above this comment are list-based old-style power 98 * managment. Please avoid using them. */ 99 100 /* 101 * Callbacks for platform drivers to implement. 102 */ 103 extern void (*pm_idle)(void); 104 extern void (*pm_power_off)(void); 105 106 typedef int __bitwise suspend_state_t; 107 108 #define PM_SUSPEND_ON ((__force suspend_state_t) 0) 109 #define PM_SUSPEND_STANDBY ((__force suspend_state_t) 1) 110 #define PM_SUSPEND_MEM ((__force suspend_state_t) 3) 111 #define PM_SUSPEND_DISK ((__force suspend_state_t) 4) 112 #define PM_SUSPEND_MAX ((__force suspend_state_t) 5) 113 114 typedef int __bitwise suspend_disk_method_t; 115 116 #define PM_DISK_FIRMWARE ((__force suspend_disk_method_t) 1) 117 #define PM_DISK_PLATFORM ((__force suspend_disk_method_t) 2) 118 #define PM_DISK_SHUTDOWN ((__force suspend_disk_method_t) 3) 119 #define PM_DISK_REBOOT ((__force suspend_disk_method_t) 4) 120 #define PM_DISK_MAX ((__force suspend_disk_method_t) 5) 121 122 struct pm_ops { 123 suspend_disk_method_t pm_disk_mode; 124 int (*valid)(suspend_state_t state); 125 int (*prepare)(suspend_state_t state); 126 int (*enter)(suspend_state_t state); 127 int (*finish)(suspend_state_t state); 128 }; 129 130 extern void pm_set_ops(struct pm_ops *); 131 extern struct pm_ops *pm_ops; 132 extern int pm_suspend(suspend_state_t state); 133 134 135 /* 136 * Device power management 137 */ 138 139 struct device; 140 141 typedef struct pm_message { 142 int event; 143 } pm_message_t; 144 145 /* 146 * There are 4 important states driver can be in: 147 * ON -- driver is working 148 * FREEZE -- stop operations and apply whatever policy is applicable to a 149 * suspended driver of that class, freeze queues for block like IDE 150 * does, drop packets for ethernet, etc... stop DMA engine too etc... 151 * so a consistent image can be saved; but do not power any hardware 152 * down. 153 * SUSPEND - like FREEZE, but hardware is doing as much powersaving as 154 * possible. Roughly pci D3. 155 * 156 * Unfortunately, current drivers only recognize numeric values 0 (ON) and 3 157 * (SUSPEND). We'll need to fix the drivers. So yes, putting 3 to all different 158 * defines is intentional, and will go away as soon as drivers are fixed. Also 159 * note that typedef is neccessary, we'll probably want to switch to 160 * typedef struct pm_message_t { int event; int flags; } pm_message_t 161 * or something similar soon. 162 */ 163 164 #define PM_EVENT_ON 0 165 #define PM_EVENT_FREEZE 1 166 #define PM_EVENT_SUSPEND 2 167 168 #define PMSG_FREEZE ((struct pm_message){ .event = PM_EVENT_FREEZE, }) 169 #define PMSG_SUSPEND ((struct pm_message){ .event = PM_EVENT_SUSPEND, }) 170 #define PMSG_ON ((struct pm_message){ .event = PM_EVENT_ON, }) 171 172 struct dev_pm_info { 173 pm_message_t power_state; 174 unsigned can_wakeup:1; 175 #ifdef CONFIG_PM 176 unsigned should_wakeup:1; 177 pm_message_t prev_state; 178 void * saved_state; 179 struct device * pm_parent; 180 struct list_head entry; 181 #endif 182 }; 183 184 extern void device_pm_set_parent(struct device * dev, struct device * parent); 185 186 extern int device_power_down(pm_message_t state); 187 extern void device_power_up(void); 188 extern void device_resume(void); 189 190 #ifdef CONFIG_PM 191 extern suspend_disk_method_t pm_disk_mode; 192 193 extern int device_suspend(pm_message_t state); 194 195 #define device_set_wakeup_enable(dev,val) \ 196 ((dev)->power.should_wakeup = !!(val)) 197 #define device_may_wakeup(dev) \ 198 (device_can_wakeup(dev) && (dev)->power.should_wakeup) 199 200 extern int dpm_runtime_suspend(struct device *, pm_message_t); 201 extern void dpm_runtime_resume(struct device *); 202 203 #else /* !CONFIG_PM */ 204 205 static inline int device_suspend(pm_message_t state) 206 { 207 return 0; 208 } 209 210 #define device_set_wakeup_enable(dev,val) do{}while(0) 211 #define device_may_wakeup(dev) (0) 212 213 static inline int dpm_runtime_suspend(struct device * dev, pm_message_t state) 214 { 215 return 0; 216 } 217 218 static inline void dpm_runtime_resume(struct device * dev) 219 { 220 } 221 222 #endif 223 224 /* changes to device_may_wakeup take effect on the next pm state change. 225 * by default, devices should wakeup if they can. 226 */ 227 #define device_can_wakeup(dev) \ 228 ((dev)->power.can_wakeup) 229 #define device_init_wakeup(dev,val) \ 230 do { \ 231 device_can_wakeup(dev) = !!(val); \ 232 device_set_wakeup_enable(dev,val); \ 233 } while(0) 234 235 #endif /* __KERNEL__ */ 236 237 #endif /* _LINUX_PM_H */ 238