[mirror_ubuntu-focal-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;
	unsigned int refcount;
	bool need_restore;
};

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

extern int __pm_genpd_name_add_device(const char *domain_name,
				      struct device *dev,
				      struct gpd_timing_data *td);

extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
				  struct device *dev);
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_add_subdomain_names(const char *master_name,
					const char *subdomain_name);
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_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)
{
	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_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_add_subdomain_names(const char *master_name,
					       const char *subdomain_name)
{
	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_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);
}

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

#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
extern void pm_genpd_syscore_switch(struct device *dev, bool suspend);
#else
static inline void pm_genpd_syscore_switch(struct device *dev, bool suspend) {}
#endif

static inline void pm_genpd_syscore_poweroff(struct device *dev)
{
	pm_genpd_syscore_switch(dev, true);
}

static inline void pm_genpd_syscore_poweron(struct device *dev)
{
	pm_genpd_syscore_switch(dev, false);
}

#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;
1d5fcfec	115	unsigned int refcount;
cd0ea672 RW	116	bool need_restore;
	117	};
	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
b5abb085 RW	141	extern int __pm_genpd_name_add_device(const char *domain_name,
	142	struct device *dev,
	143	struct gpd_timing_data *td);
c8aa130b	144
f721889f RW	145	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
f721889f RW	146	struct device *dev);
ca1d72f0	147	extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
f721889f RW	148	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
f721889f RW	149	struct generic_pm_domain *new_subdomain);
fb7268be RW	150	extern int pm_genpd_add_subdomain_names(const char *master_name,
fb7268be RW	151	const char *subdomain_name);
f721889f RW	152	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
f721889f RW	153	struct generic_pm_domain *target);
b02c999a RW	154	extern int pm_genpd_add_callbacks(struct device *dev,
	155	struct gpd_dev_ops *ops,
	156	struct gpd_timing_data *td);
	157	extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
cbc9ef02 RW	158	extern int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
cbc9ef02 RW	159	extern int genpd_detach_cpuidle(struct generic_pm_domain *genpd);
f721889f RW	160	extern void pm_genpd_init(struct generic_pm_domain *genpd,
f721889f RW	161	struct dev_power_governor *gov, bool is_off);
b02c999a	162
18b4f3f5	163	extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
b02c999a RW	164
	165	extern bool default_stop_ok(struct device *dev);
	166
925b44a2	167	extern struct dev_power_governor pm_domain_always_on_gov;
f721889f	168	#else
b02c999a	169
b642631d MD	170	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	171	{
	172	return ERR_PTR(-ENOSYS);
	173	}
b02c999a RW	174	static inline struct generic_pm_domain dev_to_genpd(struct device dev)
	175	{
	176	return ERR_PTR(-ENOSYS);
	177	}
	178	static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	179	struct device *dev,
	180	struct gpd_timing_data *td)
	181	{
	182	return -ENOSYS;
	183	}
b5abb085 RW	184	static inline int __pm_genpd_of_add_device(struct device_node *genpd_node,
	185	struct device *dev,
	186	struct gpd_timing_data *td)
	187	{
	188	return -ENOSYS;
	189	}
	190	static inline int __pm_genpd_name_add_device(const char *domain_name,
	191	struct device *dev,
	192	struct gpd_timing_data *td)
f721889f RW	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	}
ca1d72f0	201	static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
f721889f RW	202	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	203	struct generic_pm_domain *new_sd)
	204	{
	205	return -ENOSYS;
	206	}
fb7268be RW	207	static inline int pm_genpd_add_subdomain_names(const char *master_name,
	208	const char *subdomain_name)
	209	{
	210	return -ENOSYS;
	211	}
f721889f RW	212	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	213	struct generic_pm_domain *target)
	214	{
	215	return -ENOSYS;
	216	}
d5e4cbfe	217	static inline int pm_genpd_add_callbacks(struct device *dev,
b02c999a RW	218	struct gpd_dev_ops *ops,
b02c999a RW	219	struct gpd_timing_data *td)
d5e4cbfe RW	220	{
	221	return -ENOSYS;
	222	}
b02c999a	223	static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
d5e4cbfe RW	224	{
	225	return -ENOSYS;
	226	}
cbc9ef02 RW	227	static inline int genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
	228	{
	229	return -ENOSYS;
	230	}
	231	static inline int genpd_detach_cpuidle(struct generic_pm_domain *genpd)
	232	{
	233	return -ENOSYS;
	234	}
b642631d MD	235	static inline void pm_genpd_init(struct generic_pm_domain *genpd,
b642631d MD	236	struct dev_power_governor *gov, bool is_off)
b02c999a RW	237	{
b02c999a RW	238	}
18b4f3f5 MD	239	static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
	240	{
	241	return -ENOSYS;
	242	}
b02c999a RW	243	static inline bool default_stop_ok(struct device *dev)
	244	{
	245	return false;
	246	}
b642631d	247	#define simple_qos_governor NULL
925b44a2	248	#define pm_domain_always_on_gov NULL
17f2ae7f RW	249	#endif
17f2ae7f RW	250
b5abb085 RW	251	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	252	struct device *dev)
	253	{
	254	return __pm_genpd_add_device(genpd, dev, NULL);
	255	}
	256
	257	static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
	258	struct device *dev)
	259	{
	260	return __pm_genpd_of_add_device(genpd_node, dev, NULL);
	261	}
	262
	263	static inline int pm_genpd_name_add_device(const char *domain_name,
	264	struct device *dev)
	265	{
	266	return __pm_genpd_name_add_device(domain_name, dev, NULL);
	267	}
	268
b02c999a RW	269	static inline int pm_genpd_remove_callbacks(struct device *dev)
	270	{
	271	return __pm_genpd_remove_callbacks(dev, true);
	272	}
	273
17f2ae7f RW	274	#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
	275	extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
	276	extern void pm_genpd_poweroff_unused(void);
	277	#else
0bc5b2de	278	static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
17f2ae7f	279	static inline void pm_genpd_poweroff_unused(void) {}
f721889f RW	280	#endif
f721889f RW	281
77f827de RW	282	#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
	283	extern void pm_genpd_syscore_switch(struct device *dev, bool suspend);
	284	#else
	285	static inline void pm_genpd_syscore_switch(struct device *dev, bool suspend) {}
	286	#endif
	287
	288	static inline void pm_genpd_syscore_poweroff(struct device *dev)
	289	{
	290	pm_genpd_syscore_switch(dev, true);
	291	}
	292
	293	static inline void pm_genpd_syscore_poweron(struct device *dev)
	294	{
	295	pm_genpd_syscore_switch(dev, false);
	296	}
	297
f721889f	298	#endif /* _LINUX_PM_DOMAIN_H */