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

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

#ifndef _LINUX_PM_DOMAIN_H
#define _LINUX_PM_DOMAIN_H

#include <linux/device.h>
#include <linux/ktime.h>
#include <linux/mutex.h>
#include <linux/pm.h>
#include <linux/err.h>
#include <linux/of.h>
#include <linux/notifier.h>
#include <linux/spinlock.h>
#include <linux/cpumask_types.h>
#include <linux/time64.h>

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

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

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

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

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

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

struct dev_power_governor {
	bool (*power_down_ok)(struct dev_pm_domain *domain);
	bool (*suspend_ok)(struct device *dev);
};

struct gpd_dev_ops {
	int (*start)(struct device *dev);
	int (*stop)(struct device *dev);
};

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

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

struct genpd_lock_ops;
struct opp_table;

struct generic_pm_domain {
	struct device dev;
	struct dev_pm_domain domain;	/* PM domain operations */
	struct list_head gpd_list_node;	/* Node in the global PM domains list */
	struct list_head parent_links;	/* Links with PM domain as a parent */
	struct list_head child_links;	/* Links with PM domain as a child */
	struct list_head dev_list;	/* List of devices */
	struct dev_power_governor *gov;
	struct genpd_governor_data *gd;	/* Data used by a genpd governor. */
	struct work_struct power_off_work;
	struct fwnode_handle *provider;	/* Identity of the domain provider */
	bool has_provider;
	const char *name;
	atomic_t sd_count;	/* Number of subdomains with power "on" */
	enum gpd_status status;	/* Current state of the domain */
	unsigned int device_count;	/* Number of devices */
	unsigned int suspended_count;	/* System suspend device counter */
	unsigned int prepared_count;	/* Suspend counter of prepared devices */
	unsigned int performance_state;	/* Aggregated max performance state */
	cpumask_var_t cpus;		/* A cpumask of the attached CPUs */
	bool synced_poweroff;		/* A consumer needs a synced poweroff */
	int (*power_off)(struct generic_pm_domain *domain);
	int (*power_on)(struct generic_pm_domain *domain);
	struct raw_notifier_head power_notifiers; /* Power on/off notifiers */
	struct opp_table *opp_table;	/* OPP table of the genpd */
	int (*set_performance_state)(struct generic_pm_domain *genpd,
				     unsigned int state);
	struct gpd_dev_ops dev_ops;
	int (*set_hwmode_dev)(struct generic_pm_domain *domain,
			      struct device *dev, bool enable);
	bool (*get_hwmode_dev)(struct generic_pm_domain *domain,
			      struct device *dev);
	int (*attach_dev)(struct generic_pm_domain *domain,
			  struct device *dev);
	void (*detach_dev)(struct generic_pm_domain *domain,
			   struct device *dev);
	unsigned int flags;		/* Bit field of configs for genpd */
	struct genpd_power_state *states;
	void (*free_states)(struct genpd_power_state *states,
			    unsigned int state_count);
	unsigned int state_count; /* number of states */
	unsigned int state_idx; /* state that genpd will go to when off */
	u64 on_time;
	u64 accounting_time;
	const struct genpd_lock_ops *lock_ops;
	union {
		struct mutex mlock;
		struct {
			spinlock_t slock;
			unsigned long lock_flags;
		};
		struct {
			raw_spinlock_t raw_slock;
			unsigned long raw_lock_flags;
		};
	};
};

static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
{
	return container_of(pd, struct generic_pm_domain, domain);
}

struct gpd_link {
	struct generic_pm_domain *parent;
	struct list_head parent_node;
	struct generic_pm_domain *child;
	struct list_head child_node;

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

struct gpd_timing_data {
	s64 suspend_latency_ns;
	s64 resume_latency_ns;
	s64 effective_constraint_ns;
	ktime_t	next_wakeup;
	bool constraint_changed;
	bool cached_suspend_ok;
};

struct pm_domain_data {
	struct list_head list_node;
	struct device *dev;
};

struct generic_pm_domain_data {
	struct pm_domain_data base;
	struct gpd_timing_data *td;
	struct notifier_block nb;
	struct notifier_block *power_nb;
	int cpu;
	unsigned int performance_state;
	unsigned int default_pstate;
	unsigned int rpm_pstate;
	bool hw_mode;
	void *data;
};

#ifdef CONFIG_PM_GENERIC_DOMAINS
static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
{
	return container_of(pdd, struct generic_pm_domain_data, base);
}

static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return to_gpd_data(dev->power.subsys_data->domain_data);
}

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

extern struct dev_power_governor simple_qos_governor;
extern struct dev_power_governor pm_domain_always_on_gov;
#ifdef CONFIG_CPU_IDLE
extern struct dev_power_governor pm_domain_cpu_gov;
#endif
#else

static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
{
	return ERR_PTR(-ENOSYS);
}
static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
				      struct device *dev)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_device(struct device *dev)
{
	return -ENOSYS;
}
static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
					 struct generic_pm_domain *subdomain)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
					    struct generic_pm_domain *subdomain)
{
	return -ENOSYS;
}
static inline int pm_genpd_init(struct generic_pm_domain *genpd,
				struct dev_power_governor *gov, bool is_off)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
{
	return -EOPNOTSUPP;
}

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

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

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

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

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

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

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

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

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

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

/* OF PM domain providers */
struct of_device_id;

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

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

#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
int of_genpd_add_provider_simple(struct device_node *np,
				 struct generic_pm_domain *genpd);
int of_genpd_add_provider_onecell(struct device_node *np,
				  struct genpd_onecell_data *data);
void of_genpd_del_provider(struct device_node *np);
int of_genpd_add_device(const struct of_phandle_args *args, struct device *dev);
int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec,
			   const struct of_phandle_args *subdomain_spec);
int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec,
			      const struct of_phandle_args *subdomain_spec);
struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
int of_genpd_parse_idle_states(struct device_node *dn,
			       struct genpd_power_state **states, int *n);

int genpd_dev_pm_attach(struct device *dev);
struct device *genpd_dev_pm_attach_by_id(struct device *dev,
					 unsigned int index);
struct device *genpd_dev_pm_attach_by_name(struct device *dev,
					   const char *name);
#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
static inline int of_genpd_add_provider_simple(struct device_node *np,
					struct generic_pm_domain *genpd)
{
	return -EOPNOTSUPP;
}

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

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

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

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

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

static inline int of_genpd_parse_idle_states(struct device_node *dn,
			struct genpd_power_state **states, int *n)
{
	return -ENODEV;
}

static inline int genpd_dev_pm_attach(struct device *dev)
{
	return 0;
}

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

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

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

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

static inline int devm_pm_domain_attach_list(struct device *dev,
					     const struct dev_pm_domain_attach_data *data,
					     struct dev_pm_domain_list **list)
{
	return 0;
}

static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
static inline void dev_pm_domain_detach_list(struct dev_pm_domain_list *list) {}
static inline int dev_pm_domain_start(struct device *dev)
{
	return 0;
}
static inline void dev_pm_domain_set(struct device *dev,
				     struct dev_pm_domain *pd) {}
static inline int dev_pm_domain_set_performance_state(struct device *dev,
						      unsigned int state)
{
	return 0;
}
#endif

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