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