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>
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 */
24 GPD_STATE_ACTIVE = 0, /* PM domain is active */
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 unsigned int device_count; /* Number of devices */
60 unsigned int suspended_count; /* System suspend device counter */
61 unsigned int prepared_count; /* Suspend counter of prepared devices */
62 bool suspend_power_off; /* Power status before system suspend */
63 int (*power_off)(struct generic_pm_domain *domain);
64 s64 power_off_latency_ns;
65 int (*power_on)(struct generic_pm_domain *domain);
66 s64 power_on_latency_ns;
67 struct gpd_dev_ops dev_ops;
68 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
69 bool max_off_time_changed;
70 bool cached_power_down_ok;
71 struct gpd_cpuidle_data *cpuidle_data;
72 int (*attach_dev)(struct generic_pm_domain *domain,
74 void (*detach_dev)(struct generic_pm_domain *domain,
76 unsigned int flags; /* Bit field of configs for genpd */
79 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
81 return container_of(pd, struct generic_pm_domain, domain);
85 struct generic_pm_domain *master;
86 struct list_head master_node;
87 struct generic_pm_domain *slave;
88 struct list_head slave_node;
91 struct gpd_timing_data {
94 s64 save_state_latency_ns;
95 s64 restore_state_latency_ns;
96 s64 effective_constraint_ns;
97 bool constraint_changed;
101 struct pm_domain_data {
102 struct list_head list_node;
106 struct generic_pm_domain_data {
107 struct pm_domain_data base;
108 struct gpd_timing_data td;
109 struct notifier_block nb;
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 *pm_genpd_lookup_dev(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 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
135 struct generic_pm_domain *new_subdomain);
136 extern int pm_genpd_add_subdomain_names(const char *master_name,
137 const char *subdomain_name);
138 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
139 struct generic_pm_domain *target);
140 extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
141 extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
142 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
143 extern int pm_genpd_name_detach_cpuidle(const char *name);
144 extern void pm_genpd_init(struct generic_pm_domain *genpd,
145 struct dev_power_governor *gov, bool is_off);
147 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
148 extern int pm_genpd_name_poweron(const char *domain_name);
149 extern void pm_genpd_poweroff_unused(void);
151 extern struct dev_power_governor simple_qos_governor;
152 extern struct dev_power_governor pm_domain_always_on_gov;
155 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
157 return ERR_PTR(-ENOSYS);
159 static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
163 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
165 struct gpd_timing_data *td)
169 static inline int __pm_genpd_name_add_device(const char *domain_name,
171 struct gpd_timing_data *td)
175 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
180 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
181 struct generic_pm_domain *new_sd)
185 static inline int pm_genpd_add_subdomain_names(const char *master_name,
186 const char *subdomain_name)
190 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
191 struct generic_pm_domain *target)
195 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
199 static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
203 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
207 static inline int pm_genpd_name_detach_cpuidle(const char *name)
211 static inline void pm_genpd_init(struct generic_pm_domain *genpd,
212 struct dev_power_governor *gov, bool is_off)
215 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
219 static inline int pm_genpd_name_poweron(const char *domain_name)
223 static inline void pm_genpd_poweroff_unused(void) {}
226 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
229 return __pm_genpd_add_device(genpd, dev, NULL);
232 static inline int pm_genpd_name_add_device(const char *domain_name,
235 return __pm_genpd_name_add_device(domain_name, dev, NULL);
238 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
239 extern void pm_genpd_syscore_poweroff(struct device *dev);
240 extern void pm_genpd_syscore_poweron(struct device *dev);
242 static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
243 static inline void pm_genpd_syscore_poweron(struct device *dev) {}
246 /* OF PM domain providers */
249 struct genpd_onecell_data {
250 struct generic_pm_domain **domains;
251 unsigned int num_domains;
254 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
257 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
258 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
260 void of_genpd_del_provider(struct device_node *np);
261 struct generic_pm_domain *of_genpd_get_from_provider(
262 struct of_phandle_args *genpdspec);
264 struct generic_pm_domain *__of_genpd_xlate_simple(
265 struct of_phandle_args *genpdspec,
267 struct generic_pm_domain *__of_genpd_xlate_onecell(
268 struct of_phandle_args *genpdspec,
271 int genpd_dev_pm_attach(struct device *dev);
272 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
273 static inline int __of_genpd_add_provider(struct device_node *np,
274 genpd_xlate_t xlate, void *data)
278 static inline void of_genpd_del_provider(struct device_node *np) {}
280 static inline struct generic_pm_domain *of_genpd_get_from_provider(
281 struct of_phandle_args *genpdspec)
286 #define __of_genpd_xlate_simple NULL
287 #define __of_genpd_xlate_onecell NULL
289 static inline int genpd_dev_pm_attach(struct device *dev)
293 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
295 static inline int of_genpd_add_provider_simple(struct device_node *np,
296 struct generic_pm_domain *genpd)
298 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
300 static inline int of_genpd_add_provider_onecell(struct device_node *np,
301 struct genpd_onecell_data *data)
303 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
307 extern int dev_pm_domain_attach(struct device *dev, bool power_on);
308 extern void dev_pm_domain_detach(struct device *dev, bool power_off);
310 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
314 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
317 #endif /* _LINUX_PM_DOMAIN_H */