1 /* 2 * pm_domain.h - Definitions and headers related to device power domains. 3 * 4 * Copyright (C) 2011 Rafael J. Wysocki <[email protected]>, Renesas Electronics Corp. 5 * 6 * This file is released under the GPLv2. 7 */ 8 9 #ifndef _LINUX_PM_DOMAIN_H 10 #define _LINUX_PM_DOMAIN_H 11 12 #include <linux/device.h> 13 #include <linux/mutex.h> 14 #include <linux/pm.h> 15 #include <linux/err.h> 16 #include <linux/of.h> 17 #include <linux/notifier.h> 18 #include <linux/cpuidle.h> 19 20 enum gpd_status { 21 GPD_STATE_ACTIVE = 0, /* PM domain is active */ 22 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */ 23 GPD_STATE_BUSY, /* Something is happening to the PM domain */ 24 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */ 25 GPD_STATE_POWER_OFF, /* PM domain is off */ 26 }; 27 28 struct dev_power_governor { 29 bool (*power_down_ok)(struct dev_pm_domain *domain); 30 bool (*stop_ok)(struct device *dev); 31 }; 32 33 struct gpd_dev_ops { 34 int (*start)(struct device *dev); 35 int (*stop)(struct device *dev); 36 int (*save_state)(struct device *dev); 37 int (*restore_state)(struct device *dev); 38 int (*suspend)(struct device *dev); 39 int (*suspend_late)(struct device *dev); 40 int (*resume_early)(struct device *dev); 41 int (*resume)(struct device *dev); 42 int (*freeze)(struct device *dev); 43 int (*freeze_late)(struct device *dev); 44 int (*thaw_early)(struct device *dev); 45 int (*thaw)(struct device *dev); 46 bool (*active_wakeup)(struct device *dev); 47 }; 48 49 struct gpd_cpu_data { 50 unsigned int saved_exit_latency; 51 struct cpuidle_state *idle_state; 52 }; 53 54 struct generic_pm_domain { 55 struct dev_pm_domain domain; /* PM domain operations */ 56 struct list_head gpd_list_node; /* Node in the global PM domains list */ 57 struct list_head master_links; /* Links with PM domain as a master */ 58 struct list_head slave_links; /* Links with PM domain as a slave */ 59 struct list_head dev_list; /* List of devices */ 60 struct mutex lock; 61 struct dev_power_governor *gov; 62 struct work_struct power_off_work; 63 char *name; 64 unsigned int in_progress; /* Number of devices being suspended now */ 65 atomic_t sd_count; /* Number of subdomains with power "on" */ 66 enum gpd_status status; /* Current state of the domain */ 67 wait_queue_head_t status_wait_queue; 68 struct task_struct *poweroff_task; /* Powering off task */ 69 unsigned int resume_count; /* Number of devices being resumed */ 70 unsigned int device_count; /* Number of devices */ 71 unsigned int suspended_count; /* System suspend device counter */ 72 unsigned int prepared_count; /* Suspend counter of prepared devices */ 73 bool suspend_power_off; /* Power status before system suspend */ 74 bool dev_irq_safe; /* Device callbacks are IRQ-safe */ 75 int (*power_off)(struct generic_pm_domain *domain); 76 s64 power_off_latency_ns; 77 int (*power_on)(struct generic_pm_domain *domain); 78 s64 power_on_latency_ns; 79 struct gpd_dev_ops dev_ops; 80 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ 81 bool max_off_time_changed; 82 bool cached_power_down_ok; 83 struct device_node *of_node; /* Node in device tree */ 84 struct gpd_cpu_data *cpu_data; 85 }; 86 87 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) 88 { 89 return container_of(pd, struct generic_pm_domain, domain); 90 } 91 92 struct gpd_link { 93 struct generic_pm_domain *master; 94 struct list_head master_node; 95 struct generic_pm_domain *slave; 96 struct list_head slave_node; 97 }; 98 99 struct gpd_timing_data { 100 s64 stop_latency_ns; 101 s64 start_latency_ns; 102 s64 save_state_latency_ns; 103 s64 restore_state_latency_ns; 104 s64 effective_constraint_ns; 105 bool constraint_changed; 106 bool cached_stop_ok; 107 }; 108 109 struct generic_pm_domain_data { 110 struct pm_domain_data base; 111 struct gpd_dev_ops ops; 112 struct gpd_timing_data td; 113 struct notifier_block nb; 114 struct mutex lock; 115 unsigned int refcount; 116 bool need_restore; 117 bool always_on; 118 }; 119 120 #ifdef CONFIG_PM_GENERIC_DOMAINS 121 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) 122 { 123 return container_of(pdd, struct generic_pm_domain_data, base); 124 } 125 126 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 127 { 128 return to_gpd_data(dev->power.subsys_data->domain_data); 129 } 130 131 extern struct dev_power_governor simple_qos_governor; 132 133 extern struct generic_pm_domain *dev_to_genpd(struct device *dev); 134 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, 135 struct device *dev, 136 struct gpd_timing_data *td); 137 138 extern int __pm_genpd_of_add_device(struct device_node *genpd_node, 139 struct device *dev, 140 struct gpd_timing_data *td); 141 142 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, 143 struct device *dev) 144 { 145 return __pm_genpd_add_device(genpd, dev, NULL); 146 } 147 148 static inline int pm_genpd_of_add_device(struct device_node *genpd_node, 149 struct device *dev) 150 { 151 return __pm_genpd_of_add_device(genpd_node, dev, NULL); 152 } 153 154 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, 155 struct device *dev); 156 extern void pm_genpd_dev_always_on(struct device *dev, bool val); 157 extern void pm_genpd_dev_need_restore(struct device *dev, bool val); 158 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 159 struct generic_pm_domain *new_subdomain); 160 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 161 struct generic_pm_domain *target); 162 extern int pm_genpd_add_callbacks(struct device *dev, 163 struct gpd_dev_ops *ops, 164 struct gpd_timing_data *td); 165 extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td); 166 extern int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state); 167 extern int genpd_detach_cpuidle(struct generic_pm_domain *genpd); 168 extern void pm_genpd_init(struct generic_pm_domain *genpd, 169 struct dev_power_governor *gov, bool is_off); 170 171 extern int pm_genpd_poweron(struct generic_pm_domain *genpd); 172 173 extern bool default_stop_ok(struct device *dev); 174 175 extern struct dev_power_governor pm_domain_always_on_gov; 176 #else 177 178 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 179 { 180 return ERR_PTR(-ENOSYS); 181 } 182 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev) 183 { 184 return ERR_PTR(-ENOSYS); 185 } 186 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, 187 struct device *dev, 188 struct gpd_timing_data *td) 189 { 190 return -ENOSYS; 191 } 192 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, 193 struct device *dev) 194 { 195 return -ENOSYS; 196 } 197 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, 198 struct device *dev) 199 { 200 return -ENOSYS; 201 } 202 static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {} 203 static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {} 204 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 205 struct generic_pm_domain *new_sd) 206 { 207 return -ENOSYS; 208 } 209 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 210 struct generic_pm_domain *target) 211 { 212 return -ENOSYS; 213 } 214 static inline int pm_genpd_add_callbacks(struct device *dev, 215 struct gpd_dev_ops *ops, 216 struct gpd_timing_data *td) 217 { 218 return -ENOSYS; 219 } 220 static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td) 221 { 222 return -ENOSYS; 223 } 224 static inline int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st) 225 { 226 return -ENOSYS; 227 } 228 static inline int genpd_detach_cpuidle(struct generic_pm_domain *genpd) 229 { 230 return -ENOSYS; 231 } 232 static inline void pm_genpd_init(struct generic_pm_domain *genpd, 233 struct dev_power_governor *gov, bool is_off) 234 { 235 } 236 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) 237 { 238 return -ENOSYS; 239 } 240 static inline bool default_stop_ok(struct device *dev) 241 { 242 return false; 243 } 244 #define simple_qos_governor NULL 245 #define pm_domain_always_on_gov NULL 246 #endif 247 248 static inline int pm_genpd_remove_callbacks(struct device *dev) 249 { 250 return __pm_genpd_remove_callbacks(dev, true); 251 } 252 253 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME 254 extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd); 255 extern void pm_genpd_poweroff_unused(void); 256 #else 257 static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {} 258 static inline void pm_genpd_poweroff_unused(void) {} 259 #endif 260 261 #endif /* _LINUX_PM_DOMAIN_H */ 262