[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
55716d26	1	/* SPDX-License-Identifier: GPL-2.0-only */
f721889f RW	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.
f721889f RW	6	*/
	7
	8	#ifndef _LINUX_PM_DOMAIN_H
	9	#define _LINUX_PM_DOMAIN_H
	10
	11	#include <linux/device.h>
67e3242e	12	#include <linux/ktime.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>
eb594b73	19	#include <linux/cpumask.h>
1498c503	20	#include <linux/time64.h>
f721889f	21
e5089c2c UH	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.
eb594b73 UH	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.
ed61e18a LC	57	*
	58	* GENPD_FLAG_RPM_ALWAYS_ON: Instructs genpd to always keep the PM domain
	59	* powered on except for system suspend.
c79aa080 LI	60	*
	61	* GENPD_FLAG_MIN_RESIDENCY: Enable the genpd governor to consider its
	62	* components' next wakeup when determining the
	63	* optimal idle state.
e5089c2c UH	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)
eb594b73	69	#define GENPD_FLAG_CPU_DOMAIN (1U << 4)
ed61e18a	70	#define GENPD_FLAG_RPM_ALWAYS_ON (1U << 5)
c79aa080	71	#define GENPD_FLAG_MIN_RESIDENCY (1U << 6)
c11f6f5b	72
17b75eca	73	enum gpd_status {
49f618e1 UH	74	GENPD_STATE_ON = 0, /* PM domain is on */
49f618e1 UH	75	GENPD_STATE_OFF, /* PM domain is off */
17b75eca	76	};
596ba34b	77
d4f81383 UH	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
f721889f RW	85	struct dev_power_governor {
f721889f RW	86	bool (power_down_ok)(struct dev_pm_domain domain);
9df3921e	87	bool (suspend_ok)(struct device dev);
f721889f RW	88	};
f721889f RW	89
d5e4cbfe RW	90	struct gpd_dev_ops {
	91	int (start)(struct device dev);
	92	int (stop)(struct device dev);
d5e4cbfe RW	93	};
d5e4cbfe RW	94
f38d1a6d UH	95	struct genpd_governor_data {
	96	s64 max_off_time_ns;
	97	bool max_off_time_changed;
	98	ktime_t next_wakeup;
1498c503	99	ktime_t next_hrtimer;
f38d1a6d UH	100	bool cached_power_down_ok;
	101	bool cached_power_down_state_idx;
	102	};
	103
fc5cbf0c AH	104	struct genpd_power_state {
	105	s64 power_off_latency_ns;
	106	s64 power_on_latency_ns;
405f7226	107	s64 residency_ns;
c6a113b5 LI	108	u64 usage;
c6a113b5 LI	109	u64 rejected;
0c9b694a	110	struct fwnode_handle *fwnode;
bd40cbb0	111	u64 idle_time;
49a27e27	112	void *data;
fc5cbf0c AH	113	};
fc5cbf0c AH	114
35241d12	115	struct genpd_lock_ops;
6e41766a	116	struct dev_pm_opp;
1067ae3e	117	struct opp_table;
35241d12	118
f721889f	119	struct generic_pm_domain {
401ea157	120	struct device dev;
f721889f	121	struct dev_pm_domain domain; /* PM domain operations */
5125bbf3	122	struct list_head gpd_list_node; /* Node in the global PM domains list */
8d87ae48	123	struct list_head parent_links; /* Links with PM domain as a parent */
afb0367a	124	struct list_head child_links; /* Links with PM domain as a child */
f721889f	125	struct list_head dev_list; /* List of devices */
f721889f	126	struct dev_power_governor *gov;
f38d1a6d	127	struct genpd_governor_data gd; / Data used by a genpd governor. */
f721889f	128	struct work_struct power_off_work;
de0aa06d JH	129	struct fwnode_handle provider; / Identity of the domain provider */
de0aa06d JH	130	bool has_provider;
d07e9c17	131	const char *name;
c4bb3160	132	atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca	133	enum gpd_status status; /* Current state of the domain */
596ba34b RW	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 */
42f6284a	137	unsigned int performance_state; /* Aggregated max performance state */
eb594b73	138	cpumask_var_t cpus; /* A cpumask of the attached CPUs */
a9236a0a	139	bool synced_poweroff; /* A consumer needs a synced poweroff */
f721889f RW	140	int (power_off)(struct generic_pm_domain domain);
f721889f RW	141	int (power_on)(struct generic_pm_domain domain);
d4f81383	142	struct raw_notifier_head power_notifiers; /* Power on/off notifiers */
1067ae3e	143	struct opp_table opp_table; / OPP table of the genpd */
6e41766a VK	144	unsigned int (opp_to_performance_state)(struct generic_pm_domain genpd,
6e41766a VK	145	struct dev_pm_opp *opp);
42f6284a VK	146	int (set_performance_state)(struct generic_pm_domain genpd,
42f6284a VK	147	unsigned int state);
d5e4cbfe	148	struct gpd_dev_ops dev_ops;
c16561e8 UH	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);
c11f6f5b	153	unsigned int flags; /* Bit field of configs for genpd */
59d65b73	154	struct genpd_power_state *states;
49a27e27 UH	155	void (free_states)(struct genpd_power_state states,
49a27e27 UH	156	unsigned int state_count);
fc5cbf0c AH	157	unsigned int state_count; /* number of states */
fc5cbf0c AH	158	unsigned int state_idx; /* state that genpd will go to when off */
bd40cbb0 UH	159	u64 on_time;
bd40cbb0 UH	160	u64 accounting_time;
35241d12	161	const struct genpd_lock_ops *lock_ops;
d716f479 LI	162	union {
	163	struct mutex mlock;
	164	struct {
	165	spinlock_t slock;
	166	unsigned long lock_flags;
	167	};
	168	};
fc5cbf0c	169
f721889f RW	170	};
f721889f RW	171
596ba34b RW	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
5063ce15	177	struct gpd_link {
8d87ae48 KC	178	struct generic_pm_domain *parent;
	179	struct list_head parent_node;
	180	struct generic_pm_domain *child;
	181	struct list_head child_node;
18edf49c VK	182
	183	/* Sub-domain's per-master domain performance state */
	184	unsigned int performance_state;
	185	unsigned int prev_performance_state;
5063ce15 RW	186	};
5063ce15 RW	187
b02c999a	188	struct gpd_timing_data {
2b1d88cd UH	189	s64 suspend_latency_ns;
2b1d88cd UH	190	s64 resume_latency_ns;
a5bef810	191	s64 effective_constraint_ns;
9c74f2ac	192	ktime_t next_wakeup;
6ff7bb0d	193	bool constraint_changed;
9df3921e	194	bool cached_suspend_ok;
b02c999a RW	195	};
b02c999a RW	196
00e7c295 UH	197	struct pm_domain_data {
	198	struct list_head list_node;
	199	struct device *dev;
	200	};
	201
cd0ea672 RW	202	struct generic_pm_domain_data {
cd0ea672 RW	203	struct pm_domain_data base;
66d29d80	204	struct gpd_timing_data *td;
6ff7bb0d	205	struct notifier_block nb;
d4f81383	206	struct notifier_block *power_nb;
f9ccd7c3	207	int cpu;
42f6284a	208	unsigned int performance_state;
c016baf7	209	unsigned int default_pstate;
5937c3ce	210	unsigned int rpm_pstate;
a5ea7a0f	211	void *data;
cd0ea672 RW	212	};
cd0ea672 RW	213
9b4f617b	214	#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672 RW	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
d5e4cbfe RW	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
1a7a6707	225	int pm_genpd_add_device(struct generic_pm_domain genpd, struct device dev);
924f4486	226	int pm_genpd_remove_device(struct device *dev);
781b9d6b	227	int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
0d1e16c6	228	struct generic_pm_domain *subdomain);
781b9d6b	229	int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
0d1e16c6	230	struct generic_pm_domain *subdomain);
781b9d6b UH	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);
d4f81383 UH	235	int dev_pm_genpd_add_notifier(struct device dev, struct notifier_block nb);
d4f81383 UH	236	int dev_pm_genpd_remove_notifier(struct device *dev);
67e3242e	237	void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next);
1498c503	238	ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev);
a9236a0a	239	void dev_pm_genpd_synced_poweroff(struct device *dev);
b02c999a	240
ae3c511c	241	extern struct dev_power_governor simple_qos_governor;
925b44a2	242	extern struct dev_power_governor pm_domain_always_on_gov;
e9499968 UH	243	#ifdef CONFIG_CPU_IDLE
	244	extern struct dev_power_governor pm_domain_cpu_gov;
	245	#endif
f721889f	246	#else
b02c999a	247
b642631d MD	248	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	249	{
	250	return ERR_PTR(-ENOSYS);
	251	}
1a7a6707 UH	252	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
1a7a6707 UH	253	struct device *dev)
b02c999a RW	254	{
	255	return -ENOSYS;
	256	}
924f4486	257	static inline int pm_genpd_remove_device(struct device *dev)
f721889f RW	258	{
	259	return -ENOSYS;
	260	}
	261	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
0d1e16c6	262	struct generic_pm_domain *subdomain)
f721889f RW	263	{
	264	return -ENOSYS;
	265	}
	266	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
0d1e16c6	267	struct generic_pm_domain *subdomain)
f721889f RW	268	{
	269	return -ENOSYS;
	270	}
7eb231c3 UH	271	static inline int pm_genpd_init(struct generic_pm_domain *genpd,
7eb231c3 UH	272	struct dev_power_governor *gov, bool is_off)
b02c999a	273	{
7eb231c3	274	return -ENOSYS;
b02c999a	275	}
3fe57710 JH	276	static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
3fe57710 JH	277	{
a94ef811	278	return -EOPNOTSUPP;
3fe57710	279	}
16d0bf18	280
42f6284a VK	281	static inline int dev_pm_genpd_set_performance_state(struct device *dev,
	282	unsigned int state)
	283	{
a94ef811	284	return -EOPNOTSUPP;
42f6284a VK	285	}
42f6284a VK	286
d4f81383 UH	287	static inline int dev_pm_genpd_add_notifier(struct device *dev,
	288	struct notifier_block *nb)
	289	{
a94ef811	290	return -EOPNOTSUPP;
d4f81383 UH	291	}
	292
	293	static inline int dev_pm_genpd_remove_notifier(struct device *dev)
	294	{
a94ef811	295	return -EOPNOTSUPP;
d4f81383 UH	296	}
d4f81383 UH	297
67e3242e LI	298	static inline void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
	299	{ }
	300
1498c503 MS	301	static inline ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev)
	302	{
	303	return KTIME_MAX;
	304	}
a9236a0a UH	305	static inline void dev_pm_genpd_synced_poweroff(struct device *dev)
	306	{ }
	307
16d0bf18 GU	308	#define simple_qos_governor ((struct dev_power_governor )(NULL))
16d0bf18 GU	309	#define pm_domain_always_on_gov ((struct dev_power_governor )(NULL))
17f2ae7f RW	310	#endif
17f2ae7f RW	311
77f827de	312	#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
fc519890 UH	313	void dev_pm_genpd_suspend(struct device *dev);
fc519890 UH	314	void dev_pm_genpd_resume(struct device *dev);
77f827de	315	#else
fc519890 UH	316	static inline void dev_pm_genpd_suspend(struct device *dev) {}
fc519890 UH	317	static inline void dev_pm_genpd_resume(struct device *dev) {}
77f827de RW	318	#endif
77f827de RW	319
aa42240a TF	320	/* OF PM domain providers */
	321	struct of_device_id;
	322
40845524 TR	323	typedef struct generic_pm_domain (genpd_xlate_t)(struct of_phandle_args *args,
	324	void *data);
	325
aa42240a TF	326	struct genpd_onecell_data {
	327	struct generic_pm_domain **domains;
	328	unsigned int num_domains;
40845524	329	genpd_xlate_t xlate;
aa42240a TF	330	};
aa42240a TF	331
aa42240a	332	#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
892ebdcc JH	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);
aa42240a	337	void of_genpd_del_provider(struct device_node *np);
781b9d6b	338	int of_genpd_add_device(struct of_phandle_args args, struct device dev);
0d1e16c6 UH	339	int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
0d1e16c6 UH	340	struct of_phandle_args *subdomain_spec);
dedd1492 UH	341	int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
dedd1492 UH	342	struct of_phandle_args *subdomain_spec);
781b9d6b UH	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);
e38f89d3 VK	346	unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
e38f89d3 VK	347	struct dev_pm_opp *opp);
aa42240a TF	348
aa42240a TF	349	int genpd_dev_pm_attach(struct device *dev);
3c095f32 UH	350	struct device genpd_dev_pm_attach_by_id(struct device dev,
3c095f32 UH	351	unsigned int index);
5d6be70a	352	struct device genpd_dev_pm_attach_by_name(struct device dev,
7416f1f2	353	const char *name);
aa42240a	354	#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
892ebdcc JH	355	static inline int of_genpd_add_provider_simple(struct device_node *np,
892ebdcc JH	356	struct generic_pm_domain *genpd)
aa42240a	357	{
a94ef811	358	return -EOPNOTSUPP;
892ebdcc JH	359	}
	360
	361	static inline int of_genpd_add_provider_onecell(struct device_node *np,
	362	struct genpd_onecell_data *data)
	363	{
a94ef811	364	return -EOPNOTSUPP;
aa42240a	365	}
aa42240a	366
892ebdcc	367	static inline void of_genpd_del_provider(struct device_node *np) {}
aa42240a	368
ec69572b JH	369	static inline int of_genpd_add_device(struct of_phandle_args *args,
	370	struct device *dev)
	371	{
	372	return -ENODEV;
	373	}
	374
0d1e16c6 UH	375	static inline int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
0d1e16c6 UH	376	struct of_phandle_args *subdomain_spec)
ec69572b JH	377	{
	378	return -ENODEV;
	379	}
	380
dedd1492 UH	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
30f60428 LI	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
e38f89d3 VK	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
aa42240a TF	400	static inline int genpd_dev_pm_attach(struct device *dev)
aa42240a TF	401	{
919b7308	402	return 0;
aa42240a	403	}
17926551	404
3c095f32 UH	405	static inline struct device genpd_dev_pm_attach_by_id(struct device dev,
	406	unsigned int index)
	407	{
	408	return NULL;
	409	}
	410
5d6be70a	411	static inline struct device genpd_dev_pm_attach_by_name(struct device dev,
7416f1f2	412	const char *name)
5d6be70a UH	413	{
	414	return NULL;
	415	}
	416
17926551 JH	417	static inline
	418	struct generic_pm_domain of_genpd_remove_last(struct device_node np)
	419	{
a94ef811	420	return ERR_PTR(-EOPNOTSUPP);
17926551	421	}
aa42240a TF	422	#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
aa42240a TF	423
f48c767c	424	#ifdef CONFIG_PM
781b9d6b	425	int dev_pm_domain_attach(struct device *dev, bool power_on);
82e12d9e UH	426	struct device dev_pm_domain_attach_by_id(struct device dev,
82e12d9e UH	427	unsigned int index);
27dceb81	428	struct device dev_pm_domain_attach_by_name(struct device dev,
eeb35df0	429	const char *name);
781b9d6b	430	void dev_pm_domain_detach(struct device *dev, bool power_off);
ca765a8c	431	int dev_pm_domain_start(struct device *dev);
781b9d6b	432	void dev_pm_domain_set(struct device dev, struct dev_pm_domain pd);
f48c767c UH	433	#else
	434	static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
	435	{
919b7308	436	return 0;
f48c767c	437	}
82e12d9e UH	438	static inline struct device dev_pm_domain_attach_by_id(struct device dev,
	439	unsigned int index)
	440	{
	441	return NULL;
	442	}
27dceb81	443	static inline struct device dev_pm_domain_attach_by_name(struct device dev,
eeb35df0	444	const char *name)
27dceb81 UH	445	{
	446	return NULL;
	447	}
f48c767c	448	static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
ca765a8c UH	449	static inline int dev_pm_domain_start(struct device *dev)
	450	{
	451	return 0;
	452	}
989561de TV	453	static inline void dev_pm_domain_set(struct device *dev,
989561de TV	454	struct dev_pm_domain *pd) {}
f48c767c UH	455	#endif
f48c767c UH	456
f721889f	457	#endif /* _LINUX_PM_DOMAIN_H */