[deliverable/linux.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>

#define GPD_IN_SUSPEND	1
#define GPD_POWER_OFF	2

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

struct generic_pm_domain {
	struct dev_pm_domain domain;	/* PM domain operations */
	struct list_head sd_node;	/* Node in the parent's subdomain list */
	struct generic_pm_domain *parent;	/* Parent PM domain */
	struct list_head sd_list;	/* List of dubdomains */
	struct list_head dev_list;	/* List of devices */
	struct mutex lock;
	struct dev_power_governor *gov;
	struct work_struct power_off_work;
	unsigned int in_progress;	/* Number of devices being suspended now */
	unsigned int sd_count;	/* Number of subdomains with power "on" */
	bool power_is_off;	/* Whether or not power has been removed */
	unsigned int device_count;	/* Number of devices */
	unsigned int suspended_count;	/* System suspend device counter */
	unsigned int prepared_count;	/* Suspend counter of prepared devices */
	bool suspend_power_off;	/* Power status before system suspend */
	int (*power_off)(struct generic_pm_domain *domain);
	int (*power_on)(struct generic_pm_domain *domain);
	int (*start_device)(struct device *dev);
	int (*stop_device)(struct device *dev);
	bool (*active_wakeup)(struct device *dev);
};

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

struct dev_list_entry {
	struct list_head node;
	struct device *dev;
	bool need_restore;
};

#ifdef CONFIG_PM_GENERIC_DOMAINS
extern int pm_genpd_add_device(struct generic_pm_domain *genpd,
			       struct device *dev);
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 void pm_genpd_init(struct generic_pm_domain *genpd,
			  struct dev_power_governor *gov, bool is_off);
extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
#else
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 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 void pm_genpd_init(struct generic_pm_domain *genpd,
				 struct dev_power_governor *gov, bool is_off) {}
static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
{
	return -ENOSYS;
}
#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>
	13
596ba34b RW	14	#define GPD_IN_SUSPEND 1
	15	#define GPD_POWER_OFF 2
	16
f721889f RW	17	struct dev_power_governor {
	18	bool (power_down_ok)(struct dev_pm_domain domain);
	19	};
	20
	21	struct generic_pm_domain {
	22	struct dev_pm_domain domain; /* PM domain operations */
	23	struct list_head sd_node; /* Node in the parent's subdomain list */
	24	struct generic_pm_domain parent; / Parent PM domain */
	25	struct list_head sd_list; /* List of dubdomains */
	26	struct list_head dev_list; /* List of devices */
	27	struct mutex lock;
	28	struct dev_power_governor *gov;
	29	struct work_struct power_off_work;
	30	unsigned int in_progress; /* Number of devices being suspended now */
	31	unsigned int sd_count; /* Number of subdomains with power "on" */
	32	bool power_is_off; /* Whether or not power has been removed */
596ba34b RW	33	unsigned int device_count; /* Number of devices */
	34	unsigned int suspended_count; /* System suspend device counter */
	35	unsigned int prepared_count; /* Suspend counter of prepared devices */
	36	bool suspend_power_off; /* Power status before system suspend */
f721889f RW	37	int (power_off)(struct generic_pm_domain domain);
	38	int (power_on)(struct generic_pm_domain domain);
	39	int (start_device)(struct device dev);
	40	int (stop_device)(struct device dev);
d4f2d87a	41	bool (active_wakeup)(struct device dev);
f721889f RW	42	};
f721889f RW	43
596ba34b RW	44	static inline struct generic_pm_domain pd_to_genpd(struct dev_pm_domain pd)
	45	{
	46	return container_of(pd, struct generic_pm_domain, domain);
	47	}
	48
f721889f RW	49	struct dev_list_entry {
	50	struct list_head node;
	51	struct device *dev;
	52	bool need_restore;
	53	};
	54
	55	#ifdef CONFIG_PM_GENERIC_DOMAINS
	56	extern int pm_genpd_add_device(struct generic_pm_domain *genpd,
	57	struct device *dev);
	58	extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	59	struct device *dev);
	60	extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	61	struct generic_pm_domain *new_subdomain);
	62	extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	63	struct generic_pm_domain *target);
	64	extern void pm_genpd_init(struct generic_pm_domain *genpd,
	65	struct dev_power_governor *gov, bool is_off);
18b4f3f5	66	extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
f721889f RW	67	#else
	68	static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
	69	struct device *dev)
	70	{
	71	return -ENOSYS;
	72	}
	73	static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
	74	struct device *dev)
	75	{
	76	return -ENOSYS;
	77	}
	78	static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
	79	struct generic_pm_domain *new_sd)
	80	{
	81	return -ENOSYS;
	82	}
	83	static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
	84	struct generic_pm_domain *target)
	85	{
	86	return -ENOSYS;
	87	}
	88	static inline void pm_genpd_init(struct generic_pm_domain *genpd,
	89	struct dev_power_governor *gov, bool is_off) {}
18b4f3f5 MD	90	static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
	91	{
	92	return -ENOSYS;
	93	}
f721889f RW	94	#endif
	95
	96	#endif /* _LINUX_PM_DOMAIN_H */