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/err.h>
17 GPD_STATE_ACTIVE = 0, /* PM domain is active */
18 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
19 GPD_STATE_BUSY, /* Something is happening to the PM domain */
20 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
21 GPD_STATE_POWER_OFF, /* PM domain is off */
24 struct dev_power_governor {
25 bool (*power_down_ok)(struct dev_pm_domain *domain);
26 bool (*stop_ok)(struct device *dev);
30 int (*start)(struct device *dev);
31 int (*stop)(struct device *dev);
32 int (*save_state)(struct device *dev);
33 int (*restore_state)(struct device *dev);
34 int (*suspend)(struct device *dev);
35 int (*suspend_late)(struct device *dev);
36 int (*resume_early)(struct device *dev);
37 int (*resume)(struct device *dev);
38 int (*freeze)(struct device *dev);
39 int (*freeze_late)(struct device *dev);
40 int (*thaw_early)(struct device *dev);
41 int (*thaw)(struct device *dev);
42 bool (*active_wakeup)(struct device *dev);
45 struct generic_pm_domain {
46 struct dev_pm_domain domain; /* PM domain operations */
47 struct list_head gpd_list_node; /* Node in the global PM domains list */
48 struct list_head master_links; /* Links with PM domain as a master */
49 struct list_head slave_links; /* Links with PM domain as a slave */
50 struct list_head dev_list; /* List of devices */
52 struct dev_power_governor *gov;
53 struct work_struct power_off_work;
55 unsigned int in_progress; /* Number of devices being suspended now */
56 atomic_t sd_count; /* Number of subdomains with power "on" */
57 enum gpd_status status; /* Current state of the domain */
58 wait_queue_head_t status_wait_queue;
59 struct task_struct *poweroff_task; /* Powering off task */
60 unsigned int resume_count; /* Number of devices being resumed */
61 unsigned int device_count; /* Number of devices */
62 unsigned int suspended_count; /* System suspend device counter */
63 unsigned int prepared_count; /* Suspend counter of prepared devices */
64 bool suspend_power_off; /* Power status before system suspend */
65 bool dev_irq_safe; /* Device callbacks are IRQ-safe */
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 break_even_ns; /* Power break even for the entire domain. */
72 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
73 ktime_t power_off_time;
74 struct device_node *of_node; /* Node in device tree */
77 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
79 return container_of(pd, struct generic_pm_domain, domain);
83 struct generic_pm_domain *master;
84 struct list_head master_node;
85 struct generic_pm_domain *slave;
86 struct list_head slave_node;
89 struct gpd_timing_data {
92 s64 save_state_latency_ns;
93 s64 restore_state_latency_ns;
97 struct generic_pm_domain_data {
98 struct pm_domain_data base;
99 struct gpd_dev_ops ops;
100 struct gpd_timing_data td;
105 #ifdef CONFIG_PM_GENERIC_DOMAINS
106 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
108 return container_of(pdd, struct generic_pm_domain_data, base);
111 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
113 return to_gpd_data(dev->power.subsys_data->domain_data);
116 extern struct dev_power_governor simple_qos_governor;
118 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
119 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
121 struct gpd_timing_data *td);
123 extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
125 struct gpd_timing_data *td);
127 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
130 return __pm_genpd_add_device(genpd, dev, NULL);
133 static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
136 return __pm_genpd_of_add_device(genpd_node, dev, NULL);
139 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
141 extern void pm_genpd_dev_always_on(struct device *dev, bool val);
142 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
143 struct generic_pm_domain *new_subdomain);
144 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
145 struct generic_pm_domain *target);
146 extern int pm_genpd_add_callbacks(struct device *dev,
147 struct gpd_dev_ops *ops,
148 struct gpd_timing_data *td);
149 extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
150 extern void pm_genpd_init(struct generic_pm_domain *genpd,
151 struct dev_power_governor *gov, bool is_off);
153 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
155 extern bool default_stop_ok(struct device *dev);
157 extern struct dev_power_governor pm_domain_always_on_gov;
160 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
162 return ERR_PTR(-ENOSYS);
164 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
166 return ERR_PTR(-ENOSYS);
168 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
170 struct gpd_timing_data *td)
174 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
179 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
184 static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {}
185 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
186 struct generic_pm_domain *new_sd)
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_add_callbacks(struct device *dev,
196 struct gpd_dev_ops *ops,
197 struct gpd_timing_data *td)
201 static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
205 static inline void pm_genpd_init(struct generic_pm_domain *genpd,
206 struct dev_power_governor *gov, bool is_off)
209 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
213 static inline bool default_stop_ok(struct device *dev)
217 #define simple_qos_governor NULL
218 #define pm_domain_always_on_gov NULL
221 static inline int pm_genpd_remove_callbacks(struct device *dev)
223 return __pm_genpd_remove_callbacks(dev, true);
226 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
227 extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
228 extern void pm_genpd_poweroff_unused(void);
230 static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
231 static inline void pm_genpd_poweroff_unused(void) {}
234 #endif /* _LINUX_PM_DOMAIN_H */