[mirror_ubuntu-jammy-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);
	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;
	const 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 */
	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_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 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_attach_cpuidle(struct generic_pm_domain *genpd, int state);
extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
extern int pm_genpd_name_detach_cpuidle(const char *name);
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 int pm_genpd_name_poweron(const char *domain_name);

extern struct dev_power_governor simple_qos_governor;
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_attach_cpuidle(struct generic_pm_domain *genpd, int st)
{
	return -ENOSYS;
}
static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
{
	return -ENOSYS;
}
static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
{
	return -ENOSYS;
}
static inline int pm_genpd_name_detach_cpuidle(const char *name)
{
	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 int pm_genpd_name_poweron(const char *domain_name)
{
	return -ENOSYS;
}
#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);
}

#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
extern void pm_genpd_poweroff_unused(void);
#else
static inline void pm_genpd_poweroff_unused(void) {}
#endif

#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
extern void pm_genpd_syscore_poweroff(struct device *dev);
extern void pm_genpd_syscore_poweron(struct device *dev);
#else
static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
static inline void pm_genpd_syscore_poweron(struct device *dev) {}
#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);
d5e4cbfe RW	38	bool (active_wakeup)(struct device dev);
	39	};
	40
cbc9ef02 RW	41	struct gpd_cpu_data {
	42	unsigned int saved_exit_latency;
	43	struct cpuidle_state *idle_state;
	44	};
	45
f721889f RW	46	struct generic_pm_domain {
f721889f RW	47	struct dev_pm_domain domain; /* PM domain operations */
5125bbf3	48	struct list_head gpd_list_node; /* Node in the global PM domains list */
5063ce15 RW	49	struct list_head master_links; /* Links with PM domain as a master */
5063ce15 RW	50	struct list_head slave_links; /* Links with PM domain as a slave */
f721889f RW	51	struct list_head dev_list; /* List of devices */
	52	struct mutex lock;
	53	struct dev_power_governor *gov;
	54	struct work_struct power_off_work;
d07e9c17	55	const char *name;
f721889f	56	unsigned int in_progress; /* Number of devices being suspended now */
c4bb3160	57	atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca RW	58	enum gpd_status status; /* Current state of the domain */
17b75eca RW	59	wait_queue_head_t status_wait_queue;
c6d22b37 RW	60	struct task_struct poweroff_task; / Powering off task */
c6d22b37 RW	61	unsigned int resume_count; /* Number of devices being resumed */
596ba34b RW	62	unsigned int device_count; /* Number of devices */
	63	unsigned int suspended_count; /* System suspend device counter */
	64	unsigned int prepared_count; /* Suspend counter of prepared devices */
	65	bool suspend_power_off; /* Power status before system suspend */
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	71	s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
6ff7bb0d RW	72	bool max_off_time_changed;
6ff7bb0d RW	73	bool cached_power_down_ok;
c8aa130b	74	struct device_node of_node; / Node in device tree */
cbc9ef02	75	struct gpd_cpu_data *cpu_data;
f721889f RW	76	};
f721889f RW	77
596ba34b RW	78	static inline struct generic_pm_domain pd_to_genpd(struct dev_pm_domain pd)
	79	{
	80	return container_of(pd, struct generic_pm_domain, domain);
	81	}
	82
5063ce15 RW	83	struct gpd_link {
	84	struct generic_pm_domain *master;
	85	struct list_head master_node;
	86	struct generic_pm_domain *slave;
	87	struct list_head slave_node;
	88	};
	89
b02c999a RW	90	struct gpd_timing_data {
	91	s64 stop_latency_ns;
	92	s64 start_latency_ns;
221e9b58 RW	93	s64 save_state_latency_ns;
221e9b58 RW	94	s64 restore_state_latency_ns;
a5bef810	95	s64 effective_constraint_ns;
6ff7bb0d RW	96	bool constraint_changed;
6ff7bb0d RW	97	bool cached_stop_ok;
b02c999a RW	98	};
b02c999a RW	99
cd0ea672 RW	100	struct generic_pm_domain_data {
cd0ea672 RW	101	struct pm_domain_data base;
b02c999a	102	struct gpd_timing_data td;
6ff7bb0d RW	103	struct notifier_block nb;
6ff7bb0d RW	104	struct mutex lock;
1d5fcfec	105	unsigned int refcount;
cd0ea672 RW	106	bool need_restore;
	107	};
	108
9b4f617b	109	#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672 RW	110	static inline struct generic_pm_domain_data to_gpd_data(struct pm_domain_data pdd)
	111	{
	112	return container_of(pdd, struct generic_pm_domain_data, base);
	113	}
	114
d5e4cbfe RW	115	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	116	{
	117	return to_gpd_data(dev->power.subsys_data->domain_data);
	118	}
	119
b02c999a RW	120	extern struct generic_pm_domain dev_to_genpd(struct device dev);
	121	extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	122	struct device *dev,
	123	struct gpd_timing_data *td);
	124
c8aa130b TA	125	extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
	126	struct device *dev,
	127	struct gpd_timing_data *td);
	128
b5abb085 RW	129	extern int __pm_genpd_name_add_device(const char *domain_name,
	130	struct device *dev,
	131	struct gpd_timing_data *td);
c8aa130b	132
f721889f RW	133	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
f721889f RW	134	struct device *dev);
ca1d72f0	135	extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
f721889f RW	136	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
f721889f RW	137	struct generic_pm_domain *new_subdomain);
fb7268be RW	138	extern int pm_genpd_add_subdomain_names(const char *master_name,
fb7268be RW	139	const char *subdomain_name);
f721889f RW	140	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
f721889f RW	141	struct generic_pm_domain *target);
40114447	142	extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
74a2799a	143	extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
40114447	144	extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
74a2799a	145	extern int pm_genpd_name_detach_cpuidle(const char *name);
f721889f RW	146	extern void pm_genpd_init(struct generic_pm_domain *genpd,
f721889f RW	147	struct dev_power_governor *gov, bool is_off);
b02c999a	148
18b4f3f5	149	extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
8bc0251d	150	extern int pm_genpd_name_poweron(const char *domain_name);
b02c999a	151
ae3c511c	152	extern struct dev_power_governor simple_qos_governor;
925b44a2	153	extern struct dev_power_governor pm_domain_always_on_gov;
f721889f	154	#else
b02c999a	155
b642631d MD	156	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	157	{
	158	return ERR_PTR(-ENOSYS);
	159	}
b02c999a RW	160	static inline struct generic_pm_domain dev_to_genpd(struct device dev)
	161	{
	162	return ERR_PTR(-ENOSYS);
	163	}
	164	static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	165	struct device *dev,
	166	struct gpd_timing_data *td)
	167	{
	168	return -ENOSYS;
	169	}
b5abb085 RW	170	static inline int __pm_genpd_of_add_device(struct device_node *genpd_node,
	171	struct device *dev,
	172	struct gpd_timing_data *td)
	173	{
	174	return -ENOSYS;
	175	}
	176	static inline int __pm_genpd_name_add_device(const char *domain_name,
	177	struct device *dev,
	178	struct gpd_timing_data *td)
f721889f RW	179	{
	180	return -ENOSYS;
	181	}
	182	static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	183	struct device *dev)
	184	{
	185	return -ENOSYS;
	186	}
ca1d72f0	187	static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
f721889f RW	188	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	189	struct generic_pm_domain *new_sd)
	190	{
	191	return -ENOSYS;
	192	}
fb7268be RW	193	static inline int pm_genpd_add_subdomain_names(const char *master_name,
	194	const char *subdomain_name)
	195	{
	196	return -ENOSYS;
	197	}
f721889f RW	198	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	199	struct generic_pm_domain *target)
	200	{
	201	return -ENOSYS;
	202	}
40114447	203	static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
cbc9ef02 RW	204	{
	205	return -ENOSYS;
	206	}
74a2799a RW	207	static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
	208	{
	209	return -ENOSYS;
	210	}
40114447	211	static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
cbc9ef02 RW	212	{
	213	return -ENOSYS;
	214	}
74a2799a RW	215	static inline int pm_genpd_name_detach_cpuidle(const char *name)
	216	{
	217	return -ENOSYS;
	218	}
b642631d MD	219	static inline void pm_genpd_init(struct generic_pm_domain *genpd,
b642631d MD	220	struct dev_power_governor *gov, bool is_off)
b02c999a RW	221	{
b02c999a RW	222	}
18b4f3f5 MD	223	static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
	224	{
	225	return -ENOSYS;
	226	}
8bc0251d RW	227	static inline int pm_genpd_name_poweron(const char *domain_name)
	228	{
	229	return -ENOSYS;
	230	}
b642631d	231	#define simple_qos_governor NULL
925b44a2	232	#define pm_domain_always_on_gov NULL
17f2ae7f RW	233	#endif
17f2ae7f RW	234
b5abb085 RW	235	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	236	struct device *dev)
	237	{
	238	return __pm_genpd_add_device(genpd, dev, NULL);
	239	}
	240
	241	static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
	242	struct device *dev)
	243	{
	244	return __pm_genpd_of_add_device(genpd_node, dev, NULL);
	245	}
	246
	247	static inline int pm_genpd_name_add_device(const char *domain_name,
	248	struct device *dev)
	249	{
	250	return __pm_genpd_name_add_device(domain_name, dev, NULL);
	251	}
	252
17f2ae7f	253	#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
17f2ae7f RW	254	extern void pm_genpd_poweroff_unused(void);
17f2ae7f RW	255	#else
17f2ae7f	256	static inline void pm_genpd_poweroff_unused(void) {}
f721889f RW	257	#endif
f721889f RW	258
77f827de	259	#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
d47e6464 UH	260	extern void pm_genpd_syscore_poweroff(struct device *dev);
d47e6464 UH	261	extern void pm_genpd_syscore_poweron(struct device *dev);
77f827de	262	#else
d47e6464 UH	263	static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
d47e6464 UH	264	static inline void pm_genpd_syscore_poweron(struct device *dev) {}
77f827de RW	265	#endif
77f827de RW	266
f721889f	267	#endif /* _LINUX_PM_DOMAIN_H */