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