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 */ | |
17877eb5 | 25 | GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */ |
17b75eca | 26 | GPD_STATE_BUSY, /* Something is happening to the PM domain */ |
c6d22b37 | 27 | GPD_STATE_REPEAT, /* Power off in progress, to be repeated */ |
17b75eca RW |
28 | GPD_STATE_POWER_OFF, /* PM domain is off */ |
29 | }; | |
596ba34b | 30 | |
f721889f RW |
31 | struct dev_power_governor { |
32 | bool (*power_down_ok)(struct dev_pm_domain *domain); | |
b02c999a | 33 | bool (*stop_ok)(struct device *dev); |
f721889f RW |
34 | }; |
35 | ||
d5e4cbfe RW |
36 | struct gpd_dev_ops { |
37 | int (*start)(struct device *dev); | |
38 | int (*stop)(struct device *dev); | |
ecf00475 RW |
39 | int (*save_state)(struct device *dev); |
40 | int (*restore_state)(struct device *dev); | |
d5e4cbfe RW |
41 | bool (*active_wakeup)(struct device *dev); |
42 | }; | |
43 | ||
f39cb179 | 44 | struct gpd_cpuidle_data { |
cbc9ef02 RW |
45 | unsigned int saved_exit_latency; |
46 | struct cpuidle_state *idle_state; | |
47 | }; | |
48 | ||
f721889f RW |
49 | struct generic_pm_domain { |
50 | struct dev_pm_domain domain; /* PM domain operations */ | |
5125bbf3 | 51 | struct list_head gpd_list_node; /* Node in the global PM domains list */ |
5063ce15 RW |
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 */ | |
f721889f RW |
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; | |
d07e9c17 | 58 | const char *name; |
f721889f | 59 | unsigned int in_progress; /* Number of devices being suspended now */ |
c4bb3160 | 60 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
17b75eca RW |
61 | enum gpd_status status; /* Current state of the domain */ |
62 | wait_queue_head_t status_wait_queue; | |
c6d22b37 RW |
63 | struct task_struct *poweroff_task; /* Powering off task */ |
64 | unsigned int resume_count; /* Number of devices being resumed */ | |
596ba34b RW |
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 */ | |
f721889f | 69 | int (*power_off)(struct generic_pm_domain *domain); |
221e9b58 | 70 | s64 power_off_latency_ns; |
f721889f | 71 | int (*power_on)(struct generic_pm_domain *domain); |
221e9b58 | 72 | s64 power_on_latency_ns; |
d5e4cbfe | 73 | struct gpd_dev_ops dev_ops; |
221e9b58 | 74 | s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ |
6ff7bb0d RW |
75 | bool max_off_time_changed; |
76 | bool cached_power_down_ok; | |
f39cb179 | 77 | struct gpd_cpuidle_data *cpuidle_data; |
c16561e8 UH |
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); | |
c11f6f5b | 82 | unsigned int flags; /* Bit field of configs for genpd */ |
f721889f RW |
83 | }; |
84 | ||
596ba34b RW |
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 | ||
5063ce15 RW |
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 | ||
b02c999a RW |
97 | struct gpd_timing_data { |
98 | s64 stop_latency_ns; | |
99 | s64 start_latency_ns; | |
221e9b58 RW |
100 | s64 save_state_latency_ns; |
101 | s64 restore_state_latency_ns; | |
a5bef810 | 102 | s64 effective_constraint_ns; |
6ff7bb0d RW |
103 | bool constraint_changed; |
104 | bool cached_stop_ok; | |
b02c999a RW |
105 | }; |
106 | ||
00e7c295 UH |
107 | struct pm_domain_data { |
108 | struct list_head list_node; | |
109 | struct device *dev; | |
110 | }; | |
111 | ||
cd0ea672 RW |
112 | struct generic_pm_domain_data { |
113 | struct pm_domain_data base; | |
b02c999a | 114 | struct gpd_timing_data td; |
6ff7bb0d RW |
115 | struct notifier_block nb; |
116 | struct mutex lock; | |
1d5fcfec | 117 | unsigned int refcount; |
67732cd3 | 118 | int need_restore; |
cd0ea672 RW |
119 | }; |
120 | ||
9b4f617b | 121 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
cd0ea672 RW |
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 | ||
d5e4cbfe RW |
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 | ||
b02c999a RW |
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 | ||
b5abb085 RW |
137 | extern int __pm_genpd_name_add_device(const char *domain_name, |
138 | struct device *dev, | |
139 | struct gpd_timing_data *td); | |
c8aa130b | 140 | |
f721889f RW |
141 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
142 | struct device *dev); | |
ca1d72f0 | 143 | extern void pm_genpd_dev_need_restore(struct device *dev, bool val); |
f721889f RW |
144 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
145 | struct generic_pm_domain *new_subdomain); | |
fb7268be RW |
146 | extern int pm_genpd_add_subdomain_names(const char *master_name, |
147 | const char *subdomain_name); | |
f721889f RW |
148 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
149 | struct generic_pm_domain *target); | |
40114447 | 150 | extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state); |
74a2799a | 151 | extern int pm_genpd_name_attach_cpuidle(const char *name, int state); |
40114447 | 152 | extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd); |
74a2799a | 153 | extern int pm_genpd_name_detach_cpuidle(const char *name); |
f721889f RW |
154 | extern void pm_genpd_init(struct generic_pm_domain *genpd, |
155 | struct dev_power_governor *gov, bool is_off); | |
b02c999a | 156 | |
18b4f3f5 | 157 | extern int pm_genpd_poweron(struct generic_pm_domain *genpd); |
8bc0251d | 158 | extern int pm_genpd_name_poweron(const char *domain_name); |
d30d819d | 159 | extern void pm_genpd_poweroff_unused(void); |
b02c999a | 160 | |
ae3c511c | 161 | extern struct dev_power_governor simple_qos_governor; |
925b44a2 | 162 | extern struct dev_power_governor pm_domain_always_on_gov; |
f721889f | 163 | #else |
b02c999a | 164 | |
b642631d MD |
165 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
166 | { | |
167 | return ERR_PTR(-ENOSYS); | |
168 | } | |
b02c999a RW |
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 | } | |
b5abb085 RW |
179 | static inline int __pm_genpd_name_add_device(const char *domain_name, |
180 | struct device *dev, | |
181 | struct gpd_timing_data *td) | |
f721889f RW |
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 | } | |
ca1d72f0 | 190 | static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {} |
f721889f RW |
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 | } | |
fb7268be RW |
196 | static inline int pm_genpd_add_subdomain_names(const char *master_name, |
197 | const char *subdomain_name) | |
198 | { | |
199 | return -ENOSYS; | |
200 | } | |
f721889f RW |
201 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
202 | struct generic_pm_domain *target) | |
203 | { | |
204 | return -ENOSYS; | |
205 | } | |
40114447 | 206 | static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st) |
cbc9ef02 RW |
207 | { |
208 | return -ENOSYS; | |
209 | } | |
74a2799a RW |
210 | static inline int pm_genpd_name_attach_cpuidle(const char *name, int state) |
211 | { | |
212 | return -ENOSYS; | |
213 | } | |
40114447 | 214 | static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd) |
cbc9ef02 RW |
215 | { |
216 | return -ENOSYS; | |
217 | } | |
74a2799a RW |
218 | static inline int pm_genpd_name_detach_cpuidle(const char *name) |
219 | { | |
220 | return -ENOSYS; | |
221 | } | |
b642631d MD |
222 | static inline void pm_genpd_init(struct generic_pm_domain *genpd, |
223 | struct dev_power_governor *gov, bool is_off) | |
b02c999a RW |
224 | { |
225 | } | |
18b4f3f5 MD |
226 | static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) |
227 | { | |
228 | return -ENOSYS; | |
229 | } | |
8bc0251d RW |
230 | static inline int pm_genpd_name_poweron(const char *domain_name) |
231 | { | |
232 | return -ENOSYS; | |
233 | } | |
d30d819d | 234 | static inline void pm_genpd_poweroff_unused(void) {} |
b642631d | 235 | #define simple_qos_governor NULL |
925b44a2 | 236 | #define pm_domain_always_on_gov NULL |
17f2ae7f RW |
237 | #endif |
238 | ||
b5abb085 RW |
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 | ||
b5abb085 RW |
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 | ||
77f827de | 251 | #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP |
d47e6464 UH |
252 | extern void pm_genpd_syscore_poweroff(struct device *dev); |
253 | extern void pm_genpd_syscore_poweron(struct device *dev); | |
77f827de | 254 | #else |
d47e6464 UH |
255 | static inline void pm_genpd_syscore_poweroff(struct device *dev) {} |
256 | static inline void pm_genpd_syscore_poweron(struct device *dev) {} | |
77f827de RW |
257 | #endif |
258 | ||
aa42240a TF |
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); | |
7496fcbe ADK |
274 | struct generic_pm_domain *of_genpd_get_from_provider( |
275 | struct of_phandle_args *genpdspec); | |
aa42240a TF |
276 | |
277 | struct generic_pm_domain *__of_genpd_xlate_simple( | |
278 | struct of_phandle_args *genpdspec, | |
279 | void *data); | |
280 | struct generic_pm_domain *__of_genpd_xlate_onecell( | |
281 | struct of_phandle_args *genpdspec, | |
282 | void *data); | |
283 | ||
284 | int genpd_dev_pm_attach(struct device *dev); | |
285 | #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ | |
286 | static inline int __of_genpd_add_provider(struct device_node *np, | |
287 | genpd_xlate_t xlate, void *data) | |
288 | { | |
289 | return 0; | |
290 | } | |
291 | static inline void of_genpd_del_provider(struct device_node *np) {} | |
292 | ||
7496fcbe ADK |
293 | static inline struct generic_pm_domain *of_genpd_get_from_provider( |
294 | struct of_phandle_args *genpdspec) | |
295 | { | |
296 | return NULL; | |
297 | } | |
298 | ||
aa42240a TF |
299 | #define __of_genpd_xlate_simple NULL |
300 | #define __of_genpd_xlate_onecell NULL | |
301 | ||
302 | static inline int genpd_dev_pm_attach(struct device *dev) | |
303 | { | |
304 | return -ENODEV; | |
305 | } | |
306 | #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ | |
307 | ||
308 | static inline int of_genpd_add_provider_simple(struct device_node *np, | |
309 | struct generic_pm_domain *genpd) | |
310 | { | |
311 | return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd); | |
312 | } | |
313 | static inline int of_genpd_add_provider_onecell(struct device_node *np, | |
314 | struct genpd_onecell_data *data) | |
315 | { | |
316 | return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data); | |
317 | } | |
318 | ||
f48c767c UH |
319 | #ifdef CONFIG_PM |
320 | extern int dev_pm_domain_attach(struct device *dev, bool power_on); | |
321 | extern void dev_pm_domain_detach(struct device *dev, bool power_off); | |
322 | #else | |
323 | static inline int dev_pm_domain_attach(struct device *dev, bool power_on) | |
324 | { | |
325 | return -ENODEV; | |
326 | } | |
327 | static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} | |
328 | #endif | |
329 | ||
f721889f | 330 | #endif /* _LINUX_PM_DOMAIN_H */ |