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_POWER_OFF, /* PM domain is off */
26};
27
28struct dev_power_governor {
29 bool (*power_down_ok)(struct dev_pm_domain *domain);
30 bool (*stop_ok)(struct device *dev);
31};
32
33struct gpd_dev_ops {
34 int (*start)(struct device *dev);
35 int (*stop)(struct device *dev);
36 int (*save_state)(struct device *dev);
37 int (*restore_state)(struct device *dev);
38 bool (*active_wakeup)(struct device *dev);
39};
40
41struct gpd_cpuidle_data {
42 unsigned int saved_exit_latency;
43 struct cpuidle_state *idle_state;
44};
45
46struct generic_pm_domain {
47 struct dev_pm_domain domain; /* PM domain operations */
48 struct list_head gpd_list_node; /* Node in the global PM domains list */
49 struct list_head master_links; /* Links with PM domain as a master */
50 struct list_head slave_links; /* Links with PM domain as a slave */
51 struct list_head dev_list; /* List of devices */
52 struct mutex lock;
53 struct dev_power_governor *gov;
54 struct work_struct power_off_work;
55 const char *name;
56 unsigned int in_progress; /* Number of devices being suspended now */
57 atomic_t sd_count; /* Number of subdomains with power "on" */
58 enum gpd_status status; /* Current state of the domain */
59 unsigned int device_count; /* Number of devices */
60 unsigned int suspended_count; /* System suspend device counter */
61 unsigned int prepared_count; /* Suspend counter of prepared devices */
62 bool suspend_power_off; /* Power status before system suspend */
63 int (*power_off)(struct generic_pm_domain *domain);
64 s64 power_off_latency_ns;
65 int (*power_on)(struct generic_pm_domain *domain);
66 s64 power_on_latency_ns;
67 struct gpd_dev_ops dev_ops;
68 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
69 bool max_off_time_changed;
70 bool cached_power_down_ok;
71 struct gpd_cpuidle_data *cpuidle_data;
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);
76 unsigned int flags; /* Bit field of configs for genpd */
77};
78
79static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
80{
81 return container_of(pd, struct generic_pm_domain, domain);
82}
83
84struct gpd_link {
85 struct generic_pm_domain *master;
86 struct list_head master_node;
87 struct generic_pm_domain *slave;
88 struct list_head slave_node;
89};
90
91struct gpd_timing_data {
92 s64 stop_latency_ns;
93 s64 start_latency_ns;
94 s64 save_state_latency_ns;
95 s64 restore_state_latency_ns;
96 s64 effective_constraint_ns;
97 bool constraint_changed;
98 bool cached_stop_ok;
99};
100
101struct pm_domain_data {
102 struct list_head list_node;
103 struct device *dev;
104};
105
106struct generic_pm_domain_data {
107 struct pm_domain_data base;
108 struct gpd_timing_data td;
109 struct notifier_block nb;
110};
111
112#ifdef CONFIG_PM_GENERIC_DOMAINS
113static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
114{
115 return container_of(pdd, struct generic_pm_domain_data, base);
116}
117
118static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
119{
120 return to_gpd_data(dev->power.subsys_data->domain_data);
121}
122
123extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev);
124extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
125 struct device *dev,
126 struct gpd_timing_data *td);
127
128extern int __pm_genpd_name_add_device(const char *domain_name,
129 struct device *dev,
130 struct gpd_timing_data *td);
131
132extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
133 struct device *dev);
134extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
135 struct generic_pm_domain *new_subdomain);
136extern int pm_genpd_add_subdomain_names(const char *master_name,
137 const char *subdomain_name);
138extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
139 struct generic_pm_domain *target);
140extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
141extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
142extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
143extern int pm_genpd_name_detach_cpuidle(const char *name);
144extern void pm_genpd_init(struct generic_pm_domain *genpd,
145 struct dev_power_governor *gov, bool is_off);
146
147extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
148extern int pm_genpd_name_poweron(const char *domain_name);
149extern void pm_genpd_poweroff_unused(void);
150
151extern struct dev_power_governor simple_qos_governor;
152extern struct dev_power_governor pm_domain_always_on_gov;
153#else
154
155static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
156{
157 return ERR_PTR(-ENOSYS);
158}
159static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
160{
161 return NULL;
162}
163static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
164 struct device *dev,
165 struct gpd_timing_data *td)
166{
167 return -ENOSYS;
168}
169static inline int __pm_genpd_name_add_device(const char *domain_name,
170 struct device *dev,
171 struct gpd_timing_data *td)
172{
173 return -ENOSYS;
174}
175static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
176 struct device *dev)
177{
178 return -ENOSYS;
179}
180static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
181 struct generic_pm_domain *new_sd)
182{
183 return -ENOSYS;
184}
185static inline int pm_genpd_add_subdomain_names(const char *master_name,
186 const char *subdomain_name)
187{
188 return -ENOSYS;
189}
190static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
191 struct generic_pm_domain *target)
192{
193 return -ENOSYS;
194}
195static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
196{
197 return -ENOSYS;
198}
199static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
200{
201 return -ENOSYS;
202}
203static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
204{
205 return -ENOSYS;
206}
207static inline int pm_genpd_name_detach_cpuidle(const char *name)
208{
209 return -ENOSYS;
210}
211static inline void pm_genpd_init(struct generic_pm_domain *genpd,
212 struct dev_power_governor *gov, bool is_off)
213{
214}
215static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
216{
217 return -ENOSYS;
218}
219static inline int pm_genpd_name_poweron(const char *domain_name)
220{
221 return -ENOSYS;
222}
223static inline void pm_genpd_poweroff_unused(void) {}
224#endif
225
226static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
227 struct device *dev)
228{
229 return __pm_genpd_add_device(genpd, dev, NULL);
230}
231
232static inline int pm_genpd_name_add_device(const char *domain_name,
233 struct device *dev)
234{
235 return __pm_genpd_name_add_device(domain_name, dev, NULL);
236}
237
238#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
239extern void pm_genpd_syscore_poweroff(struct device *dev);
240extern void pm_genpd_syscore_poweron(struct device *dev);
241#else
242static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
243static inline void pm_genpd_syscore_poweron(struct device *dev) {}
244#endif
245
246/* OF PM domain providers */
247struct of_device_id;
248
249struct genpd_onecell_data {
250 struct generic_pm_domain **domains;
251 unsigned int num_domains;
252};
253
254typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
255 void *data);
256
257#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
258int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
259 void *data);
260void of_genpd_del_provider(struct device_node *np);
261struct generic_pm_domain *of_genpd_get_from_provider(
262 struct of_phandle_args *genpdspec);
263
264struct generic_pm_domain *__of_genpd_xlate_simple(
265 struct of_phandle_args *genpdspec,
266 void *data);
267struct generic_pm_domain *__of_genpd_xlate_onecell(
268 struct of_phandle_args *genpdspec,
269 void *data);
270
271int genpd_dev_pm_attach(struct device *dev);
272#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
273static inline int __of_genpd_add_provider(struct device_node *np,
274 genpd_xlate_t xlate, void *data)
275{
276 return 0;
277}
278static inline void of_genpd_del_provider(struct device_node *np) {}
279
280static inline struct generic_pm_domain *of_genpd_get_from_provider(
281 struct of_phandle_args *genpdspec)
282{
283 return NULL;
284}
285
286#define __of_genpd_xlate_simple NULL
287#define __of_genpd_xlate_onecell NULL
288
289static inline int genpd_dev_pm_attach(struct device *dev)
290{
291 return -ENODEV;
292}
293#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
294
295static inline int of_genpd_add_provider_simple(struct device_node *np,
296 struct generic_pm_domain *genpd)
297{
298 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
299}
300static inline int of_genpd_add_provider_onecell(struct device_node *np,
301 struct genpd_onecell_data *data)
302{
303 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
304}
305
306#ifdef CONFIG_PM
307extern int dev_pm_domain_attach(struct device *dev, bool power_on);
308extern void dev_pm_domain_detach(struct device *dev, bool power_off);
309#else
310static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
311{
312 return -ENODEV;
313}
314static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
315#endif
316
317#endif /* _LINUX_PM_DOMAIN_H */