1
2
3
4
5
6
7
8#ifndef _LINUX_PM_DOMAIN_H
9#define _LINUX_PM_DOMAIN_H
10
11#include <linux/device.h>
12#include <linux/mutex.h>
13#include <linux/pm.h>
14#include <linux/err.h>
15#include <linux/of.h>
16#include <linux/notifier.h>
17#include <linux/spinlock.h>
18#include <linux/cpumask.h>
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59#define GENPD_FLAG_PM_CLK (1U << 0)
60#define GENPD_FLAG_IRQ_SAFE (1U << 1)
61#define GENPD_FLAG_ALWAYS_ON (1U << 2)
62#define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3)
63#define GENPD_FLAG_CPU_DOMAIN (1U << 4)
64#define GENPD_FLAG_RPM_ALWAYS_ON (1U << 5)
65
66enum gpd_status {
67 GENPD_STATE_ON = 0,
68 GENPD_STATE_OFF,
69};
70
71enum genpd_notication {
72 GENPD_NOTIFY_PRE_OFF = 0,
73 GENPD_NOTIFY_OFF,
74 GENPD_NOTIFY_PRE_ON,
75 GENPD_NOTIFY_ON,
76};
77
78struct dev_power_governor {
79 bool (*power_down_ok)(struct dev_pm_domain *domain);
80 bool (*suspend_ok)(struct device *dev);
81};
82
83struct gpd_dev_ops {
84 int (*start)(struct device *dev);
85 int (*stop)(struct device *dev);
86};
87
88struct genpd_power_state {
89 s64 power_off_latency_ns;
90 s64 power_on_latency_ns;
91 s64 residency_ns;
92 u64 usage;
93 u64 rejected;
94 struct fwnode_handle *fwnode;
95 ktime_t idle_time;
96 void *data;
97};
98
99struct genpd_lock_ops;
100struct dev_pm_opp;
101struct opp_table;
102
103struct generic_pm_domain {
104 struct device dev;
105 struct dev_pm_domain domain;
106 struct list_head gpd_list_node;
107 struct list_head parent_links;
108 struct list_head child_links;
109 struct list_head dev_list;
110 struct dev_power_governor *gov;
111 struct work_struct power_off_work;
112 struct fwnode_handle *provider;
113 bool has_provider;
114 const char *name;
115 atomic_t sd_count;
116 enum gpd_status status;
117 unsigned int device_count;
118 unsigned int suspended_count;
119 unsigned int prepared_count;
120 unsigned int performance_state;
121 cpumask_var_t cpus;
122 int (*power_off)(struct generic_pm_domain *domain);
123 int (*power_on)(struct generic_pm_domain *domain);
124 struct raw_notifier_head power_notifiers;
125 struct opp_table *opp_table;
126 unsigned int (*opp_to_performance_state)(struct generic_pm_domain *genpd,
127 struct dev_pm_opp *opp);
128 int (*set_performance_state)(struct generic_pm_domain *genpd,
129 unsigned int state);
130 struct gpd_dev_ops dev_ops;
131 s64 max_off_time_ns;
132 bool max_off_time_changed;
133 bool cached_power_down_ok;
134 bool cached_power_down_state_idx;
135 int (*attach_dev)(struct generic_pm_domain *domain,
136 struct device *dev);
137 void (*detach_dev)(struct generic_pm_domain *domain,
138 struct device *dev);
139 unsigned int flags;
140 struct genpd_power_state *states;
141 void (*free_states)(struct genpd_power_state *states,
142 unsigned int state_count);
143 unsigned int state_count;
144 unsigned int state_idx;
145 ktime_t on_time;
146 ktime_t accounting_time;
147 const struct genpd_lock_ops *lock_ops;
148 union {
149 struct mutex mlock;
150 struct {
151 spinlock_t slock;
152 unsigned long lock_flags;
153 };
154 };
155
156};
157
158static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
159{
160 return container_of(pd, struct generic_pm_domain, domain);
161}
162
163struct gpd_link {
164 struct generic_pm_domain *parent;
165 struct list_head parent_node;
166 struct generic_pm_domain *child;
167 struct list_head child_node;
168
169
170 unsigned int performance_state;
171 unsigned int prev_performance_state;
172};
173
174struct gpd_timing_data {
175 s64 suspend_latency_ns;
176 s64 resume_latency_ns;
177 s64 effective_constraint_ns;
178 bool constraint_changed;
179 bool cached_suspend_ok;
180};
181
182struct pm_domain_data {
183 struct list_head list_node;
184 struct device *dev;
185};
186
187struct generic_pm_domain_data {
188 struct pm_domain_data base;
189 struct gpd_timing_data td;
190 struct notifier_block nb;
191 struct notifier_block *power_nb;
192 int cpu;
193 unsigned int performance_state;
194 void *data;
195};
196
197#ifdef CONFIG_PM_GENERIC_DOMAINS
198static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
199{
200 return container_of(pdd, struct generic_pm_domain_data, base);
201}
202
203static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
204{
205 return to_gpd_data(dev->power.subsys_data->domain_data);
206}
207
208int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev);
209int pm_genpd_remove_device(struct device *dev);
210int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
211 struct generic_pm_domain *subdomain);
212int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
213 struct generic_pm_domain *subdomain);
214int pm_genpd_init(struct generic_pm_domain *genpd,
215 struct dev_power_governor *gov, bool is_off);
216int pm_genpd_remove(struct generic_pm_domain *genpd);
217int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state);
218int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb);
219int dev_pm_genpd_remove_notifier(struct device *dev);
220
221extern struct dev_power_governor simple_qos_governor;
222extern struct dev_power_governor pm_domain_always_on_gov;
223#ifdef CONFIG_CPU_IDLE
224extern struct dev_power_governor pm_domain_cpu_gov;
225#endif
226#else
227
228static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
229{
230 return ERR_PTR(-ENOSYS);
231}
232static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
233 struct device *dev)
234{
235 return -ENOSYS;
236}
237static inline int pm_genpd_remove_device(struct device *dev)
238{
239 return -ENOSYS;
240}
241static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
242 struct generic_pm_domain *subdomain)
243{
244 return -ENOSYS;
245}
246static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
247 struct generic_pm_domain *subdomain)
248{
249 return -ENOSYS;
250}
251static inline int pm_genpd_init(struct generic_pm_domain *genpd,
252 struct dev_power_governor *gov, bool is_off)
253{
254 return -ENOSYS;
255}
256static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
257{
258 return -EOPNOTSUPP;
259}
260
261static inline int dev_pm_genpd_set_performance_state(struct device *dev,
262 unsigned int state)
263{
264 return -EOPNOTSUPP;
265}
266
267static inline int dev_pm_genpd_add_notifier(struct device *dev,
268 struct notifier_block *nb)
269{
270 return -EOPNOTSUPP;
271}
272
273static inline int dev_pm_genpd_remove_notifier(struct device *dev)
274{
275 return -EOPNOTSUPP;
276}
277
278#define simple_qos_governor (*(struct dev_power_governor *)(NULL))
279#define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL))
280#endif
281
282#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
283void dev_pm_genpd_suspend(struct device *dev);
284void dev_pm_genpd_resume(struct device *dev);
285#else
286static inline void dev_pm_genpd_suspend(struct device *dev) {}
287static inline void dev_pm_genpd_resume(struct device *dev) {}
288#endif
289
290
291struct of_device_id;
292
293typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
294 void *data);
295
296struct genpd_onecell_data {
297 struct generic_pm_domain **domains;
298 unsigned int num_domains;
299 genpd_xlate_t xlate;
300};
301
302#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
303int of_genpd_add_provider_simple(struct device_node *np,
304 struct generic_pm_domain *genpd);
305int of_genpd_add_provider_onecell(struct device_node *np,
306 struct genpd_onecell_data *data);
307void of_genpd_del_provider(struct device_node *np);
308int of_genpd_add_device(struct of_phandle_args *args, struct device *dev);
309int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
310 struct of_phandle_args *subdomain_spec);
311int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
312 struct of_phandle_args *subdomain_spec);
313struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
314int of_genpd_parse_idle_states(struct device_node *dn,
315 struct genpd_power_state **states, int *n);
316unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
317 struct dev_pm_opp *opp);
318
319int genpd_dev_pm_attach(struct device *dev);
320struct device *genpd_dev_pm_attach_by_id(struct device *dev,
321 unsigned int index);
322struct device *genpd_dev_pm_attach_by_name(struct device *dev,
323 const char *name);
324#else
325static inline int of_genpd_add_provider_simple(struct device_node *np,
326 struct generic_pm_domain *genpd)
327{
328 return -EOPNOTSUPP;
329}
330
331static inline int of_genpd_add_provider_onecell(struct device_node *np,
332 struct genpd_onecell_data *data)
333{
334 return -EOPNOTSUPP;
335}
336
337static inline void of_genpd_del_provider(struct device_node *np) {}
338
339static inline int of_genpd_add_device(struct of_phandle_args *args,
340 struct device *dev)
341{
342 return -ENODEV;
343}
344
345static inline int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
346 struct of_phandle_args *subdomain_spec)
347{
348 return -ENODEV;
349}
350
351static inline int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
352 struct of_phandle_args *subdomain_spec)
353{
354 return -ENODEV;
355}
356
357static inline int of_genpd_parse_idle_states(struct device_node *dn,
358 struct genpd_power_state **states, int *n)
359{
360 return -ENODEV;
361}
362
363static inline unsigned int
364pm_genpd_opp_to_performance_state(struct device *genpd_dev,
365 struct dev_pm_opp *opp)
366{
367 return 0;
368}
369
370static inline int genpd_dev_pm_attach(struct device *dev)
371{
372 return 0;
373}
374
375static inline struct device *genpd_dev_pm_attach_by_id(struct device *dev,
376 unsigned int index)
377{
378 return NULL;
379}
380
381static inline struct device *genpd_dev_pm_attach_by_name(struct device *dev,
382 const char *name)
383{
384 return NULL;
385}
386
387static inline
388struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
389{
390 return ERR_PTR(-EOPNOTSUPP);
391}
392#endif
393
394#ifdef CONFIG_PM
395int dev_pm_domain_attach(struct device *dev, bool power_on);
396struct device *dev_pm_domain_attach_by_id(struct device *dev,
397 unsigned int index);
398struct device *dev_pm_domain_attach_by_name(struct device *dev,
399 const char *name);
400void dev_pm_domain_detach(struct device *dev, bool power_off);
401int dev_pm_domain_start(struct device *dev);
402void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
403#else
404static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
405{
406 return 0;
407}
408static inline struct device *dev_pm_domain_attach_by_id(struct device *dev,
409 unsigned int index)
410{
411 return NULL;
412}
413static inline struct device *dev_pm_domain_attach_by_name(struct device *dev,
414 const char *name)
415{
416 return NULL;
417}
418static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
419static inline int dev_pm_domain_start(struct device *dev)
420{
421 return 0;
422}
423static inline void dev_pm_domain_set(struct device *dev,
424 struct dev_pm_domain *pd) {}
425#endif
426
427#endif
428