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_WAIT_MASTER
, /* PM domain's master is being waited for */
26 GPD_STATE_BUSY
, /* Something is happening to the PM domain */
27 GPD_STATE_REPEAT
, /* Power off in progress, to be repeated */
28 GPD_STATE_POWER_OFF
, /* PM domain is off */
31 struct dev_power_governor
{
32 bool (*power_down_ok
)(struct dev_pm_domain
*domain
);
33 bool (*stop_ok
)(struct device
*dev
);
37 int (*start
)(struct device
*dev
);
38 int (*stop
)(struct device
*dev
);
39 int (*save_state
)(struct device
*dev
);
40 int (*restore_state
)(struct device
*dev
);
41 bool (*active_wakeup
)(struct device
*dev
);
44 struct gpd_cpuidle_data
{
45 unsigned int saved_exit_latency
;
46 struct cpuidle_state
*idle_state
;
49 struct generic_pm_domain
{
50 struct dev_pm_domain domain
; /* PM domain operations */
51 struct list_head gpd_list_node
; /* Node in the global PM domains list */
52 struct list_head master_links
; /* Links with PM domain as a master */
53 struct list_head slave_links
; /* Links with PM domain as a slave */
54 struct list_head dev_list
; /* List of devices */
56 struct dev_power_governor
*gov
;
57 struct work_struct power_off_work
;
59 unsigned int in_progress
; /* Number of devices being suspended now */
60 atomic_t sd_count
; /* Number of subdomains with power "on" */
61 enum gpd_status status
; /* Current state of the domain */
62 wait_queue_head_t status_wait_queue
;
63 struct task_struct
*poweroff_task
; /* Powering off task */
64 unsigned int resume_count
; /* Number of devices being resumed */
65 unsigned int device_count
; /* Number of devices */
66 unsigned int suspended_count
; /* System suspend device counter */
67 unsigned int prepared_count
; /* Suspend counter of prepared devices */
68 bool suspend_power_off
; /* Power status before system suspend */
69 int (*power_off
)(struct generic_pm_domain
*domain
);
70 s64 power_off_latency_ns
;
71 int (*power_on
)(struct generic_pm_domain
*domain
);
72 s64 power_on_latency_ns
;
73 struct gpd_dev_ops dev_ops
;
74 s64 max_off_time_ns
; /* Maximum allowed "suspended" time. */
75 bool max_off_time_changed
;
76 bool cached_power_down_ok
;
77 struct gpd_cpuidle_data
*cpuidle_data
;
78 int (*attach_dev
)(struct generic_pm_domain
*domain
,
80 void (*detach_dev
)(struct generic_pm_domain
*domain
,
82 unsigned int flags
; /* Bit field of configs for genpd */
85 static inline struct generic_pm_domain
*pd_to_genpd(struct dev_pm_domain
*pd
)
87 return container_of(pd
, struct generic_pm_domain
, domain
);
91 struct generic_pm_domain
*master
;
92 struct list_head master_node
;
93 struct generic_pm_domain
*slave
;
94 struct list_head slave_node
;
97 struct gpd_timing_data
{
100 s64 save_state_latency_ns
;
101 s64 restore_state_latency_ns
;
102 s64 effective_constraint_ns
;
103 bool constraint_changed
;
107 struct pm_domain_data
{
108 struct list_head list_node
;
112 struct generic_pm_domain_data
{
113 struct pm_domain_data base
;
114 struct gpd_timing_data td
;
115 struct notifier_block nb
;
117 unsigned int refcount
;
121 #ifdef CONFIG_PM_GENERIC_DOMAINS
122 static inline struct generic_pm_domain_data
*to_gpd_data(struct pm_domain_data
*pdd
)
124 return container_of(pdd
, struct generic_pm_domain_data
, base
);
127 static inline struct generic_pm_domain_data
*dev_gpd_data(struct device
*dev
)
129 return to_gpd_data(dev
->power
.subsys_data
->domain_data
);
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_name_add_device(const char *domain_name
,
139 struct gpd_timing_data
*td
);
141 extern int pm_genpd_remove_device(struct generic_pm_domain
*genpd
,
143 extern void pm_genpd_dev_need_restore(struct device
*dev
, bool val
);
144 extern int pm_genpd_add_subdomain(struct generic_pm_domain
*genpd
,
145 struct generic_pm_domain
*new_subdomain
);
146 extern int pm_genpd_add_subdomain_names(const char *master_name
,
147 const char *subdomain_name
);
148 extern int pm_genpd_remove_subdomain(struct generic_pm_domain
*genpd
,
149 struct generic_pm_domain
*target
);
150 extern int pm_genpd_attach_cpuidle(struct generic_pm_domain
*genpd
, int state
);
151 extern int pm_genpd_name_attach_cpuidle(const char *name
, int state
);
152 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain
*genpd
);
153 extern int pm_genpd_name_detach_cpuidle(const char *name
);
154 extern void pm_genpd_init(struct generic_pm_domain
*genpd
,
155 struct dev_power_governor
*gov
, bool is_off
);
157 extern int pm_genpd_poweron(struct generic_pm_domain
*genpd
);
158 extern int pm_genpd_name_poweron(const char *domain_name
);
159 extern void pm_genpd_poweroff_unused(void);
161 extern struct dev_power_governor simple_qos_governor
;
162 extern struct dev_power_governor pm_domain_always_on_gov
;
165 static inline struct generic_pm_domain_data
*dev_gpd_data(struct device
*dev
)
167 return ERR_PTR(-ENOSYS
);
169 static inline struct generic_pm_domain
*dev_to_genpd(struct device
*dev
)
171 return ERR_PTR(-ENOSYS
);
173 static inline int __pm_genpd_add_device(struct generic_pm_domain
*genpd
,
175 struct gpd_timing_data
*td
)
179 static inline int __pm_genpd_name_add_device(const char *domain_name
,
181 struct gpd_timing_data
*td
)
185 static inline int pm_genpd_remove_device(struct generic_pm_domain
*genpd
,
190 static inline void pm_genpd_dev_need_restore(struct device
*dev
, bool val
) {}
191 static inline int pm_genpd_add_subdomain(struct generic_pm_domain
*genpd
,
192 struct generic_pm_domain
*new_sd
)
196 static inline int pm_genpd_add_subdomain_names(const char *master_name
,
197 const char *subdomain_name
)
201 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain
*genpd
,
202 struct generic_pm_domain
*target
)
206 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain
*genpd
, int st
)
210 static inline int pm_genpd_name_attach_cpuidle(const char *name
, int state
)
214 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain
*genpd
)
218 static inline int pm_genpd_name_detach_cpuidle(const char *name
)
222 static inline void pm_genpd_init(struct generic_pm_domain
*genpd
,
223 struct dev_power_governor
*gov
, bool is_off
)
226 static inline int pm_genpd_poweron(struct generic_pm_domain
*genpd
)
230 static inline int pm_genpd_name_poweron(const char *domain_name
)
234 static inline void pm_genpd_poweroff_unused(void) {}
235 #define simple_qos_governor NULL
236 #define pm_domain_always_on_gov NULL
239 static inline int pm_genpd_add_device(struct generic_pm_domain
*genpd
,
242 return __pm_genpd_add_device(genpd
, dev
, NULL
);
245 static inline int pm_genpd_name_add_device(const char *domain_name
,
248 return __pm_genpd_name_add_device(domain_name
, dev
, NULL
);
251 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
252 extern void pm_genpd_syscore_poweroff(struct device
*dev
);
253 extern void pm_genpd_syscore_poweron(struct device
*dev
);
255 static inline void pm_genpd_syscore_poweroff(struct device
*dev
) {}
256 static inline void pm_genpd_syscore_poweron(struct device
*dev
) {}
259 /* OF PM domain providers */
262 struct genpd_onecell_data
{
263 struct generic_pm_domain
**domains
;
264 unsigned int num_domains
;
267 typedef struct generic_pm_domain
*(*genpd_xlate_t
)(struct of_phandle_args
*args
,
270 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
271 int __of_genpd_add_provider(struct device_node
*np
, genpd_xlate_t xlate
,
273 void of_genpd_del_provider(struct device_node
*np
);
274 struct generic_pm_domain
*of_genpd_get_from_provider(
275 struct of_phandle_args
*genpdspec
);
277 struct generic_pm_domain
*__of_genpd_xlate_simple(
278 struct of_phandle_args
*genpdspec
,
280 struct generic_pm_domain
*__of_genpd_xlate_onecell(
281 struct of_phandle_args
*genpdspec
,
284 int genpd_dev_pm_attach(struct device
*dev
);
285 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
286 static inline int __of_genpd_add_provider(struct device_node
*np
,
287 genpd_xlate_t xlate
, void *data
)
291 static inline void of_genpd_del_provider(struct device_node
*np
) {}
293 static inline struct generic_pm_domain
*of_genpd_get_from_provider(
294 struct of_phandle_args
*genpdspec
)
299 #define __of_genpd_xlate_simple NULL
300 #define __of_genpd_xlate_onecell NULL
302 static inline int genpd_dev_pm_attach(struct device
*dev
)
306 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
308 static inline int of_genpd_add_provider_simple(struct device_node
*np
,
309 struct generic_pm_domain
*genpd
)
311 return __of_genpd_add_provider(np
, __of_genpd_xlate_simple
, genpd
);
313 static inline int of_genpd_add_provider_onecell(struct device_node
*np
,
314 struct genpd_onecell_data
*data
)
316 return __of_genpd_add_provider(np
, __of_genpd_xlate_onecell
, data
);
320 extern int dev_pm_domain_attach(struct device
*dev
, bool power_on
);
321 extern void dev_pm_domain_detach(struct device
*dev
, bool power_off
);
323 static inline int dev_pm_domain_attach(struct device
*dev
, bool power_on
)
327 static inline void dev_pm_domain_detach(struct device
*dev
, bool power_off
) {}
330 #endif /* _LINUX_PM_DOMAIN_H */