pm_domain.h 8.1 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/cpuidle.h>
19

20 21
enum gpd_status {
	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 26
	GPD_STATE_POWER_OFF,	/* PM domain is off */
};
27

28 29
struct dev_power_governor {
	bool (*power_down_ok)(struct dev_pm_domain *domain);
30
	bool (*stop_ok)(struct device *dev);
31 32
};

33 34 35
struct gpd_dev_ops {
	int (*start)(struct device *dev);
	int (*stop)(struct device *dev);
36 37
	int (*save_state)(struct device *dev);
	int (*restore_state)(struct device *dev);
38 39 40
	bool (*active_wakeup)(struct device *dev);
};

41 42 43 44 45
struct gpd_cpu_data {
	unsigned int saved_exit_latency;
	struct cpuidle_state *idle_state;
};

46 47
struct generic_pm_domain {
	struct dev_pm_domain domain;	/* PM domain operations */
48
	struct list_head gpd_list_node;	/* Node in the global PM domains list */
49 50
	struct list_head master_links;	/* Links with PM domain as a master */
	struct list_head slave_links;	/* Links with PM domain as a slave */
51 52 53 54
	struct list_head dev_list;	/* List of devices */
	struct mutex lock;
	struct dev_power_governor *gov;
	struct work_struct power_off_work;
55
	const char *name;
56
	unsigned int in_progress;	/* Number of devices being suspended now */
57
	atomic_t sd_count;	/* Number of subdomains with power "on" */
58 59
	enum gpd_status status;	/* Current state of the domain */
	wait_queue_head_t status_wait_queue;
60 61
	struct task_struct *poweroff_task;	/* Powering off task */
	unsigned int resume_count;	/* Number of devices being resumed */
62 63 64 65
	unsigned int device_count;	/* Number of devices */
	unsigned int suspended_count;	/* System suspend device counter */
	unsigned int prepared_count;	/* Suspend counter of prepared devices */
	bool suspend_power_off;	/* Power status before system suspend */
66
	int (*power_off)(struct generic_pm_domain *domain);
67
	s64 power_off_latency_ns;
68
	int (*power_on)(struct generic_pm_domain *domain);
69
	s64 power_on_latency_ns;
70
	struct gpd_dev_ops dev_ops;
71
	s64 max_off_time_ns;	/* Maximum allowed "suspended" time. */
72 73
	bool max_off_time_changed;
	bool cached_power_down_ok;
T
Thomas Abraham 已提交
74
	struct device_node *of_node; /* Node in device tree */
75
	struct gpd_cpu_data *cpu_data;
76 77
};

78 79 80 81 82
static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
{
	return container_of(pd, struct generic_pm_domain, domain);
}

83 84 85 86 87 88 89
struct gpd_link {
	struct generic_pm_domain *master;
	struct list_head master_node;
	struct generic_pm_domain *slave;
	struct list_head slave_node;
};

90 91 92
struct gpd_timing_data {
	s64 stop_latency_ns;
	s64 start_latency_ns;
93 94
	s64 save_state_latency_ns;
	s64 restore_state_latency_ns;
95
	s64 effective_constraint_ns;
96 97
	bool constraint_changed;
	bool cached_stop_ok;
98 99
};

100 101
struct generic_pm_domain_data {
	struct pm_domain_data base;
102
	struct gpd_timing_data td;
103 104
	struct notifier_block nb;
	struct mutex lock;
105
	unsigned int refcount;
106 107 108
	bool need_restore;
};

109
#ifdef CONFIG_PM_GENERIC_DOMAINS
110 111 112 113 114
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);
}

115 116 117 118 119
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return to_gpd_data(dev->power.subsys_data->domain_data);
}

120 121 122 123 124 125 126
extern struct dev_power_governor simple_qos_governor;

extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
				 struct device *dev,
				 struct gpd_timing_data *td);

T
Thomas Abraham 已提交
127 128 129 130
extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
				    struct device *dev,
				    struct gpd_timing_data *td);

131 132 133
extern int __pm_genpd_name_add_device(const char *domain_name,
				      struct device *dev,
				      struct gpd_timing_data *td);
T
Thomas Abraham 已提交
134

135 136
extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
				  struct device *dev);
137
extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
138 139
extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
				  struct generic_pm_domain *new_subdomain);
140 141
extern int pm_genpd_add_subdomain_names(const char *master_name,
					const char *subdomain_name);
142 143
extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
				     struct generic_pm_domain *target);
144
extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
145
extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
146
extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
147
extern int pm_genpd_name_detach_cpuidle(const char *name);
148 149
extern void pm_genpd_init(struct generic_pm_domain *genpd,
			  struct dev_power_governor *gov, bool is_off);
150

151
extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
152
extern int pm_genpd_name_poweron(const char *domain_name);
153

154
extern struct dev_power_governor pm_domain_always_on_gov;
155
#else
156

157 158 159 160
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return ERR_PTR(-ENOSYS);
}
161 162 163 164 165 166 167 168 169 170
static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
{
	return ERR_PTR(-ENOSYS);
}
static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
					struct device *dev,
					struct gpd_timing_data *td)
{
	return -ENOSYS;
}
171 172 173 174 175 176 177 178 179
static inline int __pm_genpd_of_add_device(struct device_node *genpd_node,
					   struct device *dev,
					   struct gpd_timing_data *td)
{
	return -ENOSYS;
}
static inline int __pm_genpd_name_add_device(const char *domain_name,
					     struct device *dev,
					     struct gpd_timing_data *td)
180 181 182 183 184 185 186 187
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
					 struct device *dev)
{
	return -ENOSYS;
}
188
static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
189 190 191 192 193
static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
					 struct generic_pm_domain *new_sd)
{
	return -ENOSYS;
}
194 195 196 197 198
static inline int pm_genpd_add_subdomain_names(const char *master_name,
					       const char *subdomain_name)
{
	return -ENOSYS;
}
199 200 201 202 203
static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
					    struct generic_pm_domain *target)
{
	return -ENOSYS;
}
204
static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
205 206 207
{
	return -ENOSYS;
}
208 209 210 211
static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
{
	return -ENOSYS;
}
212
static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
213 214 215
{
	return -ENOSYS;
}
216 217 218 219
static inline int pm_genpd_name_detach_cpuidle(const char *name)
{
	return -ENOSYS;
}
220 221
static inline void pm_genpd_init(struct generic_pm_domain *genpd,
				 struct dev_power_governor *gov, bool is_off)
222 223
{
}
224 225 226 227
static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
{
	return -ENOSYS;
}
228 229 230 231
static inline int pm_genpd_name_poweron(const char *domain_name)
{
	return -ENOSYS;
}
232
#define simple_qos_governor NULL
233
#define pm_domain_always_on_gov NULL
234 235
#endif

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
				      struct device *dev)
{
	return __pm_genpd_add_device(genpd, dev, NULL);
}

static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
					 struct device *dev)
{
	return __pm_genpd_of_add_device(genpd_node, dev, NULL);
}

static inline int pm_genpd_name_add_device(const char *domain_name,
					   struct device *dev)
{
	return __pm_genpd_name_add_device(domain_name, dev, NULL);
}

254 255 256 257
#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
extern void pm_genpd_poweroff_unused(void);
#else
static inline void pm_genpd_poweroff_unused(void) {}
258 259
#endif

260
#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
261 262
extern void pm_genpd_syscore_poweroff(struct device *dev);
extern void pm_genpd_syscore_poweron(struct device *dev);
263
#else
264 265
static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
static inline void pm_genpd_syscore_poweron(struct device *dev) {}
266 267
#endif

268
#endif /* _LINUX_PM_DOMAIN_H */