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/spinlock.h>
21 * Flags to control the behaviour of a genpd.
23 * These flags may be set in the struct generic_pm_domain's flags field by a
24 * genpd backend driver. The flags must be set before it calls pm_genpd_init(),
25 * which initializes a genpd.
27 * GENPD_FLAG_PM_CLK: Instructs genpd to use the PM clk framework,
28 * while powering on/off attached devices.
30 * GENPD_FLAG_IRQ_SAFE: This informs genpd that its backend callbacks,
31 * ->power_on|off(), doesn't sleep. Hence, these
32 * can be invoked from within atomic context, which
33 * enables genpd to power on/off the PM domain,
34 * even when pm_runtime_is_irq_safe() returns true,
35 * for any of its attached devices. Note that, a
36 * genpd having this flag set, requires its
37 * masterdomains to also have it set.
39 * GENPD_FLAG_ALWAYS_ON: Instructs genpd to always keep the PM domain
42 * GENPD_FLAG_ACTIVE_WAKEUP: Instructs genpd to keep the PM domain powered
43 * on, in case any of its attached devices is used
44 * in the wakeup path to serve system wakeups.
46 #define GENPD_FLAG_PM_CLK (1U << 0)
47 #define GENPD_FLAG_IRQ_SAFE (1U << 1)
48 #define GENPD_FLAG_ALWAYS_ON (1U << 2)
49 #define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3)
52 GPD_STATE_ACTIVE = 0, /* PM domain is active */
53 GPD_STATE_POWER_OFF, /* PM domain is off */
56 struct dev_power_governor {
57 bool (*power_down_ok)(struct dev_pm_domain *domain);
58 bool (*suspend_ok)(struct device *dev);
62 int (*start)(struct device *dev);
63 int (*stop)(struct device *dev);
66 struct genpd_power_state {
67 s64 power_off_latency_ns;
68 s64 power_on_latency_ns;
70 struct fwnode_handle *fwnode;
74 struct genpd_lock_ops;
78 struct generic_pm_domain {
80 struct dev_pm_domain domain; /* PM domain operations */
81 struct list_head gpd_list_node; /* Node in the global PM domains list */
82 struct list_head master_links; /* Links with PM domain as a master */
83 struct list_head slave_links; /* Links with PM domain as a slave */
84 struct list_head dev_list; /* List of devices */
85 struct dev_power_governor *gov;
86 struct work_struct power_off_work;
87 struct fwnode_handle *provider; /* Identity of the domain provider */
90 atomic_t sd_count; /* Number of subdomains with power "on" */
91 enum gpd_status status; /* Current state of the domain */
92 unsigned int device_count; /* Number of devices */
93 unsigned int suspended_count; /* System suspend device counter */
94 unsigned int prepared_count; /* Suspend counter of prepared devices */
95 unsigned int performance_state; /* Aggregated max performance state */
96 int (*power_off)(struct generic_pm_domain *domain);
97 int (*power_on)(struct generic_pm_domain *domain);
98 struct opp_table *opp_table; /* OPP table of the genpd */
99 unsigned int (*opp_to_performance_state)(struct generic_pm_domain *genpd,
100 struct dev_pm_opp *opp);
101 int (*set_performance_state)(struct generic_pm_domain *genpd,
103 struct gpd_dev_ops dev_ops;
104 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
105 bool max_off_time_changed;
106 bool cached_power_down_ok;
107 int (*attach_dev)(struct generic_pm_domain *domain,
109 void (*detach_dev)(struct generic_pm_domain *domain,
111 unsigned int flags; /* Bit field of configs for genpd */
112 struct genpd_power_state *states;
113 unsigned int state_count; /* number of states */
114 unsigned int state_idx; /* state that genpd will go to when off */
115 void *free; /* Free the state that was allocated for default */
117 ktime_t accounting_time;
118 const struct genpd_lock_ops *lock_ops;
123 unsigned long lock_flags;
129 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
131 return container_of(pd, struct generic_pm_domain, domain);
135 struct generic_pm_domain *master;
136 struct list_head master_node;
137 struct generic_pm_domain *slave;
138 struct list_head slave_node;
140 /* Sub-domain's per-master domain performance state */
141 unsigned int performance_state;
142 unsigned int prev_performance_state;
145 struct gpd_timing_data {
146 s64 suspend_latency_ns;
147 s64 resume_latency_ns;
148 s64 effective_constraint_ns;
149 bool constraint_changed;
150 bool cached_suspend_ok;
153 struct pm_domain_data {
154 struct list_head list_node;
158 struct generic_pm_domain_data {
159 struct pm_domain_data base;
160 struct gpd_timing_data td;
161 struct notifier_block nb;
162 unsigned int performance_state;
166 #ifdef CONFIG_PM_GENERIC_DOMAINS
167 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
169 return container_of(pdd, struct generic_pm_domain_data, base);
172 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
174 return to_gpd_data(dev->power.subsys_data->domain_data);
177 int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev);
178 int pm_genpd_remove_device(struct device *dev);
179 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
180 struct generic_pm_domain *new_subdomain);
181 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
182 struct generic_pm_domain *target);
183 int pm_genpd_init(struct generic_pm_domain *genpd,
184 struct dev_power_governor *gov, bool is_off);
185 int pm_genpd_remove(struct generic_pm_domain *genpd);
186 int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state);
188 extern struct dev_power_governor simple_qos_governor;
189 extern struct dev_power_governor pm_domain_always_on_gov;
192 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
194 return ERR_PTR(-ENOSYS);
196 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
201 static inline int pm_genpd_remove_device(struct device *dev)
205 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
206 struct generic_pm_domain *new_sd)
210 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
211 struct generic_pm_domain *target)
215 static inline int pm_genpd_init(struct generic_pm_domain *genpd,
216 struct dev_power_governor *gov, bool is_off)
220 static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
225 static inline int dev_pm_genpd_set_performance_state(struct device *dev,
231 #define simple_qos_governor (*(struct dev_power_governor *)(NULL))
232 #define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL))
235 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
236 void pm_genpd_syscore_poweroff(struct device *dev);
237 void pm_genpd_syscore_poweron(struct device *dev);
239 static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
240 static inline void pm_genpd_syscore_poweron(struct device *dev) {}
243 /* OF PM domain providers */
246 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
249 struct genpd_onecell_data {
250 struct generic_pm_domain **domains;
251 unsigned int num_domains;
255 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
256 int of_genpd_add_provider_simple(struct device_node *np,
257 struct generic_pm_domain *genpd);
258 int of_genpd_add_provider_onecell(struct device_node *np,
259 struct genpd_onecell_data *data);
260 void of_genpd_del_provider(struct device_node *np);
261 int of_genpd_add_device(struct of_phandle_args *args, struct device *dev);
262 int of_genpd_add_subdomain(struct of_phandle_args *parent,
263 struct of_phandle_args *new_subdomain);
264 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
265 int of_genpd_parse_idle_states(struct device_node *dn,
266 struct genpd_power_state **states, int *n);
267 unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
268 struct dev_pm_opp *opp);
270 int genpd_dev_pm_attach(struct device *dev);
271 struct device *genpd_dev_pm_attach_by_id(struct device *dev,
273 struct device *genpd_dev_pm_attach_by_name(struct device *dev,
275 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
276 static inline int of_genpd_add_provider_simple(struct device_node *np,
277 struct generic_pm_domain *genpd)
282 static inline int of_genpd_add_provider_onecell(struct device_node *np,
283 struct genpd_onecell_data *data)
288 static inline void of_genpd_del_provider(struct device_node *np) {}
290 static inline int of_genpd_add_device(struct of_phandle_args *args,
296 static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
297 struct of_phandle_args *new_subdomain)
302 static inline int of_genpd_parse_idle_states(struct device_node *dn,
303 struct genpd_power_state **states, int *n)
308 static inline unsigned int
309 pm_genpd_opp_to_performance_state(struct device *genpd_dev,
310 struct dev_pm_opp *opp)
315 static inline int genpd_dev_pm_attach(struct device *dev)
320 static inline struct device *genpd_dev_pm_attach_by_id(struct device *dev,
326 static inline struct device *genpd_dev_pm_attach_by_name(struct device *dev,
333 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
335 return ERR_PTR(-ENOTSUPP);
337 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
340 int dev_pm_domain_attach(struct device *dev, bool power_on);
341 struct device *dev_pm_domain_attach_by_id(struct device *dev,
343 struct device *dev_pm_domain_attach_by_name(struct device *dev,
345 void dev_pm_domain_detach(struct device *dev, bool power_off);
346 void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
348 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
352 static inline struct device *dev_pm_domain_attach_by_id(struct device *dev,
357 static inline struct device *dev_pm_domain_attach_by_name(struct device *dev,
362 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
363 static inline void dev_pm_domain_set(struct device *dev,
364 struct dev_pm_domain *pd) {}
367 #endif /* _LINUX_PM_DOMAIN_H */