pm_domain.h 9.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * pm_domain.h - Definitions and headers related to device power domains.
 *
 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
 *
 * This file is released under the GPLv2.
 */

#ifndef _LINUX_PM_DOMAIN_H
#define _LINUX_PM_DOMAIN_H

#include <linux/device.h>
13 14
#include <linux/mutex.h>
#include <linux/pm.h>
15
#include <linux/err.h>
T
Thomas Abraham 已提交
16
#include <linux/of.h>
17
#include <linux/notifier.h>
18
#include <linux/spinlock.h>
19

20
/* Defines used for the flags field in the struct generic_pm_domain */
21 22 23 24
#define GENPD_FLAG_PM_CLK	 (1U << 0) /* PM domain uses PM clk */
#define GENPD_FLAG_IRQ_SAFE	 (1U << 1) /* PM domain operates in atomic */
#define GENPD_FLAG_ALWAYS_ON	 (1U << 2) /* PM domain is always powered on */
#define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3) /* Keep devices active if wakeup */
25

26 27 28 29
enum gpd_status {
	GPD_STATE_ACTIVE = 0,	/* PM domain is active */
	GPD_STATE_POWER_OFF,	/* PM domain is off */
};
30

31 32
struct dev_power_governor {
	bool (*power_down_ok)(struct dev_pm_domain *domain);
33
	bool (*suspend_ok)(struct device *dev);
34 35
};

36 37 38 39 40
struct gpd_dev_ops {
	int (*start)(struct device *dev);
	int (*stop)(struct device *dev);
};

41 42 43
struct genpd_power_state {
	s64 power_off_latency_ns;
	s64 power_on_latency_ns;
44
	s64 residency_ns;
45
	struct fwnode_handle *fwnode;
46
	ktime_t idle_time;
47 48
};

L
Lina Iyer 已提交
49
struct genpd_lock_ops;
50
struct dev_pm_opp;
L
Lina Iyer 已提交
51

52
struct generic_pm_domain {
53
	struct device dev;
54
	struct dev_pm_domain domain;	/* PM domain operations */
55
	struct list_head gpd_list_node;	/* Node in the global PM domains list */
56 57
	struct list_head master_links;	/* Links with PM domain as a master */
	struct list_head slave_links;	/* Links with PM domain as a slave */
58 59 60
	struct list_head dev_list;	/* List of devices */
	struct dev_power_governor *gov;
	struct work_struct power_off_work;
61 62
	struct fwnode_handle *provider;	/* Identity of the domain provider */
	bool has_provider;
63
	const char *name;
64
	atomic_t sd_count;	/* Number of subdomains with power "on" */
65
	enum gpd_status status;	/* Current state of the domain */
66 67 68
	unsigned int device_count;	/* Number of devices */
	unsigned int suspended_count;	/* System suspend device counter */
	unsigned int prepared_count;	/* Suspend counter of prepared devices */
69
	unsigned int performance_state;	/* Aggregated max performance state */
70 71
	int (*power_off)(struct generic_pm_domain *domain);
	int (*power_on)(struct generic_pm_domain *domain);
72 73
	unsigned int (*opp_to_performance_state)(struct generic_pm_domain *genpd,
						 struct dev_pm_opp *opp);
74 75
	int (*set_performance_state)(struct generic_pm_domain *genpd,
				     unsigned int state);
76
	struct gpd_dev_ops dev_ops;
77
	s64 max_off_time_ns;	/* Maximum allowed "suspended" time. */
78 79
	bool max_off_time_changed;
	bool cached_power_down_ok;
80 81 82 83
	int (*attach_dev)(struct generic_pm_domain *domain,
			  struct device *dev);
	void (*detach_dev)(struct generic_pm_domain *domain,
			   struct device *dev);
84
	unsigned int flags;		/* Bit field of configs for genpd */
85
	struct genpd_power_state *states;
86 87
	unsigned int state_count; /* number of states */
	unsigned int state_idx; /* state that genpd will go to when off */
88
	void *free; /* Free the state that was allocated for default */
89 90
	ktime_t on_time;
	ktime_t accounting_time;
L
Lina Iyer 已提交
91
	const struct genpd_lock_ops *lock_ops;
92 93 94 95 96 97 98
	union {
		struct mutex mlock;
		struct {
			spinlock_t slock;
			unsigned long lock_flags;
		};
	};
99

100 101
};

102 103 104 105 106
static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
{
	return container_of(pd, struct generic_pm_domain, domain);
}

107 108 109 110 111 112 113
struct gpd_link {
	struct generic_pm_domain *master;
	struct list_head master_node;
	struct generic_pm_domain *slave;
	struct list_head slave_node;
};

114
struct gpd_timing_data {
115 116
	s64 suspend_latency_ns;
	s64 resume_latency_ns;
117
	s64 effective_constraint_ns;
118
	bool constraint_changed;
119
	bool cached_suspend_ok;
120 121
};

122 123 124 125 126
struct pm_domain_data {
	struct list_head list_node;
	struct device *dev;
};

127 128
struct generic_pm_domain_data {
	struct pm_domain_data base;
129
	struct gpd_timing_data td;
130
	struct notifier_block nb;
131
	unsigned int performance_state;
132
	void *data;
133 134
};

135
#ifdef CONFIG_PM_GENERIC_DOMAINS
136 137 138 139 140
static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
{
	return container_of(pdd, struct generic_pm_domain_data, base);
}

141 142 143 144 145
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return to_gpd_data(dev->power.subsys_data->domain_data);
}

146 147 148 149
extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
				 struct device *dev,
				 struct gpd_timing_data *td);

150 151 152 153 154 155
extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
				  struct device *dev);
extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
				  struct generic_pm_domain *new_subdomain);
extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
				     struct generic_pm_domain *target);
156 157
extern int pm_genpd_init(struct generic_pm_domain *genpd,
			 struct dev_power_governor *gov, bool is_off);
158
extern int pm_genpd_remove(struct generic_pm_domain *genpd);
159 160
extern int dev_pm_genpd_set_performance_state(struct device *dev,
					      unsigned int state);
161

162
extern struct dev_power_governor simple_qos_governor;
163
extern struct dev_power_governor pm_domain_always_on_gov;
164
#else
165

166 167 168 169
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return ERR_PTR(-ENOSYS);
}
170 171 172 173 174 175
static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
					struct device *dev,
					struct gpd_timing_data *td)
{
	return -ENOSYS;
}
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
					 struct device *dev)
{
	return -ENOSYS;
}
static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
					 struct generic_pm_domain *new_sd)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
					    struct generic_pm_domain *target)
{
	return -ENOSYS;
}
191 192
static inline int pm_genpd_init(struct generic_pm_domain *genpd,
				struct dev_power_governor *gov, bool is_off)
193
{
194
	return -ENOSYS;
195
}
196 197 198 199
static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
{
	return -ENOTSUPP;
}
200

201 202 203 204 205 206
static inline int dev_pm_genpd_set_performance_state(struct device *dev,
						     unsigned int state)
{
	return -ENOTSUPP;
}

207 208
#define simple_qos_governor		(*(struct dev_power_governor *)(NULL))
#define pm_domain_always_on_gov		(*(struct dev_power_governor *)(NULL))
209 210
#endif

211 212 213 214 215 216
static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
				      struct device *dev)
{
	return __pm_genpd_add_device(genpd, dev, NULL);
}

217
#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
218 219
extern void pm_genpd_syscore_poweroff(struct device *dev);
extern void pm_genpd_syscore_poweron(struct device *dev);
220
#else
221 222
static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
static inline void pm_genpd_syscore_poweron(struct device *dev) {}
223 224
#endif

225 226 227
/* OF PM domain providers */
struct of_device_id;

228 229 230
typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
						   void *data);

231 232 233
struct genpd_onecell_data {
	struct generic_pm_domain **domains;
	unsigned int num_domains;
234
	genpd_xlate_t xlate;
235 236 237
};

#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
238 239 240 241
int of_genpd_add_provider_simple(struct device_node *np,
				 struct generic_pm_domain *genpd);
int of_genpd_add_provider_onecell(struct device_node *np,
				  struct genpd_onecell_data *data);
242
void of_genpd_del_provider(struct device_node *np);
243 244 245 246
extern int of_genpd_add_device(struct of_phandle_args *args,
			       struct device *dev);
extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
				  struct of_phandle_args *new_subdomain);
247
extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
248 249
extern int of_genpd_parse_idle_states(struct device_node *dn,
			struct genpd_power_state **states, int *n);
250 251
extern unsigned int of_genpd_opp_to_performance_state(struct device *dev,
				struct device_node *opp_node);
252 253 254

int genpd_dev_pm_attach(struct device *dev);
#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
255 256
static inline int of_genpd_add_provider_simple(struct device_node *np,
					struct generic_pm_domain *genpd)
257
{
258 259 260 261 262 263 264
	return -ENOTSUPP;
}

static inline int of_genpd_add_provider_onecell(struct device_node *np,
					struct genpd_onecell_data *data)
{
	return -ENOTSUPP;
265 266
}

267
static inline void of_genpd_del_provider(struct device_node *np) {}
268

269 270 271 272 273 274 275 276 277 278 279 280
static inline int of_genpd_add_device(struct of_phandle_args *args,
				      struct device *dev)
{
	return -ENODEV;
}

static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
					 struct of_phandle_args *new_subdomain)
{
	return -ENODEV;
}

281 282 283 284 285 286
static inline int of_genpd_parse_idle_states(struct device_node *dn,
			struct genpd_power_state **states, int *n)
{
	return -ENODEV;
}

287 288 289 290 291 292 293
static inline unsigned int
of_genpd_opp_to_performance_state(struct device *dev,
				  struct device_node *opp_node)
{
	return -ENODEV;
}

294 295
static inline int genpd_dev_pm_attach(struct device *dev)
{
296
	return 0;
297
}
298 299 300 301 302 303

static inline
struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
{
	return ERR_PTR(-ENOTSUPP);
}
304 305
#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */

306 307 308
#ifdef CONFIG_PM
extern int dev_pm_domain_attach(struct device *dev, bool power_on);
extern void dev_pm_domain_detach(struct device *dev, bool power_off);
309
extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
310 311 312
#else
static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
{
313
	return 0;
314 315
}
static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
316 317
static inline void dev_pm_domain_set(struct device *dev,
				     struct dev_pm_domain *pd) {}
318 319
#endif

320
#endif /* _LINUX_PM_DOMAIN_H */