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 | |
17b75eca RW |
20 | enum gpd_status { |
21 | GPD_STATE_ACTIVE = 0, /* PM domain is active */ | |
17877eb5 | 22 | GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */ |
17b75eca | 23 | GPD_STATE_BUSY, /* Something is happening to the PM domain */ |
c6d22b37 | 24 | GPD_STATE_REPEAT, /* Power off in progress, to be repeated */ |
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); | |
d23b9b00 RW |
38 | int (*suspend)(struct device *dev); |
39 | int (*suspend_late)(struct device *dev); | |
40 | int (*resume_early)(struct device *dev); | |
41 | int (*resume)(struct device *dev); | |
42 | int (*freeze)(struct device *dev); | |
43 | int (*freeze_late)(struct device *dev); | |
44 | int (*thaw_early)(struct device *dev); | |
45 | int (*thaw)(struct device *dev); | |
d5e4cbfe RW |
46 | bool (*active_wakeup)(struct device *dev); |
47 | }; | |
48 | ||
cbc9ef02 RW |
49 | struct gpd_cpu_data { |
50 | unsigned int saved_exit_latency; | |
51 | struct cpuidle_state *idle_state; | |
52 | }; | |
53 | ||
f721889f RW |
54 | struct generic_pm_domain { |
55 | struct dev_pm_domain domain; /* PM domain operations */ | |
5125bbf3 | 56 | struct list_head gpd_list_node; /* Node in the global PM domains list */ |
5063ce15 RW |
57 | struct list_head master_links; /* Links with PM domain as a master */ |
58 | struct list_head slave_links; /* Links with PM domain as a slave */ | |
f721889f RW |
59 | struct list_head dev_list; /* List of devices */ |
60 | struct mutex lock; | |
61 | struct dev_power_governor *gov; | |
62 | struct work_struct power_off_work; | |
e84b2c20 | 63 | char *name; |
f721889f | 64 | unsigned int in_progress; /* Number of devices being suspended now */ |
c4bb3160 | 65 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
17b75eca RW |
66 | enum gpd_status status; /* Current state of the domain */ |
67 | wait_queue_head_t status_wait_queue; | |
c6d22b37 RW |
68 | struct task_struct *poweroff_task; /* Powering off task */ |
69 | unsigned int resume_count; /* Number of devices being resumed */ | |
596ba34b RW |
70 | unsigned int device_count; /* Number of devices */ |
71 | unsigned int suspended_count; /* System suspend device counter */ | |
72 | unsigned int prepared_count; /* Suspend counter of prepared devices */ | |
73 | bool suspend_power_off; /* Power status before system suspend */ | |
0aa2a221 | 74 | bool dev_irq_safe; /* Device callbacks are IRQ-safe */ |
f721889f | 75 | int (*power_off)(struct generic_pm_domain *domain); |
221e9b58 | 76 | s64 power_off_latency_ns; |
f721889f | 77 | int (*power_on)(struct generic_pm_domain *domain); |
221e9b58 | 78 | s64 power_on_latency_ns; |
d5e4cbfe | 79 | struct gpd_dev_ops dev_ops; |
221e9b58 | 80 | s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ |
6ff7bb0d RW |
81 | bool max_off_time_changed; |
82 | bool cached_power_down_ok; | |
c8aa130b | 83 | struct device_node *of_node; /* Node in device tree */ |
cbc9ef02 | 84 | struct gpd_cpu_data *cpu_data; |
f721889f RW |
85 | }; |
86 | ||
596ba34b RW |
87 | static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) |
88 | { | |
89 | return container_of(pd, struct generic_pm_domain, domain); | |
90 | } | |
91 | ||
5063ce15 RW |
92 | struct gpd_link { |
93 | struct generic_pm_domain *master; | |
94 | struct list_head master_node; | |
95 | struct generic_pm_domain *slave; | |
96 | struct list_head slave_node; | |
97 | }; | |
98 | ||
b02c999a RW |
99 | struct gpd_timing_data { |
100 | s64 stop_latency_ns; | |
101 | s64 start_latency_ns; | |
221e9b58 RW |
102 | s64 save_state_latency_ns; |
103 | s64 restore_state_latency_ns; | |
a5bef810 | 104 | s64 effective_constraint_ns; |
6ff7bb0d RW |
105 | bool constraint_changed; |
106 | bool cached_stop_ok; | |
b02c999a RW |
107 | }; |
108 | ||
cd0ea672 RW |
109 | struct generic_pm_domain_data { |
110 | struct pm_domain_data base; | |
d5e4cbfe | 111 | struct gpd_dev_ops ops; |
b02c999a | 112 | struct gpd_timing_data td; |
6ff7bb0d RW |
113 | struct notifier_block nb; |
114 | struct mutex lock; | |
1d5fcfec | 115 | unsigned int refcount; |
cd0ea672 RW |
116 | bool need_restore; |
117 | }; | |
118 | ||
9b4f617b | 119 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
cd0ea672 RW |
120 | static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) |
121 | { | |
122 | return container_of(pdd, struct generic_pm_domain_data, base); | |
123 | } | |
124 | ||
d5e4cbfe RW |
125 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
126 | { | |
127 | return to_gpd_data(dev->power.subsys_data->domain_data); | |
128 | } | |
129 | ||
b02c999a RW |
130 | extern struct dev_power_governor simple_qos_governor; |
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 | ||
c8aa130b TA |
137 | extern int __pm_genpd_of_add_device(struct device_node *genpd_node, |
138 | struct device *dev, | |
139 | struct gpd_timing_data *td); | |
140 | ||
b5abb085 RW |
141 | extern int __pm_genpd_name_add_device(const char *domain_name, |
142 | struct device *dev, | |
143 | struct gpd_timing_data *td); | |
c8aa130b | 144 | |
f721889f RW |
145 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
146 | struct device *dev); | |
ca1d72f0 | 147 | extern void pm_genpd_dev_need_restore(struct device *dev, bool val); |
f721889f RW |
148 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
149 | struct generic_pm_domain *new_subdomain); | |
fb7268be RW |
150 | extern int pm_genpd_add_subdomain_names(const char *master_name, |
151 | const char *subdomain_name); | |
f721889f RW |
152 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
153 | struct generic_pm_domain *target); | |
b02c999a RW |
154 | extern int pm_genpd_add_callbacks(struct device *dev, |
155 | struct gpd_dev_ops *ops, | |
156 | struct gpd_timing_data *td); | |
157 | extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td); | |
40114447 | 158 | extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state); |
74a2799a | 159 | extern int pm_genpd_name_attach_cpuidle(const char *name, int state); |
40114447 | 160 | extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd); |
74a2799a | 161 | extern int pm_genpd_name_detach_cpuidle(const char *name); |
f721889f RW |
162 | extern void pm_genpd_init(struct generic_pm_domain *genpd, |
163 | struct dev_power_governor *gov, bool is_off); | |
b02c999a | 164 | |
18b4f3f5 | 165 | extern int pm_genpd_poweron(struct generic_pm_domain *genpd); |
8bc0251d | 166 | extern int pm_genpd_name_poweron(const char *domain_name); |
b02c999a RW |
167 | |
168 | extern bool default_stop_ok(struct device *dev); | |
169 | ||
925b44a2 | 170 | extern struct dev_power_governor pm_domain_always_on_gov; |
f721889f | 171 | #else |
b02c999a | 172 | |
b642631d MD |
173 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
174 | { | |
175 | return ERR_PTR(-ENOSYS); | |
176 | } | |
b02c999a RW |
177 | static inline struct generic_pm_domain *dev_to_genpd(struct device *dev) |
178 | { | |
179 | return ERR_PTR(-ENOSYS); | |
180 | } | |
181 | static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, | |
182 | struct device *dev, | |
183 | struct gpd_timing_data *td) | |
184 | { | |
185 | return -ENOSYS; | |
186 | } | |
b5abb085 RW |
187 | static inline int __pm_genpd_of_add_device(struct device_node *genpd_node, |
188 | struct device *dev, | |
189 | struct gpd_timing_data *td) | |
190 | { | |
191 | return -ENOSYS; | |
192 | } | |
193 | static inline int __pm_genpd_name_add_device(const char *domain_name, | |
194 | struct device *dev, | |
195 | struct gpd_timing_data *td) | |
f721889f RW |
196 | { |
197 | return -ENOSYS; | |
198 | } | |
199 | static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, | |
200 | struct device *dev) | |
201 | { | |
202 | return -ENOSYS; | |
203 | } | |
ca1d72f0 | 204 | static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {} |
f721889f RW |
205 | static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
206 | struct generic_pm_domain *new_sd) | |
207 | { | |
208 | return -ENOSYS; | |
209 | } | |
fb7268be RW |
210 | static inline int pm_genpd_add_subdomain_names(const char *master_name, |
211 | const char *subdomain_name) | |
212 | { | |
213 | return -ENOSYS; | |
214 | } | |
f721889f RW |
215 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
216 | struct generic_pm_domain *target) | |
217 | { | |
218 | return -ENOSYS; | |
219 | } | |
d5e4cbfe | 220 | static inline int pm_genpd_add_callbacks(struct device *dev, |
b02c999a RW |
221 | struct gpd_dev_ops *ops, |
222 | struct gpd_timing_data *td) | |
d5e4cbfe RW |
223 | { |
224 | return -ENOSYS; | |
225 | } | |
b02c999a | 226 | static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td) |
d5e4cbfe RW |
227 | { |
228 | return -ENOSYS; | |
229 | } | |
40114447 | 230 | static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st) |
cbc9ef02 RW |
231 | { |
232 | return -ENOSYS; | |
233 | } | |
74a2799a RW |
234 | static inline int pm_genpd_name_attach_cpuidle(const char *name, int state) |
235 | { | |
236 | return -ENOSYS; | |
237 | } | |
40114447 | 238 | static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd) |
cbc9ef02 RW |
239 | { |
240 | return -ENOSYS; | |
241 | } | |
74a2799a RW |
242 | static inline int pm_genpd_name_detach_cpuidle(const char *name) |
243 | { | |
244 | return -ENOSYS; | |
245 | } | |
b642631d MD |
246 | static inline void pm_genpd_init(struct generic_pm_domain *genpd, |
247 | struct dev_power_governor *gov, bool is_off) | |
b02c999a RW |
248 | { |
249 | } | |
18b4f3f5 MD |
250 | static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) |
251 | { | |
252 | return -ENOSYS; | |
253 | } | |
8bc0251d RW |
254 | static inline int pm_genpd_name_poweron(const char *domain_name) |
255 | { | |
256 | return -ENOSYS; | |
257 | } | |
b02c999a RW |
258 | static inline bool default_stop_ok(struct device *dev) |
259 | { | |
260 | return false; | |
261 | } | |
b642631d | 262 | #define simple_qos_governor NULL |
925b44a2 | 263 | #define pm_domain_always_on_gov NULL |
17f2ae7f RW |
264 | #endif |
265 | ||
b5abb085 RW |
266 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
267 | struct device *dev) | |
268 | { | |
269 | return __pm_genpd_add_device(genpd, dev, NULL); | |
270 | } | |
271 | ||
272 | static inline int pm_genpd_of_add_device(struct device_node *genpd_node, | |
273 | struct device *dev) | |
274 | { | |
275 | return __pm_genpd_of_add_device(genpd_node, dev, NULL); | |
276 | } | |
277 | ||
278 | static inline int pm_genpd_name_add_device(const char *domain_name, | |
279 | struct device *dev) | |
280 | { | |
281 | return __pm_genpd_name_add_device(domain_name, dev, NULL); | |
282 | } | |
283 | ||
b02c999a RW |
284 | static inline int pm_genpd_remove_callbacks(struct device *dev) |
285 | { | |
286 | return __pm_genpd_remove_callbacks(dev, true); | |
287 | } | |
288 | ||
17f2ae7f RW |
289 | #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME |
290 | extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd); | |
291 | extern void pm_genpd_poweroff_unused(void); | |
292 | #else | |
0bc5b2de | 293 | static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {} |
17f2ae7f | 294 | static inline void pm_genpd_poweroff_unused(void) {} |
f721889f RW |
295 | #endif |
296 | ||
77f827de RW |
297 | #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP |
298 | extern void pm_genpd_syscore_switch(struct device *dev, bool suspend); | |
299 | #else | |
300 | static inline void pm_genpd_syscore_switch(struct device *dev, bool suspend) {} | |
301 | #endif | |
302 | ||
303 | static inline void pm_genpd_syscore_poweroff(struct device *dev) | |
304 | { | |
305 | pm_genpd_syscore_switch(dev, true); | |
306 | } | |
307 | ||
308 | static inline void pm_genpd_syscore_poweron(struct device *dev) | |
309 | { | |
310 | pm_genpd_syscore_switch(dev, false); | |
311 | } | |
312 | ||
f721889f | 313 | #endif /* _LINUX_PM_DOMAIN_H */ |