[mirror_ubuntu-zesty-kernel.git] / include / linux / pm_domain.h

/*
 * 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>
#include <linux/mutex.h>
#include <linux/pm.h>
#include <linux/err.h>
#include <linux/of.h>
#include <linux/notifier.h>
#include <linux/cpuidle.h>

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

struct dev_power_governor {
	bool (*power_down_ok)(struct dev_pm_domain *domain);
	bool (*stop_ok)(struct device *dev);
};

struct gpd_dev_ops {
	int (*start)(struct device *dev);
	int (*stop)(struct device *dev);
	int (*save_state)(struct device *dev);
	int (*restore_state)(struct device *dev);
	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);
	bool (*active_wakeup)(struct device *dev);
};

struct gpd_cpu_data {
	unsigned int saved_exit_latency;
	struct cpuidle_state *idle_state;
};

struct generic_pm_domain {
	struct dev_pm_domain domain;	/* PM domain operations */
	struct list_head gpd_list_node;	/* Node in the global PM domains list */
	struct list_head master_links;	/* Links with PM domain as a master */
	struct list_head slave_links;	/* Links with PM domain as a slave */
	struct list_head dev_list;	/* List of devices */
	struct mutex lock;
	struct dev_power_governor *gov;
	struct work_struct power_off_work;
	char *name;
	unsigned int in_progress;	/* Number of devices being suspended now */
	atomic_t sd_count;	/* Number of subdomains with power "on" */
	enum gpd_status status;	/* Current state of the domain */
	wait_queue_head_t status_wait_queue;
	struct task_struct *poweroff_task;	/* Powering off task */
	unsigned int resume_count;	/* Number of devices being resumed */
	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 */
	bool dev_irq_safe;	/* Device callbacks are IRQ-safe */
	int (*power_off)(struct generic_pm_domain *domain);
	s64 power_off_latency_ns;
	int (*power_on)(struct generic_pm_domain *domain);
	s64 power_on_latency_ns;
	struct gpd_dev_ops dev_ops;
	s64 max_off_time_ns;	/* Maximum allowed "suspended" time. */
	bool max_off_time_changed;
	bool cached_power_down_ok;
	struct device_node *of_node; /* Node in device tree */
	struct gpd_cpu_data *cpu_data;
};

static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
{
	return container_of(pd, struct generic_pm_domain, domain);
}

struct gpd_link {
	struct generic_pm_domain *master;
	struct list_head master_node;
	struct generic_pm_domain *slave;
	struct list_head slave_node;
};

struct gpd_timing_data {
	s64 stop_latency_ns;
	s64 start_latency_ns;
	s64 save_state_latency_ns;
	s64 restore_state_latency_ns;
	s64 effective_constraint_ns;
	bool constraint_changed;
	bool cached_stop_ok;
};

struct generic_pm_domain_data {
	struct pm_domain_data base;
	struct gpd_dev_ops ops;
	struct gpd_timing_data td;
	struct notifier_block nb;
	struct mutex lock;
	bool need_restore;
	bool always_on;
};

#ifdef CONFIG_PM_GENERIC_DOMAINS
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);
}

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

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);

extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
				    struct device *dev,
				    struct gpd_timing_data *td);

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);
}

extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
				  struct device *dev);
extern void pm_genpd_dev_always_on(struct device *dev, bool val);
extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
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);
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);
extern int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
extern int genpd_detach_cpuidle(struct generic_pm_domain *genpd);
extern void pm_genpd_init(struct generic_pm_domain *genpd,
			  struct dev_power_governor *gov, bool is_off);

extern int pm_genpd_poweron(struct generic_pm_domain *genpd);

extern bool default_stop_ok(struct device *dev);

extern struct dev_power_governor pm_domain_always_on_gov;
#else

static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return ERR_PTR(-ENOSYS);
}
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;
}
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;
}
static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {}
static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
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;
}
static inline int pm_genpd_add_callbacks(struct device *dev,
					 struct gpd_dev_ops *ops,
					 struct gpd_timing_data *td)
{
	return -ENOSYS;
}
static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
{
	return -ENOSYS;
}
static inline int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
{
	return -ENOSYS;
}
static inline int genpd_detach_cpuidle(struct generic_pm_domain *genpd)
{
	return -ENOSYS;
}
static inline void pm_genpd_init(struct generic_pm_domain *genpd,
				 struct dev_power_governor *gov, bool is_off)
{
}
static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
{
	return -ENOSYS;
}
static inline bool default_stop_ok(struct device *dev)
{
	return false;
}
#define simple_qos_governor NULL
#define pm_domain_always_on_gov NULL
#endif

static inline int pm_genpd_remove_callbacks(struct device *dev)
{
	return __pm_genpd_remove_callbacks(dev, true);
}

#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
static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
static inline void pm_genpd_poweroff_unused(void) {}
#endif

#endif /* _LINUX_PM_DOMAIN_H */
Commit	Line	Data
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>
313162d0 PG	14	#include <linux/pm.h>
4f042cda	15	#include <linux/err.h>
c8aa130b	16	#include <linux/of.h>
6ff7bb0d	17	#include <linux/notifier.h>
cbc9ef02	18	#include <linux/cpuidle.h>
f721889f	19
17b75eca RW	20	enum gpd_status {
17b75eca RW	21	GPD_STATE_ACTIVE = 0, /* PM domain is active */
17877eb5	22	GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
17b75eca	23	GPD_STATE_BUSY, /* Something is happening to the PM domain */
c6d22b37	24	GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
17b75eca RW	25	GPD_STATE_POWER_OFF, /* PM domain is off */
17b75eca RW	26	};
596ba34b	27
f721889f RW	28	struct dev_power_governor {
f721889f RW	29	bool (power_down_ok)(struct dev_pm_domain domain);
b02c999a	30	bool (stop_ok)(struct device dev);
f721889f RW	31	};
f721889f RW	32
d5e4cbfe RW	33	struct gpd_dev_ops {
	34	int (start)(struct device dev);
	35	int (stop)(struct device dev);
ecf00475 RW	36	int (save_state)(struct device dev);
ecf00475 RW	37	int (restore_state)(struct device dev);
d23b9b00 RW	38	int (suspend)(struct device dev);
	39	int (suspend_late)(struct device dev);
	40	int (resume_early)(struct device dev);
	41	int (resume)(struct device dev);
	42	int (freeze)(struct device dev);
	43	int (freeze_late)(struct device dev);
	44	int (thaw_early)(struct device dev);
	45	int (thaw)(struct device dev);
d5e4cbfe RW	46	bool (active_wakeup)(struct device dev);
	47	};
	48
cbc9ef02 RW	49	struct gpd_cpu_data {
	50	unsigned int saved_exit_latency;
	51	struct cpuidle_state *idle_state;
	52	};
	53
f721889f RW	54	struct generic_pm_domain {
f721889f RW	55	struct dev_pm_domain domain; /* PM domain operations */
5125bbf3	56	struct list_head gpd_list_node; /* Node in the global PM domains list */
5063ce15 RW	57	struct list_head master_links; /* Links with PM domain as a master */
5063ce15 RW	58	struct list_head slave_links; /* Links with PM domain as a slave */
f721889f RW	59	struct list_head dev_list; /* List of devices */
	60	struct mutex lock;
	61	struct dev_power_governor *gov;
	62	struct work_struct power_off_work;
e84b2c20	63	char *name;
f721889f	64	unsigned int in_progress; /* Number of devices being suspended now */
c4bb3160	65	atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca RW	66	enum gpd_status status; /* Current state of the domain */
17b75eca RW	67	wait_queue_head_t status_wait_queue;
c6d22b37 RW	68	struct task_struct poweroff_task; / Powering off task */
c6d22b37 RW	69	unsigned int resume_count; /* Number of devices being resumed */
596ba34b RW	70	unsigned int device_count; /* Number of devices */
	71	unsigned int suspended_count; /* System suspend device counter */
	72	unsigned int prepared_count; /* Suspend counter of prepared devices */
	73	bool suspend_power_off; /* Power status before system suspend */
0aa2a221	74	bool dev_irq_safe; /* Device callbacks are IRQ-safe */
f721889f	75	int (power_off)(struct generic_pm_domain domain);
221e9b58	76	s64 power_off_latency_ns;
f721889f	77	int (power_on)(struct generic_pm_domain domain);
221e9b58	78	s64 power_on_latency_ns;
d5e4cbfe	79	struct gpd_dev_ops dev_ops;
221e9b58	80	s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
6ff7bb0d RW	81	bool max_off_time_changed;
6ff7bb0d RW	82	bool cached_power_down_ok;
c8aa130b	83	struct device_node of_node; / Node in device tree */
cbc9ef02	84	struct gpd_cpu_data *cpu_data;
f721889f RW	85	};
f721889f RW	86
596ba34b RW	87	static inline struct generic_pm_domain pd_to_genpd(struct dev_pm_domain pd)
	88	{
	89	return container_of(pd, struct generic_pm_domain, domain);
	90	}
	91
5063ce15 RW	92	struct gpd_link {
	93	struct generic_pm_domain *master;
	94	struct list_head master_node;
	95	struct generic_pm_domain *slave;
	96	struct list_head slave_node;
	97	};
	98
b02c999a RW	99	struct gpd_timing_data {
	100	s64 stop_latency_ns;
	101	s64 start_latency_ns;
221e9b58 RW	102	s64 save_state_latency_ns;
221e9b58 RW	103	s64 restore_state_latency_ns;
a5bef810	104	s64 effective_constraint_ns;
6ff7bb0d RW	105	bool constraint_changed;
6ff7bb0d RW	106	bool cached_stop_ok;
b02c999a RW	107	};
b02c999a RW	108
cd0ea672 RW	109	struct generic_pm_domain_data {
cd0ea672 RW	110	struct pm_domain_data base;
d5e4cbfe	111	struct gpd_dev_ops ops;
b02c999a	112	struct gpd_timing_data td;
6ff7bb0d RW	113	struct notifier_block nb;
6ff7bb0d RW	114	struct mutex lock;
cd0ea672	115	bool need_restore;
1e78a0c7	116	bool always_on;
cd0ea672 RW	117	};
cd0ea672 RW	118
9b4f617b	119	#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672 RW	120	static inline struct generic_pm_domain_data to_gpd_data(struct pm_domain_data pdd)
	121	{
	122	return container_of(pdd, struct generic_pm_domain_data, base);
	123	}
	124
d5e4cbfe RW	125	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	126	{
	127	return to_gpd_data(dev->power.subsys_data->domain_data);
	128	}
	129
b02c999a RW	130	extern struct dev_power_governor simple_qos_governor;
	131
	132	extern struct generic_pm_domain dev_to_genpd(struct device dev);
	133	extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	134	struct device *dev,
	135	struct gpd_timing_data *td);
	136
c8aa130b TA	137	extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
	138	struct device *dev,
	139	struct gpd_timing_data *td);
	140
b02c999a RW	141	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	142	struct device *dev)
	143	{
	144	return __pm_genpd_add_device(genpd, dev, NULL);
	145	}
	146
c8aa130b TA	147	static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
	148	struct device *dev)
	149	{
	150	return __pm_genpd_of_add_device(genpd_node, dev, NULL);
	151	}
	152
f721889f RW	153	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
f721889f RW	154	struct device *dev);
1e78a0c7	155	extern void pm_genpd_dev_always_on(struct device *dev, bool val);
ca1d72f0	156	extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
f721889f RW	157	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	158	struct generic_pm_domain *new_subdomain);
	159	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	160	struct generic_pm_domain *target);
b02c999a RW	161	extern int pm_genpd_add_callbacks(struct device *dev,
	162	struct gpd_dev_ops *ops,
	163	struct gpd_timing_data *td);
	164	extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
cbc9ef02 RW	165	extern int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
cbc9ef02 RW	166	extern int genpd_detach_cpuidle(struct generic_pm_domain *genpd);
f721889f RW	167	extern void pm_genpd_init(struct generic_pm_domain *genpd,
f721889f RW	168	struct dev_power_governor *gov, bool is_off);
b02c999a	169
18b4f3f5	170	extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
b02c999a RW	171
	172	extern bool default_stop_ok(struct device *dev);
	173
925b44a2	174	extern struct dev_power_governor pm_domain_always_on_gov;
f721889f	175	#else
b02c999a	176
b642631d MD	177	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	178	{
	179	return ERR_PTR(-ENOSYS);
	180	}
b02c999a RW	181	static inline struct generic_pm_domain dev_to_genpd(struct device dev)
	182	{
	183	return ERR_PTR(-ENOSYS);
	184	}
	185	static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	186	struct device *dev,
	187	struct gpd_timing_data *td)
	188	{
	189	return -ENOSYS;
	190	}
f721889f RW	191	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	192	struct device *dev)
	193	{
	194	return -ENOSYS;
	195	}
	196	static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	197	struct device *dev)
	198	{
	199	return -ENOSYS;
	200	}
1e78a0c7	201	static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {}
ca1d72f0	202	static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
f721889f RW	203	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	204	struct generic_pm_domain *new_sd)
	205	{
	206	return -ENOSYS;
	207	}
	208	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	209	struct generic_pm_domain *target)
	210	{
	211	return -ENOSYS;
	212	}
d5e4cbfe	213	static inline int pm_genpd_add_callbacks(struct device *dev,
b02c999a RW	214	struct gpd_dev_ops *ops,
b02c999a RW	215	struct gpd_timing_data *td)
d5e4cbfe RW	216	{
	217	return -ENOSYS;
	218	}
b02c999a	219	static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
d5e4cbfe RW	220	{
	221	return -ENOSYS;
	222	}
cbc9ef02 RW	223	static inline int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
	224	{
	225	return -ENOSYS;
	226	}
	227	static inline int genpd_detach_cpuidle(struct generic_pm_domain *genpd)
	228	{
	229	return -ENOSYS;
	230	}
b642631d MD	231	static inline void pm_genpd_init(struct generic_pm_domain *genpd,
b642631d MD	232	struct dev_power_governor *gov, bool is_off)
b02c999a RW	233	{
b02c999a RW	234	}
18b4f3f5 MD	235	static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
	236	{
	237	return -ENOSYS;
	238	}
b02c999a RW	239	static inline bool default_stop_ok(struct device *dev)
	240	{
	241	return false;
	242	}
b642631d	243	#define simple_qos_governor NULL
925b44a2	244	#define pm_domain_always_on_gov NULL
17f2ae7f RW	245	#endif
17f2ae7f RW	246
b02c999a RW	247	static inline int pm_genpd_remove_callbacks(struct device *dev)
	248	{
	249	return __pm_genpd_remove_callbacks(dev, true);
	250	}
	251
17f2ae7f RW	252	#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
	253	extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
	254	extern void pm_genpd_poweroff_unused(void);
	255	#else
0bc5b2de	256	static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
17f2ae7f	257	static inline void pm_genpd_poweroff_unused(void) {}
f721889f RW	258	#endif
	259
	260	#endif /* _LINUX_PM_DOMAIN_H */