Commit | Line | Data |
---|---|---|
f721889f RW |
1 | /* |
2 | * pm_domain.h - Definitions and headers related to device power domains. | |
3 | * | |
4 | * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, 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> | |
313162d0 PG |
13 | #include <linux/mutex.h> |
14 | #include <linux/pm.h> | |
4f042cda | 15 | #include <linux/err.h> |
c8aa130b | 16 | #include <linux/of.h> |
6ff7bb0d | 17 | #include <linux/notifier.h> |
cbc9ef02 | 18 | #include <linux/cpuidle.h> |
f721889f | 19 | |
c11f6f5b UH |
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 | ||
17b75eca RW |
23 | enum gpd_status { |
24 | GPD_STATE_ACTIVE = 0, /* PM domain is active */ | |
17b75eca RW |
25 | GPD_STATE_POWER_OFF, /* PM domain is off */ |
26 | }; | |
596ba34b | 27 | |
f721889f RW |
28 | struct dev_power_governor { |
29 | bool (*power_down_ok)(struct dev_pm_domain *domain); | |
b02c999a | 30 | bool (*stop_ok)(struct device *dev); |
f721889f RW |
31 | }; |
32 | ||
d5e4cbfe RW |
33 | struct gpd_dev_ops { |
34 | int (*start)(struct device *dev); | |
35 | int (*stop)(struct device *dev); | |
ecf00475 RW |
36 | int (*save_state)(struct device *dev); |
37 | int (*restore_state)(struct device *dev); | |
d5e4cbfe RW |
38 | bool (*active_wakeup)(struct device *dev); |
39 | }; | |
40 | ||
f39cb179 | 41 | struct gpd_cpuidle_data { |
cbc9ef02 RW |
42 | unsigned int saved_exit_latency; |
43 | struct cpuidle_state *idle_state; | |
44 | }; | |
45 | ||
f721889f RW |
46 | struct generic_pm_domain { |
47 | struct dev_pm_domain domain; /* PM domain operations */ | |
5125bbf3 | 48 | struct list_head gpd_list_node; /* Node in the global PM domains list */ |
5063ce15 RW |
49 | struct list_head master_links; /* Links with PM domain as a master */ |
50 | struct list_head slave_links; /* Links with PM domain as a slave */ | |
f721889f RW |
51 | struct list_head dev_list; /* List of devices */ |
52 | struct mutex lock; | |
53 | struct dev_power_governor *gov; | |
54 | struct work_struct power_off_work; | |
d07e9c17 | 55 | const char *name; |
f721889f | 56 | unsigned int in_progress; /* Number of devices being suspended now */ |
c4bb3160 | 57 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
17b75eca | 58 | enum gpd_status status; /* Current state of the domain */ |
596ba34b RW |
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 */ | |
f721889f | 63 | int (*power_off)(struct generic_pm_domain *domain); |
221e9b58 | 64 | s64 power_off_latency_ns; |
f721889f | 65 | int (*power_on)(struct generic_pm_domain *domain); |
221e9b58 | 66 | s64 power_on_latency_ns; |
d5e4cbfe | 67 | struct gpd_dev_ops dev_ops; |
221e9b58 | 68 | s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ |
6ff7bb0d RW |
69 | bool max_off_time_changed; |
70 | bool cached_power_down_ok; | |
f39cb179 | 71 | struct gpd_cpuidle_data *cpuidle_data; |
c16561e8 UH |
72 | int (*attach_dev)(struct generic_pm_domain *domain, |
73 | struct device *dev); | |
74 | void (*detach_dev)(struct generic_pm_domain *domain, | |
75 | struct device *dev); | |
c11f6f5b | 76 | unsigned int flags; /* Bit field of configs for genpd */ |
f721889f RW |
77 | }; |
78 | ||
596ba34b RW |
79 | static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) |
80 | { | |
81 | return container_of(pd, struct generic_pm_domain, domain); | |
82 | } | |
83 | ||
5063ce15 RW |
84 | struct gpd_link { |
85 | struct generic_pm_domain *master; | |
86 | struct list_head master_node; | |
87 | struct generic_pm_domain *slave; | |
88 | struct list_head slave_node; | |
89 | }; | |
90 | ||
b02c999a RW |
91 | struct gpd_timing_data { |
92 | s64 stop_latency_ns; | |
93 | s64 start_latency_ns; | |
221e9b58 RW |
94 | s64 save_state_latency_ns; |
95 | s64 restore_state_latency_ns; | |
a5bef810 | 96 | s64 effective_constraint_ns; |
6ff7bb0d RW |
97 | bool constraint_changed; |
98 | bool cached_stop_ok; | |
b02c999a RW |
99 | }; |
100 | ||
00e7c295 UH |
101 | struct pm_domain_data { |
102 | struct list_head list_node; | |
103 | struct device *dev; | |
104 | }; | |
105 | ||
cd0ea672 RW |
106 | struct generic_pm_domain_data { |
107 | struct pm_domain_data base; | |
b02c999a | 108 | struct gpd_timing_data td; |
6ff7bb0d | 109 | struct notifier_block nb; |
cd0ea672 RW |
110 | }; |
111 | ||
9b4f617b | 112 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
cd0ea672 RW |
113 | static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) |
114 | { | |
115 | return container_of(pdd, struct generic_pm_domain_data, base); | |
116 | } | |
117 | ||
d5e4cbfe RW |
118 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
119 | { | |
120 | return to_gpd_data(dev->power.subsys_data->domain_data); | |
121 | } | |
122 | ||
446d999c | 123 | extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev); |
b02c999a RW |
124 | extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
125 | struct device *dev, | |
126 | struct gpd_timing_data *td); | |
127 | ||
b5abb085 RW |
128 | extern int __pm_genpd_name_add_device(const char *domain_name, |
129 | struct device *dev, | |
130 | struct gpd_timing_data *td); | |
c8aa130b | 131 | |
f721889f RW |
132 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
133 | struct device *dev); | |
134 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, | |
135 | struct generic_pm_domain *new_subdomain); | |
fb7268be RW |
136 | extern int pm_genpd_add_subdomain_names(const char *master_name, |
137 | const char *subdomain_name); | |
f721889f RW |
138 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
139 | struct generic_pm_domain *target); | |
40114447 | 140 | extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state); |
74a2799a | 141 | extern int pm_genpd_name_attach_cpuidle(const char *name, int state); |
40114447 | 142 | extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd); |
74a2799a | 143 | extern int pm_genpd_name_detach_cpuidle(const char *name); |
f721889f RW |
144 | extern void pm_genpd_init(struct generic_pm_domain *genpd, |
145 | struct dev_power_governor *gov, bool is_off); | |
b02c999a | 146 | |
18b4f3f5 | 147 | extern int pm_genpd_poweron(struct generic_pm_domain *genpd); |
8bc0251d | 148 | extern int pm_genpd_name_poweron(const char *domain_name); |
d30d819d | 149 | extern void pm_genpd_poweroff_unused(void); |
b02c999a | 150 | |
ae3c511c | 151 | extern struct dev_power_governor simple_qos_governor; |
925b44a2 | 152 | extern struct dev_power_governor pm_domain_always_on_gov; |
f721889f | 153 | #else |
b02c999a | 154 | |
b642631d MD |
155 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
156 | { | |
157 | return ERR_PTR(-ENOSYS); | |
158 | } | |
446d999c | 159 | static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev) |
b02c999a | 160 | { |
446d999c | 161 | return NULL; |
b02c999a RW |
162 | } |
163 | static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, | |
164 | struct device *dev, | |
165 | struct gpd_timing_data *td) | |
166 | { | |
167 | return -ENOSYS; | |
168 | } | |
b5abb085 RW |
169 | static inline int __pm_genpd_name_add_device(const char *domain_name, |
170 | struct device *dev, | |
171 | struct gpd_timing_data *td) | |
f721889f RW |
172 | { |
173 | return -ENOSYS; | |
174 | } | |
175 | static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, | |
176 | struct device *dev) | |
177 | { | |
178 | return -ENOSYS; | |
179 | } | |
180 | static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, | |
181 | struct generic_pm_domain *new_sd) | |
182 | { | |
183 | return -ENOSYS; | |
184 | } | |
fb7268be RW |
185 | static inline int pm_genpd_add_subdomain_names(const char *master_name, |
186 | const char *subdomain_name) | |
187 | { | |
188 | return -ENOSYS; | |
189 | } | |
f721889f RW |
190 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
191 | struct generic_pm_domain *target) | |
192 | { | |
193 | return -ENOSYS; | |
194 | } | |
40114447 | 195 | static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st) |
cbc9ef02 RW |
196 | { |
197 | return -ENOSYS; | |
198 | } | |
74a2799a RW |
199 | static inline int pm_genpd_name_attach_cpuidle(const char *name, int state) |
200 | { | |
201 | return -ENOSYS; | |
202 | } | |
40114447 | 203 | static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd) |
cbc9ef02 RW |
204 | { |
205 | return -ENOSYS; | |
206 | } | |
74a2799a RW |
207 | static inline int pm_genpd_name_detach_cpuidle(const char *name) |
208 | { | |
209 | return -ENOSYS; | |
210 | } | |
b642631d MD |
211 | static inline void pm_genpd_init(struct generic_pm_domain *genpd, |
212 | struct dev_power_governor *gov, bool is_off) | |
b02c999a RW |
213 | { |
214 | } | |
18b4f3f5 MD |
215 | static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) |
216 | { | |
217 | return -ENOSYS; | |
218 | } | |
8bc0251d RW |
219 | static inline int pm_genpd_name_poweron(const char *domain_name) |
220 | { | |
221 | return -ENOSYS; | |
222 | } | |
d30d819d | 223 | static inline void pm_genpd_poweroff_unused(void) {} |
17f2ae7f RW |
224 | #endif |
225 | ||
b5abb085 RW |
226 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
227 | struct device *dev) | |
228 | { | |
229 | return __pm_genpd_add_device(genpd, dev, NULL); | |
230 | } | |
231 | ||
b5abb085 RW |
232 | static inline int pm_genpd_name_add_device(const char *domain_name, |
233 | struct device *dev) | |
234 | { | |
235 | return __pm_genpd_name_add_device(domain_name, dev, NULL); | |
236 | } | |
237 | ||
77f827de | 238 | #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP |
d47e6464 UH |
239 | extern void pm_genpd_syscore_poweroff(struct device *dev); |
240 | extern void pm_genpd_syscore_poweron(struct device *dev); | |
77f827de | 241 | #else |
d47e6464 UH |
242 | static inline void pm_genpd_syscore_poweroff(struct device *dev) {} |
243 | static inline void pm_genpd_syscore_poweron(struct device *dev) {} | |
77f827de RW |
244 | #endif |
245 | ||
aa42240a TF |
246 | /* OF PM domain providers */ |
247 | struct of_device_id; | |
248 | ||
249 | struct genpd_onecell_data { | |
250 | struct generic_pm_domain **domains; | |
251 | unsigned int num_domains; | |
252 | }; | |
253 | ||
254 | typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, | |
255 | void *data); | |
256 | ||
257 | #ifdef CONFIG_PM_GENERIC_DOMAINS_OF | |
258 | int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, | |
259 | void *data); | |
260 | void of_genpd_del_provider(struct device_node *np); | |
7496fcbe ADK |
261 | struct generic_pm_domain *of_genpd_get_from_provider( |
262 | struct of_phandle_args *genpdspec); | |
aa42240a TF |
263 | |
264 | struct generic_pm_domain *__of_genpd_xlate_simple( | |
265 | struct of_phandle_args *genpdspec, | |
266 | void *data); | |
267 | struct generic_pm_domain *__of_genpd_xlate_onecell( | |
268 | struct of_phandle_args *genpdspec, | |
269 | void *data); | |
270 | ||
271 | int genpd_dev_pm_attach(struct device *dev); | |
272 | #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ | |
273 | static inline int __of_genpd_add_provider(struct device_node *np, | |
274 | genpd_xlate_t xlate, void *data) | |
275 | { | |
276 | return 0; | |
277 | } | |
278 | static inline void of_genpd_del_provider(struct device_node *np) {} | |
279 | ||
7496fcbe ADK |
280 | static inline struct generic_pm_domain *of_genpd_get_from_provider( |
281 | struct of_phandle_args *genpdspec) | |
282 | { | |
283 | return NULL; | |
284 | } | |
285 | ||
aa42240a TF |
286 | #define __of_genpd_xlate_simple NULL |
287 | #define __of_genpd_xlate_onecell NULL | |
288 | ||
289 | static inline int genpd_dev_pm_attach(struct device *dev) | |
290 | { | |
291 | return -ENODEV; | |
292 | } | |
293 | #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ | |
294 | ||
295 | static inline int of_genpd_add_provider_simple(struct device_node *np, | |
296 | struct generic_pm_domain *genpd) | |
297 | { | |
298 | return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd); | |
299 | } | |
300 | static inline int of_genpd_add_provider_onecell(struct device_node *np, | |
301 | struct genpd_onecell_data *data) | |
302 | { | |
303 | return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data); | |
304 | } | |
305 | ||
f48c767c UH |
306 | #ifdef CONFIG_PM |
307 | extern int dev_pm_domain_attach(struct device *dev, bool power_on); | |
308 | extern void dev_pm_domain_detach(struct device *dev, bool power_off); | |
309 | #else | |
310 | static inline int dev_pm_domain_attach(struct device *dev, bool power_on) | |
311 | { | |
312 | return -ENODEV; | |
313 | } | |
314 | static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} | |
315 | #endif | |
316 | ||
f721889f | 317 | #endif /* _LINUX_PM_DOMAIN_H */ |