[net-next-2.6.git] / include / linux / pm_wakeup.h

/*
 *  pm_wakeup.h - Power management wakeup interface
 *
 *  Copyright (C) 2008 Alan Stern
 *  Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _LINUX_PM_WAKEUP_H
#define _LINUX_PM_WAKEUP_H

#ifndef _DEVICE_H_
# error "please don't include this file directly"
#endif

#include <linux/types.h>

/**
 * struct wakeup_source - Representation of wakeup sources
 *
 * @total_time: Total time this wakeup source has been active.
 * @max_time: Maximum time this wakeup source has been continuously active.
 * @last_time: Monotonic clock when the wakeup source's was activated last time.
 * @event_count: Number of signaled wakeup events.
 * @active_count: Number of times the wakeup sorce was activated.
 * @relax_count: Number of times the wakeup sorce was deactivated.
 * @hit_count: Number of times the wakeup sorce might abort system suspend.
 * @active: Status of the wakeup source.
 */
struct wakeup_source {
	char 			*name;
	struct list_head	entry;
	spinlock_t		lock;
	struct timer_list	timer;
	unsigned long		timer_expires;
	ktime_t total_time;
	ktime_t max_time;
	ktime_t last_time;
	unsigned long		event_count;
	unsigned long		active_count;
	unsigned long		relax_count;
	unsigned long		hit_count;
	unsigned int		active:1;
};

#ifdef CONFIG_PM_SLEEP

/*
 * Changes to device_may_wakeup take effect on the next pm state change.
 */

static inline void device_set_wakeup_capable(struct device *dev, bool capable)
{
	dev->power.can_wakeup = capable;
}

static inline bool device_can_wakeup(struct device *dev)
{
	return dev->power.can_wakeup;
}


static inline bool device_may_wakeup(struct device *dev)
{
	return dev->power.can_wakeup && !!dev->power.wakeup;
}

/* drivers/base/power/wakeup.c */
extern struct wakeup_source *wakeup_source_create(const char *name);
extern void wakeup_source_destroy(struct wakeup_source *ws);
extern void wakeup_source_add(struct wakeup_source *ws);
extern void wakeup_source_remove(struct wakeup_source *ws);
extern struct wakeup_source *wakeup_source_register(const char *name);
extern void wakeup_source_unregister(struct wakeup_source *ws);
extern int device_wakeup_enable(struct device *dev);
extern int device_wakeup_disable(struct device *dev);
extern int device_init_wakeup(struct device *dev, bool val);
extern int device_set_wakeup_enable(struct device *dev, bool enable);
extern void __pm_stay_awake(struct wakeup_source *ws);
extern void pm_stay_awake(struct device *dev);
extern void __pm_relax(struct wakeup_source *ws);
extern void pm_relax(struct device *dev);
extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
extern void pm_wakeup_event(struct device *dev, unsigned int msec);

#else /* !CONFIG_PM_SLEEP */

static inline void device_set_wakeup_capable(struct device *dev, bool capable)
{
	dev->power.can_wakeup = capable;
}

static inline bool device_can_wakeup(struct device *dev)
{
	return dev->power.can_wakeup;
}

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

static inline struct wakeup_source *wakeup_source_create(const char *name)
{
	return NULL;
}

static inline void wakeup_source_destroy(struct wakeup_source *ws) {}

static inline void wakeup_source_add(struct wakeup_source *ws) {}

static inline void wakeup_source_remove(struct wakeup_source *ws) {}

static inline struct wakeup_source *wakeup_source_register(const char *name)
{
	return NULL;
}

static inline void wakeup_source_unregister(struct wakeup_source *ws) {}

static inline int device_wakeup_enable(struct device *dev)
{
	return -EINVAL;
}

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

static inline int device_init_wakeup(struct device *dev, bool val)
{
	dev->power.can_wakeup = val;
	return val ? -EINVAL : 0;
}


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

static inline void __pm_stay_awake(struct wakeup_source *ws) {}

static inline void pm_stay_awake(struct device *dev) {}

static inline void __pm_relax(struct wakeup_source *ws) {}

static inline void pm_relax(struct device *dev) {}

static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}

static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}

#endif /* !CONFIG_PM_SLEEP */

#endif /* _LINUX_PM_WAKEUP_H */
Commit	Line	Data
9a3df1f7 AS	1	/*
	2	* pm_wakeup.h - Power management wakeup interface
	3	*
	4	* Copyright (C) 2008 Alan Stern
074037ec	5	* Copyright (C) 2010 Rafael J. Wysocki, Novell Inc.
9a3df1f7 AS	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*/
	21
	22	#ifndef _LINUX_PM_WAKEUP_H
	23	#define _LINUX_PM_WAKEUP_H
	24
	25	#ifndef _DEVICE_H_
	26	# error "please don't include this file directly"
	27	#endif
	28
228c54ef DT	29	#include <linux/types.h>
228c54ef DT	30
074037ec RW	31	/**
074037ec RW	32	* struct wakeup_source - Representation of wakeup sources
2430d12c	33	*
074037ec RW	34	* @total_time: Total time this wakeup source has been active.
	35	* @max_time: Maximum time this wakeup source has been continuously active.
	36	* @last_time: Monotonic clock when the wakeup source's was activated last time.
	37	* @event_count: Number of signaled wakeup events.
	38	* @active_count: Number of times the wakeup sorce was activated.
	39	* @relax_count: Number of times the wakeup sorce was deactivated.
	40	* @hit_count: Number of times the wakeup sorce might abort system suspend.
	41	* @active: Status of the wakeup source.
9a3df1f7	42	*/
074037ec RW	43	struct wakeup_source {
	44	char *name;
	45	struct list_head entry;
	46	spinlock_t lock;
	47	struct timer_list timer;
	48	unsigned long timer_expires;
	49	ktime_t total_time;
	50	ktime_t max_time;
	51	ktime_t last_time;
	52	unsigned long event_count;
	53	unsigned long active_count;
	54	unsigned long relax_count;
	55	unsigned long hit_count;
	56	unsigned int active:1;
	57	};
	58
	59	#ifdef CONFIG_PM_SLEEP
	60
	61	/*
	62	* Changes to device_may_wakeup take effect on the next pm state change.
	63	*/
	64
	65	static inline void device_set_wakeup_capable(struct device *dev, bool capable)
	66	{
	67	dev->power.can_wakeup = capable;
	68	}
	69
	70	static inline bool device_can_wakeup(struct device *dev)
	71	{
	72	return dev->power.can_wakeup;
	73	}
	74
	75
	76
	77	static inline bool device_may_wakeup(struct device *dev)
9a3df1f7	78	{
074037ec	79	return dev->power.can_wakeup && !!dev->power.wakeup;
9a3df1f7 AS	80	}
9a3df1f7 AS	81
074037ec RW	82	/* drivers/base/power/wakeup.c */
	83	extern struct wakeup_source wakeup_source_create(const char name);
	84	extern void wakeup_source_destroy(struct wakeup_source *ws);
	85	extern void wakeup_source_add(struct wakeup_source *ws);
	86	extern void wakeup_source_remove(struct wakeup_source *ws);
	87	extern struct wakeup_source wakeup_source_register(const char name);
	88	extern void wakeup_source_unregister(struct wakeup_source *ws);
	89	extern int device_wakeup_enable(struct device *dev);
	90	extern int device_wakeup_disable(struct device *dev);
	91	extern int device_init_wakeup(struct device *dev, bool val);
	92	extern int device_set_wakeup_enable(struct device *dev, bool enable);
	93	extern void __pm_stay_awake(struct wakeup_source *ws);
	94	extern void pm_stay_awake(struct device *dev);
	95	extern void __pm_relax(struct wakeup_source *ws);
	96	extern void pm_relax(struct device *dev);
	97	extern void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec);
	98	extern void pm_wakeup_event(struct device *dev, unsigned int msec);
	99
	100	#else /* !CONFIG_PM_SLEEP */
	101
228c54ef	102	static inline void device_set_wakeup_capable(struct device *dev, bool capable)
eb9d0fe4	103	{
228c54ef	104	dev->power.can_wakeup = capable;
eb9d0fe4 RW	105	}
eb9d0fe4 RW	106
228c54ef	107	static inline bool device_can_wakeup(struct device *dev)
9a3df1f7 AS	108	{
	109	return dev->power.can_wakeup;
	110	}
	111
074037ec	112	static inline bool device_may_wakeup(struct device *dev)
9a3df1f7	113	{
074037ec	114	return false;
9a3df1f7 AS	115	}
9a3df1f7 AS	116
074037ec	117	static inline struct wakeup_source wakeup_source_create(const char name)
9a3df1f7	118	{
074037ec	119	return NULL;
9a3df1f7 AS	120	}
9a3df1f7 AS	121
074037ec RW	122	static inline void wakeup_source_destroy(struct wakeup_source *ws) {}
	123
	124	static inline void wakeup_source_add(struct wakeup_source *ws) {}
9a3df1f7	125
074037ec RW	126	static inline void wakeup_source_remove(struct wakeup_source *ws) {}
	127
	128	static inline struct wakeup_source wakeup_source_register(const char name)
9a3df1f7	129	{
074037ec	130	return NULL;
9a3df1f7 AS	131	}
9a3df1f7 AS	132
074037ec RW	133	static inline void wakeup_source_unregister(struct wakeup_source *ws) {}
	134
	135	static inline int device_wakeup_enable(struct device *dev)
228c54ef	136	{
074037ec	137	return -EINVAL;
228c54ef	138	}
c300bd2f	139
074037ec	140	static inline int device_wakeup_disable(struct device *dev)
9a3df1f7	141	{
074037ec	142	return 0;
9a3df1f7 AS	143	}
9a3df1f7 AS	144
074037ec	145	static inline int device_init_wakeup(struct device *dev, bool val)
228c54ef	146	{
074037ec RW	147	dev->power.can_wakeup = val;
074037ec RW	148	return val ? -EINVAL : 0;
228c54ef DT	149	}
228c54ef DT	150
074037ec RW	151
074037ec RW	152	static inline int device_set_wakeup_enable(struct device *dev, bool enable)
228c54ef	153	{
074037ec	154	return -EINVAL;
228c54ef	155	}
9a3df1f7	156
074037ec RW	157	static inline void __pm_stay_awake(struct wakeup_source *ws) {}
	158
	159	static inline void pm_stay_awake(struct device *dev) {}
	160
	161	static inline void __pm_relax(struct wakeup_source *ws) {}
	162
	163	static inline void pm_relax(struct device *dev) {}
	164
	165	static inline void __pm_wakeup_event(struct wakeup_source *ws, unsigned int msec) {}
	166
	167	static inline void pm_wakeup_event(struct device *dev, unsigned int msec) {}
	168
	169	#endif /* !CONFIG_PM_SLEEP */
9a3df1f7 AS	170
9a3df1f7 AS	171	#endif /* _LINUX_PM_WAKEUP_H */