[deliverable/linux.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/err.h>
#include <linux/of.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 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 break_even_ns;	/* Power break even for the entire domain. */
	s64 max_off_time_ns;	/* Maximum allowed "suspended" time. */
	ktime_t power_off_time;
	struct device_node *of_node; /* Node in device tree */
};

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

struct generic_pm_domain_data {
	struct pm_domain_data base;
	struct gpd_dev_ops ops;
	struct gpd_timing_data td;
	bool need_restore;
};

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

#ifdef CONFIG_PM_GENERIC_DOMAINS
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 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 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 *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 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 void pm_genpd_init(struct generic_pm_domain *genpd, 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 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>
4f042cda	13	#include <linux/err.h>
c8aa130b	14	#include <linux/of.h>
f721889f	15
17b75eca RW	16	enum gpd_status {
17b75eca RW	17	GPD_STATE_ACTIVE = 0, /* PM domain is active */
17877eb5	18	GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
17b75eca	19	GPD_STATE_BUSY, /* Something is happening to the PM domain */
c6d22b37	20	GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
17b75eca RW	21	GPD_STATE_POWER_OFF, /* PM domain is off */
17b75eca RW	22	};
596ba34b	23
f721889f RW	24	struct dev_power_governor {
f721889f RW	25	bool (power_down_ok)(struct dev_pm_domain domain);
b02c999a	26	bool (stop_ok)(struct device dev);
f721889f RW	27	};
f721889f RW	28
d5e4cbfe RW	29	struct gpd_dev_ops {
	30	int (start)(struct device dev);
	31	int (stop)(struct device dev);
ecf00475 RW	32	int (save_state)(struct device dev);
ecf00475 RW	33	int (restore_state)(struct device dev);
d23b9b00 RW	34	int (suspend)(struct device dev);
	35	int (suspend_late)(struct device dev);
	36	int (resume_early)(struct device dev);
	37	int (resume)(struct device dev);
	38	int (freeze)(struct device dev);
	39	int (freeze_late)(struct device dev);
	40	int (thaw_early)(struct device dev);
	41	int (thaw)(struct device dev);
d5e4cbfe RW	42	bool (active_wakeup)(struct device dev);
	43	};
	44
f721889f RW	45	struct generic_pm_domain {
f721889f RW	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 */
5063ce15 RW	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;
e84b2c20	54	char *name;
f721889f	55	unsigned int in_progress; /* Number of devices being suspended now */
c4bb3160	56	atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca RW	57	enum gpd_status status; /* Current state of the domain */
17b75eca RW	58	wait_queue_head_t status_wait_queue;
c6d22b37 RW	59	struct task_struct poweroff_task; / Powering off task */
c6d22b37 RW	60	unsigned int resume_count; /* Number of devices being resumed */
596ba34b RW	61	unsigned int device_count; /* Number of devices */
	62	unsigned int suspended_count; /* System suspend device counter */
	63	unsigned int prepared_count; /* Suspend counter of prepared devices */
	64	bool suspend_power_off; /* Power status before system suspend */
0aa2a221	65	bool dev_irq_safe; /* Device callbacks are IRQ-safe */
f721889f	66	int (power_off)(struct generic_pm_domain domain);
221e9b58	67	s64 power_off_latency_ns;
f721889f	68	int (power_on)(struct generic_pm_domain domain);
221e9b58	69	s64 power_on_latency_ns;
d5e4cbfe	70	struct gpd_dev_ops dev_ops;
221e9b58 RW	71	s64 break_even_ns; /* Power break even for the entire domain. */
	72	s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
	73	ktime_t power_off_time;
c8aa130b	74	struct device_node of_node; / Node in device tree */
f721889f RW	75	};
f721889f RW	76
596ba34b RW	77	static 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	82	struct 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 RW	89	struct gpd_timing_data {
	90	s64 stop_latency_ns;
	91	s64 start_latency_ns;
221e9b58 RW	92	s64 save_state_latency_ns;
221e9b58 RW	93	s64 restore_state_latency_ns;
b02c999a RW	94	s64 break_even_ns;
	95	};
	96
cd0ea672 RW	97	struct generic_pm_domain_data {
cd0ea672 RW	98	struct pm_domain_data base;
d5e4cbfe	99	struct gpd_dev_ops ops;
b02c999a	100	struct gpd_timing_data td;
cd0ea672 RW	101	bool need_restore;
	102	};
	103
	104	static inline struct generic_pm_domain_data to_gpd_data(struct pm_domain_data pdd)
	105	{
	106	return container_of(pdd, struct generic_pm_domain_data, base);
	107	}
	108
f721889f	109	#ifdef CONFIG_PM_GENERIC_DOMAINS
d5e4cbfe RW	110	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	111	{
	112	return to_gpd_data(dev->power.subsys_data->domain_data);
	113	}
	114
b02c999a RW	115	extern struct dev_power_governor simple_qos_governor;
	116
	117	extern struct generic_pm_domain dev_to_genpd(struct device dev);
	118	extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	119	struct device *dev,
	120	struct gpd_timing_data *td);
	121
c8aa130b TA	122	extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
	123	struct device *dev,
	124	struct gpd_timing_data *td);
	125
b02c999a RW	126	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	127	struct device *dev)
	128	{
	129	return __pm_genpd_add_device(genpd, dev, NULL);
	130	}
	131
c8aa130b TA	132	static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
	133	struct device *dev)
	134	{
	135	return __pm_genpd_of_add_device(genpd_node, dev, NULL);
	136	}
	137
f721889f RW	138	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	139	struct device *dev);
	140	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	141	struct generic_pm_domain *new_subdomain);
	142	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	143	struct generic_pm_domain *target);
b02c999a RW	144	extern int pm_genpd_add_callbacks(struct device *dev,
	145	struct gpd_dev_ops *ops,
	146	struct gpd_timing_data *td);
	147	extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
f721889f RW	148	extern void pm_genpd_init(struct generic_pm_domain *genpd,
f721889f RW	149	struct dev_power_governor *gov, bool is_off);
b02c999a	150
18b4f3f5	151	extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
b02c999a RW	152
	153	extern bool default_stop_ok(struct device *dev);
	154
925b44a2	155	extern struct dev_power_governor pm_domain_always_on_gov;
f721889f	156	#else
b02c999a RW	157
	158	static inline struct generic_pm_domain dev_to_genpd(struct device dev)
	159	{
	160	return ERR_PTR(-ENOSYS);
	161	}
	162	static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	163	struct device *dev,
	164	struct gpd_timing_data *td)
	165	{
	166	return -ENOSYS;
	167	}
f721889f RW	168	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	169	struct device *dev)
	170	{
	171	return -ENOSYS;
	172	}
	173	static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	174	struct device *dev)
	175	{
	176	return -ENOSYS;
	177	}
	178	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	179	struct generic_pm_domain *new_sd)
	180	{
	181	return -ENOSYS;
	182	}
	183	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	184	struct generic_pm_domain *target)
	185	{
	186	return -ENOSYS;
	187	}
d5e4cbfe	188	static inline int pm_genpd_add_callbacks(struct device *dev,
b02c999a RW	189	struct gpd_dev_ops *ops,
b02c999a RW	190	struct gpd_timing_data *td)
d5e4cbfe RW	191	{
	192	return -ENOSYS;
	193	}
b02c999a	194	static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
d5e4cbfe RW	195	{
	196	return -ENOSYS;
	197	}
b02c999a RW	198	static inline void pm_genpd_init(struct generic_pm_domain *genpd, bool is_off)
	199	{
	200	}
18b4f3f5 MD	201	static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
	202	{
	203	return -ENOSYS;
	204	}
b02c999a RW	205	static inline bool default_stop_ok(struct device *dev)
	206	{
	207	return false;
	208	}
925b44a2	209	#define pm_domain_always_on_gov NULL
17f2ae7f RW	210	#endif
17f2ae7f RW	211
b02c999a RW	212	static inline int pm_genpd_remove_callbacks(struct device *dev)
	213	{
	214	return __pm_genpd_remove_callbacks(dev, true);
	215	}
	216
17f2ae7f RW	217	#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
	218	extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
	219	extern void pm_genpd_poweroff_unused(void);
	220	#else
0bc5b2de	221	static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
17f2ae7f	222	static inline void pm_genpd_poweroff_unused(void) {}
f721889f RW	223	#endif
	224
	225	#endif /* _LINUX_PM_DOMAIN_H */