[linux-block.git] / include / linux / pm_domain.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * pm_domain.h - Definitions and headers related to device power domains.
 *
 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
 */

#ifndef _LINUX_PM_DOMAIN_H
#define _LINUX_PM_DOMAIN_H

#include <linux/device.h>
#include <linux/ktime.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>
#include <linux/cpumask_types.h>
#include <linux/time64.h>

/*
 * Flags to control the behaviour when attaching a device to its PM domains.
 *
 * PD_FLAG_NO_DEV_LINK:		As the default behaviour creates a device-link
 *				for every PM domain that gets attached, this
 *				flag can be used to skip that.
 *
 * PD_FLAG_DEV_LINK_ON:		Add the DL_FLAG_RPM_ACTIVE to power-on the
 *				supplier and its PM domain when creating the
 *				device-links.
 *
 */
#define PD_FLAG_NO_DEV_LINK		BIT(0)
#define PD_FLAG_DEV_LINK_ON		BIT(1)

struct dev_pm_domain_attach_data {
	const char * const *pd_names;
	const u32 num_pd_names;
	const u32 pd_flags;
};

struct dev_pm_domain_list {
	struct device **pd_devs;
	struct device_link **pd_links;
	u32 num_pds;
};

/*
 * Flags to control the behaviour of a genpd.
 *
 * These flags may be set in the struct generic_pm_domain's flags field by a
 * genpd backend driver. The flags must be set before it calls pm_genpd_init(),
 * which initializes a genpd.
 *
 * GENPD_FLAG_PM_CLK:		Instructs genpd to use the PM clk framework,
 *				while powering on/off attached devices.
 *
 * GENPD_FLAG_IRQ_SAFE:		This informs genpd that its backend callbacks,
 *				->power_on|off(), doesn't sleep. Hence, these
 *				can be invoked from within atomic context, which
 *				enables genpd to power on/off the PM domain,
 *				even when pm_runtime_is_irq_safe() returns true,
 *				for any of its attached devices. Note that, a
 *				genpd having this flag set, requires its
 *				masterdomains to also have it set.
 *
 * GENPD_FLAG_ALWAYS_ON:	Instructs genpd to always keep the PM domain
 *				powered on.
 *
 * GENPD_FLAG_ACTIVE_WAKEUP:	Instructs genpd to keep the PM domain powered
 *				on, in case any of its attached devices is used
 *				in the wakeup path to serve system wakeups.
 *
 * GENPD_FLAG_CPU_DOMAIN:	Instructs genpd that it should expect to get
 *				devices attached, which may belong to CPUs or
 *				possibly have subdomains with CPUs attached.
 *				This flag enables the genpd backend driver to
 *				deploy idle power management support for CPUs
 *				and groups of CPUs. Note that, the backend
 *				driver must then comply with the so called,
 *				last-man-standing algorithm, for the CPUs in the
 *				PM domain.
 *
 * GENPD_FLAG_RPM_ALWAYS_ON:	Instructs genpd to always keep the PM domain
 *				powered on except for system suspend.
 *
 * GENPD_FLAG_MIN_RESIDENCY:	Enable the genpd governor to consider its
 *				components' next wakeup when determining the
 *				optimal idle state.
 *
 * GENPD_FLAG_OPP_TABLE_FW:	The genpd provider supports performance states,
 *				but its corresponding OPP tables are not
 *				described in DT, but are given directly by FW.
 */
#define GENPD_FLAG_PM_CLK	 (1U << 0)
#define GENPD_FLAG_IRQ_SAFE	 (1U << 1)
#define GENPD_FLAG_ALWAYS_ON	 (1U << 2)
#define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3)
#define GENPD_FLAG_CPU_DOMAIN	 (1U << 4)
#define GENPD_FLAG_RPM_ALWAYS_ON (1U << 5)
#define GENPD_FLAG_MIN_RESIDENCY (1U << 6)
#define GENPD_FLAG_OPP_TABLE_FW	 (1U << 7)

enum gpd_status {
	GENPD_STATE_ON = 0,	/* PM domain is on */
	GENPD_STATE_OFF,	/* PM domain is off */
};

enum genpd_notication {
	GENPD_NOTIFY_PRE_OFF = 0,
	GENPD_NOTIFY_OFF,
	GENPD_NOTIFY_PRE_ON,
	GENPD_NOTIFY_ON,
};

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

struct genpd_governor_data {
	s64 max_off_time_ns;
	bool max_off_time_changed;
	ktime_t next_wakeup;
	ktime_t next_hrtimer;
	bool cached_power_down_ok;
	bool cached_power_down_state_idx;
};

struct genpd_power_state {
	s64 power_off_latency_ns;
	s64 power_on_latency_ns;
	s64 residency_ns;
	u64 usage;
	u64 rejected;
	struct fwnode_handle *fwnode;
	u64 idle_time;
	void *data;
};

struct genpd_lock_ops;
struct opp_table;

struct generic_pm_domain {
	struct device dev;
	struct dev_pm_domain domain;	/* PM domain operations */
	struct list_head gpd_list_node;	/* Node in the global PM domains list */
	struct list_head parent_links;	/* Links with PM domain as a parent */
	struct list_head child_links;	/* Links with PM domain as a child */
	struct list_head dev_list;	/* List of devices */
	struct dev_power_governor *gov;
	struct genpd_governor_data *gd;	/* Data used by a genpd governor. */
	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 */
	unsigned int performance_state;	/* Aggregated max performance state */
	cpumask_var_t cpus;		/* A cpumask of the attached CPUs */
	bool synced_poweroff;		/* A consumer needs a synced poweroff */
	int (*power_off)(struct generic_pm_domain *domain);
	int (*power_on)(struct generic_pm_domain *domain);
	struct raw_notifier_head power_notifiers; /* Power on/off notifiers */
	struct opp_table *opp_table;	/* OPP table of the genpd */
	int (*set_performance_state)(struct generic_pm_domain *genpd,
				     unsigned int state);
	struct gpd_dev_ops dev_ops;
	int (*set_hwmode_dev)(struct generic_pm_domain *domain,
			      struct device *dev, bool enable);
	bool (*get_hwmode_dev)(struct generic_pm_domain *domain,
			      struct device *dev);
	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;
	void (*free_states)(struct genpd_power_state *states,
			    unsigned int state_count);
	unsigned int state_count; /* number of states */
	unsigned int state_idx; /* state that genpd will go to when off */
	u64 on_time;
	u64 accounting_time;
	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 *parent;
	struct list_head parent_node;
	struct generic_pm_domain *child;
	struct list_head child_node;

	/* Sub-domain's per-master domain performance state */
	unsigned int performance_state;
	unsigned int prev_performance_state;
};

struct gpd_timing_data {
	s64 suspend_latency_ns;
	s64 resume_latency_ns;
	s64 effective_constraint_ns;
	ktime_t	next_wakeup;
	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;
	struct notifier_block *power_nb;
	int cpu;
	unsigned int performance_state;
	unsigned int default_pstate;
	unsigned int rpm_pstate;
	bool hw_mode;
	void *data;
};

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

int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev);
int pm_genpd_remove_device(struct device *dev);
int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
			   struct generic_pm_domain *subdomain);
int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
			      struct generic_pm_domain *subdomain);
int pm_genpd_init(struct generic_pm_domain *genpd,
		  struct dev_power_governor *gov, bool is_off);
int pm_genpd_remove(struct generic_pm_domain *genpd);
struct device *dev_to_genpd_dev(struct device *dev);
int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state);
int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb);
int dev_pm_genpd_remove_notifier(struct device *dev);
void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next);
ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev);
void dev_pm_genpd_synced_poweroff(struct device *dev);
int dev_pm_genpd_set_hwmode(struct device *dev, bool enable);
bool dev_pm_genpd_get_hwmode(struct device *dev);

extern struct dev_power_governor simple_qos_governor;
extern struct dev_power_governor pm_domain_always_on_gov;
#ifdef CONFIG_CPU_IDLE
extern struct dev_power_governor pm_domain_cpu_gov;
#endif
#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)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_device(struct device *dev)
{
	return -ENOSYS;
}
static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
					 struct generic_pm_domain *subdomain)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
					    struct generic_pm_domain *subdomain)
{
	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 -EOPNOTSUPP;
}

static inline struct device *dev_to_genpd_dev(struct device *dev)
{
	return ERR_PTR(-EOPNOTSUPP);
}

static inline int dev_pm_genpd_set_performance_state(struct device *dev,
						     unsigned int state)
{
	return -EOPNOTSUPP;
}

static inline int dev_pm_genpd_add_notifier(struct device *dev,
					    struct notifier_block *nb)
{
	return -EOPNOTSUPP;
}

static inline int dev_pm_genpd_remove_notifier(struct device *dev)
{
	return -EOPNOTSUPP;
}

static inline void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
{ }

static inline ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev)
{
	return KTIME_MAX;
}
static inline void dev_pm_genpd_synced_poweroff(struct device *dev)
{ }

static inline int dev_pm_genpd_set_hwmode(struct device *dev, bool enable)
{
	return -EOPNOTSUPP;
}

static inline bool dev_pm_genpd_get_hwmode(struct device *dev)
{
	return false;
}

#define simple_qos_governor		(*(struct dev_power_governor *)(NULL))
#define pm_domain_always_on_gov		(*(struct dev_power_governor *)(NULL))
#endif

#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
void dev_pm_genpd_suspend(struct device *dev);
void dev_pm_genpd_resume(struct device *dev);
#else
static inline void dev_pm_genpd_suspend(struct device *dev) {}
static inline void dev_pm_genpd_resume(struct device *dev) {}
#endif

/* OF PM domain providers */
struct of_device_id;

typedef struct generic_pm_domain *(*genpd_xlate_t)(const struct of_phandle_args *args,
						   void *data);

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

#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);
int of_genpd_add_device(const struct of_phandle_args *args, struct device *dev);
int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec,
			   const struct of_phandle_args *subdomain_spec);
int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec,
			      const struct of_phandle_args *subdomain_spec);
struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
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);
struct device *genpd_dev_pm_attach_by_id(struct device *dev,
					 unsigned int index);
struct device *genpd_dev_pm_attach_by_name(struct device *dev,
					   const char *name);
#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
static inline int of_genpd_add_provider_simple(struct device_node *np,
					struct generic_pm_domain *genpd)
{
	return -EOPNOTSUPP;
}

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

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

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

static inline int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec,
					 const struct of_phandle_args *subdomain_spec)
{
	return -ENODEV;
}

static inline int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec,
					    const struct of_phandle_args *subdomain_spec)
{
	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 0;
}

static inline struct device *genpd_dev_pm_attach_by_id(struct device *dev,
						       unsigned int index)
{
	return NULL;
}

static inline struct device *genpd_dev_pm_attach_by_name(struct device *dev,
							 const char *name)
{
	return NULL;
}

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

#ifdef CONFIG_PM
int dev_pm_domain_attach(struct device *dev, bool power_on);
struct device *dev_pm_domain_attach_by_id(struct device *dev,
					  unsigned int index);
struct device *dev_pm_domain_attach_by_name(struct device *dev,
					    const char *name);
int dev_pm_domain_attach_list(struct device *dev,
			      const struct dev_pm_domain_attach_data *data,
			      struct dev_pm_domain_list **list);
void dev_pm_domain_detach(struct device *dev, bool power_off);
void dev_pm_domain_detach_list(struct dev_pm_domain_list *list);
int dev_pm_domain_start(struct device *dev);
void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
int dev_pm_domain_set_performance_state(struct device *dev, unsigned int state);
#else
static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
{
	return 0;
}
static inline struct device *dev_pm_domain_attach_by_id(struct device *dev,
							unsigned int index)
{
	return NULL;
}
static inline struct device *dev_pm_domain_attach_by_name(struct device *dev,
							  const char *name)
{
	return NULL;
}
static inline int dev_pm_domain_attach_list(struct device *dev,
				const struct dev_pm_domain_attach_data *data,
				struct dev_pm_domain_list **list)
{
	return 0;
}
static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
static inline void dev_pm_domain_detach_list(struct dev_pm_domain_list *list) {}
static inline int dev_pm_domain_start(struct device *dev)
{
	return 0;
}
static inline void dev_pm_domain_set(struct device *dev,
				     struct dev_pm_domain *pd) {}
static inline int dev_pm_domain_set_performance_state(struct device *dev,
						      unsigned int state)
{
	return 0;
}
#endif

#endif /* _LINUX_PM_DOMAIN_H */
Commit	Line	Data
	1	/* SPDX-License-Identifier: GPL-2.0-only */
	2	/*
	3	* pm_domain.h - Definitions and headers related to device power domains.
	4	*
	5	* Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
	6	*/
	7
	8	#ifndef _LINUX_PM_DOMAIN_H
	9	#define _LINUX_PM_DOMAIN_H
	10
	11	#include <linux/device.h>
	12	#include <linux/ktime.h>
	13	#include <linux/mutex.h>
	14	#include <linux/pm.h>
	15	#include <linux/err.h>
	16	#include <linux/of.h>
	17	#include <linux/notifier.h>
	18	#include <linux/spinlock.h>
	19	#include <linux/cpumask_types.h>
	20	#include <linux/time64.h>
	21
	22	/*
	23	* Flags to control the behaviour when attaching a device to its PM domains.
	24	*
	25	* PD_FLAG_NO_DEV_LINK: As the default behaviour creates a device-link
	26	* for every PM domain that gets attached, this
	27	* flag can be used to skip that.
	28	*
	29	* PD_FLAG_DEV_LINK_ON: Add the DL_FLAG_RPM_ACTIVE to power-on the
	30	* supplier and its PM domain when creating the
	31	* device-links.
	32	*
	33	*/
	34	#define PD_FLAG_NO_DEV_LINK BIT(0)
	35	#define PD_FLAG_DEV_LINK_ON BIT(1)
	36
	37	struct dev_pm_domain_attach_data {
	38	const char * const *pd_names;
	39	const u32 num_pd_names;
	40	const u32 pd_flags;
	41	};
	42
	43	struct dev_pm_domain_list {
	44	struct device **pd_devs;
	45	struct device_link **pd_links;
	46	u32 num_pds;
	47	};
	48
	49	/*
	50	* Flags to control the behaviour of a genpd.
	51	*
	52	* These flags may be set in the struct generic_pm_domain's flags field by a
	53	* genpd backend driver. The flags must be set before it calls pm_genpd_init(),
	54	* which initializes a genpd.
	55	*
	56	* GENPD_FLAG_PM_CLK: Instructs genpd to use the PM clk framework,
	57	* while powering on/off attached devices.
	58	*
	59	* GENPD_FLAG_IRQ_SAFE: This informs genpd that its backend callbacks,
	60	* ->power_on\|off(), doesn't sleep. Hence, these
	61	* can be invoked from within atomic context, which
	62	* enables genpd to power on/off the PM domain,
	63	* even when pm_runtime_is_irq_safe() returns true,
	64	* for any of its attached devices. Note that, a
	65	* genpd having this flag set, requires its
	66	* masterdomains to also have it set.
	67	*
	68	* GENPD_FLAG_ALWAYS_ON: Instructs genpd to always keep the PM domain
	69	* powered on.
	70	*
	71	* GENPD_FLAG_ACTIVE_WAKEUP: Instructs genpd to keep the PM domain powered
	72	* on, in case any of its attached devices is used
	73	* in the wakeup path to serve system wakeups.
	74	*
	75	* GENPD_FLAG_CPU_DOMAIN: Instructs genpd that it should expect to get
	76	* devices attached, which may belong to CPUs or
	77	* possibly have subdomains with CPUs attached.
	78	* This flag enables the genpd backend driver to
	79	* deploy idle power management support for CPUs
	80	* and groups of CPUs. Note that, the backend
	81	* driver must then comply with the so called,
	82	* last-man-standing algorithm, for the CPUs in the
	83	* PM domain.
	84	*
	85	* GENPD_FLAG_RPM_ALWAYS_ON: Instructs genpd to always keep the PM domain
	86	* powered on except for system suspend.
	87	*
	88	* GENPD_FLAG_MIN_RESIDENCY: Enable the genpd governor to consider its
	89	* components' next wakeup when determining the
	90	* optimal idle state.
	91	*
	92	* GENPD_FLAG_OPP_TABLE_FW: The genpd provider supports performance states,
	93	* but its corresponding OPP tables are not
	94	* described in DT, but are given directly by FW.
	95	*/
	96	#define GENPD_FLAG_PM_CLK (1U << 0)
	97	#define GENPD_FLAG_IRQ_SAFE (1U << 1)
	98	#define GENPD_FLAG_ALWAYS_ON (1U << 2)
	99	#define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3)
	100	#define GENPD_FLAG_CPU_DOMAIN (1U << 4)
	101	#define GENPD_FLAG_RPM_ALWAYS_ON (1U << 5)
	102	#define GENPD_FLAG_MIN_RESIDENCY (1U << 6)
	103	#define GENPD_FLAG_OPP_TABLE_FW (1U << 7)
	104
	105	enum gpd_status {
	106	GENPD_STATE_ON = 0, /* PM domain is on */
	107	GENPD_STATE_OFF, /* PM domain is off */
	108	};
	109
	110	enum genpd_notication {
	111	GENPD_NOTIFY_PRE_OFF = 0,
	112	GENPD_NOTIFY_OFF,
	113	GENPD_NOTIFY_PRE_ON,
	114	GENPD_NOTIFY_ON,
	115	};
	116
	117	struct dev_power_governor {
	118	bool (power_down_ok)(struct dev_pm_domain domain);
	119	bool (suspend_ok)(struct device dev);
	120	};
	121
	122	struct gpd_dev_ops {
	123	int (start)(struct device dev);
	124	int (stop)(struct device dev);
	125	};
	126
	127	struct genpd_governor_data {
	128	s64 max_off_time_ns;
	129	bool max_off_time_changed;
	130	ktime_t next_wakeup;
	131	ktime_t next_hrtimer;
	132	bool cached_power_down_ok;
	133	bool cached_power_down_state_idx;
	134	};
	135
	136	struct genpd_power_state {
	137	s64 power_off_latency_ns;
	138	s64 power_on_latency_ns;
	139	s64 residency_ns;
	140	u64 usage;
	141	u64 rejected;
	142	struct fwnode_handle *fwnode;
	143	u64 idle_time;
	144	void *data;
	145	};
	146
	147	struct genpd_lock_ops;
	148	struct opp_table;
	149
	150	struct generic_pm_domain {
	151	struct device dev;
	152	struct dev_pm_domain domain; /* PM domain operations */
	153	struct list_head gpd_list_node; /* Node in the global PM domains list */
	154	struct list_head parent_links; /* Links with PM domain as a parent */
	155	struct list_head child_links; /* Links with PM domain as a child */
	156	struct list_head dev_list; /* List of devices */
	157	struct dev_power_governor *gov;
	158	struct genpd_governor_data gd; / Data used by a genpd governor. */
	159	struct work_struct power_off_work;
	160	struct fwnode_handle provider; / Identity of the domain provider */
	161	bool has_provider;
	162	const char *name;
	163	atomic_t sd_count; /* Number of subdomains with power "on" */
	164	enum gpd_status status; /* Current state of the domain */
	165	unsigned int device_count; /* Number of devices */
	166	unsigned int suspended_count; /* System suspend device counter */
	167	unsigned int prepared_count; /* Suspend counter of prepared devices */
	168	unsigned int performance_state; /* Aggregated max performance state */
	169	cpumask_var_t cpus; /* A cpumask of the attached CPUs */
	170	bool synced_poweroff; /* A consumer needs a synced poweroff */
	171	int (power_off)(struct generic_pm_domain domain);
	172	int (power_on)(struct generic_pm_domain domain);
	173	struct raw_notifier_head power_notifiers; /* Power on/off notifiers */
	174	struct opp_table opp_table; / OPP table of the genpd */
	175	int (set_performance_state)(struct generic_pm_domain genpd,
	176	unsigned int state);
	177	struct gpd_dev_ops dev_ops;
	178	int (set_hwmode_dev)(struct generic_pm_domain domain,
	179	struct device *dev, bool enable);
	180	bool (get_hwmode_dev)(struct generic_pm_domain domain,
	181	struct device *dev);
	182	int (attach_dev)(struct generic_pm_domain domain,
	183	struct device *dev);
	184	void (detach_dev)(struct generic_pm_domain domain,
	185	struct device *dev);
	186	unsigned int flags; /* Bit field of configs for genpd */
	187	struct genpd_power_state *states;
	188	void (free_states)(struct genpd_power_state states,
	189	unsigned int state_count);
	190	unsigned int state_count; /* number of states */
	191	unsigned int state_idx; /* state that genpd will go to when off */
	192	u64 on_time;
	193	u64 accounting_time;
	194	const struct genpd_lock_ops *lock_ops;
	195	union {
	196	struct mutex mlock;
	197	struct {
	198	spinlock_t slock;
	199	unsigned long lock_flags;
	200	};
	201	};
	202
	203	};
	204
	205	static inline struct generic_pm_domain pd_to_genpd(struct dev_pm_domain pd)
	206	{
	207	return container_of(pd, struct generic_pm_domain, domain);
	208	}
	209
	210	struct gpd_link {
	211	struct generic_pm_domain *parent;
	212	struct list_head parent_node;
	213	struct generic_pm_domain *child;
	214	struct list_head child_node;
	215
	216	/* Sub-domain's per-master domain performance state */
	217	unsigned int performance_state;
	218	unsigned int prev_performance_state;
	219	};
	220
	221	struct gpd_timing_data {
	222	s64 suspend_latency_ns;
	223	s64 resume_latency_ns;
	224	s64 effective_constraint_ns;
	225	ktime_t next_wakeup;
	226	bool constraint_changed;
	227	bool cached_suspend_ok;
	228	};
	229
	230	struct pm_domain_data {
	231	struct list_head list_node;
	232	struct device *dev;
	233	};
	234
	235	struct generic_pm_domain_data {
	236	struct pm_domain_data base;
	237	struct gpd_timing_data *td;
	238	struct notifier_block nb;
	239	struct notifier_block *power_nb;
	240	int cpu;
	241	unsigned int performance_state;
	242	unsigned int default_pstate;
	243	unsigned int rpm_pstate;
	244	bool hw_mode;
	245	void *data;
	246	};
	247
	248	#ifdef CONFIG_PM_GENERIC_DOMAINS
	249	static inline struct generic_pm_domain_data to_gpd_data(struct pm_domain_data pdd)
	250	{
	251	return container_of(pdd, struct generic_pm_domain_data, base);
	252	}
	253
	254	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	255	{
	256	return to_gpd_data(dev->power.subsys_data->domain_data);
	257	}
	258
	259	int pm_genpd_add_device(struct generic_pm_domain genpd, struct device dev);
	260	int pm_genpd_remove_device(struct device *dev);
	261	int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	262	struct generic_pm_domain *subdomain);
	263	int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	264	struct generic_pm_domain *subdomain);
	265	int pm_genpd_init(struct generic_pm_domain *genpd,
	266	struct dev_power_governor *gov, bool is_off);
	267	int pm_genpd_remove(struct generic_pm_domain *genpd);
	268	struct device dev_to_genpd_dev(struct device dev);
	269	int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state);
	270	int dev_pm_genpd_add_notifier(struct device dev, struct notifier_block nb);
	271	int dev_pm_genpd_remove_notifier(struct device *dev);
	272	void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next);
	273	ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev);
	274	void dev_pm_genpd_synced_poweroff(struct device *dev);
	275	int dev_pm_genpd_set_hwmode(struct device *dev, bool enable);
	276	bool dev_pm_genpd_get_hwmode(struct device *dev);
	277
	278	extern struct dev_power_governor simple_qos_governor;
	279	extern struct dev_power_governor pm_domain_always_on_gov;
	280	#ifdef CONFIG_CPU_IDLE
	281	extern struct dev_power_governor pm_domain_cpu_gov;
	282	#endif
	283	#else
	284
	285	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	286	{
	287	return ERR_PTR(-ENOSYS);
	288	}
	289	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	290	struct device *dev)
	291	{
	292	return -ENOSYS;
	293	}
	294	static inline int pm_genpd_remove_device(struct device *dev)
	295	{
	296	return -ENOSYS;
	297	}
	298	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	299	struct generic_pm_domain *subdomain)
	300	{
	301	return -ENOSYS;
	302	}
	303	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	304	struct generic_pm_domain *subdomain)
	305	{
	306	return -ENOSYS;
	307	}
	308	static inline int pm_genpd_init(struct generic_pm_domain *genpd,
	309	struct dev_power_governor *gov, bool is_off)
	310	{
	311	return -ENOSYS;
	312	}
	313	static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
	314	{
	315	return -EOPNOTSUPP;
	316	}
	317
	318	static inline struct device dev_to_genpd_dev(struct device dev)
	319	{
	320	return ERR_PTR(-EOPNOTSUPP);
	321	}
	322
	323	static inline int dev_pm_genpd_set_performance_state(struct device *dev,
	324	unsigned int state)
	325	{
	326	return -EOPNOTSUPP;
	327	}
	328
	329	static inline int dev_pm_genpd_add_notifier(struct device *dev,
	330	struct notifier_block *nb)
	331	{
	332	return -EOPNOTSUPP;
	333	}
	334
	335	static inline int dev_pm_genpd_remove_notifier(struct device *dev)
	336	{
	337	return -EOPNOTSUPP;
	338	}
	339
	340	static inline void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
	341	{ }
	342
	343	static inline ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev)
	344	{
	345	return KTIME_MAX;
	346	}
	347	static inline void dev_pm_genpd_synced_poweroff(struct device *dev)
	348	{ }
	349
	350	static inline int dev_pm_genpd_set_hwmode(struct device *dev, bool enable)
	351	{
	352	return -EOPNOTSUPP;
	353	}
	354
	355	static inline bool dev_pm_genpd_get_hwmode(struct device *dev)
	356	{
	357	return false;
	358	}
	359
	360	#define simple_qos_governor ((struct dev_power_governor )(NULL))
	361	#define pm_domain_always_on_gov ((struct dev_power_governor )(NULL))
	362	#endif
	363
	364	#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
	365	void dev_pm_genpd_suspend(struct device *dev);
	366	void dev_pm_genpd_resume(struct device *dev);
	367	#else
	368	static inline void dev_pm_genpd_suspend(struct device *dev) {}
	369	static inline void dev_pm_genpd_resume(struct device *dev) {}
	370	#endif
	371
	372	/* OF PM domain providers */
	373	struct of_device_id;
	374
	375	typedef struct generic_pm_domain (genpd_xlate_t)(const struct of_phandle_args *args,
	376	void *data);
	377
	378	struct genpd_onecell_data {
	379	struct generic_pm_domain **domains;
	380	unsigned int num_domains;
	381	genpd_xlate_t xlate;
	382	};
	383
	384	#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
	385	int of_genpd_add_provider_simple(struct device_node *np,
	386	struct generic_pm_domain *genpd);
	387	int of_genpd_add_provider_onecell(struct device_node *np,
	388	struct genpd_onecell_data *data);
	389	void of_genpd_del_provider(struct device_node *np);
	390	int of_genpd_add_device(const struct of_phandle_args args, struct device dev);
	391	int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec,
	392	const struct of_phandle_args *subdomain_spec);
	393	int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec,
	394	const struct of_phandle_args *subdomain_spec);
	395	struct generic_pm_domain of_genpd_remove_last(struct device_node np);
	396	int of_genpd_parse_idle_states(struct device_node *dn,
	397	struct genpd_power_state *states, int n);
	398
	399	int genpd_dev_pm_attach(struct device *dev);
	400	struct device genpd_dev_pm_attach_by_id(struct device dev,
	401	unsigned int index);
	402	struct device genpd_dev_pm_attach_by_name(struct device dev,
	403	const char *name);
	404	#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
	405	static inline int of_genpd_add_provider_simple(struct device_node *np,
	406	struct generic_pm_domain *genpd)
	407	{
	408	return -EOPNOTSUPP;
	409	}
	410
	411	static inline int of_genpd_add_provider_onecell(struct device_node *np,
	412	struct genpd_onecell_data *data)
	413	{
	414	return -EOPNOTSUPP;
	415	}
	416
	417	static inline void of_genpd_del_provider(struct device_node *np) {}
	418
	419	static inline int of_genpd_add_device(const struct of_phandle_args *args,
	420	struct device *dev)
	421	{
	422	return -ENODEV;
	423	}
	424
	425	static inline int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec,
	426	const struct of_phandle_args *subdomain_spec)
	427	{
	428	return -ENODEV;
	429	}
	430
	431	static inline int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec,
	432	const struct of_phandle_args *subdomain_spec)
	433	{
	434	return -ENODEV;
	435	}
	436
	437	static inline int of_genpd_parse_idle_states(struct device_node *dn,
	438	struct genpd_power_state *states, int n)
	439	{
	440	return -ENODEV;
	441	}
	442
	443	static inline int genpd_dev_pm_attach(struct device *dev)
	444	{
	445	return 0;
	446	}
	447
	448	static inline struct device genpd_dev_pm_attach_by_id(struct device dev,
	449	unsigned int index)
	450	{
	451	return NULL;
	452	}
	453
	454	static inline struct device genpd_dev_pm_attach_by_name(struct device dev,
	455	const char *name)
	456	{
	457	return NULL;
	458	}
	459
	460	static inline
	461	struct generic_pm_domain of_genpd_remove_last(struct device_node np)
	462	{
	463	return ERR_PTR(-EOPNOTSUPP);
	464	}
	465	#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
	466
	467	#ifdef CONFIG_PM
	468	int dev_pm_domain_attach(struct device *dev, bool power_on);
	469	struct device dev_pm_domain_attach_by_id(struct device dev,
	470	unsigned int index);
	471	struct device dev_pm_domain_attach_by_name(struct device dev,
	472	const char *name);
	473	int dev_pm_domain_attach_list(struct device *dev,
	474	const struct dev_pm_domain_attach_data *data,
	475	struct dev_pm_domain_list **list);
	476	void dev_pm_domain_detach(struct device *dev, bool power_off);
	477	void dev_pm_domain_detach_list(struct dev_pm_domain_list *list);
	478	int dev_pm_domain_start(struct device *dev);
	479	void dev_pm_domain_set(struct device dev, struct dev_pm_domain pd);
	480	int dev_pm_domain_set_performance_state(struct device *dev, unsigned int state);
	481	#else
	482	static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
	483	{
	484	return 0;
	485	}
	486	static inline struct device dev_pm_domain_attach_by_id(struct device dev,
	487	unsigned int index)
	488	{
	489	return NULL;
	490	}
	491	static inline struct device dev_pm_domain_attach_by_name(struct device dev,
	492	const char *name)
	493	{
	494	return NULL;
	495	}
	496	static inline int dev_pm_domain_attach_list(struct device *dev,
	497	const struct dev_pm_domain_attach_data *data,
	498	struct dev_pm_domain_list **list)
	499	{
	500	return 0;
	501	}
	502	static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
	503	static inline void dev_pm_domain_detach_list(struct dev_pm_domain_list *list) {}
	504	static inline int dev_pm_domain_start(struct device *dev)
	505	{
	506	return 0;
	507	}
	508	static inline void dev_pm_domain_set(struct device *dev,
	509	struct dev_pm_domain *pd) {}
	510	static inline int dev_pm_domain_set_performance_state(struct device *dev,
	511	unsigned int state)
	512	{
	513	return 0;
	514	}
	515	#endif
	516
	517	#endif /* _LINUX_PM_DOMAIN_H */