2 * pm_domain.h - Definitions and headers related to device power domains.
4 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
6 * This file is released under the GPLv2.
9 #ifndef _LINUX_PM_DOMAIN_H
10 #define _LINUX_PM_DOMAIN_H
12 #include <linux/device.h>
13 #include <linux/mutex.h>
15 #include <linux/err.h>
17 #include <linux/notifier.h>
18 #include <linux/cpuidle.h>
21 GPD_STATE_ACTIVE = 0, /* PM domain is active */
22 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
23 GPD_STATE_BUSY, /* Something is happening to the PM domain */
24 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
25 GPD_STATE_POWER_OFF, /* PM domain is off */
28 struct dev_power_governor {
29 bool (*power_down_ok)(struct dev_pm_domain *domain);
30 bool (*stop_ok)(struct device *dev);
34 int (*start)(struct device *dev);
35 int (*stop)(struct device *dev);
36 int (*save_state)(struct device *dev);
37 int (*restore_state)(struct device *dev);
38 bool (*active_wakeup)(struct device *dev);
41 struct gpd_cpuidle_data {
42 unsigned int saved_exit_latency;
43 struct cpuidle_state *idle_state;
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 */
53 struct dev_power_governor *gov;
54 struct work_struct power_off_work;
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 int (*power_off)(struct generic_pm_domain *domain);
67 s64 power_off_latency_ns;
68 int (*power_on)(struct generic_pm_domain *domain);
69 s64 power_on_latency_ns;
70 struct gpd_dev_ops dev_ops;
71 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
72 bool max_off_time_changed;
73 bool cached_power_down_ok;
74 struct gpd_cpuidle_data *cpuidle_data;
75 int (*attach_dev)(struct generic_pm_domain *domain,
77 void (*detach_dev)(struct generic_pm_domain *domain,
81 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
83 return container_of(pd, struct generic_pm_domain, domain);
87 struct generic_pm_domain *master;
88 struct list_head master_node;
89 struct generic_pm_domain *slave;
90 struct list_head slave_node;
93 struct gpd_timing_data {
96 s64 save_state_latency_ns;
97 s64 restore_state_latency_ns;
98 s64 effective_constraint_ns;
99 bool constraint_changed;
103 struct generic_pm_domain_data {
104 struct pm_domain_data base;
105 struct gpd_timing_data td;
106 struct notifier_block nb;
108 unsigned int refcount;
112 #ifdef CONFIG_PM_GENERIC_DOMAINS
113 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
115 return container_of(pdd, struct generic_pm_domain_data, base);
118 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
120 return to_gpd_data(dev->power.subsys_data->domain_data);
123 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
124 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
126 struct gpd_timing_data *td);
128 extern int __pm_genpd_name_add_device(const char *domain_name,
130 struct gpd_timing_data *td);
132 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
134 extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
135 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
136 struct generic_pm_domain *new_subdomain);
137 extern int pm_genpd_add_subdomain_names(const char *master_name,
138 const char *subdomain_name);
139 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
140 struct generic_pm_domain *target);
141 extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
142 extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
143 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
144 extern int pm_genpd_name_detach_cpuidle(const char *name);
145 extern void pm_genpd_init(struct generic_pm_domain *genpd,
146 struct dev_power_governor *gov, bool is_off);
148 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
149 extern int pm_genpd_name_poweron(const char *domain_name);
150 extern void pm_genpd_poweroff_unused(void);
152 extern struct dev_power_governor simple_qos_governor;
153 extern struct dev_power_governor pm_domain_always_on_gov;
156 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
158 return ERR_PTR(-ENOSYS);
160 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
162 return ERR_PTR(-ENOSYS);
164 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
166 struct gpd_timing_data *td)
170 static inline int __pm_genpd_name_add_device(const char *domain_name,
172 struct gpd_timing_data *td)
176 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
181 static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
182 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
183 struct generic_pm_domain *new_sd)
187 static inline int pm_genpd_add_subdomain_names(const char *master_name,
188 const char *subdomain_name)
192 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
193 struct generic_pm_domain *target)
197 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
201 static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
205 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
209 static inline int pm_genpd_name_detach_cpuidle(const char *name)
213 static inline void pm_genpd_init(struct generic_pm_domain *genpd,
214 struct dev_power_governor *gov, bool is_off)
217 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
221 static inline int pm_genpd_name_poweron(const char *domain_name)
225 static inline void pm_genpd_poweroff_unused(void) {}
226 #define simple_qos_governor NULL
227 #define pm_domain_always_on_gov NULL
230 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
233 return __pm_genpd_add_device(genpd, dev, NULL);
236 static inline int pm_genpd_name_add_device(const char *domain_name,
239 return __pm_genpd_name_add_device(domain_name, dev, NULL);
242 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
243 extern void pm_genpd_syscore_poweroff(struct device *dev);
244 extern void pm_genpd_syscore_poweron(struct device *dev);
246 static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
247 static inline void pm_genpd_syscore_poweron(struct device *dev) {}
250 /* OF PM domain providers */
253 struct genpd_onecell_data {
254 struct generic_pm_domain **domains;
255 unsigned int num_domains;
258 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
261 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
262 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
264 void of_genpd_del_provider(struct device_node *np);
266 struct generic_pm_domain *__of_genpd_xlate_simple(
267 struct of_phandle_args *genpdspec,
269 struct generic_pm_domain *__of_genpd_xlate_onecell(
270 struct of_phandle_args *genpdspec,
273 int genpd_dev_pm_attach(struct device *dev);
274 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
275 static inline int __of_genpd_add_provider(struct device_node *np,
276 genpd_xlate_t xlate, void *data)
280 static inline void of_genpd_del_provider(struct device_node *np) {}
282 #define __of_genpd_xlate_simple NULL
283 #define __of_genpd_xlate_onecell NULL
285 static inline int genpd_dev_pm_attach(struct device *dev)
289 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
291 static inline int of_genpd_add_provider_simple(struct device_node *np,
292 struct generic_pm_domain *genpd)
294 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
296 static inline int of_genpd_add_provider_onecell(struct device_node *np,
297 struct genpd_onecell_data *data)
299 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
303 extern int dev_pm_domain_attach(struct device *dev, bool power_on);
304 extern void dev_pm_domain_detach(struct device *dev, bool power_off);
306 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
310 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
313 #endif /* _LINUX_PM_DOMAIN_H */