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/spinlock.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 #define GENPD_FLAG_IRQ_SAFE (1U << 1) /* PM domain operates in atomic */ 23 24 enum gpd_status { 25 GPD_STATE_ACTIVE = 0, /* PM domain is active */ 26 GPD_STATE_POWER_OFF, /* PM domain is off */ 27 }; 28 29 struct dev_power_governor { 30 bool (*power_down_ok)(struct dev_pm_domain *domain); 31 bool (*suspend_ok)(struct device *dev); 32 }; 33 34 struct gpd_dev_ops { 35 int (*start)(struct device *dev); 36 int (*stop)(struct device *dev); 37 bool (*active_wakeup)(struct device *dev); 38 }; 39 40 struct genpd_power_state { 41 s64 power_off_latency_ns; 42 s64 power_on_latency_ns; 43 s64 residency_ns; 44 struct fwnode_handle *fwnode; 45 }; 46 47 struct genpd_lock_ops; 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 dev_power_governor *gov; 56 struct work_struct power_off_work; 57 struct fwnode_handle *provider; /* Identity of the domain provider */ 58 bool has_provider; 59 const char *name; 60 atomic_t sd_count; /* Number of subdomains with power "on" */ 61 enum gpd_status status; /* Current state of the domain */ 62 unsigned int device_count; /* Number of devices */ 63 unsigned int suspended_count; /* System suspend device counter */ 64 unsigned int prepared_count; /* Suspend counter of prepared devices */ 65 int (*power_off)(struct generic_pm_domain *domain); 66 int (*power_on)(struct generic_pm_domain *domain); 67 struct gpd_dev_ops dev_ops; 68 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ 69 bool max_off_time_changed; 70 bool cached_power_down_ok; 71 int (*attach_dev)(struct generic_pm_domain *domain, 72 struct device *dev); 73 void (*detach_dev)(struct generic_pm_domain *domain, 74 struct device *dev); 75 unsigned int flags; /* Bit field of configs for genpd */ 76 struct genpd_power_state *states; 77 unsigned int state_count; /* number of states */ 78 unsigned int state_idx; /* state that genpd will go to when off */ 79 void *free; /* Free the state that was allocated for default */ 80 const struct genpd_lock_ops *lock_ops; 81 union { 82 struct mutex mlock; 83 struct { 84 spinlock_t slock; 85 unsigned long lock_flags; 86 }; 87 }; 88 89 }; 90 91 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) 92 { 93 return container_of(pd, struct generic_pm_domain, domain); 94 } 95 96 struct gpd_link { 97 struct generic_pm_domain *master; 98 struct list_head master_node; 99 struct generic_pm_domain *slave; 100 struct list_head slave_node; 101 }; 102 103 struct gpd_timing_data { 104 s64 suspend_latency_ns; 105 s64 resume_latency_ns; 106 s64 effective_constraint_ns; 107 bool constraint_changed; 108 bool cached_suspend_ok; 109 }; 110 111 struct pm_domain_data { 112 struct list_head list_node; 113 struct device *dev; 114 }; 115 116 struct generic_pm_domain_data { 117 struct pm_domain_data base; 118 struct gpd_timing_data td; 119 struct notifier_block nb; 120 }; 121 122 #ifdef CONFIG_PM_GENERIC_DOMAINS 123 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) 124 { 125 return container_of(pdd, struct generic_pm_domain_data, base); 126 } 127 128 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 129 { 130 return to_gpd_data(dev->power.subsys_data->domain_data); 131 } 132 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_remove_device(struct generic_pm_domain *genpd, 138 struct device *dev); 139 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 140 struct generic_pm_domain *new_subdomain); 141 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 142 struct generic_pm_domain *target); 143 extern int pm_genpd_init(struct generic_pm_domain *genpd, 144 struct dev_power_governor *gov, bool is_off); 145 extern int pm_genpd_remove(struct generic_pm_domain *genpd); 146 147 extern struct dev_power_governor simple_qos_governor; 148 extern struct dev_power_governor pm_domain_always_on_gov; 149 #else 150 151 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 152 { 153 return ERR_PTR(-ENOSYS); 154 } 155 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, 156 struct device *dev, 157 struct gpd_timing_data *td) 158 { 159 return -ENOSYS; 160 } 161 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, 162 struct device *dev) 163 { 164 return -ENOSYS; 165 } 166 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 167 struct generic_pm_domain *new_sd) 168 { 169 return -ENOSYS; 170 } 171 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 172 struct generic_pm_domain *target) 173 { 174 return -ENOSYS; 175 } 176 static inline int pm_genpd_init(struct generic_pm_domain *genpd, 177 struct dev_power_governor *gov, bool is_off) 178 { 179 return -ENOSYS; 180 } 181 static inline int pm_genpd_remove(struct generic_pm_domain *genpd) 182 { 183 return -ENOTSUPP; 184 } 185 186 #define simple_qos_governor (*(struct dev_power_governor *)(NULL)) 187 #define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL)) 188 #endif 189 190 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, 191 struct device *dev) 192 { 193 return __pm_genpd_add_device(genpd, dev, NULL); 194 } 195 196 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP 197 extern void pm_genpd_syscore_poweroff(struct device *dev); 198 extern void pm_genpd_syscore_poweron(struct device *dev); 199 #else 200 static inline void pm_genpd_syscore_poweroff(struct device *dev) {} 201 static inline void pm_genpd_syscore_poweron(struct device *dev) {} 202 #endif 203 204 /* OF PM domain providers */ 205 struct of_device_id; 206 207 struct genpd_onecell_data { 208 struct generic_pm_domain **domains; 209 unsigned int num_domains; 210 }; 211 212 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF 213 int of_genpd_add_provider_simple(struct device_node *np, 214 struct generic_pm_domain *genpd); 215 int of_genpd_add_provider_onecell(struct device_node *np, 216 struct genpd_onecell_data *data); 217 void of_genpd_del_provider(struct device_node *np); 218 extern int of_genpd_add_device(struct of_phandle_args *args, 219 struct device *dev); 220 extern int of_genpd_add_subdomain(struct of_phandle_args *parent, 221 struct of_phandle_args *new_subdomain); 222 extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np); 223 extern int of_genpd_parse_idle_states(struct device_node *dn, 224 struct genpd_power_state **states, int *n); 225 226 int genpd_dev_pm_attach(struct device *dev); 227 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ 228 static inline int of_genpd_add_provider_simple(struct device_node *np, 229 struct generic_pm_domain *genpd) 230 { 231 return -ENOTSUPP; 232 } 233 234 static inline int of_genpd_add_provider_onecell(struct device_node *np, 235 struct genpd_onecell_data *data) 236 { 237 return -ENOTSUPP; 238 } 239 240 static inline void of_genpd_del_provider(struct device_node *np) {} 241 242 static inline int of_genpd_add_device(struct of_phandle_args *args, 243 struct device *dev) 244 { 245 return -ENODEV; 246 } 247 248 static inline int of_genpd_add_subdomain(struct of_phandle_args *parent, 249 struct of_phandle_args *new_subdomain) 250 { 251 return -ENODEV; 252 } 253 254 static inline int of_genpd_parse_idle_states(struct device_node *dn, 255 struct genpd_power_state **states, int *n) 256 { 257 return -ENODEV; 258 } 259 260 static inline int genpd_dev_pm_attach(struct device *dev) 261 { 262 return -ENODEV; 263 } 264 265 static inline 266 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np) 267 { 268 return ERR_PTR(-ENOTSUPP); 269 } 270 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ 271 272 #ifdef CONFIG_PM 273 extern int dev_pm_domain_attach(struct device *dev, bool power_on); 274 extern void dev_pm_domain_detach(struct device *dev, bool power_off); 275 extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd); 276 #else 277 static inline int dev_pm_domain_attach(struct device *dev, bool power_on) 278 { 279 return -ENODEV; 280 } 281 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} 282 static inline void dev_pm_domain_set(struct device *dev, 283 struct dev_pm_domain *pd) {} 284 #endif 285 286 #endif /* _LINUX_PM_DOMAIN_H */ 287