[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/spinlock.h>

/* Defines used for the flags field in the struct generic_pm_domain */
#define GENPD_FLAG_PM_CLK	(1U << 0) /* PM domain uses PM clk */
#define GENPD_FLAG_IRQ_SAFE	(1U << 1) /* PM domain operates in atomic */

enum gpd_status {
	GPD_STATE_ACTIVE = 0,	/* PM domain is active */
	GPD_STATE_POWER_OFF,	/* PM domain is off */
};

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

struct gpd_dev_ops {
	int (*start)(struct device *dev);
	int (*stop)(struct device *dev);
	bool (*active_wakeup)(struct device *dev);
};

struct genpd_power_state {
	s64 power_off_latency_ns;
	s64 power_on_latency_ns;
	s64 residency_ns;
	struct fwnode_handle *fwnode;
};

struct genpd_lock_ops;

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 dev_power_governor *gov;
	struct work_struct power_off_work;
	struct fwnode_handle *provider;	/* Identity of the domain provider */
	bool has_provider;
	const char *name;
	atomic_t sd_count;	/* Number of subdomains with power "on" */
	enum gpd_status status;	/* Current state of the domain */
	unsigned int device_count;	/* Number of devices */
	unsigned int suspended_count;	/* System suspend device counter */
	unsigned int prepared_count;	/* Suspend counter of prepared devices */
	int (*power_off)(struct generic_pm_domain *domain);
	int (*power_on)(struct generic_pm_domain *domain);
	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;
	int (*attach_dev)(struct generic_pm_domain *domain,
			  struct device *dev);
	void (*detach_dev)(struct generic_pm_domain *domain,
			   struct device *dev);
	unsigned int flags;		/* Bit field of configs for genpd */
	struct genpd_power_state *states;
	unsigned int state_count; /* number of states */
	unsigned int state_idx; /* state that genpd will go to when off */
	void *free; /* Free the state that was allocated for default */
	const struct genpd_lock_ops *lock_ops;
	union {
		struct mutex mlock;
		struct {
			spinlock_t slock;
			unsigned long lock_flags;
		};
	};

};

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 suspend_latency_ns;
	s64 resume_latency_ns;
	s64 effective_constraint_ns;
	bool constraint_changed;
	bool cached_suspend_ok;
};

struct pm_domain_data {
	struct list_head list_node;
	struct device *dev;
};

struct generic_pm_domain_data {
	struct pm_domain_data base;
	struct gpd_timing_data td;
	struct notifier_block nb;
};

#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 int __pm_genpd_add_device(struct generic_pm_domain *genpd,
				 struct device *dev,
				 struct gpd_timing_data *td);

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_init(struct generic_pm_domain *genpd,
			 struct dev_power_governor *gov, bool is_off);
extern int pm_genpd_remove(struct generic_pm_domain *genpd);

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 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_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_init(struct generic_pm_domain *genpd,
				struct dev_power_governor *gov, bool is_off)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
{
	return -ENOTSUPP;
}

#define simple_qos_governor		(*(struct dev_power_governor *)(NULL))
#define pm_domain_always_on_gov		(*(struct dev_power_governor *)(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);
}

#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

/* OF PM domain providers */
struct of_device_id;

struct genpd_onecell_data {
	struct generic_pm_domain **domains;
	unsigned int num_domains;
};

#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
int of_genpd_add_provider_simple(struct device_node *np,
				 struct generic_pm_domain *genpd);
int of_genpd_add_provider_onecell(struct device_node *np,
				  struct genpd_onecell_data *data);
void of_genpd_del_provider(struct device_node *np);
extern int of_genpd_add_device(struct of_phandle_args *args,
			       struct device *dev);
extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
				  struct of_phandle_args *new_subdomain);
extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
extern int of_genpd_parse_idle_states(struct device_node *dn,
			struct genpd_power_state **states, int *n);

int genpd_dev_pm_attach(struct device *dev);
#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
static inline int of_genpd_add_provider_simple(struct device_node *np,
					struct generic_pm_domain *genpd)
{
	return -ENOTSUPP;
}

static inline int of_genpd_add_provider_onecell(struct device_node *np,
					struct genpd_onecell_data *data)
{
	return -ENOTSUPP;
}

static inline void of_genpd_del_provider(struct device_node *np) {}

static inline int of_genpd_add_device(struct of_phandle_args *args,
				      struct device *dev)
{
	return -ENODEV;
}

static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
					 struct of_phandle_args *new_subdomain)
{
	return -ENODEV;
}

static inline int of_genpd_parse_idle_states(struct device_node *dn,
			struct genpd_power_state **states, int *n)
{
	return -ENODEV;
}

static inline int genpd_dev_pm_attach(struct device *dev)
{
	return -ENODEV;
}

static inline
struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
{
	return ERR_PTR(-ENOTSUPP);
}
#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */

#ifdef CONFIG_PM
extern int dev_pm_domain_attach(struct device *dev, bool power_on);
extern void dev_pm_domain_detach(struct device *dev, bool power_off);
extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
#else
static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
{
	return -ENODEV;
}
static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
static inline void dev_pm_domain_set(struct device *dev,
				     struct dev_pm_domain *pd) {}
#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>
d716f479	18	#include <linux/spinlock.h>
f721889f	19
c11f6f5b UH	20	/* Defines used for the flags field in the struct generic_pm_domain */
c11f6f5b UH	21	#define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */
d716f479	22	#define GENPD_FLAG_IRQ_SAFE (1U << 1) /* PM domain operates in atomic */
c11f6f5b	23
17b75eca RW	24	enum gpd_status {
17b75eca RW	25	GPD_STATE_ACTIVE = 0, /* PM domain is active */
17b75eca RW	26	GPD_STATE_POWER_OFF, /* PM domain is off */
17b75eca RW	27	};
596ba34b	28
f721889f RW	29	struct dev_power_governor {
f721889f RW	30	bool (power_down_ok)(struct dev_pm_domain domain);
9df3921e	31	bool (suspend_ok)(struct device dev);
f721889f RW	32	};
f721889f RW	33
d5e4cbfe RW	34	struct gpd_dev_ops {
	35	int (start)(struct device dev);
	36	int (stop)(struct device dev);
	37	bool (active_wakeup)(struct device dev);
	38	};
	39
fc5cbf0c AH	40	struct genpd_power_state {
	41	s64 power_off_latency_ns;
	42	s64 power_on_latency_ns;
405f7226	43	s64 residency_ns;
0c9b694a	44	struct fwnode_handle *fwnode;
fc5cbf0c AH	45	};
fc5cbf0c AH	46
35241d12 LI	47	struct genpd_lock_ops;
35241d12 LI	48
f721889f RW	49	struct generic_pm_domain {
f721889f RW	50	struct dev_pm_domain domain; /* PM domain operations */
5125bbf3	51	struct list_head gpd_list_node; /* Node in the global PM domains list */
5063ce15 RW	52	struct list_head master_links; /* Links with PM domain as a master */
5063ce15 RW	53	struct list_head slave_links; /* Links with PM domain as a slave */
f721889f	54	struct list_head dev_list; /* List of devices */
f721889f RW	55	struct dev_power_governor *gov;
f721889f RW	56	struct work_struct power_off_work;
de0aa06d JH	57	struct fwnode_handle provider; / Identity of the domain provider */
de0aa06d JH	58	bool has_provider;
d07e9c17	59	const char *name;
c4bb3160	60	atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca	61	enum gpd_status status; /* Current state of the domain */
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 */
f721889f RW	65	int (power_off)(struct generic_pm_domain domain);
f721889f RW	66	int (power_on)(struct generic_pm_domain domain);
d5e4cbfe	67	struct gpd_dev_ops dev_ops;
221e9b58	68	s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
6ff7bb0d RW	69	bool max_off_time_changed;
6ff7bb0d RW	70	bool cached_power_down_ok;
c16561e8 UH	71	int (attach_dev)(struct generic_pm_domain domain,
	72	struct device *dev);
	73	void (detach_dev)(struct generic_pm_domain domain,
	74	struct device *dev);
c11f6f5b	75	unsigned int flags; /* Bit field of configs for genpd */
59d65b73	76	struct genpd_power_state *states;
fc5cbf0c AH	77	unsigned int state_count; /* number of states */
fc5cbf0c AH	78	unsigned int state_idx; /* state that genpd will go to when off */
59d65b73	79	void free; / Free the state that was allocated for default */
35241d12	80	const struct genpd_lock_ops *lock_ops;
d716f479 LI	81	union {
	82	struct mutex mlock;
	83	struct {
	84	spinlock_t slock;
	85	unsigned long lock_flags;
	86	};
	87	};
fc5cbf0c	88
f721889f RW	89	};
f721889f RW	90
596ba34b RW	91	static inline struct generic_pm_domain pd_to_genpd(struct dev_pm_domain pd)
	92	{
	93	return container_of(pd, struct generic_pm_domain, domain);
	94	}
	95
5063ce15 RW	96	struct gpd_link {
	97	struct generic_pm_domain *master;
	98	struct list_head master_node;
	99	struct generic_pm_domain *slave;
	100	struct list_head slave_node;
	101	};
	102
b02c999a	103	struct gpd_timing_data {
2b1d88cd UH	104	s64 suspend_latency_ns;
2b1d88cd UH	105	s64 resume_latency_ns;
a5bef810	106	s64 effective_constraint_ns;
6ff7bb0d	107	bool constraint_changed;
9df3921e	108	bool cached_suspend_ok;
b02c999a RW	109	};
b02c999a RW	110
00e7c295 UH	111	struct pm_domain_data {
	112	struct list_head list_node;
	113	struct device *dev;
	114	};
	115
cd0ea672 RW	116	struct generic_pm_domain_data {
cd0ea672 RW	117	struct pm_domain_data base;
b02c999a	118	struct gpd_timing_data td;
6ff7bb0d	119	struct notifier_block nb;
cd0ea672 RW	120	};
cd0ea672 RW	121
9b4f617b	122	#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672 RW	123	static inline struct generic_pm_domain_data to_gpd_data(struct pm_domain_data pdd)
	124	{
	125	return container_of(pdd, struct generic_pm_domain_data, base);
	126	}
	127
d5e4cbfe RW	128	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	129	{
	130	return to_gpd_data(dev->power.subsys_data->domain_data);
	131	}
	132
b02c999a RW	133	extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	134	struct device *dev,
	135	struct gpd_timing_data *td);
	136
f721889f RW	137	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	138	struct device *dev);
	139	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	140	struct generic_pm_domain *new_subdomain);
	141	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	142	struct generic_pm_domain *target);
7eb231c3 UH	143	extern int pm_genpd_init(struct generic_pm_domain *genpd,
7eb231c3 UH	144	struct dev_power_governor *gov, bool is_off);
3fe57710	145	extern int pm_genpd_remove(struct generic_pm_domain *genpd);
b02c999a	146
ae3c511c	147	extern struct dev_power_governor simple_qos_governor;
925b44a2	148	extern struct dev_power_governor pm_domain_always_on_gov;
f721889f	149	#else
b02c999a	150
b642631d MD	151	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	152	{
	153	return ERR_PTR(-ENOSYS);
	154	}
b02c999a RW	155	static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	156	struct device *dev,
	157	struct gpd_timing_data *td)
	158	{
	159	return -ENOSYS;
	160	}
f721889f RW	161	static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	162	struct device *dev)
	163	{
	164	return -ENOSYS;
	165	}
	166	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	167	struct generic_pm_domain *new_sd)
	168	{
	169	return -ENOSYS;
	170	}
	171	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	172	struct generic_pm_domain *target)
	173	{
	174	return -ENOSYS;
	175	}
7eb231c3 UH	176	static inline int pm_genpd_init(struct generic_pm_domain *genpd,
7eb231c3 UH	177	struct dev_power_governor *gov, bool is_off)
b02c999a	178	{
7eb231c3	179	return -ENOSYS;
b02c999a	180	}
3fe57710 JH	181	static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
	182	{
	183	return -ENOTSUPP;
	184	}
16d0bf18 GU	185
	186	#define simple_qos_governor ((struct dev_power_governor )(NULL))
	187	#define pm_domain_always_on_gov ((struct dev_power_governor )(NULL))
17f2ae7f RW	188	#endif
17f2ae7f RW	189
b5abb085 RW	190	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	191	struct device *dev)
	192	{
	193	return __pm_genpd_add_device(genpd, dev, NULL);
	194	}
	195
77f827de	196	#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
d47e6464 UH	197	extern void pm_genpd_syscore_poweroff(struct device *dev);
d47e6464 UH	198	extern void pm_genpd_syscore_poweron(struct device *dev);
77f827de	199	#else
d47e6464 UH	200	static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
d47e6464 UH	201	static inline void pm_genpd_syscore_poweron(struct device *dev) {}
77f827de RW	202	#endif
77f827de RW	203
aa42240a TF	204	/* OF PM domain providers */
	205	struct of_device_id;
	206
	207	struct genpd_onecell_data {
	208	struct generic_pm_domain **domains;
	209	unsigned int num_domains;
	210	};
	211
aa42240a	212	#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
892ebdcc JH	213	int of_genpd_add_provider_simple(struct device_node *np,
	214	struct generic_pm_domain *genpd);
	215	int of_genpd_add_provider_onecell(struct device_node *np,
	216	struct genpd_onecell_data *data);
aa42240a	217	void of_genpd_del_provider(struct device_node *np);
ec69572b JH	218	extern int of_genpd_add_device(struct of_phandle_args *args,
	219	struct device *dev);
	220	extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
	221	struct of_phandle_args *new_subdomain);
17926551	222	extern struct generic_pm_domain of_genpd_remove_last(struct device_node np);
30f60428 LI	223	extern int of_genpd_parse_idle_states(struct device_node *dn,
30f60428 LI	224	struct genpd_power_state *states, int n);
aa42240a TF	225
	226	int genpd_dev_pm_attach(struct device *dev);
	227	#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
892ebdcc JH	228	static inline int of_genpd_add_provider_simple(struct device_node *np,
892ebdcc JH	229	struct generic_pm_domain *genpd)
aa42240a	230	{
892ebdcc JH	231	return -ENOTSUPP;
	232	}
	233
	234	static inline int of_genpd_add_provider_onecell(struct device_node *np,
	235	struct genpd_onecell_data *data)
	236	{
	237	return -ENOTSUPP;
aa42240a	238	}
aa42240a	239
892ebdcc	240	static inline void of_genpd_del_provider(struct device_node *np) {}
aa42240a	241
ec69572b JH	242	static inline int of_genpd_add_device(struct of_phandle_args *args,
	243	struct device *dev)
	244	{
	245	return -ENODEV;
	246	}
	247
	248	static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
	249	struct of_phandle_args *new_subdomain)
	250	{
	251	return -ENODEV;
	252	}
	253
30f60428 LI	254	static inline int of_genpd_parse_idle_states(struct device_node *dn,
	255	struct genpd_power_state *states, int n)
	256	{
	257	return -ENODEV;
	258	}
	259
aa42240a TF	260	static inline int genpd_dev_pm_attach(struct device *dev)
	261	{
	262	return -ENODEV;
	263	}
17926551 JH	264
	265	static inline
	266	struct generic_pm_domain of_genpd_remove_last(struct device_node np)
	267	{
	268	return ERR_PTR(-ENOTSUPP);
	269	}
aa42240a TF	270	#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
aa42240a TF	271
f48c767c UH	272	#ifdef CONFIG_PM
	273	extern int dev_pm_domain_attach(struct device *dev, bool power_on);
	274	extern void dev_pm_domain_detach(struct device *dev, bool power_off);
989561de	275	extern void dev_pm_domain_set(struct device dev, struct dev_pm_domain pd);
f48c767c UH	276	#else
	277	static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
	278	{
	279	return -ENODEV;
	280	}
	281	static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
989561de TV	282	static inline void dev_pm_domain_set(struct device *dev,
989561de TV	283	struct dev_pm_domain *pd) {}
f48c767c UH	284	#endif
f48c767c UH	285
f721889f	286	#endif /* _LINUX_PM_DOMAIN_H */