mm: memcontrol: pull the NULL check from __mem_cgroup_same_or_subtree()
[linux-2.6-block.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;
c16561e8
UH
75 int (*attach_dev)(struct generic_pm_domain *domain,
76 struct device *dev);
77 void (*detach_dev)(struct generic_pm_domain *domain,
78 struct device *dev);
f721889f
RW
79};
80
596ba34b
RW
81static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
82{
83 return container_of(pd, struct generic_pm_domain, domain);
84}
85
5063ce15
RW
86struct gpd_link {
87 struct generic_pm_domain *master;
88 struct list_head master_node;
89 struct generic_pm_domain *slave;
90 struct list_head slave_node;
91};
92
b02c999a
RW
93struct gpd_timing_data {
94 s64 stop_latency_ns;
95 s64 start_latency_ns;
221e9b58
RW
96 s64 save_state_latency_ns;
97 s64 restore_state_latency_ns;
a5bef810 98 s64 effective_constraint_ns;
6ff7bb0d
RW
99 bool constraint_changed;
100 bool cached_stop_ok;
b02c999a
RW
101};
102
cd0ea672
RW
103struct generic_pm_domain_data {
104 struct pm_domain_data base;
b02c999a 105 struct gpd_timing_data td;
6ff7bb0d
RW
106 struct notifier_block nb;
107 struct mutex lock;
1d5fcfec 108 unsigned int refcount;
67732cd3 109 int need_restore;
cd0ea672
RW
110};
111
9b4f617b 112#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672
RW
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
d5e4cbfe
RW
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
b02c999a
RW
123extern struct generic_pm_domain *dev_to_genpd(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
b5abb085
RW
128extern int __pm_genpd_name_add_device(const char *domain_name,
129 struct device *dev,
130 struct gpd_timing_data *td);
c8aa130b 131
f721889f
RW
132extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
133 struct device *dev);
ca1d72f0 134extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
f721889f
RW
135extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
136 struct generic_pm_domain *new_subdomain);
fb7268be
RW
137extern int pm_genpd_add_subdomain_names(const char *master_name,
138 const char *subdomain_name);
f721889f
RW
139extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
140 struct generic_pm_domain *target);
40114447 141extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
74a2799a 142extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
40114447 143extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
74a2799a 144extern int pm_genpd_name_detach_cpuidle(const char *name);
f721889f
RW
145extern void pm_genpd_init(struct generic_pm_domain *genpd,
146 struct dev_power_governor *gov, bool is_off);
b02c999a 147
18b4f3f5 148extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
8bc0251d 149extern int pm_genpd_name_poweron(const char *domain_name);
b02c999a 150
ae3c511c 151extern struct dev_power_governor simple_qos_governor;
925b44a2 152extern struct dev_power_governor pm_domain_always_on_gov;
f721889f 153#else
b02c999a 154
b642631d
MD
155static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
156{
157 return ERR_PTR(-ENOSYS);
158}
b02c999a
RW
159static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
160{
161 return ERR_PTR(-ENOSYS);
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}
b5abb085
RW
169static inline int __pm_genpd_name_add_device(const char *domain_name,
170 struct device *dev,
171 struct gpd_timing_data *td)
f721889f
RW
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}
ca1d72f0 180static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
f721889f
RW
181static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
182 struct generic_pm_domain *new_sd)
183{
184 return -ENOSYS;
185}
fb7268be
RW
186static inline int pm_genpd_add_subdomain_names(const char *master_name,
187 const char *subdomain_name)
188{
189 return -ENOSYS;
190}
f721889f
RW
191static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
192 struct generic_pm_domain *target)
193{
194 return -ENOSYS;
195}
40114447 196static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
cbc9ef02
RW
197{
198 return -ENOSYS;
199}
74a2799a
RW
200static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
201{
202 return -ENOSYS;
203}
40114447 204static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
cbc9ef02
RW
205{
206 return -ENOSYS;
207}
74a2799a
RW
208static inline int pm_genpd_name_detach_cpuidle(const char *name)
209{
210 return -ENOSYS;
211}
b642631d
MD
212static inline void pm_genpd_init(struct generic_pm_domain *genpd,
213 struct dev_power_governor *gov, bool is_off)
b02c999a
RW
214{
215}
18b4f3f5
MD
216static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
217{
218 return -ENOSYS;
219}
8bc0251d
RW
220static inline int pm_genpd_name_poweron(const char *domain_name)
221{
222 return -ENOSYS;
223}
b642631d 224#define simple_qos_governor NULL
925b44a2 225#define pm_domain_always_on_gov NULL
17f2ae7f
RW
226#endif
227
b5abb085
RW
228static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
229 struct device *dev)
230{
231 return __pm_genpd_add_device(genpd, dev, NULL);
232}
233
b5abb085
RW
234static inline int pm_genpd_name_add_device(const char *domain_name,
235 struct device *dev)
236{
237 return __pm_genpd_name_add_device(domain_name, dev, NULL);
238}
239
17f2ae7f 240#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
17f2ae7f
RW
241extern void pm_genpd_poweroff_unused(void);
242#else
17f2ae7f 243static inline void pm_genpd_poweroff_unused(void) {}
f721889f
RW
244#endif
245
77f827de 246#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
d47e6464
UH
247extern void pm_genpd_syscore_poweroff(struct device *dev);
248extern void pm_genpd_syscore_poweron(struct device *dev);
77f827de 249#else
d47e6464
UH
250static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
251static inline void pm_genpd_syscore_poweron(struct device *dev) {}
77f827de
RW
252#endif
253
aa42240a
TF
254/* OF PM domain providers */
255struct of_device_id;
256
257struct genpd_onecell_data {
258 struct generic_pm_domain **domains;
259 unsigned int num_domains;
260};
261
262typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
263 void *data);
264
265#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
266int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
267 void *data);
268void of_genpd_del_provider(struct device_node *np);
269
270struct generic_pm_domain *__of_genpd_xlate_simple(
271 struct of_phandle_args *genpdspec,
272 void *data);
273struct generic_pm_domain *__of_genpd_xlate_onecell(
274 struct of_phandle_args *genpdspec,
275 void *data);
276
277int genpd_dev_pm_attach(struct device *dev);
278#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
279static inline int __of_genpd_add_provider(struct device_node *np,
280 genpd_xlate_t xlate, void *data)
281{
282 return 0;
283}
284static inline void of_genpd_del_provider(struct device_node *np) {}
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
f48c767c
UH
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
f721889f 317#endif /* _LINUX_PM_DOMAIN_H */