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

/*
 * 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_power_state {
	s64 power_off_latency_ns;
	s64 power_on_latency_ns;
	s64 residency_ns;
	u64 usage;
	u64 rejected;
	struct fwnode_handle *fwnode;
	ktime_t 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 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 */
	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;
	s64 max_off_time_ns;	/* Maximum allowed "suspended" time. */
	ktime_t next_wakeup;	/* Maintained by the domain governor */
	bool max_off_time_changed;
	bool cached_power_down_ok;
	bool cached_power_down_state_idx;
	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 */
	ktime_t on_time;
	ktime_t 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;
	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 rpm_pstate;
	ktime_t	next_wakeup;
	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);

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

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