[GitHub/moto-9609/android_kernel_motorola_exynos9610.git] / include / linux / pm_domain.h

/*
 * pm_domain.h - Definitions and headers related to device power domains.
 *
 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
 *
 * This file is released under the GPLv2.
 */

#ifndef _LINUX_PM_DOMAIN_H
#define _LINUX_PM_DOMAIN_H

#include <linux/device.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>

/* Defines used for the flags field in the struct generic_pm_domain */
#define GENPD_FLAG_PM_CLK	(1U << 0) /* PM domain uses PM clk */
#define GENPD_FLAG_IRQ_SAFE	(1U << 1) /* PM domain operates in atomic */
#define GENPD_FLAG_ALWAYS_ON	(1U << 2) /* PM domain is always powered on */

enum gpd_status {
	GPD_STATE_ACTIVE = 0,	/* PM domain is active */
	GPD_STATE_POWER_OFF,	/* PM domain is off */
};

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);
	bool (*active_wakeup)(struct device *dev);
};

struct genpd_power_state {
	s64 power_off_latency_ns;
	s64 power_on_latency_ns;
	s64 residency_ns;
	struct fwnode_handle *fwnode;
	ktime_t idle_time;
};

struct genpd_lock_ops;

struct generic_pm_domain {
	struct dev_pm_domain domain;	/* PM domain operations */
	struct list_head gpd_list_node;	/* Node in the global PM domains list */
	struct list_head master_links;	/* Links with PM domain as a master */
	struct list_head slave_links;	/* Links with PM domain as a slave */
	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 */
	int (*power_off)(struct generic_pm_domain *domain);
	int (*power_on)(struct generic_pm_domain *domain);
	struct gpd_dev_ops dev_ops;
	s64 max_off_time_ns;	/* Maximum allowed "suspended" time. */
	bool max_off_time_changed;
	bool cached_power_down_ok;
	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;
	unsigned int state_count; /* number of states */
	unsigned int state_idx; /* state that genpd will go to when off */
	void *free; /* Free the state that was allocated for default */
	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 *master;
	struct list_head master_node;
	struct generic_pm_domain *slave;
	struct list_head slave_node;
};

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

extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
				 struct device *dev,
				 struct gpd_timing_data *td);

extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
				  struct device *dev);
extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
				  struct generic_pm_domain *new_subdomain);
extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
				     struct generic_pm_domain *target);
extern int pm_genpd_init(struct generic_pm_domain *genpd,
			 struct dev_power_governor *gov, bool is_off);
extern int pm_genpd_remove(struct generic_pm_domain *genpd);

extern struct dev_power_governor simple_qos_governor;
extern struct dev_power_governor pm_domain_always_on_gov;
#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,
					struct gpd_timing_data *td)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
					 struct device *dev)
{
	return -ENOSYS;
}
static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
					 struct generic_pm_domain *new_sd)
{
	return -ENOSYS;
}
static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
					    struct generic_pm_domain *target)
{
	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 -ENOTSUPP;
}

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

static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
				      struct device *dev)
{
	return __pm_genpd_add_device(genpd, dev, NULL);
}

#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
extern void pm_genpd_syscore_poweroff(struct device *dev);
extern void pm_genpd_syscore_poweron(struct device *dev);
#else
static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
static inline void pm_genpd_syscore_poweron(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);
extern int of_genpd_add_device(struct of_phandle_args *args,
			       struct device *dev);
extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
				  struct of_phandle_args *new_subdomain);
extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
extern 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);
#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
static inline int of_genpd_add_provider_simple(struct device_node *np,
					struct generic_pm_domain *genpd)
{
	return -ENOTSUPP;
}

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

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,
					 struct of_phandle_args *new_subdomain)
{
	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 -ENODEV;
}

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

#ifdef CONFIG_PM
extern int dev_pm_domain_attach(struct device *dev, bool power_on);
extern void dev_pm_domain_detach(struct device *dev, bool power_off);
extern 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 -ENODEV;
}
static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
static inline void dev_pm_domain_set(struct device *dev,
				     struct dev_pm_domain *pd) {}
#endif

#endif /* _LINUX_PM_DOMAIN_H */
Commit	Line	Data
f721889f RW	1	/*
	2	* pm_domain.h - Definitions and headers related to device power domains.
	3	*
	4	* Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
	5	*
	6	* This file is released under the GPLv2.
	7	*/
	8
	9	#ifndef _LINUX_PM_DOMAIN_H
	10	#define _LINUX_PM_DOMAIN_H
	11
	12	#include <linux/device.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>
f721889f	19
c11f6f5b UH	20	/* Defines used for the flags field in the struct generic_pm_domain */
c11f6f5b UH	21	#define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */
d716f479	22	#define GENPD_FLAG_IRQ_SAFE (1U << 1) /* PM domain operates in atomic */
ffaa42e8	23	#define GENPD_FLAG_ALWAYS_ON (1U << 2) /* PM domain is always powered on */
c11f6f5b	24
17b75eca RW	25	enum gpd_status {
17b75eca RW	26	GPD_STATE_ACTIVE = 0, /* PM domain is active */
17b75eca RW	27	GPD_STATE_POWER_OFF, /* PM domain is off */
17b75eca RW	28	};
596ba34b	29
f721889f RW	30	struct dev_power_governor {
f721889f RW	31	bool (power_down_ok)(struct dev_pm_domain domain);
9df3921e	32	bool (suspend_ok)(struct device dev);
f721889f RW	33	};
f721889f RW	34
d5e4cbfe RW	35	struct gpd_dev_ops {
	36	int (start)(struct device dev);
	37	int (stop)(struct device dev);
	38	bool (active_wakeup)(struct device dev);
	39	};
	40
fc5cbf0c AH	41	struct genpd_power_state {
	42	s64 power_off_latency_ns;
	43	s64 power_on_latency_ns;
405f7226	44	s64 residency_ns;
0c9b694a	45	struct fwnode_handle *fwnode;
afece3ab	46	ktime_t idle_time;
fc5cbf0c AH	47	};
fc5cbf0c AH	48
35241d12 LI	49	struct genpd_lock_ops;
35241d12 LI	50
f721889f RW	51	struct generic_pm_domain {
f721889f RW	52	struct dev_pm_domain domain; /* PM domain operations */
5125bbf3	53	struct list_head gpd_list_node; /* Node in the global PM domains list */
5063ce15 RW	54	struct list_head master_links; /* Links with PM domain as a master */
5063ce15 RW	55	struct list_head slave_links; /* Links with PM domain as a slave */
f721889f	56	struct list_head dev_list; /* List of devices */
f721889f RW	57	struct dev_power_governor *gov;
f721889f RW	58	struct work_struct power_off_work;
de0aa06d JH	59	struct fwnode_handle provider; / Identity of the domain provider */
de0aa06d JH	60	bool has_provider;
d07e9c17	61	const char *name;
c4bb3160	62	atomic_t sd_count; /* Number of subdomains with power "on" */
17b75eca	63	enum gpd_status status; /* Current state of the domain */
596ba34b RW	64	unsigned int device_count; /* Number of devices */
	65	unsigned int suspended_count; /* System suspend device counter */
	66	unsigned int prepared_count; /* Suspend counter of prepared devices */
f721889f RW	67	int (power_off)(struct generic_pm_domain domain);
f721889f RW	68	int (power_on)(struct generic_pm_domain domain);
d5e4cbfe	69	struct gpd_dev_ops dev_ops;
221e9b58	70	s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
6ff7bb0d RW	71	bool max_off_time_changed;
6ff7bb0d RW	72	bool cached_power_down_ok;
c16561e8 UH	73	int (attach_dev)(struct generic_pm_domain domain,
	74	struct device *dev);
	75	void (detach_dev)(struct generic_pm_domain domain,
	76	struct device *dev);
c11f6f5b	77	unsigned int flags; /* Bit field of configs for genpd */
59d65b73	78	struct genpd_power_state *states;
fc5cbf0c AH	79	unsigned int state_count; /* number of states */
fc5cbf0c AH	80	unsigned int state_idx; /* state that genpd will go to when off */
59d65b73	81	void free; / Free the state that was allocated for default */
afece3ab TG	82	ktime_t on_time;
afece3ab TG	83	ktime_t accounting_time;
35241d12	84	const struct genpd_lock_ops *lock_ops;
d716f479 LI	85	union {
	86	struct mutex mlock;
	87	struct {
	88	spinlock_t slock;
	89	unsigned long lock_flags;
	90	};
	91	};
fc5cbf0c	92
f721889f RW	93	};
f721889f RW	94
596ba34b RW	95	static inline struct generic_pm_domain pd_to_genpd(struct dev_pm_domain pd)
	96	{
	97	return container_of(pd, struct generic_pm_domain, domain);
	98	}
	99
5063ce15 RW	100	struct gpd_link {
	101	struct generic_pm_domain *master;
	102	struct list_head master_node;
	103	struct generic_pm_domain *slave;
	104	struct list_head slave_node;
	105	};
	106
b02c999a	107	struct gpd_timing_data {
2b1d88cd UH	108	s64 suspend_latency_ns;
2b1d88cd UH	109	s64 resume_latency_ns;
a5bef810	110	s64 effective_constraint_ns;
6ff7bb0d	111	bool constraint_changed;
9df3921e	112	bool cached_suspend_ok;
b02c999a RW	113	};
b02c999a RW	114
00e7c295 UH	115	struct pm_domain_data {
	116	struct list_head list_node;
	117	struct device *dev;
	118	};
	119
cd0ea672 RW	120	struct generic_pm_domain_data {
cd0ea672 RW	121	struct pm_domain_data base;
b02c999a	122	struct gpd_timing_data td;
6ff7bb0d	123	struct notifier_block nb;
a5ea7a0f	124	void *data;
cd0ea672 RW	125	};
cd0ea672 RW	126
9b4f617b	127	#ifdef CONFIG_PM_GENERIC_DOMAINS
cd0ea672 RW	128	static inline struct generic_pm_domain_data to_gpd_data(struct pm_domain_data pdd)
	129	{
	130	return container_of(pdd, struct generic_pm_domain_data, base);
	131	}
	132
d5e4cbfe RW	133	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	134	{
	135	return to_gpd_data(dev->power.subsys_data->domain_data);
	136	}
	137
b02c999a RW	138	extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	139	struct device *dev,
	140	struct gpd_timing_data *td);
	141
f721889f RW	142	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	143	struct device *dev);
	144	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	145	struct generic_pm_domain *new_subdomain);
	146	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	147	struct generic_pm_domain *target);
7eb231c3 UH	148	extern int pm_genpd_init(struct generic_pm_domain *genpd,
7eb231c3 UH	149	struct dev_power_governor *gov, bool is_off);
3fe57710	150	extern int pm_genpd_remove(struct generic_pm_domain *genpd);
b02c999a	151
ae3c511c	152	extern struct dev_power_governor simple_qos_governor;
925b44a2	153	extern struct dev_power_governor pm_domain_always_on_gov;
f721889f	154	#else
b02c999a	155
b642631d MD	156	static inline struct generic_pm_domain_data dev_gpd_data(struct device dev)
	157	{
	158	return ERR_PTR(-ENOSYS);
	159	}
b02c999a RW	160	static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
	161	struct device *dev,
	162	struct gpd_timing_data *td)
	163	{
	164	return -ENOSYS;
	165	}
f721889f RW	166	static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	167	struct device *dev)
	168	{
	169	return -ENOSYS;
	170	}
	171	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	172	struct generic_pm_domain *new_sd)
	173	{
	174	return -ENOSYS;
	175	}
	176	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	177	struct generic_pm_domain *target)
	178	{
	179	return -ENOSYS;
	180	}
7eb231c3 UH	181	static inline int pm_genpd_init(struct generic_pm_domain *genpd,
7eb231c3 UH	182	struct dev_power_governor *gov, bool is_off)
b02c999a	183	{
7eb231c3	184	return -ENOSYS;
b02c999a	185	}
3fe57710 JH	186	static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
	187	{
	188	return -ENOTSUPP;
	189	}
16d0bf18 GU	190
	191	#define simple_qos_governor ((struct dev_power_governor )(NULL))
	192	#define pm_domain_always_on_gov ((struct dev_power_governor )(NULL))
17f2ae7f RW	193	#endif
17f2ae7f RW	194
b5abb085 RW	195	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	196	struct device *dev)
	197	{
	198	return __pm_genpd_add_device(genpd, dev, NULL);
	199	}
	200
77f827de	201	#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
d47e6464 UH	202	extern void pm_genpd_syscore_poweroff(struct device *dev);
d47e6464 UH	203	extern void pm_genpd_syscore_poweron(struct device *dev);
77f827de	204	#else
d47e6464 UH	205	static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
d47e6464 UH	206	static inline void pm_genpd_syscore_poweron(struct device *dev) {}
77f827de RW	207	#endif
77f827de RW	208
aa42240a TF	209	/* OF PM domain providers */
	210	struct of_device_id;
	211
40845524 TR	212	typedef struct generic_pm_domain (genpd_xlate_t)(struct of_phandle_args *args,
	213	void *data);
	214
aa42240a TF	215	struct genpd_onecell_data {
	216	struct generic_pm_domain **domains;
	217	unsigned int num_domains;
40845524	218	genpd_xlate_t xlate;
aa42240a TF	219	};
aa42240a TF	220
aa42240a	221	#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
892ebdcc JH	222	int of_genpd_add_provider_simple(struct device_node *np,
	223	struct generic_pm_domain *genpd);
	224	int of_genpd_add_provider_onecell(struct device_node *np,
	225	struct genpd_onecell_data *data);
aa42240a	226	void of_genpd_del_provider(struct device_node *np);
ec69572b JH	227	extern int of_genpd_add_device(struct of_phandle_args *args,
	228	struct device *dev);
	229	extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
	230	struct of_phandle_args *new_subdomain);
17926551	231	extern struct generic_pm_domain of_genpd_remove_last(struct device_node np);
30f60428 LI	232	extern int of_genpd_parse_idle_states(struct device_node *dn,
30f60428 LI	233	struct genpd_power_state *states, int n);
aa42240a TF	234
	235	int genpd_dev_pm_attach(struct device *dev);
	236	#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
892ebdcc JH	237	static inline int of_genpd_add_provider_simple(struct device_node *np,
892ebdcc JH	238	struct generic_pm_domain *genpd)
aa42240a	239	{
892ebdcc JH	240	return -ENOTSUPP;
	241	}
	242
	243	static inline int of_genpd_add_provider_onecell(struct device_node *np,
	244	struct genpd_onecell_data *data)
	245	{
	246	return -ENOTSUPP;
aa42240a	247	}
aa42240a	248
892ebdcc	249	static inline void of_genpd_del_provider(struct device_node *np) {}
aa42240a	250
ec69572b JH	251	static inline int of_genpd_add_device(struct of_phandle_args *args,
	252	struct device *dev)
	253	{
	254	return -ENODEV;
	255	}
	256
	257	static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
	258	struct of_phandle_args *new_subdomain)
	259	{
	260	return -ENODEV;
	261	}
	262
30f60428 LI	263	static inline int of_genpd_parse_idle_states(struct device_node *dn,
	264	struct genpd_power_state *states, int n)
	265	{
	266	return -ENODEV;
	267	}
	268
aa42240a TF	269	static inline int genpd_dev_pm_attach(struct device *dev)
	270	{
	271	return -ENODEV;
	272	}
17926551 JH	273
	274	static inline
	275	struct generic_pm_domain of_genpd_remove_last(struct device_node np)
	276	{
	277	return ERR_PTR(-ENOTSUPP);
	278	}
aa42240a TF	279	#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
aa42240a TF	280
f48c767c UH	281	#ifdef CONFIG_PM
	282	extern int dev_pm_domain_attach(struct device *dev, bool power_on);
	283	extern void dev_pm_domain_detach(struct device *dev, bool power_off);
989561de	284	extern void dev_pm_domain_set(struct device dev, struct dev_pm_domain pd);
f48c767c UH	285	#else
	286	static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
	287	{
	288	return -ENODEV;
	289	}
	290	static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
989561de TV	291	static inline void dev_pm_domain_set(struct device *dev,
989561de TV	292	struct dev_pm_domain *pd) {}
f48c767c UH	293	#endif
f48c767c UH	294
f721889f	295	#endif /* _LINUX_PM_DOMAIN_H */