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

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);
	int (*power_on)(struct generic_pm_domain *domain);
	int (*start_device)(struct device *dev);
	int (*stop_device)(struct device *dev);
	bool (*active_wakeup)(struct device *dev);
};

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

#ifdef CONFIG_PM_GENERIC_DOMAINS
extern int pm_genpd_add_device(struct generic_pm_domain *genpd,
			       struct device *dev);
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 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);
#else
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 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;
}
#endif

#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 {
	23	bool (power_down_ok)(struct dev_pm_domain domain);
	24	};
	25
	26	struct generic_pm_domain {
	27	struct dev_pm_domain domain; /* PM domain operations */
5125bbf3	28	struct list_head gpd_list_node; /* Node in the global PM domains list */
5063ce15 RW	29	struct list_head master_links; /* Links with PM domain as a master */
5063ce15 RW	30	struct list_head slave_links; /* Links with PM domain as a slave */
f721889f RW	31	struct list_head dev_list; /* List of devices */
	32	struct mutex lock;
	33	struct dev_power_governor *gov;
	34	struct work_struct power_off_work;
	35	unsigned int in_progress; /* Number of devices being suspended now */
c4bb3160	36	atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca RW	37	enum gpd_status status; /* Current state of the domain */
17b75eca RW	38	wait_queue_head_t status_wait_queue;
c6d22b37 RW	39	struct task_struct poweroff_task; / Powering off task */
c6d22b37 RW	40	unsigned int resume_count; /* Number of devices being resumed */
596ba34b RW	41	unsigned int device_count; /* Number of devices */
	42	unsigned int suspended_count; /* System suspend device counter */
	43	unsigned int prepared_count; /* Suspend counter of prepared devices */
	44	bool suspend_power_off; /* Power status before system suspend */
0aa2a221	45	bool dev_irq_safe; /* Device callbacks are IRQ-safe */
f721889f RW	46	int (power_off)(struct generic_pm_domain domain);
	47	int (power_on)(struct generic_pm_domain domain);
	48	int (start_device)(struct device dev);
	49	int (stop_device)(struct device dev);
d4f2d87a	50	bool (active_wakeup)(struct device dev);
f721889f RW	51	};
f721889f RW	52
596ba34b RW	53	static inline struct generic_pm_domain pd_to_genpd(struct dev_pm_domain pd)
	54	{
	55	return container_of(pd, struct generic_pm_domain, domain);
	56	}
	57
5063ce15 RW	58	struct gpd_link {
	59	struct generic_pm_domain *master;
	60	struct list_head master_node;
	61	struct generic_pm_domain *slave;
	62	struct list_head slave_node;
	63	};
	64
f721889f RW	65	#ifdef CONFIG_PM_GENERIC_DOMAINS
	66	extern int pm_genpd_add_device(struct generic_pm_domain *genpd,
	67	struct device *dev);
	68	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	69	struct device *dev);
	70	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	71	struct generic_pm_domain *new_subdomain);
	72	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	73	struct generic_pm_domain *target);
	74	extern void pm_genpd_init(struct generic_pm_domain *genpd,
	75	struct dev_power_governor *gov, bool is_off);
18b4f3f5	76	extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
f721889f RW	77	#else
	78	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	79	struct device *dev)
	80	{
	81	return -ENOSYS;
	82	}
	83	static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	84	struct device *dev)
	85	{
	86	return -ENOSYS;
	87	}
	88	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	89	struct generic_pm_domain *new_sd)
	90	{
	91	return -ENOSYS;
	92	}
	93	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	94	struct generic_pm_domain *target)
	95	{
	96	return -ENOSYS;
	97	}
	98	static inline void pm_genpd_init(struct generic_pm_domain *genpd,
	99	struct dev_power_governor *gov, bool is_off) {}
18b4f3f5 MD	100	static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
	101	{
	102	return -ENOSYS;
	103	}
17f2ae7f RW	104	#endif
	105
	106	#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
	107	extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
	108	extern void pm_genpd_poweroff_unused(void);
	109	#else
0bc5b2de	110	static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
17f2ae7f	111	static inline void pm_genpd_poweroff_unused(void) {}
f721889f RW	112	#endif
	113
	114	#endif /* _LINUX_PM_DOMAIN_H */