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