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/spinlock.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 #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
25 enum gpd_status {
26 GPD_STATE_ACTIVE = 0, /* PM domain is active */
27 GPD_STATE_POWER_OFF, /* PM domain is off */
28 };
29
30 struct dev_power_governor {
31 bool (*power_down_ok)(struct dev_pm_domain *domain);
32 bool (*suspend_ok)(struct device *dev);
33 };
34
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
41 struct genpd_power_state {
42 s64 power_off_latency_ns;
43 s64 power_on_latency_ns;
44 s64 residency_ns;
45 struct fwnode_handle *fwnode;
46 ktime_t idle_time;
47 };
48
49 struct genpd_lock_ops;
50
51 struct generic_pm_domain {
52 struct dev_pm_domain domain; /* PM domain operations */
53 struct list_head gpd_list_node; /* Node in the global PM domains list */
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 */
56 struct list_head dev_list; /* List of devices */
57 struct dev_power_governor *gov;
58 struct work_struct power_off_work;
59 struct fwnode_handle *provider; /* Identity of the domain provider */
60 bool has_provider;
61 const char *name;
62 atomic_t sd_count; /* Number of subdomains with power "on" */
63 enum gpd_status status; /* Current state of the domain */
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 */
67 int (*power_off)(struct generic_pm_domain *domain);
68 int (*power_on)(struct generic_pm_domain *domain);
69 struct gpd_dev_ops dev_ops;
70 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
71 bool max_off_time_changed;
72 bool cached_power_down_ok;
73 int (*attach_dev)(struct generic_pm_domain *domain,
74 struct device *dev);
75 void (*detach_dev)(struct generic_pm_domain *domain,
76 struct device *dev);
77 unsigned int flags; /* Bit field of configs for genpd */
78 struct genpd_power_state *states;
79 unsigned int state_count; /* number of states */
80 unsigned int state_idx; /* state that genpd will go to when off */
81 void *free; /* Free the state that was allocated for default */
82 ktime_t on_time;
83 ktime_t accounting_time;
84 const struct genpd_lock_ops *lock_ops;
85 union {
86 struct mutex mlock;
87 struct {
88 spinlock_t slock;
89 unsigned long lock_flags;
90 };
91 };
92
93 };
94
pd_to_genpd(struct dev_pm_domain * pd)95 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
96 {
97 return container_of(pd, struct generic_pm_domain, domain);
98 }
99
100 struct gpd_link {
101 struct generic_pm_domain *master;
102 struct list_head master_node;
103 struct generic_pm_domain *slave;
104 struct list_head slave_node;
105 };
106
107 struct gpd_timing_data {
108 s64 suspend_latency_ns;
109 s64 resume_latency_ns;
110 s64 effective_constraint_ns;
111 bool constraint_changed;
112 bool cached_suspend_ok;
113 };
114
115 struct pm_domain_data {
116 struct list_head list_node;
117 struct device *dev;
118 };
119
120 struct generic_pm_domain_data {
121 struct pm_domain_data base;
122 struct gpd_timing_data td;
123 struct notifier_block nb;
124 void *data;
125 };
126
127 #ifdef CONFIG_PM_GENERIC_DOMAINS
to_gpd_data(struct pm_domain_data * pdd)128 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
129 {
130 return container_of(pdd, struct generic_pm_domain_data, base);
131 }
132
dev_gpd_data(struct device * dev)133 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
134 {
135 return to_gpd_data(dev->power.subsys_data->domain_data);
136 }
137
138 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
139 struct device *dev,
140 struct gpd_timing_data *td);
141
142 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
143 struct device *dev);
144 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
145 struct generic_pm_domain *new_subdomain);
146 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
147 struct generic_pm_domain *target);
148 extern int pm_genpd_init(struct generic_pm_domain *genpd,
149 struct dev_power_governor *gov, bool is_off);
150 extern int pm_genpd_remove(struct generic_pm_domain *genpd);
151
152 extern struct dev_power_governor simple_qos_governor;
153 extern struct dev_power_governor pm_domain_always_on_gov;
154 #else
155
dev_gpd_data(struct device * dev)156 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
157 {
158 return ERR_PTR(-ENOSYS);
159 }
__pm_genpd_add_device(struct generic_pm_domain * genpd,struct device * dev,struct gpd_timing_data * td)160 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
161 struct device *dev,
162 struct gpd_timing_data *td)
163 {
164 return -ENOSYS;
165 }
pm_genpd_remove_device(struct generic_pm_domain * genpd,struct device * dev)166 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
167 struct device *dev)
168 {
169 return -ENOSYS;
170 }
pm_genpd_add_subdomain(struct generic_pm_domain * genpd,struct generic_pm_domain * new_sd)171 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
172 struct generic_pm_domain *new_sd)
173 {
174 return -ENOSYS;
175 }
pm_genpd_remove_subdomain(struct generic_pm_domain * genpd,struct generic_pm_domain * target)176 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
177 struct generic_pm_domain *target)
178 {
179 return -ENOSYS;
180 }
pm_genpd_init(struct generic_pm_domain * genpd,struct dev_power_governor * gov,bool is_off)181 static inline int pm_genpd_init(struct generic_pm_domain *genpd,
182 struct dev_power_governor *gov, bool is_off)
183 {
184 return -ENOSYS;
185 }
pm_genpd_remove(struct generic_pm_domain * genpd)186 static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
187 {
188 return -ENOTSUPP;
189 }
190
191 #define simple_qos_governor (*(struct dev_power_governor *)(NULL))
192 #define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL))
193 #endif
194
pm_genpd_add_device(struct generic_pm_domain * genpd,struct device * dev)195 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
196 struct device *dev)
197 {
198 return __pm_genpd_add_device(genpd, dev, NULL);
199 }
200
201 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
202 extern void pm_genpd_syscore_poweroff(struct device *dev);
203 extern void pm_genpd_syscore_poweron(struct device *dev);
204 #else
pm_genpd_syscore_poweroff(struct device * dev)205 static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
pm_genpd_syscore_poweron(struct device * dev)206 static inline void pm_genpd_syscore_poweron(struct device *dev) {}
207 #endif
208
209 /* OF PM domain providers */
210 struct of_device_id;
211
212 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
213 void *data);
214
215 struct genpd_onecell_data {
216 struct generic_pm_domain **domains;
217 unsigned int num_domains;
218 genpd_xlate_t xlate;
219 };
220
221 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
222 int of_genpd_add_provider_simple(struct device_node *np,
223 struct generic_pm_domain *genpd);
224 int of_genpd_add_provider_onecell(struct device_node *np,
225 struct genpd_onecell_data *data);
226 void of_genpd_del_provider(struct device_node *np);
227 extern int of_genpd_add_device(struct of_phandle_args *args,
228 struct device *dev);
229 extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
230 struct of_phandle_args *new_subdomain);
231 extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
232 extern int of_genpd_parse_idle_states(struct device_node *dn,
233 struct genpd_power_state **states, int *n);
234
235 int genpd_dev_pm_attach(struct device *dev);
236 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
of_genpd_add_provider_simple(struct device_node * np,struct generic_pm_domain * genpd)237 static inline int of_genpd_add_provider_simple(struct device_node *np,
238 struct generic_pm_domain *genpd)
239 {
240 return -ENOTSUPP;
241 }
242
of_genpd_add_provider_onecell(struct device_node * np,struct genpd_onecell_data * data)243 static inline int of_genpd_add_provider_onecell(struct device_node *np,
244 struct genpd_onecell_data *data)
245 {
246 return -ENOTSUPP;
247 }
248
of_genpd_del_provider(struct device_node * np)249 static inline void of_genpd_del_provider(struct device_node *np) {}
250
of_genpd_add_device(struct of_phandle_args * args,struct device * dev)251 static inline int of_genpd_add_device(struct of_phandle_args *args,
252 struct device *dev)
253 {
254 return -ENODEV;
255 }
256
of_genpd_add_subdomain(struct of_phandle_args * parent,struct of_phandle_args * new_subdomain)257 static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
258 struct of_phandle_args *new_subdomain)
259 {
260 return -ENODEV;
261 }
262
of_genpd_parse_idle_states(struct device_node * dn,struct genpd_power_state ** states,int * n)263 static inline int of_genpd_parse_idle_states(struct device_node *dn,
264 struct genpd_power_state **states, int *n)
265 {
266 return -ENODEV;
267 }
268
genpd_dev_pm_attach(struct device * dev)269 static inline int genpd_dev_pm_attach(struct device *dev)
270 {
271 return -ENODEV;
272 }
273
274 static inline
of_genpd_remove_last(struct device_node * np)275 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
276 {
277 return ERR_PTR(-ENOTSUPP);
278 }
279 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
280
281 #ifdef CONFIG_PM
282 extern int dev_pm_domain_attach(struct device *dev, bool power_on);
283 extern void dev_pm_domain_detach(struct device *dev, bool power_off);
284 extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
285 #else
dev_pm_domain_attach(struct device * dev,bool power_on)286 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
287 {
288 return -ENODEV;
289 }
dev_pm_domain_detach(struct device * dev,bool power_off)290 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
dev_pm_domain_set(struct device * dev,struct dev_pm_domain * pd)291 static inline void dev_pm_domain_set(struct device *dev,
292 struct dev_pm_domain *pd) {}
293 #endif
294
295 #endif /* _LINUX_PM_DOMAIN_H */
296