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 /* Defines used for the flags field in the struct generic_pm_domain */ 21 #define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */ 22 23 enum gpd_status { 24 GPD_STATE_ACTIVE = 0, /* PM domain is active */ 25 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */ 26 GPD_STATE_BUSY, /* Something is happening to the PM domain */ 27 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */ 28 GPD_STATE_POWER_OFF, /* PM domain is off */ 29 }; 30 31 struct dev_power_governor { 32 bool (*power_down_ok)(struct dev_pm_domain *domain); 33 bool (*stop_ok)(struct device *dev); 34 }; 35 36 struct gpd_dev_ops { 37 int (*start)(struct device *dev); 38 int (*stop)(struct device *dev); 39 int (*save_state)(struct device *dev); 40 int (*restore_state)(struct device *dev); 41 bool (*active_wakeup)(struct device *dev); 42 }; 43 44 struct gpd_cpuidle_data { 45 unsigned int saved_exit_latency; 46 struct cpuidle_state *idle_state; 47 }; 48 49 struct generic_pm_domain { 50 struct dev_pm_domain domain; /* PM domain operations */ 51 struct list_head gpd_list_node; /* Node in the global PM domains list */ 52 struct list_head master_links; /* Links with PM domain as a master */ 53 struct list_head slave_links; /* Links with PM domain as a slave */ 54 struct list_head dev_list; /* List of devices */ 55 struct mutex lock; 56 struct dev_power_governor *gov; 57 struct work_struct power_off_work; 58 const char *name; 59 unsigned int in_progress; /* Number of devices being suspended now */ 60 atomic_t sd_count; /* Number of subdomains with power "on" */ 61 enum gpd_status status; /* Current state of the domain */ 62 wait_queue_head_t status_wait_queue; 63 struct task_struct *poweroff_task; /* Powering off task */ 64 unsigned int resume_count; /* Number of devices being resumed */ 65 unsigned int device_count; /* Number of devices */ 66 unsigned int suspended_count; /* System suspend device counter */ 67 unsigned int prepared_count; /* Suspend counter of prepared devices */ 68 bool suspend_power_off; /* Power status before system suspend */ 69 int (*power_off)(struct generic_pm_domain *domain); 70 s64 power_off_latency_ns; 71 int (*power_on)(struct generic_pm_domain *domain); 72 s64 power_on_latency_ns; 73 struct gpd_dev_ops dev_ops; 74 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ 75 bool max_off_time_changed; 76 bool cached_power_down_ok; 77 struct gpd_cpuidle_data *cpuidle_data; 78 int (*attach_dev)(struct generic_pm_domain *domain, 79 struct device *dev); 80 void (*detach_dev)(struct generic_pm_domain *domain, 81 struct device *dev); 82 unsigned int flags; /* Bit field of configs for genpd */ 83 }; 84 85 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) 86 { 87 return container_of(pd, struct generic_pm_domain, domain); 88 } 89 90 struct gpd_link { 91 struct generic_pm_domain *master; 92 struct list_head master_node; 93 struct generic_pm_domain *slave; 94 struct list_head slave_node; 95 }; 96 97 struct gpd_timing_data { 98 s64 stop_latency_ns; 99 s64 start_latency_ns; 100 s64 save_state_latency_ns; 101 s64 restore_state_latency_ns; 102 s64 effective_constraint_ns; 103 bool constraint_changed; 104 bool cached_stop_ok; 105 }; 106 107 struct pm_domain_data { 108 struct list_head list_node; 109 struct device *dev; 110 }; 111 112 struct generic_pm_domain_data { 113 struct pm_domain_data base; 114 struct gpd_timing_data td; 115 struct notifier_block nb; 116 struct mutex lock; 117 unsigned int refcount; 118 int need_restore; 119 }; 120 121 #ifdef CONFIG_PM_GENERIC_DOMAINS 122 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) 123 { 124 return container_of(pdd, struct generic_pm_domain_data, base); 125 } 126 127 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 128 { 129 return to_gpd_data(dev->power.subsys_data->domain_data); 130 } 131 132 extern struct generic_pm_domain *dev_to_genpd(struct device *dev); 133 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, 134 struct device *dev, 135 struct gpd_timing_data *td); 136 137 extern int __pm_genpd_name_add_device(const char *domain_name, 138 struct device *dev, 139 struct gpd_timing_data *td); 140 141 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, 142 struct device *dev); 143 extern void pm_genpd_dev_need_restore(struct device *dev, bool val); 144 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 145 struct generic_pm_domain *new_subdomain); 146 extern int pm_genpd_add_subdomain_names(const char *master_name, 147 const char *subdomain_name); 148 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 149 struct generic_pm_domain *target); 150 extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state); 151 extern int pm_genpd_name_attach_cpuidle(const char *name, int state); 152 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd); 153 extern int pm_genpd_name_detach_cpuidle(const char *name); 154 extern void pm_genpd_init(struct generic_pm_domain *genpd, 155 struct dev_power_governor *gov, bool is_off); 156 157 extern int pm_genpd_poweron(struct generic_pm_domain *genpd); 158 extern int pm_genpd_name_poweron(const char *domain_name); 159 extern void pm_genpd_poweroff_unused(void); 160 161 extern struct dev_power_governor simple_qos_governor; 162 extern struct dev_power_governor pm_domain_always_on_gov; 163 #else 164 165 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 166 { 167 return ERR_PTR(-ENOSYS); 168 } 169 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev) 170 { 171 return ERR_PTR(-ENOSYS); 172 } 173 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, 174 struct device *dev, 175 struct gpd_timing_data *td) 176 { 177 return -ENOSYS; 178 } 179 static inline int __pm_genpd_name_add_device(const char *domain_name, 180 struct device *dev, 181 struct gpd_timing_data *td) 182 { 183 return -ENOSYS; 184 } 185 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, 186 struct device *dev) 187 { 188 return -ENOSYS; 189 } 190 static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {} 191 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 192 struct generic_pm_domain *new_sd) 193 { 194 return -ENOSYS; 195 } 196 static inline int pm_genpd_add_subdomain_names(const char *master_name, 197 const char *subdomain_name) 198 { 199 return -ENOSYS; 200 } 201 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 202 struct generic_pm_domain *target) 203 { 204 return -ENOSYS; 205 } 206 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st) 207 { 208 return -ENOSYS; 209 } 210 static inline int pm_genpd_name_attach_cpuidle(const char *name, int state) 211 { 212 return -ENOSYS; 213 } 214 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd) 215 { 216 return -ENOSYS; 217 } 218 static inline int pm_genpd_name_detach_cpuidle(const char *name) 219 { 220 return -ENOSYS; 221 } 222 static inline void pm_genpd_init(struct generic_pm_domain *genpd, 223 struct dev_power_governor *gov, bool is_off) 224 { 225 } 226 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) 227 { 228 return -ENOSYS; 229 } 230 static inline int pm_genpd_name_poweron(const char *domain_name) 231 { 232 return -ENOSYS; 233 } 234 static inline void pm_genpd_poweroff_unused(void) {} 235 #define simple_qos_governor NULL 236 #define pm_domain_always_on_gov NULL 237 #endif 238 239 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, 240 struct device *dev) 241 { 242 return __pm_genpd_add_device(genpd, dev, NULL); 243 } 244 245 static inline int pm_genpd_name_add_device(const char *domain_name, 246 struct device *dev) 247 { 248 return __pm_genpd_name_add_device(domain_name, dev, NULL); 249 } 250 251 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP 252 extern void pm_genpd_syscore_poweroff(struct device *dev); 253 extern void pm_genpd_syscore_poweron(struct device *dev); 254 #else 255 static inline void pm_genpd_syscore_poweroff(struct device *dev) {} 256 static inline void pm_genpd_syscore_poweron(struct device *dev) {} 257 #endif 258 259 /* OF PM domain providers */ 260 struct of_device_id; 261 262 struct genpd_onecell_data { 263 struct generic_pm_domain **domains; 264 unsigned int num_domains; 265 }; 266 267 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, 268 void *data); 269 270 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF 271 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, 272 void *data); 273 void of_genpd_del_provider(struct device_node *np); 274 275 struct generic_pm_domain *__of_genpd_xlate_simple( 276 struct of_phandle_args *genpdspec, 277 void *data); 278 struct generic_pm_domain *__of_genpd_xlate_onecell( 279 struct of_phandle_args *genpdspec, 280 void *data); 281 282 int genpd_dev_pm_attach(struct device *dev); 283 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ 284 static inline int __of_genpd_add_provider(struct device_node *np, 285 genpd_xlate_t xlate, void *data) 286 { 287 return 0; 288 } 289 static inline void of_genpd_del_provider(struct device_node *np) {} 290 291 #define __of_genpd_xlate_simple NULL 292 #define __of_genpd_xlate_onecell NULL 293 294 static inline int genpd_dev_pm_attach(struct device *dev) 295 { 296 return -ENODEV; 297 } 298 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ 299 300 static inline int of_genpd_add_provider_simple(struct device_node *np, 301 struct generic_pm_domain *genpd) 302 { 303 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd); 304 } 305 static inline int of_genpd_add_provider_onecell(struct device_node *np, 306 struct genpd_onecell_data *data) 307 { 308 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data); 309 } 310 311 #ifdef CONFIG_PM 312 extern int dev_pm_domain_attach(struct device *dev, bool power_on); 313 extern void dev_pm_domain_detach(struct device *dev, bool power_off); 314 #else 315 static inline int dev_pm_domain_attach(struct device *dev, bool power_on) 316 { 317 return -ENODEV; 318 } 319 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} 320 #endif 321 322 #endif /* _LINUX_PM_DOMAIN_H */ 323