projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
PM / Domains: Stop/start devices during system PM suspend/resume in genpd
[linux-block.git] / include / linux / pm_domain.h
CommitLineData
f721889f
RW		 1/*
2 * pm_domain.h - Definitions and headers related to device power domains.
3 *
4 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
5 *
6 * This file is released under the GPLv2.
7 */
8
9#ifndef _LINUX_PM_DOMAIN_H
10#define _LINUX_PM_DOMAIN_H
11
12#include <linux/device.h>
313162d0
PG		 13#include <linux/mutex.h>
14#include <linux/pm.h>
4f042cda 15#include <linux/err.h>
c8aa130b 16#include <linux/of.h>
6ff7bb0d 17#include <linux/notifier.h>
f721889f 18
c11f6f5b
UH		 19/* Defines used for the flags field in the struct generic_pm_domain */
20#define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */
21
fc5cbf0c
AH		 22#define GENPD_MAX_NUM_STATES 8 /* Number of possible low power states */
23
17b75eca
RW		 24enum gpd_status {
25 GPD_STATE_ACTIVE = 0, /* PM domain is active */
17b75eca
RW		 26 GPD_STATE_POWER_OFF, /* PM domain is off */
27};
596ba34b 28
f721889f
RW		 29struct dev_power_governor {
30 bool (*power_down_ok)(struct dev_pm_domain *domain);
9df3921e 31 bool (*suspend_ok)(struct device *dev);
f721889f
RW		 32};
33
d5e4cbfe
RW		 34struct gpd_dev_ops {
35 int (*start)(struct device *dev);
36 int (*stop)(struct device *dev);
37 bool (*active_wakeup)(struct device *dev);
38};
39
fc5cbf0c
AH		 40struct genpd_power_state {
41 s64 power_off_latency_ns;
42 s64 power_on_latency_ns;
43};
44
f721889f
RW		 45struct generic_pm_domain {
46 struct dev_pm_domain domain; /* PM domain operations */
5125bbf3 47 struct list_head gpd_list_node; /* Node in the global PM domains list */
5063ce15
RW		 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 */
f721889f
RW		 50 struct list_head dev_list; /* List of devices */
51 struct mutex lock;
52 struct dev_power_governor *gov;
53 struct work_struct power_off_work;
d07e9c17 54 const char *name;
c4bb3160 55 atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca 56 enum gpd_status status; /* Current state of the domain */
596ba34b
RW		 57 unsigned int device_count; /* Number of devices */
58 unsigned int suspended_count; /* System suspend device counter */
59 unsigned int prepared_count; /* Suspend counter of prepared devices */
f721889f
RW		 60 int (*power_off)(struct generic_pm_domain *domain);
61 int (*power_on)(struct generic_pm_domain *domain);
d5e4cbfe 62 struct gpd_dev_ops dev_ops;
221e9b58 63 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
6ff7bb0d
RW		 64 bool max_off_time_changed;
65 bool cached_power_down_ok;
c16561e8
UH		 66 int (*attach_dev)(struct generic_pm_domain *domain,
67 struct device *dev);
68 void (*detach_dev)(struct generic_pm_domain *domain,
69 struct device *dev);
c11f6f5b 70 unsigned int flags; /* Bit field of configs for genpd */
fc5cbf0c
AH		 71 struct genpd_power_state states[GENPD_MAX_NUM_STATES];
72 unsigned int state_count; /* number of states */
73 unsigned int state_idx; /* state that genpd will go to when off */
74
f721889f
RW		 75};
76
596ba34b
RW		 77static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
78{
79 return container_of(pd, struct generic_pm_domain, domain);
80}
81
5063ce15
RW		 82struct gpd_link {
83 struct generic_pm_domain *master;
84 struct list_head master_node;
85 struct generic_pm_domain *slave;
86 struct list_head slave_node;
87};
88
b02c999a 89struct gpd_timing_data {
2b1d88cd
UH		 90 s64 suspend_latency_ns;
91 s64 resume_latency_ns;
a5bef810 92 s64 effective_constraint_ns;
6ff7bb0d 93 bool constraint_changed;
9df3921e 94 bool cached_suspend_ok;
b02c999a
RW		 95};
96
00e7c295
UH		 97struct pm_domain_data {
98 struct list_head list_node;
99 struct device *dev;
100};
101
cd0ea672
RW		 102struct generic_pm_domain_data {
103 struct pm_domain_data base;
b02c999a 104 struct gpd_timing_data td;
6ff7bb0d 105 struct notifier_block nb;
cd0ea672
RW		 106};
107
9b4f617b 108#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672
RW		 109static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
110{
111 return container_of(pdd, struct generic_pm_domain_data, base);
112}
113
d5e4cbfe
RW		 114static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
115{
116 return to_gpd_data(dev->power.subsys_data->domain_data);
117}
118
446d999c 119extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev);
b02c999a
RW		 120extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
121 struct device *dev,
122 struct gpd_timing_data *td);
123
f721889f
RW		 124extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
125 struct device *dev);
126extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
127 struct generic_pm_domain *new_subdomain);
128extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
129 struct generic_pm_domain *target);
130extern void pm_genpd_init(struct generic_pm_domain *genpd,
131 struct dev_power_governor *gov, bool is_off);
b02c999a 132
ae3c511c 133extern struct dev_power_governor simple_qos_governor;
925b44a2 134extern struct dev_power_governor pm_domain_always_on_gov;
f721889f 135#else
b02c999a 136
b642631d
MD		 137static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
138{
139 return ERR_PTR(-ENOSYS);
140}
446d999c 141static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
b02c999a 142{
446d999c 143 return NULL;
b02c999a
RW		 144}
145static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
146 struct device *dev,
147 struct gpd_timing_data *td)
148{
149 return -ENOSYS;
150}
f721889f
RW		 151static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
152 struct device *dev)
153{
154 return -ENOSYS;
155}
156static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
157 struct generic_pm_domain *new_sd)
158{
159 return -ENOSYS;
160}
161static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
162 struct generic_pm_domain *target)
163{
164 return -ENOSYS;
165}
b642631d
MD		 166static inline void pm_genpd_init(struct generic_pm_domain *genpd,
167 struct dev_power_governor *gov, bool is_off)
b02c999a
RW		 168{
169}
17f2ae7f
RW		 170#endif
171
b5abb085
RW		 172static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
173 struct device *dev)
174{
175 return __pm_genpd_add_device(genpd, dev, NULL);
176}
177
77f827de 178#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
d47e6464
UH		 179extern void pm_genpd_syscore_poweroff(struct device *dev);
180extern void pm_genpd_syscore_poweron(struct device *dev);
77f827de 181#else
d47e6464
UH		 182static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
183static inline void pm_genpd_syscore_poweron(struct device *dev) {}
77f827de
RW		 184#endif
185
aa42240a
TF		 186/* OF PM domain providers */
187struct of_device_id;
188
189struct genpd_onecell_data {
190 struct generic_pm_domain **domains;
191 unsigned int num_domains;
192};
193
194typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
195 void *data);
196
197#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
198int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
199 void *data);
200void of_genpd_del_provider(struct device_node *np);
7496fcbe
ADK		 201struct generic_pm_domain *of_genpd_get_from_provider(
202 struct of_phandle_args *genpdspec);
aa42240a
TF		 203
204struct generic_pm_domain *__of_genpd_xlate_simple(
205 struct of_phandle_args *genpdspec,
206 void *data);
207struct generic_pm_domain *__of_genpd_xlate_onecell(
208 struct of_phandle_args *genpdspec,
209 void *data);
210
211int genpd_dev_pm_attach(struct device *dev);
212#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
213static inline int __of_genpd_add_provider(struct device_node *np,
214 genpd_xlate_t xlate, void *data)
215{
216 return 0;
217}
218static inline void of_genpd_del_provider(struct device_node *np) {}
219
7496fcbe
ADK		 220static inline struct generic_pm_domain *of_genpd_get_from_provider(
221 struct of_phandle_args *genpdspec)
222{
223 return NULL;
224}
225
aa42240a
TF		 226#define __of_genpd_xlate_simple NULL
227#define __of_genpd_xlate_onecell NULL
228
229static inline int genpd_dev_pm_attach(struct device *dev)
230{
231 return -ENODEV;
232}
233#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
234
235static inline int of_genpd_add_provider_simple(struct device_node *np,
236 struct generic_pm_domain *genpd)
237{
238 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
239}
240static inline int of_genpd_add_provider_onecell(struct device_node *np,
241 struct genpd_onecell_data *data)
242{
243 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
244}
245
f48c767c
UH		 246#ifdef CONFIG_PM
247extern int dev_pm_domain_attach(struct device *dev, bool power_on);
248extern void dev_pm_domain_detach(struct device *dev, bool power_off);
989561de 249extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
f48c767c
UH		 250#else
251static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
252{
253 return -ENODEV;
254}
255static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
989561de
TV		 256static inline void dev_pm_domain_set(struct device *dev,
257 struct dev_pm_domain *pd) {}
f48c767c
UH		 258#endif
259
f721889f 260#endif /* _LINUX_PM_DOMAIN_H */
Linux 6.x block layer and io_uring tree(s)