]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/linux/pm_domain.h
Linux 3.18-rc3
[mirror_ubuntu-focal-kernel.git] / include / linux / pm_domain.h
CommitLineData
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>
cbc9ef02 18#include <linux/cpuidle.h>
f721889f 19
17b75eca
RW
20enum gpd_status {
21 GPD_STATE_ACTIVE = 0, /* PM domain is active */
17877eb5 22 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
17b75eca 23 GPD_STATE_BUSY, /* Something is happening to the PM domain */
c6d22b37 24 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
17b75eca
RW
25 GPD_STATE_POWER_OFF, /* PM domain is off */
26};
596ba34b 27
f721889f
RW
28struct dev_power_governor {
29 bool (*power_down_ok)(struct dev_pm_domain *domain);
b02c999a 30 bool (*stop_ok)(struct device *dev);
f721889f
RW
31};
32
d5e4cbfe
RW
33struct gpd_dev_ops {
34 int (*start)(struct device *dev);
35 int (*stop)(struct device *dev);
ecf00475
RW
36 int (*save_state)(struct device *dev);
37 int (*restore_state)(struct device *dev);
d5e4cbfe
RW
38 bool (*active_wakeup)(struct device *dev);
39};
40
f39cb179 41struct gpd_cpuidle_data {
cbc9ef02
RW
42 unsigned int saved_exit_latency;
43 struct cpuidle_state *idle_state;
44};
45
f721889f
RW
46struct generic_pm_domain {
47 struct dev_pm_domain domain; /* PM domain operations */
5125bbf3 48 struct list_head gpd_list_node; /* Node in the global PM domains list */
5063ce15
RW
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 */
f721889f
RW
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;
d07e9c17 55 const char *name;
f721889f 56 unsigned int in_progress; /* Number of devices being suspended now */
c4bb3160 57 atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca
RW
58 enum gpd_status status; /* Current state of the domain */
59 wait_queue_head_t status_wait_queue;
c6d22b37
RW
60 struct task_struct *poweroff_task; /* Powering off task */
61 unsigned int resume_count; /* Number of devices being resumed */
596ba34b
RW
62 unsigned int device_count; /* Number of devices */
63 unsigned int suspended_count; /* System suspend device counter */
64 unsigned int prepared_count; /* Suspend counter of prepared devices */
65 bool suspend_power_off; /* Power status before system suspend */
f721889f 66 int (*power_off)(struct generic_pm_domain *domain);
221e9b58 67 s64 power_off_latency_ns;
f721889f 68 int (*power_on)(struct generic_pm_domain *domain);
221e9b58 69 s64 power_on_latency_ns;
d5e4cbfe 70 struct gpd_dev_ops dev_ops;
221e9b58 71 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
6ff7bb0d
RW
72 bool max_off_time_changed;
73 bool cached_power_down_ok;
f39cb179 74 struct gpd_cpuidle_data *cpuidle_data;
d79b6fe1
GU
75 void (*attach_dev)(struct device *dev);
76 void (*detach_dev)(struct device *dev);
f721889f
RW
77};
78
596ba34b
RW
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
5063ce15
RW
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
b02c999a
RW
91struct gpd_timing_data {
92 s64 stop_latency_ns;
93 s64 start_latency_ns;
221e9b58
RW
94 s64 save_state_latency_ns;
95 s64 restore_state_latency_ns;
a5bef810 96 s64 effective_constraint_ns;
6ff7bb0d
RW
97 bool constraint_changed;
98 bool cached_stop_ok;
b02c999a
RW
99};
100
cd0ea672
RW
101struct generic_pm_domain_data {
102 struct pm_domain_data base;
b02c999a 103 struct gpd_timing_data td;
6ff7bb0d
RW
104 struct notifier_block nb;
105 struct mutex lock;
1d5fcfec 106 unsigned int refcount;
cd0ea672
RW
107 bool need_restore;
108};
109
9b4f617b 110#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672
RW
111static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
112{
113 return container_of(pdd, struct generic_pm_domain_data, base);
114}
115
d5e4cbfe
RW
116static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
117{
118 return to_gpd_data(dev->power.subsys_data->domain_data);
119}
120
b02c999a
RW
121extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
122extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
123 struct device *dev,
124 struct gpd_timing_data *td);
125
b5abb085
RW
126extern int __pm_genpd_name_add_device(const char *domain_name,
127 struct device *dev,
128 struct gpd_timing_data *td);
c8aa130b 129
f721889f
RW
130extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
131 struct device *dev);
ca1d72f0 132extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
f721889f
RW
133extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
134 struct generic_pm_domain *new_subdomain);
fb7268be
RW
135extern int pm_genpd_add_subdomain_names(const char *master_name,
136 const char *subdomain_name);
f721889f
RW
137extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
138 struct generic_pm_domain *target);
40114447 139extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
74a2799a 140extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
40114447 141extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
74a2799a 142extern int pm_genpd_name_detach_cpuidle(const char *name);
f721889f
RW
143extern void pm_genpd_init(struct generic_pm_domain *genpd,
144 struct dev_power_governor *gov, bool is_off);
b02c999a 145
18b4f3f5 146extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
8bc0251d 147extern int pm_genpd_name_poweron(const char *domain_name);
b02c999a 148
ae3c511c 149extern struct dev_power_governor simple_qos_governor;
925b44a2 150extern struct dev_power_governor pm_domain_always_on_gov;
f721889f 151#else
b02c999a 152
b642631d
MD
153static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
154{
155 return ERR_PTR(-ENOSYS);
156}
b02c999a
RW
157static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
158{
159 return ERR_PTR(-ENOSYS);
160}
161static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
162 struct device *dev,
163 struct gpd_timing_data *td)
164{
165 return -ENOSYS;
166}
b5abb085
RW
167static inline int __pm_genpd_name_add_device(const char *domain_name,
168 struct device *dev,
169 struct gpd_timing_data *td)
f721889f
RW
170{
171 return -ENOSYS;
172}
173static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
174 struct device *dev)
175{
176 return -ENOSYS;
177}
ca1d72f0 178static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
f721889f
RW
179static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
180 struct generic_pm_domain *new_sd)
181{
182 return -ENOSYS;
183}
fb7268be
RW
184static inline int pm_genpd_add_subdomain_names(const char *master_name,
185 const char *subdomain_name)
186{
187 return -ENOSYS;
188}
f721889f
RW
189static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
190 struct generic_pm_domain *target)
191{
192 return -ENOSYS;
193}
40114447 194static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
cbc9ef02
RW
195{
196 return -ENOSYS;
197}
74a2799a
RW
198static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
199{
200 return -ENOSYS;
201}
40114447 202static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
cbc9ef02
RW
203{
204 return -ENOSYS;
205}
74a2799a
RW
206static inline int pm_genpd_name_detach_cpuidle(const char *name)
207{
208 return -ENOSYS;
209}
b642631d
MD
210static inline void pm_genpd_init(struct generic_pm_domain *genpd,
211 struct dev_power_governor *gov, bool is_off)
b02c999a
RW
212{
213}
18b4f3f5
MD
214static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
215{
216 return -ENOSYS;
217}
8bc0251d
RW
218static inline int pm_genpd_name_poweron(const char *domain_name)
219{
220 return -ENOSYS;
221}
b642631d 222#define simple_qos_governor NULL
925b44a2 223#define pm_domain_always_on_gov NULL
17f2ae7f
RW
224#endif
225
b5abb085
RW
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
b5abb085
RW
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
17f2ae7f 238#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
17f2ae7f
RW
239extern void pm_genpd_poweroff_unused(void);
240#else
17f2ae7f 241static inline void pm_genpd_poweroff_unused(void) {}
f721889f
RW
242#endif
243
77f827de 244#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
d47e6464
UH
245extern void pm_genpd_syscore_poweroff(struct device *dev);
246extern void pm_genpd_syscore_poweron(struct device *dev);
77f827de 247#else
d47e6464
UH
248static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
249static inline void pm_genpd_syscore_poweron(struct device *dev) {}
77f827de
RW
250#endif
251
aa42240a
TF
252/* OF PM domain providers */
253struct of_device_id;
254
255struct genpd_onecell_data {
256 struct generic_pm_domain **domains;
257 unsigned int num_domains;
258};
259
260typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
261 void *data);
262
263#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
264int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
265 void *data);
266void of_genpd_del_provider(struct device_node *np);
267
268struct generic_pm_domain *__of_genpd_xlate_simple(
269 struct of_phandle_args *genpdspec,
270 void *data);
271struct generic_pm_domain *__of_genpd_xlate_onecell(
272 struct of_phandle_args *genpdspec,
273 void *data);
274
275int genpd_dev_pm_attach(struct device *dev);
276#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
277static inline int __of_genpd_add_provider(struct device_node *np,
278 genpd_xlate_t xlate, void *data)
279{
280 return 0;
281}
282static inline void of_genpd_del_provider(struct device_node *np) {}
283
284#define __of_genpd_xlate_simple NULL
285#define __of_genpd_xlate_onecell NULL
286
287static inline int genpd_dev_pm_attach(struct device *dev)
288{
289 return -ENODEV;
290}
291#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
292
293static inline int of_genpd_add_provider_simple(struct device_node *np,
294 struct generic_pm_domain *genpd)
295{
296 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
297}
298static inline int of_genpd_add_provider_onecell(struct device_node *np,
299 struct genpd_onecell_data *data)
300{
301 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
302}
303
f48c767c
UH
304#ifdef CONFIG_PM
305extern int dev_pm_domain_attach(struct device *dev, bool power_on);
306extern void dev_pm_domain_detach(struct device *dev, bool power_off);
307#else
308static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
309{
310 return -ENODEV;
311}
312static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
313#endif
314
f721889f 315#endif /* _LINUX_PM_DOMAIN_H */