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>
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 */
22 #define GENPD_FLAG_IRQ_SAFE (1U << 1) /* PM domain operates in atomic */
23 #define GENPD_FLAG_ALWAYS_ON (1U << 2) /* PM domain is always powered on */
26 GPD_STATE_ACTIVE
= 0, /* PM domain is active */
27 GPD_STATE_POWER_OFF
, /* PM domain is off */
30 struct dev_power_governor
{
31 bool (*power_down_ok
)(struct dev_pm_domain
*domain
);
32 bool (*suspend_ok
)(struct device
*dev
);
36 int (*start
)(struct device
*dev
);
37 int (*stop
)(struct device
*dev
);
38 bool (*active_wakeup
)(struct device
*dev
);
41 struct genpd_power_state
{
42 s64 power_off_latency_ns
;
43 s64 power_on_latency_ns
;
45 struct fwnode_handle
*fwnode
;
49 struct genpd_lock_ops
;
51 struct generic_pm_domain
{
52 struct dev_pm_domain domain
; /* PM domain operations */
53 struct list_head gpd_list_node
; /* Node in the global PM domains list */
54 struct list_head master_links
; /* Links with PM domain as a master */
55 struct list_head slave_links
; /* Links with PM domain as a slave */
56 struct list_head dev_list
; /* List of devices */
57 struct dev_power_governor
*gov
;
58 struct work_struct power_off_work
;
59 struct fwnode_handle
*provider
; /* Identity of the domain provider */
62 atomic_t sd_count
; /* Number of subdomains with power "on" */
63 enum gpd_status status
; /* Current state of the domain */
64 unsigned int device_count
; /* Number of devices */
65 unsigned int suspended_count
; /* System suspend device counter */
66 unsigned int prepared_count
; /* Suspend counter of prepared devices */
67 int (*power_off
)(struct generic_pm_domain
*domain
);
68 int (*power_on
)(struct generic_pm_domain
*domain
);
69 struct gpd_dev_ops dev_ops
;
70 s64 max_off_time_ns
; /* Maximum allowed "suspended" time. */
71 bool max_off_time_changed
;
72 bool cached_power_down_ok
;
73 int (*attach_dev
)(struct generic_pm_domain
*domain
,
75 void (*detach_dev
)(struct generic_pm_domain
*domain
,
77 unsigned int flags
; /* Bit field of configs for genpd */
78 struct genpd_power_state
*states
;
79 unsigned int state_count
; /* number of states */
80 unsigned int state_idx
; /* state that genpd will go to when off */
81 void *free
; /* Free the state that was allocated for default */
83 ktime_t accounting_time
;
84 const struct genpd_lock_ops
*lock_ops
;
89 unsigned long lock_flags
;
95 static inline struct generic_pm_domain
*pd_to_genpd(struct dev_pm_domain
*pd
)
97 return container_of(pd
, struct generic_pm_domain
, domain
);
101 struct generic_pm_domain
*master
;
102 struct list_head master_node
;
103 struct generic_pm_domain
*slave
;
104 struct list_head slave_node
;
107 struct gpd_timing_data
{
108 s64 suspend_latency_ns
;
109 s64 resume_latency_ns
;
110 s64 effective_constraint_ns
;
111 bool constraint_changed
;
112 bool cached_suspend_ok
;
115 struct pm_domain_data
{
116 struct list_head list_node
;
120 struct generic_pm_domain_data
{
121 struct pm_domain_data base
;
122 struct gpd_timing_data td
;
123 struct notifier_block nb
;
127 #ifdef CONFIG_PM_GENERIC_DOMAINS
128 static inline struct generic_pm_domain_data
*to_gpd_data(struct pm_domain_data
*pdd
)
130 return container_of(pdd
, struct generic_pm_domain_data
, base
);
133 static inline struct generic_pm_domain_data
*dev_gpd_data(struct device
*dev
)
135 return to_gpd_data(dev
->power
.subsys_data
->domain_data
);
138 extern int __pm_genpd_add_device(struct generic_pm_domain
*genpd
,
140 struct gpd_timing_data
*td
);
142 extern int pm_genpd_remove_device(struct generic_pm_domain
*genpd
,
144 extern int pm_genpd_add_subdomain(struct generic_pm_domain
*genpd
,
145 struct generic_pm_domain
*new_subdomain
);
146 extern int pm_genpd_remove_subdomain(struct generic_pm_domain
*genpd
,
147 struct generic_pm_domain
*target
);
148 extern int pm_genpd_init(struct generic_pm_domain
*genpd
,
149 struct dev_power_governor
*gov
, bool is_off
);
150 extern int pm_genpd_remove(struct generic_pm_domain
*genpd
);
152 extern struct dev_power_governor simple_qos_governor
;
153 extern struct dev_power_governor pm_domain_always_on_gov
;
156 static inline struct generic_pm_domain_data
*dev_gpd_data(struct device
*dev
)
158 return ERR_PTR(-ENOSYS
);
160 static inline int __pm_genpd_add_device(struct generic_pm_domain
*genpd
,
162 struct gpd_timing_data
*td
)
166 static inline int pm_genpd_remove_device(struct generic_pm_domain
*genpd
,
171 static inline int pm_genpd_add_subdomain(struct generic_pm_domain
*genpd
,
172 struct generic_pm_domain
*new_sd
)
176 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain
*genpd
,
177 struct generic_pm_domain
*target
)
181 static inline int pm_genpd_init(struct generic_pm_domain
*genpd
,
182 struct dev_power_governor
*gov
, bool is_off
)
186 static inline int pm_genpd_remove(struct generic_pm_domain
*genpd
)
191 #define simple_qos_governor (*(struct dev_power_governor *)(NULL))
192 #define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL))
195 static inline int pm_genpd_add_device(struct generic_pm_domain
*genpd
,
198 return __pm_genpd_add_device(genpd
, dev
, NULL
);
201 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
202 extern void pm_genpd_syscore_poweroff(struct device
*dev
);
203 extern void pm_genpd_syscore_poweron(struct device
*dev
);
205 static inline void pm_genpd_syscore_poweroff(struct device
*dev
) {}
206 static inline void pm_genpd_syscore_poweron(struct device
*dev
) {}
209 /* OF PM domain providers */
212 typedef struct generic_pm_domain
*(*genpd_xlate_t
)(struct of_phandle_args
*args
,
215 struct genpd_onecell_data
{
216 struct generic_pm_domain
**domains
;
217 unsigned int num_domains
;
221 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
222 int of_genpd_add_provider_simple(struct device_node
*np
,
223 struct generic_pm_domain
*genpd
);
224 int of_genpd_add_provider_onecell(struct device_node
*np
,
225 struct genpd_onecell_data
*data
);
226 void of_genpd_del_provider(struct device_node
*np
);
227 extern int of_genpd_add_device(struct of_phandle_args
*args
,
229 extern int of_genpd_add_subdomain(struct of_phandle_args
*parent
,
230 struct of_phandle_args
*new_subdomain
);
231 extern struct generic_pm_domain
*of_genpd_remove_last(struct device_node
*np
);
232 extern int of_genpd_parse_idle_states(struct device_node
*dn
,
233 struct genpd_power_state
**states
, int *n
);
235 int genpd_dev_pm_attach(struct device
*dev
);
236 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
237 static inline int of_genpd_add_provider_simple(struct device_node
*np
,
238 struct generic_pm_domain
*genpd
)
243 static inline int of_genpd_add_provider_onecell(struct device_node
*np
,
244 struct genpd_onecell_data
*data
)
249 static inline void of_genpd_del_provider(struct device_node
*np
) {}
251 static inline int of_genpd_add_device(struct of_phandle_args
*args
,
257 static inline int of_genpd_add_subdomain(struct of_phandle_args
*parent
,
258 struct of_phandle_args
*new_subdomain
)
263 static inline int of_genpd_parse_idle_states(struct device_node
*dn
,
264 struct genpd_power_state
**states
, int *n
)
269 static inline int genpd_dev_pm_attach(struct device
*dev
)
275 struct generic_pm_domain
*of_genpd_remove_last(struct device_node
*np
)
277 return ERR_PTR(-ENOTSUPP
);
279 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
282 extern int dev_pm_domain_attach(struct device
*dev
, bool power_on
);
283 extern void dev_pm_domain_detach(struct device
*dev
, bool power_off
);
284 extern void dev_pm_domain_set(struct device
*dev
, struct dev_pm_domain
*pd
);
286 static inline int dev_pm_domain_attach(struct device
*dev
, bool power_on
)
290 static inline void dev_pm_domain_detach(struct device
*dev
, bool power_off
) {}
291 static inline void dev_pm_domain_set(struct device
*dev
,
292 struct dev_pm_domain
*pd
) {}
295 #endif /* _LINUX_PM_DOMAIN_H */