pm_domain.h 7.3 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

19 20
enum gpd_status {
	GPD_STATE_ACTIVE = 0,	/* PM domain is active */
21
	GPD_STATE_WAIT_MASTER,	/* PM domain's master is being waited for */
22
	GPD_STATE_BUSY,		/* Something is happening to the PM domain */
23
	GPD_STATE_REPEAT,	/* Power off in progress, to be repeated */
24 25
	GPD_STATE_POWER_OFF,	/* PM domain is off */
};
26

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

32 33 34
struct gpd_dev_ops {
	int (*start)(struct device *dev);
	int (*stop)(struct device *dev);
35 36
	int (*save_state)(struct device *dev);
	int (*restore_state)(struct device *dev);
37 38 39 40 41 42 43 44
	int (*suspend)(struct device *dev);
	int (*suspend_late)(struct device *dev);
	int (*resume_early)(struct device *dev);
	int (*resume)(struct device *dev);
	int (*freeze)(struct device *dev);
	int (*freeze_late)(struct device *dev);
	int (*thaw_early)(struct device *dev);
	int (*thaw)(struct device *dev);
45 46 47
	bool (*active_wakeup)(struct device *dev);
};

48 49
struct generic_pm_domain {
	struct dev_pm_domain domain;	/* PM domain operations */
50
	struct list_head gpd_list_node;	/* Node in the global PM domains list */
51 52
	struct list_head master_links;	/* Links with PM domain as a master */
	struct list_head slave_links;	/* Links with PM domain as a slave */
53 54 55 56
	struct list_head dev_list;	/* List of devices */
	struct mutex lock;
	struct dev_power_governor *gov;
	struct work_struct power_off_work;
57
	char *name;
58
	unsigned int in_progress;	/* Number of devices being suspended now */
59
	atomic_t sd_count;	/* Number of subdomains with power "on" */
60 61
	enum gpd_status status;	/* Current state of the domain */
	wait_queue_head_t status_wait_queue;
62 63
	struct task_struct *poweroff_task;	/* Powering off task */
	unsigned int resume_count;	/* Number of devices being resumed */
64 65 66 67
	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 */
68
	bool dev_irq_safe;	/* Device callbacks are IRQ-safe */
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 76
	bool max_off_time_changed;
	bool cached_power_down_ok;
T
Thomas Abraham 已提交
77
	struct device_node *of_node; /* Node in device tree */
78 79
};

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

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

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

102 103
struct generic_pm_domain_data {
	struct pm_domain_data base;
104
	struct gpd_dev_ops ops;
105
	struct gpd_timing_data td;
106 107
	struct notifier_block nb;
	struct mutex lock;
108
	bool need_restore;
109
	bool always_on;
110 111
};

112
#ifdef CONFIG_PM_GENERIC_DOMAINS
113 114 115 116 117
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);
}

118 119 120 121 122
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return to_gpd_data(dev->power.subsys_data->domain_data);
}

123 124 125 126 127 128 129
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 已提交
130 131 132 133
extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
				    struct device *dev,
				    struct gpd_timing_data *td);

134 135 136 137 138 139
static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
				      struct device *dev)
{
	return __pm_genpd_add_device(genpd, dev, NULL);
}

T
Thomas Abraham 已提交
140 141 142 143 144 145
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);
}

146 147
extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
				  struct device *dev);
148
extern void pm_genpd_dev_always_on(struct device *dev, bool val);
149 150 151 152
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);
153 154 155 156
extern int pm_genpd_add_callbacks(struct device *dev,
				  struct gpd_dev_ops *ops,
				  struct gpd_timing_data *td);
extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
157 158
extern void pm_genpd_init(struct generic_pm_domain *genpd,
			  struct dev_power_governor *gov, bool is_off);
159

160
extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
161 162 163

extern bool default_stop_ok(struct device *dev);

164
extern struct dev_power_governor pm_domain_always_on_gov;
165
#else
166

167 168 169 170
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return ERR_PTR(-ENOSYS);
}
171 172 173 174 175 176 177 178 179 180
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;
}
181 182 183 184 185 186 187 188 189 190
static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
				      struct device *dev)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
					 struct device *dev)
{
	return -ENOSYS;
}
191
static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {}
192 193 194 195 196 197 198 199 200 201
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;
}
202
static inline int pm_genpd_add_callbacks(struct device *dev,
203 204
					 struct gpd_dev_ops *ops,
					 struct gpd_timing_data *td)
205 206 207
{
	return -ENOSYS;
}
208
static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
209 210 211
{
	return -ENOSYS;
}
212 213
static inline void pm_genpd_init(struct generic_pm_domain *genpd,
				 struct dev_power_governor *gov, bool is_off)
214 215
{
}
216 217 218 219
static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
{
	return -ENOSYS;
}
220 221 222 223
static inline bool default_stop_ok(struct device *dev)
{
	return false;
}
224
#define simple_qos_governor NULL
225
#define pm_domain_always_on_gov NULL
226 227
#endif

228 229 230 231 232
static inline int pm_genpd_remove_callbacks(struct device *dev)
{
	return __pm_genpd_remove_callbacks(dev, true);
}

233 234 235 236
#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
extern void pm_genpd_poweroff_unused(void);
#else
237
static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
238
static inline void pm_genpd_poweroff_unused(void) {}
239 240 241
#endif

#endif /* _LINUX_PM_DOMAIN_H */