[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.h>
#include <linux/time64.h>

/*
 * 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.
 */
#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)

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 dev_pm_opp;
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 */
	unsigned int (*opp_to_performance_state)(struct generic_pm_domain *genpd,
						 struct dev_pm_opp *opp);
	int (*set_performance_state)(struct generic_pm_domain *genpd,
				     unsigned int state);
	struct gpd_dev_ops dev_ops;
	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;
	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);
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);

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

#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)(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(struct of_phandle_args *args, struct device *dev);
int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
			   struct of_phandle_args *subdomain_spec);
int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
			      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);
unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
					       struct dev_pm_opp *opp);

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(struct of_phandle_args *args,
				      struct device *dev)
{
	return -ENODEV;
}

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

static inline int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
					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 unsigned int
pm_genpd_opp_to_performance_state(struct device *genpd_dev,
				  struct dev_pm_opp *opp)
{
	return 0;
}

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