[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>

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

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

static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
				      struct device *dev)
{
	return __pm_genpd_add_device(genpd, 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);

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