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 int (*suspend
)(struct device
*dev
);
39 int (*suspend_late
)(struct device
*dev
);
40 int (*resume_early
)(struct device
*dev
);
41 int (*resume
)(struct device
*dev
);
42 int (*freeze
)(struct device
*dev
);
43 int (*freeze_late
)(struct device
*dev
);
44 int (*thaw_early
)(struct device
*dev
);
45 int (*thaw
)(struct device
*dev
);
46 bool (*active_wakeup
)(struct device
*dev
);
50 unsigned int saved_exit_latency
;
51 struct cpuidle_state
*idle_state
;
54 struct generic_pm_domain
{
55 struct dev_pm_domain domain
; /* PM domain operations */
56 struct list_head gpd_list_node
; /* Node in the global PM domains list */
57 struct list_head master_links
; /* Links with PM domain as a master */
58 struct list_head slave_links
; /* Links with PM domain as a slave */
59 struct list_head dev_list
; /* List of devices */
61 struct dev_power_governor
*gov
;
62 struct work_struct power_off_work
;
64 unsigned int in_progress
; /* Number of devices being suspended now */
65 atomic_t sd_count
; /* Number of subdomains with power "on" */
66 enum gpd_status status
; /* Current state of the domain */
67 wait_queue_head_t status_wait_queue
;
68 struct task_struct
*poweroff_task
; /* Powering off task */
69 unsigned int resume_count
; /* Number of devices being resumed */
70 unsigned int device_count
; /* Number of devices */
71 unsigned int suspended_count
; /* System suspend device counter */
72 unsigned int prepared_count
; /* Suspend counter of prepared devices */
73 bool suspend_power_off
; /* Power status before system suspend */
74 bool dev_irq_safe
; /* Device callbacks are IRQ-safe */
75 int (*power_off
)(struct generic_pm_domain
*domain
);
76 s64 power_off_latency_ns
;
77 int (*power_on
)(struct generic_pm_domain
*domain
);
78 s64 power_on_latency_ns
;
79 struct gpd_dev_ops dev_ops
;
80 s64 max_off_time_ns
; /* Maximum allowed "suspended" time. */
81 bool max_off_time_changed
;
82 bool cached_power_down_ok
;
83 struct device_node
*of_node
; /* Node in device tree */
84 struct gpd_cpu_data
*cpu_data
;
87 static inline struct generic_pm_domain
*pd_to_genpd(struct dev_pm_domain
*pd
)
89 return container_of(pd
, struct generic_pm_domain
, domain
);
93 struct generic_pm_domain
*master
;
94 struct list_head master_node
;
95 struct generic_pm_domain
*slave
;
96 struct list_head slave_node
;
99 struct gpd_timing_data
{
101 s64 start_latency_ns
;
102 s64 save_state_latency_ns
;
103 s64 restore_state_latency_ns
;
104 s64 effective_constraint_ns
;
105 bool constraint_changed
;
109 struct generic_pm_domain_data
{
110 struct pm_domain_data base
;
111 struct gpd_dev_ops ops
;
112 struct gpd_timing_data td
;
113 struct notifier_block nb
;
115 unsigned int refcount
;
119 #ifdef CONFIG_PM_GENERIC_DOMAINS
120 static inline struct generic_pm_domain_data
*to_gpd_data(struct pm_domain_data
*pdd
)
122 return container_of(pdd
, struct generic_pm_domain_data
, base
);
125 static inline struct generic_pm_domain_data
*dev_gpd_data(struct device
*dev
)
127 return to_gpd_data(dev
->power
.subsys_data
->domain_data
);
130 extern struct dev_power_governor simple_qos_governor
;
132 extern struct generic_pm_domain
*dev_to_genpd(struct device
*dev
);
133 extern int __pm_genpd_add_device(struct generic_pm_domain
*genpd
,
135 struct gpd_timing_data
*td
);
137 extern int __pm_genpd_of_add_device(struct device_node
*genpd_node
,
139 struct gpd_timing_data
*td
);
141 extern int __pm_genpd_name_add_device(const char *domain_name
,
143 struct gpd_timing_data
*td
);
145 extern int pm_genpd_remove_device(struct generic_pm_domain
*genpd
,
147 extern void pm_genpd_dev_need_restore(struct device
*dev
, bool val
);
148 extern int pm_genpd_add_subdomain(struct generic_pm_domain
*genpd
,
149 struct generic_pm_domain
*new_subdomain
);
150 extern int pm_genpd_add_subdomain_names(const char *master_name
,
151 const char *subdomain_name
);
152 extern int pm_genpd_remove_subdomain(struct generic_pm_domain
*genpd
,
153 struct generic_pm_domain
*target
);
154 extern int pm_genpd_add_callbacks(struct device
*dev
,
155 struct gpd_dev_ops
*ops
,
156 struct gpd_timing_data
*td
);
157 extern int __pm_genpd_remove_callbacks(struct device
*dev
, bool clear_td
);
158 extern int pm_genpd_attach_cpuidle(struct generic_pm_domain
*genpd
, int state
);
159 extern int pm_genpd_name_attach_cpuidle(const char *name
, int state
);
160 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain
*genpd
);
161 extern int pm_genpd_name_detach_cpuidle(const char *name
);
162 extern void pm_genpd_init(struct generic_pm_domain
*genpd
,
163 struct dev_power_governor
*gov
, bool is_off
);
165 extern int pm_genpd_poweron(struct generic_pm_domain
*genpd
);
166 extern int pm_genpd_name_poweron(const char *domain_name
);
168 extern bool default_stop_ok(struct device
*dev
);
170 extern struct dev_power_governor pm_domain_always_on_gov
;
173 static inline struct generic_pm_domain_data
*dev_gpd_data(struct device
*dev
)
175 return ERR_PTR(-ENOSYS
);
177 static inline struct generic_pm_domain
*dev_to_genpd(struct device
*dev
)
179 return ERR_PTR(-ENOSYS
);
181 static inline int __pm_genpd_add_device(struct generic_pm_domain
*genpd
,
183 struct gpd_timing_data
*td
)
187 static inline int __pm_genpd_of_add_device(struct device_node
*genpd_node
,
189 struct gpd_timing_data
*td
)
193 static inline int __pm_genpd_name_add_device(const char *domain_name
,
195 struct gpd_timing_data
*td
)
199 static inline int pm_genpd_remove_device(struct generic_pm_domain
*genpd
,
204 static inline void pm_genpd_dev_need_restore(struct device
*dev
, bool val
) {}
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_add_subdomain_names(const char *master_name
,
211 const char *subdomain_name
)
215 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain
*genpd
,
216 struct generic_pm_domain
*target
)
220 static inline int pm_genpd_add_callbacks(struct device
*dev
,
221 struct gpd_dev_ops
*ops
,
222 struct gpd_timing_data
*td
)
226 static inline int __pm_genpd_remove_callbacks(struct device
*dev
, bool clear_td
)
230 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain
*genpd
, int st
)
234 static inline int pm_genpd_name_attach_cpuidle(const char *name
, int state
)
238 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain
*genpd
)
242 static inline int pm_genpd_name_detach_cpuidle(const char *name
)
246 static inline void pm_genpd_init(struct generic_pm_domain
*genpd
,
247 struct dev_power_governor
*gov
, bool is_off
)
250 static inline int pm_genpd_poweron(struct generic_pm_domain
*genpd
)
254 static inline int pm_genpd_name_poweron(const char *domain_name
)
258 static inline bool default_stop_ok(struct device
*dev
)
262 #define simple_qos_governor NULL
263 #define pm_domain_always_on_gov NULL
266 static inline int pm_genpd_add_device(struct generic_pm_domain
*genpd
,
269 return __pm_genpd_add_device(genpd
, dev
, NULL
);
272 static inline int pm_genpd_of_add_device(struct device_node
*genpd_node
,
275 return __pm_genpd_of_add_device(genpd_node
, dev
, NULL
);
278 static inline int pm_genpd_name_add_device(const char *domain_name
,
281 return __pm_genpd_name_add_device(domain_name
, dev
, NULL
);
284 static inline int pm_genpd_remove_callbacks(struct device
*dev
)
286 return __pm_genpd_remove_callbacks(dev
, true);
289 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
290 extern void genpd_queue_power_off_work(struct generic_pm_domain
*genpd
);
291 extern void pm_genpd_poweroff_unused(void);
293 static inline void genpd_queue_power_off_work(struct generic_pm_domain
*gpd
) {}
294 static inline void pm_genpd_poweroff_unused(void) {}
297 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
298 extern void pm_genpd_syscore_switch(struct device
*dev
, bool suspend
);
300 static inline void pm_genpd_syscore_switch(struct device
*dev
, bool suspend
) {}
303 static inline void pm_genpd_syscore_poweroff(struct device
*dev
)
305 pm_genpd_syscore_switch(dev
, true);
308 static inline void pm_genpd_syscore_poweron(struct device
*dev
)
310 pm_genpd_syscore_switch(dev
, false);
313 #endif /* _LINUX_PM_DOMAIN_H */