device.h: audit and cleanup users in main include dir
[linux-2.6.git] / include / linux / pm_domain.h
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
17 enum gpd_status {
18         GPD_STATE_ACTIVE = 0,   /* PM domain is active */
19         GPD_STATE_WAIT_MASTER,  /* PM domain's master is being waited for */
20         GPD_STATE_BUSY,         /* Something is happening to the PM domain */
21         GPD_STATE_REPEAT,       /* Power off in progress, to be repeated */
22         GPD_STATE_POWER_OFF,    /* PM domain is off */
23 };
24
25 struct dev_power_governor {
26         bool (*power_down_ok)(struct dev_pm_domain *domain);
27         bool (*stop_ok)(struct device *dev);
28 };
29
30 struct gpd_dev_ops {
31         int (*start)(struct device *dev);
32         int (*stop)(struct device *dev);
33         int (*save_state)(struct device *dev);
34         int (*restore_state)(struct device *dev);
35         int (*suspend)(struct device *dev);
36         int (*suspend_late)(struct device *dev);
37         int (*resume_early)(struct device *dev);
38         int (*resume)(struct device *dev);
39         int (*freeze)(struct device *dev);
40         int (*freeze_late)(struct device *dev);
41         int (*thaw_early)(struct device *dev);
42         int (*thaw)(struct device *dev);
43         bool (*active_wakeup)(struct device *dev);
44 };
45
46 struct 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         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         wait_queue_head_t status_wait_queue;
60         struct task_struct *poweroff_task;      /* Powering off task */
61         unsigned int resume_count;      /* Number of devices being resumed */
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 */
66         bool dev_irq_safe;      /* Device callbacks are IRQ-safe */
67         int (*power_off)(struct generic_pm_domain *domain);
68         s64 power_off_latency_ns;
69         int (*power_on)(struct generic_pm_domain *domain);
70         s64 power_on_latency_ns;
71         struct gpd_dev_ops dev_ops;
72         s64 break_even_ns;      /* Power break even for the entire domain. */
73         s64 max_off_time_ns;    /* Maximum allowed "suspended" time. */
74         ktime_t power_off_time;
75 };
76
77 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
78 {
79         return container_of(pd, struct generic_pm_domain, domain);
80 }
81
82 struct gpd_link {
83         struct generic_pm_domain *master;
84         struct list_head master_node;
85         struct generic_pm_domain *slave;
86         struct list_head slave_node;
87 };
88
89 struct gpd_timing_data {
90         s64 stop_latency_ns;
91         s64 start_latency_ns;
92         s64 save_state_latency_ns;
93         s64 restore_state_latency_ns;
94         s64 break_even_ns;
95 };
96
97 struct generic_pm_domain_data {
98         struct pm_domain_data base;
99         struct gpd_dev_ops ops;
100         struct gpd_timing_data td;
101         bool need_restore;
102 };
103
104 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
105 {
106         return container_of(pdd, struct generic_pm_domain_data, base);
107 }
108
109 #ifdef CONFIG_PM_GENERIC_DOMAINS
110 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
111 {
112         return to_gpd_data(dev->power.subsys_data->domain_data);
113 }
114
115 extern struct dev_power_governor simple_qos_governor;
116
117 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
118 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
119                                  struct device *dev,
120                                  struct gpd_timing_data *td);
121
122 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
123                                       struct device *dev)
124 {
125         return __pm_genpd_add_device(genpd, dev, NULL);
126 }
127
128 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
129                                   struct device *dev);
130 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
131                                   struct generic_pm_domain *new_subdomain);
132 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
133                                      struct generic_pm_domain *target);
134 extern int pm_genpd_add_callbacks(struct device *dev,
135                                   struct gpd_dev_ops *ops,
136                                   struct gpd_timing_data *td);
137 extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
138 extern void pm_genpd_init(struct generic_pm_domain *genpd,
139                           struct dev_power_governor *gov, bool is_off);
140
141 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
142
143 extern bool default_stop_ok(struct device *dev);
144
145 extern struct dev_power_governor pm_domain_always_on_gov;
146 #else
147
148 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
149 {
150         return ERR_PTR(-ENOSYS);
151 }
152 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
153                                         struct device *dev,
154                                         struct gpd_timing_data *td)
155 {
156         return -ENOSYS;
157 }
158 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
159                                       struct device *dev)
160 {
161         return -ENOSYS;
162 }
163 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
164                                          struct device *dev)
165 {
166         return -ENOSYS;
167 }
168 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
169                                          struct generic_pm_domain *new_sd)
170 {
171         return -ENOSYS;
172 }
173 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
174                                             struct generic_pm_domain *target)
175 {
176         return -ENOSYS;
177 }
178 static inline int pm_genpd_add_callbacks(struct device *dev,
179                                          struct gpd_dev_ops *ops,
180                                          struct gpd_timing_data *td)
181 {
182         return -ENOSYS;
183 }
184 static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
185 {
186         return -ENOSYS;
187 }
188 static inline void pm_genpd_init(struct generic_pm_domain *genpd, bool is_off)
189 {
190 }
191 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
192 {
193         return -ENOSYS;
194 }
195 static inline bool default_stop_ok(struct device *dev)
196 {
197         return false;
198 }
199 #define pm_domain_always_on_gov NULL
200 #endif
201
202 static inline int pm_genpd_remove_callbacks(struct device *dev)
203 {
204         return __pm_genpd_remove_callbacks(dev, true);
205 }
206
207 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
208 extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
209 extern void pm_genpd_poweroff_unused(void);
210 #else
211 static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
212 static inline void pm_genpd_poweroff_unused(void) {}
213 #endif
214
215 #endif /* _LINUX_PM_DOMAIN_H */