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> |
d716f479 | 18 | #include <linux/spinlock.h> |
f721889f | 19 | |
c11f6f5b | 20 | /* Defines used for the flags field in the struct generic_pm_domain */ |
95a20ef6 GU |
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 | #define GENPD_FLAG_ALWAYS_ON (1U << 2) /* PM domain is always powered on */ | |
24 | #define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3) /* Keep devices active if wakeup */ | |
c11f6f5b | 25 | |
17b75eca RW |
26 | enum gpd_status { |
27 | GPD_STATE_ACTIVE = 0, /* PM domain is active */ | |
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); | |
9df3921e | 33 | bool (*suspend_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); | |
d5e4cbfe RW |
39 | }; |
40 | ||
fc5cbf0c AH |
41 | struct genpd_power_state { |
42 | s64 power_off_latency_ns; | |
43 | s64 power_on_latency_ns; | |
405f7226 | 44 | s64 residency_ns; |
0c9b694a | 45 | struct fwnode_handle *fwnode; |
afece3ab | 46 | ktime_t idle_time; |
fc5cbf0c AH |
47 | }; |
48 | ||
35241d12 LI |
49 | struct genpd_lock_ops; |
50 | ||
f721889f RW |
51 | struct generic_pm_domain { |
52 | struct dev_pm_domain domain; /* PM domain operations */ | |
5125bbf3 | 53 | struct list_head gpd_list_node; /* Node in the global PM domains list */ |
5063ce15 RW |
54 | struct list_head master_links; /* Links with PM domain as a master */ |
55 | struct list_head slave_links; /* Links with PM domain as a slave */ | |
f721889f | 56 | struct list_head dev_list; /* List of devices */ |
f721889f RW |
57 | struct dev_power_governor *gov; |
58 | struct work_struct power_off_work; | |
de0aa06d JH |
59 | struct fwnode_handle *provider; /* Identity of the domain provider */ |
60 | bool has_provider; | |
d07e9c17 | 61 | const char *name; |
c4bb3160 | 62 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
17b75eca | 63 | enum gpd_status status; /* Current state of the domain */ |
596ba34b RW |
64 | unsigned int device_count; /* Number of devices */ |
65 | unsigned int suspended_count; /* System suspend device counter */ | |
66 | unsigned int prepared_count; /* Suspend counter of prepared devices */ | |
42f6284a | 67 | unsigned int performance_state; /* Aggregated max performance state */ |
f721889f RW |
68 | int (*power_off)(struct generic_pm_domain *domain); |
69 | int (*power_on)(struct generic_pm_domain *domain); | |
42f6284a VK |
70 | int (*set_performance_state)(struct generic_pm_domain *genpd, |
71 | unsigned int state); | |
d5e4cbfe | 72 | struct gpd_dev_ops dev_ops; |
221e9b58 | 73 | s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ |
6ff7bb0d RW |
74 | bool max_off_time_changed; |
75 | bool cached_power_down_ok; | |
c16561e8 UH |
76 | int (*attach_dev)(struct generic_pm_domain *domain, |
77 | struct device *dev); | |
78 | void (*detach_dev)(struct generic_pm_domain *domain, | |
79 | struct device *dev); | |
c11f6f5b | 80 | unsigned int flags; /* Bit field of configs for genpd */ |
59d65b73 | 81 | struct genpd_power_state *states; |
fc5cbf0c AH |
82 | unsigned int state_count; /* number of states */ |
83 | unsigned int state_idx; /* state that genpd will go to when off */ | |
59d65b73 | 84 | void *free; /* Free the state that was allocated for default */ |
afece3ab TG |
85 | ktime_t on_time; |
86 | ktime_t accounting_time; | |
35241d12 | 87 | const struct genpd_lock_ops *lock_ops; |
d716f479 LI |
88 | union { |
89 | struct mutex mlock; | |
90 | struct { | |
91 | spinlock_t slock; | |
92 | unsigned long lock_flags; | |
93 | }; | |
94 | }; | |
fc5cbf0c | 95 | |
f721889f RW |
96 | }; |
97 | ||
596ba34b RW |
98 | static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) |
99 | { | |
100 | return container_of(pd, struct generic_pm_domain, domain); | |
101 | } | |
102 | ||
5063ce15 RW |
103 | struct gpd_link { |
104 | struct generic_pm_domain *master; | |
105 | struct list_head master_node; | |
106 | struct generic_pm_domain *slave; | |
107 | struct list_head slave_node; | |
108 | }; | |
109 | ||
b02c999a | 110 | struct gpd_timing_data { |
2b1d88cd UH |
111 | s64 suspend_latency_ns; |
112 | s64 resume_latency_ns; | |
a5bef810 | 113 | s64 effective_constraint_ns; |
6ff7bb0d | 114 | bool constraint_changed; |
9df3921e | 115 | bool cached_suspend_ok; |
b02c999a RW |
116 | }; |
117 | ||
00e7c295 UH |
118 | struct pm_domain_data { |
119 | struct list_head list_node; | |
120 | struct device *dev; | |
121 | }; | |
122 | ||
cd0ea672 RW |
123 | struct generic_pm_domain_data { |
124 | struct pm_domain_data base; | |
b02c999a | 125 | struct gpd_timing_data td; |
6ff7bb0d | 126 | struct notifier_block nb; |
42f6284a | 127 | unsigned int performance_state; |
a5ea7a0f | 128 | void *data; |
cd0ea672 RW |
129 | }; |
130 | ||
9b4f617b | 131 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
cd0ea672 RW |
132 | static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) |
133 | { | |
134 | return container_of(pdd, struct generic_pm_domain_data, base); | |
135 | } | |
136 | ||
d5e4cbfe RW |
137 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
138 | { | |
139 | return to_gpd_data(dev->power.subsys_data->domain_data); | |
140 | } | |
141 | ||
b02c999a RW |
142 | extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
143 | struct device *dev, | |
144 | struct gpd_timing_data *td); | |
145 | ||
f721889f RW |
146 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
147 | struct device *dev); | |
148 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, | |
149 | struct generic_pm_domain *new_subdomain); | |
150 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, | |
151 | struct generic_pm_domain *target); | |
7eb231c3 UH |
152 | extern int pm_genpd_init(struct generic_pm_domain *genpd, |
153 | struct dev_power_governor *gov, bool is_off); | |
3fe57710 | 154 | extern int pm_genpd_remove(struct generic_pm_domain *genpd); |
42f6284a VK |
155 | extern int dev_pm_genpd_set_performance_state(struct device *dev, |
156 | unsigned int state); | |
b02c999a | 157 | |
ae3c511c | 158 | extern struct dev_power_governor simple_qos_governor; |
925b44a2 | 159 | extern struct dev_power_governor pm_domain_always_on_gov; |
f721889f | 160 | #else |
b02c999a | 161 | |
b642631d MD |
162 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
163 | { | |
164 | return ERR_PTR(-ENOSYS); | |
165 | } | |
b02c999a RW |
166 | static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
167 | struct device *dev, | |
168 | struct gpd_timing_data *td) | |
169 | { | |
170 | return -ENOSYS; | |
171 | } | |
f721889f RW |
172 | static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
173 | struct device *dev) | |
174 | { | |
175 | return -ENOSYS; | |
176 | } | |
177 | static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, | |
178 | struct generic_pm_domain *new_sd) | |
179 | { | |
180 | return -ENOSYS; | |
181 | } | |
182 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, | |
183 | struct generic_pm_domain *target) | |
184 | { | |
185 | return -ENOSYS; | |
186 | } | |
7eb231c3 UH |
187 | static inline int pm_genpd_init(struct generic_pm_domain *genpd, |
188 | struct dev_power_governor *gov, bool is_off) | |
b02c999a | 189 | { |
7eb231c3 | 190 | return -ENOSYS; |
b02c999a | 191 | } |
3fe57710 JH |
192 | static inline int pm_genpd_remove(struct generic_pm_domain *genpd) |
193 | { | |
194 | return -ENOTSUPP; | |
195 | } | |
16d0bf18 | 196 | |
42f6284a VK |
197 | static inline int dev_pm_genpd_set_performance_state(struct device *dev, |
198 | unsigned int state) | |
199 | { | |
200 | return -ENOTSUPP; | |
201 | } | |
202 | ||
16d0bf18 GU |
203 | #define simple_qos_governor (*(struct dev_power_governor *)(NULL)) |
204 | #define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL)) | |
17f2ae7f RW |
205 | #endif |
206 | ||
b5abb085 RW |
207 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
208 | struct device *dev) | |
209 | { | |
210 | return __pm_genpd_add_device(genpd, dev, NULL); | |
211 | } | |
212 | ||
77f827de | 213 | #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP |
d47e6464 UH |
214 | extern void pm_genpd_syscore_poweroff(struct device *dev); |
215 | extern void pm_genpd_syscore_poweron(struct device *dev); | |
77f827de | 216 | #else |
d47e6464 UH |
217 | static inline void pm_genpd_syscore_poweroff(struct device *dev) {} |
218 | static inline void pm_genpd_syscore_poweron(struct device *dev) {} | |
77f827de RW |
219 | #endif |
220 | ||
aa42240a TF |
221 | /* OF PM domain providers */ |
222 | struct of_device_id; | |
223 | ||
40845524 TR |
224 | typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, |
225 | void *data); | |
226 | ||
aa42240a TF |
227 | struct genpd_onecell_data { |
228 | struct generic_pm_domain **domains; | |
229 | unsigned int num_domains; | |
40845524 | 230 | genpd_xlate_t xlate; |
aa42240a TF |
231 | }; |
232 | ||
aa42240a | 233 | #ifdef CONFIG_PM_GENERIC_DOMAINS_OF |
892ebdcc JH |
234 | int of_genpd_add_provider_simple(struct device_node *np, |
235 | struct generic_pm_domain *genpd); | |
236 | int of_genpd_add_provider_onecell(struct device_node *np, | |
237 | struct genpd_onecell_data *data); | |
aa42240a | 238 | void of_genpd_del_provider(struct device_node *np); |
ec69572b JH |
239 | extern int of_genpd_add_device(struct of_phandle_args *args, |
240 | struct device *dev); | |
241 | extern int of_genpd_add_subdomain(struct of_phandle_args *parent, | |
242 | struct of_phandle_args *new_subdomain); | |
17926551 | 243 | extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np); |
30f60428 LI |
244 | extern int of_genpd_parse_idle_states(struct device_node *dn, |
245 | struct genpd_power_state **states, int *n); | |
aa42240a TF |
246 | |
247 | int genpd_dev_pm_attach(struct device *dev); | |
248 | #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ | |
892ebdcc JH |
249 | static inline int of_genpd_add_provider_simple(struct device_node *np, |
250 | struct generic_pm_domain *genpd) | |
aa42240a | 251 | { |
892ebdcc JH |
252 | return -ENOTSUPP; |
253 | } | |
254 | ||
255 | static inline int of_genpd_add_provider_onecell(struct device_node *np, | |
256 | struct genpd_onecell_data *data) | |
257 | { | |
258 | return -ENOTSUPP; | |
aa42240a | 259 | } |
aa42240a | 260 | |
892ebdcc | 261 | static inline void of_genpd_del_provider(struct device_node *np) {} |
aa42240a | 262 | |
ec69572b JH |
263 | static inline int of_genpd_add_device(struct of_phandle_args *args, |
264 | struct device *dev) | |
265 | { | |
266 | return -ENODEV; | |
267 | } | |
268 | ||
269 | static inline int of_genpd_add_subdomain(struct of_phandle_args *parent, | |
270 | struct of_phandle_args *new_subdomain) | |
271 | { | |
272 | return -ENODEV; | |
273 | } | |
274 | ||
30f60428 LI |
275 | static inline int of_genpd_parse_idle_states(struct device_node *dn, |
276 | struct genpd_power_state **states, int *n) | |
277 | { | |
278 | return -ENODEV; | |
279 | } | |
280 | ||
aa42240a TF |
281 | static inline int genpd_dev_pm_attach(struct device *dev) |
282 | { | |
283 | return -ENODEV; | |
284 | } | |
17926551 JH |
285 | |
286 | static inline | |
287 | struct generic_pm_domain *of_genpd_remove_last(struct device_node *np) | |
288 | { | |
289 | return ERR_PTR(-ENOTSUPP); | |
290 | } | |
aa42240a TF |
291 | #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ |
292 | ||
f48c767c UH |
293 | #ifdef CONFIG_PM |
294 | extern int dev_pm_domain_attach(struct device *dev, bool power_on); | |
295 | extern void dev_pm_domain_detach(struct device *dev, bool power_off); | |
989561de | 296 | extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd); |
f48c767c UH |
297 | #else |
298 | static inline int dev_pm_domain_attach(struct device *dev, bool power_on) | |
299 | { | |
300 | return -ENODEV; | |
301 | } | |
302 | static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} | |
989561de TV |
303 | static inline void dev_pm_domain_set(struct device *dev, |
304 | struct dev_pm_domain *pd) {} | |
f48c767c UH |
305 | #endif |
306 | ||
f721889f | 307 | #endif /* _LINUX_PM_DOMAIN_H */ |