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 19 /* Defines used for the flags field in the struct generic_pm_domain */ 20 #define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */ 21 22 #define GENPD_MAX_NUM_STATES 8 /* Number of possible low power states */ 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 (*stop_ok)(struct device *dev); 32 }; 33 34 struct gpd_dev_ops { 35 int (*start)(struct device *dev); 36 int (*stop)(struct device *dev); 37 int (*save_state)(struct device *dev); 38 int (*restore_state)(struct device *dev); 39 bool (*active_wakeup)(struct device *dev); 40 }; 41 42 struct genpd_power_state { 43 s64 power_off_latency_ns; 44 s64 power_on_latency_ns; 45 }; 46 47 struct generic_pm_domain { 48 struct dev_pm_domain domain; /* PM domain operations */ 49 struct list_head gpd_list_node; /* Node in the global PM domains list */ 50 struct list_head master_links; /* Links with PM domain as a master */ 51 struct list_head slave_links; /* Links with PM domain as a slave */ 52 struct list_head dev_list; /* List of devices */ 53 struct mutex lock; 54 struct dev_power_governor *gov; 55 struct work_struct power_off_work; 56 const char *name; 57 atomic_t sd_count; /* Number of subdomains with power "on" */ 58 enum gpd_status status; /* Current state of the domain */ 59 unsigned int device_count; /* Number of devices */ 60 unsigned int suspended_count; /* System suspend device counter */ 61 unsigned int prepared_count; /* Suspend counter of prepared devices */ 62 bool suspend_power_off; /* Power status before system suspend */ 63 int (*power_off)(struct generic_pm_domain *domain); 64 int (*power_on)(struct generic_pm_domain *domain); 65 struct gpd_dev_ops dev_ops; 66 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ 67 bool max_off_time_changed; 68 bool cached_power_down_ok; 69 int (*attach_dev)(struct generic_pm_domain *domain, 70 struct device *dev); 71 void (*detach_dev)(struct generic_pm_domain *domain, 72 struct device *dev); 73 unsigned int flags; /* Bit field of configs for genpd */ 74 struct genpd_power_state states[GENPD_MAX_NUM_STATES]; 75 unsigned int state_count; /* number of states */ 76 unsigned int state_idx; /* state that genpd will go to when off */ 77 78 }; 79 80 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) 81 { 82 return container_of(pd, struct generic_pm_domain, domain); 83 } 84 85 struct gpd_link { 86 struct generic_pm_domain *master; 87 struct list_head master_node; 88 struct generic_pm_domain *slave; 89 struct list_head slave_node; 90 }; 91 92 struct gpd_timing_data { 93 s64 suspend_latency_ns; 94 s64 resume_latency_ns; 95 s64 effective_constraint_ns; 96 bool constraint_changed; 97 bool cached_stop_ok; 98 }; 99 100 struct pm_domain_data { 101 struct list_head list_node; 102 struct device *dev; 103 }; 104 105 struct generic_pm_domain_data { 106 struct pm_domain_data base; 107 struct gpd_timing_data td; 108 struct notifier_block nb; 109 }; 110 111 #ifdef CONFIG_PM_GENERIC_DOMAINS 112 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) 113 { 114 return container_of(pdd, struct generic_pm_domain_data, base); 115 } 116 117 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 118 { 119 return to_gpd_data(dev->power.subsys_data->domain_data); 120 } 121 122 extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev); 123 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, 124 struct device *dev, 125 struct gpd_timing_data *td); 126 127 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, 128 struct device *dev); 129 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 130 struct generic_pm_domain *new_subdomain); 131 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 132 struct generic_pm_domain *target); 133 extern void pm_genpd_init(struct generic_pm_domain *genpd, 134 struct dev_power_governor *gov, bool is_off); 135 136 extern struct dev_power_governor simple_qos_governor; 137 extern struct dev_power_governor pm_domain_always_on_gov; 138 #else 139 140 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) 141 { 142 return ERR_PTR(-ENOSYS); 143 } 144 static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev) 145 { 146 return NULL; 147 } 148 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, 149 struct device *dev, 150 struct gpd_timing_data *td) 151 { 152 return -ENOSYS; 153 } 154 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, 155 struct device *dev) 156 { 157 return -ENOSYS; 158 } 159 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, 160 struct generic_pm_domain *new_sd) 161 { 162 return -ENOSYS; 163 } 164 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, 165 struct generic_pm_domain *target) 166 { 167 return -ENOSYS; 168 } 169 static inline void pm_genpd_init(struct generic_pm_domain *genpd, 170 struct dev_power_governor *gov, bool is_off) 171 { 172 } 173 #endif 174 175 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, 176 struct device *dev) 177 { 178 return __pm_genpd_add_device(genpd, dev, NULL); 179 } 180 181 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP 182 extern void pm_genpd_syscore_poweroff(struct device *dev); 183 extern void pm_genpd_syscore_poweron(struct device *dev); 184 #else 185 static inline void pm_genpd_syscore_poweroff(struct device *dev) {} 186 static inline void pm_genpd_syscore_poweron(struct device *dev) {} 187 #endif 188 189 /* OF PM domain providers */ 190 struct of_device_id; 191 192 struct genpd_onecell_data { 193 struct generic_pm_domain **domains; 194 unsigned int num_domains; 195 }; 196 197 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, 198 void *data); 199 200 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF 201 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, 202 void *data); 203 void of_genpd_del_provider(struct device_node *np); 204 struct generic_pm_domain *of_genpd_get_from_provider( 205 struct of_phandle_args *genpdspec); 206 207 struct generic_pm_domain *__of_genpd_xlate_simple( 208 struct of_phandle_args *genpdspec, 209 void *data); 210 struct generic_pm_domain *__of_genpd_xlate_onecell( 211 struct of_phandle_args *genpdspec, 212 void *data); 213 214 int genpd_dev_pm_attach(struct device *dev); 215 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ 216 static inline int __of_genpd_add_provider(struct device_node *np, 217 genpd_xlate_t xlate, void *data) 218 { 219 return 0; 220 } 221 static inline void of_genpd_del_provider(struct device_node *np) {} 222 223 static inline struct generic_pm_domain *of_genpd_get_from_provider( 224 struct of_phandle_args *genpdspec) 225 { 226 return NULL; 227 } 228 229 #define __of_genpd_xlate_simple NULL 230 #define __of_genpd_xlate_onecell NULL 231 232 static inline int genpd_dev_pm_attach(struct device *dev) 233 { 234 return -ENODEV; 235 } 236 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ 237 238 static inline int of_genpd_add_provider_simple(struct device_node *np, 239 struct generic_pm_domain *genpd) 240 { 241 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd); 242 } 243 static inline int of_genpd_add_provider_onecell(struct device_node *np, 244 struct genpd_onecell_data *data) 245 { 246 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data); 247 } 248 249 #ifdef CONFIG_PM 250 extern int dev_pm_domain_attach(struct device *dev, bool power_on); 251 extern void dev_pm_domain_detach(struct device *dev, bool power_off); 252 extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd); 253 #else 254 static inline int dev_pm_domain_attach(struct device *dev, bool power_on) 255 { 256 return -ENODEV; 257 } 258 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} 259 static inline void dev_pm_domain_set(struct device *dev, 260 struct dev_pm_domain *pd) {} 261 #endif 262 263 #endif /* _LINUX_PM_DOMAIN_H */ 264