Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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>
13#include <linux/mutex.h>
14#include <linux/pm.h>
15#include <linux/err.h>
16#include <linux/of.h>
17#include <linux/notifier.h>
18#include <linux/cpuidle.h>
19
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
23enum gpd_status {
24 GPD_STATE_ACTIVE = 0, /* PM domain is active */
25 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
26 GPD_STATE_BUSY, /* Something is happening to the PM domain */
27 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
28 GPD_STATE_POWER_OFF, /* PM domain is off */
29};
30
31struct dev_power_governor {
32 bool (*power_down_ok)(struct dev_pm_domain *domain);
33 bool (*stop_ok)(struct device *dev);
34};
35
36struct gpd_dev_ops {
37 int (*start)(struct device *dev);
38 int (*stop)(struct device *dev);
39 int (*save_state)(struct device *dev);
40 int (*restore_state)(struct device *dev);
41 bool (*active_wakeup)(struct device *dev);
42};
43
44struct gpd_cpuidle_data {
45 unsigned int saved_exit_latency;
46 struct cpuidle_state *idle_state;
47};
48
49struct generic_pm_domain {
50 struct dev_pm_domain domain; /* PM domain operations */
51 struct list_head gpd_list_node; /* Node in the global PM domains list */
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 */
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;
58 const char *name;
59 unsigned int in_progress; /* Number of devices being suspended now */
60 atomic_t sd_count; /* Number of subdomains with power "on" */
61 enum gpd_status status; /* Current state of the domain */
62 wait_queue_head_t status_wait_queue;
63 struct task_struct *poweroff_task; /* Powering off task */
64 unsigned int resume_count; /* Number of devices being resumed */
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 */
69 int (*power_off)(struct generic_pm_domain *domain);
70 s64 power_off_latency_ns;
71 int (*power_on)(struct generic_pm_domain *domain);
72 s64 power_on_latency_ns;
73 struct gpd_dev_ops dev_ops;
74 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
75 bool max_off_time_changed;
76 bool cached_power_down_ok;
77 struct gpd_cpuidle_data *cpuidle_data;
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);
82 unsigned int flags; /* Bit field of configs for genpd */
83};
84
85static 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
90struct 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
97struct gpd_timing_data {
98 s64 stop_latency_ns;
99 s64 start_latency_ns;
100 s64 save_state_latency_ns;
101 s64 restore_state_latency_ns;
102 s64 effective_constraint_ns;
103 bool constraint_changed;
104 bool cached_stop_ok;
105};
106
107struct pm_domain_data {
108 struct list_head list_node;
109 struct device *dev;
110};
111
112struct generic_pm_domain_data {
113 struct pm_domain_data base;
114 struct gpd_timing_data td;
115 struct notifier_block nb;
116 struct mutex lock;
117 unsigned int refcount;
118 int need_restore;
119};
120
121#ifdef CONFIG_PM_GENERIC_DOMAINS
122static 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
127static 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
132extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
133extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
134 struct device *dev,
135 struct gpd_timing_data *td);
136
137extern int __pm_genpd_name_add_device(const char *domain_name,
138 struct device *dev,
139 struct gpd_timing_data *td);
140
141extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
142 struct device *dev);
143extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
144extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
145 struct generic_pm_domain *new_subdomain);
146extern int pm_genpd_add_subdomain_names(const char *master_name,
147 const char *subdomain_name);
148extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
149 struct generic_pm_domain *target);
150extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
151extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
152extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
153extern int pm_genpd_name_detach_cpuidle(const char *name);
154extern void pm_genpd_init(struct generic_pm_domain *genpd,
155 struct dev_power_governor *gov, bool is_off);
156
157extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
158extern int pm_genpd_name_poweron(const char *domain_name);
159extern void pm_genpd_poweroff_unused(void);
160
161extern struct dev_power_governor simple_qos_governor;
162extern struct dev_power_governor pm_domain_always_on_gov;
163#else
164
165static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
166{
167 return ERR_PTR(-ENOSYS);
168}
169static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
170{
171 return ERR_PTR(-ENOSYS);
172}
173static 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}
179static inline int __pm_genpd_name_add_device(const char *domain_name,
180 struct device *dev,
181 struct gpd_timing_data *td)
182{
183 return -ENOSYS;
184}
185static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
186 struct device *dev)
187{
188 return -ENOSYS;
189}
190static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
191static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
192 struct generic_pm_domain *new_sd)
193{
194 return -ENOSYS;
195}
196static inline int pm_genpd_add_subdomain_names(const char *master_name,
197 const char *subdomain_name)
198{
199 return -ENOSYS;
200}
201static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
202 struct generic_pm_domain *target)
203{
204 return -ENOSYS;
205}
206static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
207{
208 return -ENOSYS;
209}
210static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
211{
212 return -ENOSYS;
213}
214static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
215{
216 return -ENOSYS;
217}
218static inline int pm_genpd_name_detach_cpuidle(const char *name)
219{
220 return -ENOSYS;
221}
222static inline void pm_genpd_init(struct generic_pm_domain *genpd,
223 struct dev_power_governor *gov, bool is_off)
224{
225}
226static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
227{
228 return -ENOSYS;
229}
230static inline int pm_genpd_name_poweron(const char *domain_name)
231{
232 return -ENOSYS;
233}
234static inline void pm_genpd_poweroff_unused(void) {}
235#define simple_qos_governor NULL
236#define pm_domain_always_on_gov NULL
237#endif
238
239static 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
245static 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
251#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
252extern void pm_genpd_syscore_poweroff(struct device *dev);
253extern void pm_genpd_syscore_poweron(struct device *dev);
254#else
255static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
256static inline void pm_genpd_syscore_poweron(struct device *dev) {}
257#endif
258
259/* OF PM domain providers */
260struct of_device_id;
261
262struct genpd_onecell_data {
263 struct generic_pm_domain **domains;
264 unsigned int num_domains;
265};
266
267typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
268 void *data);
269
270#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
271int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
272 void *data);
273void of_genpd_del_provider(struct device_node *np);
274struct generic_pm_domain *of_genpd_get_from_provider(
275 struct of_phandle_args *genpdspec);
276
277struct generic_pm_domain *__of_genpd_xlate_simple(
278 struct of_phandle_args *genpdspec,
279 void *data);
280struct generic_pm_domain *__of_genpd_xlate_onecell(
281 struct of_phandle_args *genpdspec,
282 void *data);
283
284int genpd_dev_pm_attach(struct device *dev);
285#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
286static inline int __of_genpd_add_provider(struct device_node *np,
287 genpd_xlate_t xlate, void *data)
288{
289 return 0;
290}
291static inline void of_genpd_del_provider(struct device_node *np) {}
292
293static inline struct generic_pm_domain *of_genpd_get_from_provider(
294 struct of_phandle_args *genpdspec)
295{
296 return NULL;
297}
298
299#define __of_genpd_xlate_simple NULL
300#define __of_genpd_xlate_onecell NULL
301
302static inline int genpd_dev_pm_attach(struct device *dev)
303{
304 return -ENODEV;
305}
306#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
307
308static 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}
313static 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
319#ifdef CONFIG_PM
320extern int dev_pm_domain_attach(struct device *dev, bool power_on);
321extern void dev_pm_domain_detach(struct device *dev, bool power_off);
322#else
323static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
324{
325 return -ENODEV;
326}
327static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
328#endif
329
330#endif /* _LINUX_PM_DOMAIN_H */