[mirror_ubuntu-artful-kernel.git] / include / linux / pm.h

/*
 *  pm.h - Power management interface
 *
 *  Copyright (C) 2000 Andrew Henroid
 *
 *  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_H
#define _LINUX_PM_H

#ifdef __KERNEL__

#include <linux/list.h>
#include <asm/atomic.h>

/*
 * Power management requests... these are passed to pm_send_all() and friends.
 *
 * these functions are old and deprecated, see below.
 */
typedef int __bitwise pm_request_t;

#define PM_SUSPEND	((__force pm_request_t) 1)	/* enter D1-D3 */
#define PM_RESUME	((__force pm_request_t) 2)	/* enter D0 */


/*
 * Device types... these are passed to pm_register
 */
typedef int __bitwise pm_dev_t;

#define PM_UNKNOWN_DEV	((__force pm_dev_t) 0)	/* generic */
#define PM_SYS_DEV	((__force pm_dev_t) 1)	/* system device (fan, KB controller, ...) */
#define PM_PCI_DEV	((__force pm_dev_t) 2)	/* PCI device */
#define PM_USB_DEV	((__force pm_dev_t) 3)	/* USB device */
#define PM_SCSI_DEV	((__force pm_dev_t) 4)	/* SCSI device */
#define PM_ISA_DEV	((__force pm_dev_t) 5)	/* ISA device */
#define	PM_MTD_DEV	((__force pm_dev_t) 6)	/* Memory Technology Device */

/*
 * System device hardware ID (PnP) values
 */
enum
{
	PM_SYS_UNKNOWN = 0x00000000, /* generic */
	PM_SYS_KBC =	 0x41d00303, /* keyboard controller */
	PM_SYS_COM =	 0x41d00500, /* serial port */
	PM_SYS_IRDA =	 0x41d00510, /* IRDA controller */
	PM_SYS_FDC =	 0x41d00700, /* floppy controller */
	PM_SYS_VGA =	 0x41d00900, /* VGA controller */
	PM_SYS_PCMCIA =	 0x41d00e00, /* PCMCIA controller */
};

/*
 * Device identifier
 */
#define PM_PCI_ID(dev) ((dev)->bus->number << 16 | (dev)->devfn)

/*
 * Request handler callback
 */
struct pm_dev;

typedef int (*pm_callback)(struct pm_dev *dev, pm_request_t rqst, void *data);

/*
 * Dynamic device information
 */
struct pm_dev
{
	pm_dev_t	 type;
	unsigned long	 id;
	pm_callback	 callback;
	void		*data;

	unsigned long	 flags;
	unsigned long	 state;
	unsigned long	 prev_state;

	struct list_head entry;
};

/* Functions above this comment are list-based old-style power
 * managment. Please avoid using them.  */

/*
 * Callbacks for platform drivers to implement.
 */
extern void (*pm_idle)(void);
extern void (*pm_power_off)(void);

typedef int __bitwise suspend_state_t;

#define PM_SUSPEND_ON		((__force suspend_state_t) 0)
#define PM_SUSPEND_STANDBY	((__force suspend_state_t) 1)
#define PM_SUSPEND_MEM		((__force suspend_state_t) 3)
#define PM_SUSPEND_DISK		((__force suspend_state_t) 4)
#define PM_SUSPEND_MAX		((__force suspend_state_t) 5)

typedef int __bitwise suspend_disk_method_t;

#define	PM_DISK_FIRMWARE	((__force suspend_disk_method_t) 1)
#define	PM_DISK_PLATFORM	((__force suspend_disk_method_t) 2)
#define	PM_DISK_SHUTDOWN	((__force suspend_disk_method_t) 3)
#define	PM_DISK_REBOOT		((__force suspend_disk_method_t) 4)
#define	PM_DISK_TEST		((__force suspend_disk_method_t) 5)
#define	PM_DISK_TESTPROC	((__force suspend_disk_method_t) 6)
#define	PM_DISK_MAX		((__force suspend_disk_method_t) 7)

struct pm_ops {
	suspend_disk_method_t pm_disk_mode;
	int (*valid)(suspend_state_t state);
	int (*prepare)(suspend_state_t state);
	int (*enter)(suspend_state_t state);
	int (*finish)(suspend_state_t state);
};

extern void pm_set_ops(struct pm_ops *);
extern struct pm_ops *pm_ops;
extern int pm_suspend(suspend_state_t state);


/*
 * Device power management
 */

struct device;

typedef struct pm_message {
	int event;
} pm_message_t;

/*
 * Several driver power state transitions are externally visible, affecting
 * the state of pending I/O queues and (for drivers that touch hardware)
 * interrupts, wakeups, DMA, and other hardware state.  There may also be
 * internal transitions to various low power modes, which are transparent
 * to the rest of the driver stack (such as a driver that's ON gating off
 * clocks which are not in active use).
 *
 * One transition is triggered by resume(), after a suspend() call; the
 * message is implicit:
 *
 * ON		Driver starts working again, responding to hardware events
 * 		and software requests.  The hardware may have gone through
 * 		a power-off reset, or it may have maintained state from the
 * 		previous suspend() which the driver will rely on while
 * 		resuming.  On most platforms, there are no restrictions on
 * 		availability of resources like clocks during resume().
 *
 * Other transitions are triggered by messages sent using suspend().  All
 * these transitions quiesce the driver, so that I/O queues are inactive.
 * That commonly entails turning off IRQs and DMA; there may be rules
 * about how to quiesce that are specific to the bus or the device's type.
 * (For example, network drivers mark the link state.)  Other details may
 * differ according to the message:
 *
 * SUSPEND	Quiesce, enter a low power device state appropriate for
 * 		the upcoming system state (such as PCI_D3hot), and enable
 * 		wakeup events as appropriate.
 *
 * FREEZE	Quiesce operations so that a consistent image can be saved;
 * 		but do NOT otherwise enter a low power device state, and do
 * 		NOT emit system wakeup events.
 *
 * PRETHAW	Quiesce as if for FREEZE; additionally, prepare for restoring
 * 		the system from a snapshot taken after an earlier FREEZE.
 * 		Some drivers will need to reset their hardware state instead
 * 		of preserving it, to ensure that it's never mistaken for the
 * 		state which that earlier snapshot had set up.
 *
 * A minimally power-aware driver treats all messages as SUSPEND, fully
 * reinitializes its device during resume() -- whether or not it was reset
 * during the suspend/resume cycle -- and can't issue wakeup events.
 *
 * More power-aware drivers may also use low power states at runtime as
 * well as during system sleep states like PM_SUSPEND_STANDBY.  They may
 * be able to use wakeup events to exit from runtime low-power states,
 * or from system low-power states such as standby or suspend-to-RAM.
 */

#define PM_EVENT_ON 0
#define PM_EVENT_FREEZE 1
#define PM_EVENT_SUSPEND 2
#define PM_EVENT_PRETHAW 3

#define PMSG_FREEZE	((struct pm_message){ .event = PM_EVENT_FREEZE, })
#define PMSG_PRETHAW	((struct pm_message){ .event = PM_EVENT_PRETHAW, })
#define PMSG_SUSPEND	((struct pm_message){ .event = PM_EVENT_SUSPEND, })
#define PMSG_ON		((struct pm_message){ .event = PM_EVENT_ON, })

struct dev_pm_info {
	pm_message_t		power_state;
	unsigned		can_wakeup:1;
#ifdef	CONFIG_PM
	unsigned		should_wakeup:1;
	pm_message_t		prev_state;
	void			* saved_state;
	struct device		* pm_parent;
	struct list_head	entry;
#endif
};

extern void device_pm_set_parent(struct device * dev, struct device * parent);

extern int device_power_down(pm_message_t state);
extern void device_power_up(void);
extern void device_resume(void);

#ifdef CONFIG_PM
extern suspend_disk_method_t pm_disk_mode;

extern int device_suspend(pm_message_t state);
extern int device_prepare_suspend(pm_message_t state);

#define device_set_wakeup_enable(dev,val) \
	((dev)->power.should_wakeup = !!(val))
#define device_may_wakeup(dev) \
	(device_can_wakeup(dev) && (dev)->power.should_wakeup)

extern int dpm_runtime_suspend(struct device *, pm_message_t);
extern void dpm_runtime_resume(struct device *);
extern void __suspend_report_result(const char *function, void *fn, int ret);

#define suspend_report_result(fn, ret)					\
	do {								\
		__suspend_report_result(__FUNCTION__, fn, ret);		\
	} while (0)

#else /* !CONFIG_PM */

static inline int device_suspend(pm_message_t state)
{
	return 0;
}

#define device_set_wakeup_enable(dev,val)	do{}while(0)
#define device_may_wakeup(dev)			(0)

static inline int dpm_runtime_suspend(struct device * dev, pm_message_t state)
{
	return 0;
}

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

#define suspend_report_result(fn, ret) do { } while (0)

#endif

/* changes to device_may_wakeup take effect on the next pm state change.
 * by default, devices should wakeup if they can.
 */
#define device_can_wakeup(dev) \
	((dev)->power.can_wakeup)
#define device_init_wakeup(dev,val) \
	do { \
		device_can_wakeup(dev) = !!(val); \
		device_set_wakeup_enable(dev,val); \
	} while(0)

#endif /* __KERNEL__ */

#endif /* _LINUX_PM_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* pm.h - Power management interface
	3	*
	4	* Copyright (C) 2000 Andrew Henroid
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*/
	20
	21	#ifndef _LINUX_PM_H
	22	#define _LINUX_PM_H
	23
	24	#ifdef __KERNEL__
	25
1da177e4 LT	26	#include <linux/list.h>
	27	#include <asm/atomic.h>
	28
	29	/*
	30	* Power management requests... these are passed to pm_send_all() and friends.
	31	*
	32	* these functions are old and deprecated, see below.
	33	*/
	34	typedef int __bitwise pm_request_t;
	35
	36	#define PM_SUSPEND ((__force pm_request_t) 1) /* enter D1-D3 */
	37	#define PM_RESUME ((__force pm_request_t) 2) /* enter D0 */
	38
	39
	40	/*
	41	* Device types... these are passed to pm_register
	42	*/
	43	typedef int __bitwise pm_dev_t;
	44
	45	#define PM_UNKNOWN_DEV ((__force pm_dev_t) 0) /* generic */
	46	#define PM_SYS_DEV ((__force pm_dev_t) 1) /* system device (fan, KB controller, ...) */
	47	#define PM_PCI_DEV ((__force pm_dev_t) 2) /* PCI device */
	48	#define PM_USB_DEV ((__force pm_dev_t) 3) /* USB device */
	49	#define PM_SCSI_DEV ((__force pm_dev_t) 4) /* SCSI device */
	50	#define PM_ISA_DEV ((__force pm_dev_t) 5) /* ISA device */
	51	#define PM_MTD_DEV ((__force pm_dev_t) 6) /* Memory Technology Device */
	52
	53	/*
	54	* System device hardware ID (PnP) values
	55	*/
	56	enum
	57	{
	58	PM_SYS_UNKNOWN = 0x00000000, /* generic */
	59	PM_SYS_KBC = 0x41d00303, /* keyboard controller */
	60	PM_SYS_COM = 0x41d00500, /* serial port */
	61	PM_SYS_IRDA = 0x41d00510, /* IRDA controller */
	62	PM_SYS_FDC = 0x41d00700, /* floppy controller */
	63	PM_SYS_VGA = 0x41d00900, /* VGA controller */
	64	PM_SYS_PCMCIA = 0x41d00e00, /* PCMCIA controller */
	65	};
	66
	67	/*
	68	* Device identifier
	69	*/
	70	#define PM_PCI_ID(dev) ((dev)->bus->number << 16 \| (dev)->devfn)
	71
	72	/*
	73	* Request handler callback
	74	*/
	75	struct pm_dev;
	76
	77	typedef int (pm_callback)(struct pm_dev dev, pm_request_t rqst, void *data);
	78
	79	/*
	80	* Dynamic device information
	81	*/
	82	struct pm_dev
	83	{
	84	pm_dev_t type;
	85	unsigned long id;
	86	pm_callback callback;
	87	void *data;
	88
	89	unsigned long flags;
90	unsigned long state;
91	unsigned long prev_state;
92
93	struct list_head entry;
94	};
95
1da177e4 LT	96	/* Functions above this comment are list-based old-style power
	97	* managment. Please avoid using them. */
	98
	99	/*
	100	* Callbacks for platform drivers to implement.
	101	*/
	102	extern void (*pm_idle)(void);
	103	extern void (*pm_power_off)(void);
	104
	105	typedef int __bitwise suspend_state_t;
	106
	107	#define PM_SUSPEND_ON ((__force suspend_state_t) 0)
	108	#define PM_SUSPEND_STANDBY ((__force suspend_state_t) 1)
	109	#define PM_SUSPEND_MEM ((__force suspend_state_t) 3)
	110	#define PM_SUSPEND_DISK ((__force suspend_state_t) 4)
	111	#define PM_SUSPEND_MAX ((__force suspend_state_t) 5)
	112
	113	typedef int __bitwise suspend_disk_method_t;
	114
	115	#define PM_DISK_FIRMWARE ((__force suspend_disk_method_t) 1)
	116	#define PM_DISK_PLATFORM ((__force suspend_disk_method_t) 2)
	117	#define PM_DISK_SHUTDOWN ((__force suspend_disk_method_t) 3)
	118	#define PM_DISK_REBOOT ((__force suspend_disk_method_t) 4)
b918f6e6 RW	119	#define PM_DISK_TEST ((__force suspend_disk_method_t) 5)
	120	#define PM_DISK_TESTPROC ((__force suspend_disk_method_t) 6)
	121	#define PM_DISK_MAX ((__force suspend_disk_method_t) 7)
1da177e4 LT	122
	123	struct pm_ops {
	124	suspend_disk_method_t pm_disk_mode;
eb9289eb	125	int (*valid)(suspend_state_t state);
1da177e4 LT	126	int (*prepare)(suspend_state_t state);
	127	int (*enter)(suspend_state_t state);
	128	int (*finish)(suspend_state_t state);
	129	};
	130
	131	extern void pm_set_ops(struct pm_ops *);
e2a5b420	132	extern struct pm_ops *pm_ops;
1da177e4 LT	133	extern int pm_suspend(suspend_state_t state);
	134
	135
	136	/*
	137	* Device power management
	138	*/
	139
	140	struct device;
	141
ca078bae PM	142	typedef struct pm_message {
	143	int event;
	144	} pm_message_t;
1da177e4 LT	145
1da177e4 LT	146	/*
82bb67f2 DB	147	* Several driver power state transitions are externally visible, affecting
	148	* the state of pending I/O queues and (for drivers that touch hardware)
	149	* interrupts, wakeups, DMA, and other hardware state. There may also be
	150	* internal transitions to various low power modes, which are transparent
	151	* to the rest of the driver stack (such as a driver that's ON gating off
	152	* clocks which are not in active use).
1da177e4	153	*
82bb67f2 DB	154	* One transition is triggered by resume(), after a suspend() call; the
	155	* message is implicit:
	156	*
	157	* ON Driver starts working again, responding to hardware events
	158	* and software requests. The hardware may have gone through
	159	* a power-off reset, or it may have maintained state from the
	160	* previous suspend() which the driver will rely on while
	161	* resuming. On most platforms, there are no restrictions on
	162	* availability of resources like clocks during resume().
	163	*
	164	* Other transitions are triggered by messages sent using suspend(). All
	165	* these transitions quiesce the driver, so that I/O queues are inactive.
	166	* That commonly entails turning off IRQs and DMA; there may be rules
	167	* about how to quiesce that are specific to the bus or the device's type.
	168	* (For example, network drivers mark the link state.) Other details may
	169	* differ according to the message:
	170	*
	171	* SUSPEND Quiesce, enter a low power device state appropriate for
	172	* the upcoming system state (such as PCI_D3hot), and enable
	173	* wakeup events as appropriate.
	174	*
	175	* FREEZE Quiesce operations so that a consistent image can be saved;
	176	* but do NOT otherwise enter a low power device state, and do
	177	* NOT emit system wakeup events.
	178	*
	179	* PRETHAW Quiesce as if for FREEZE; additionally, prepare for restoring
	180	* the system from a snapshot taken after an earlier FREEZE.
	181	* Some drivers will need to reset their hardware state instead
	182	* of preserving it, to ensure that it's never mistaken for the
	183	* state which that earlier snapshot had set up.
	184	*
	185	* A minimally power-aware driver treats all messages as SUSPEND, fully
	186	* reinitializes its device during resume() -- whether or not it was reset
	187	* during the suspend/resume cycle -- and can't issue wakeup events.
	188	*
	189	* More power-aware drivers may also use low power states at runtime as
	190	* well as during system sleep states like PM_SUSPEND_STANDBY. They may
	191	* be able to use wakeup events to exit from runtime low-power states,
	192	* or from system low-power states such as standby or suspend-to-RAM.
1da177e4 LT	193	*/
1da177e4 LT	194
ca078bae PM	195	#define PM_EVENT_ON 0
	196	#define PM_EVENT_FREEZE 1
	197	#define PM_EVENT_SUSPEND 2
82bb67f2	198	#define PM_EVENT_PRETHAW 3
ca078bae PM	199
ca078bae PM	200	#define PMSG_FREEZE ((struct pm_message){ .event = PM_EVENT_FREEZE, })
82bb67f2	201	#define PMSG_PRETHAW ((struct pm_message){ .event = PM_EVENT_PRETHAW, })
ca078bae PM	202	#define PMSG_SUSPEND ((struct pm_message){ .event = PM_EVENT_SUSPEND, })
ca078bae PM	203	#define PMSG_ON ((struct pm_message){ .event = PM_EVENT_ON, })
1da177e4 LT	204
	205	struct dev_pm_info {
	206	pm_message_t power_state;
0ac85241	207	unsigned can_wakeup:1;
1da177e4	208	#ifdef CONFIG_PM
0ac85241	209	unsigned should_wakeup:1;
1da177e4 LT	210	pm_message_t prev_state;
1da177e4 LT	211	void * saved_state;
1da177e4 LT	212	struct device * pm_parent;
	213	struct list_head entry;
	214	#endif
	215	};
	216
	217	extern void device_pm_set_parent(struct device * dev, struct device * parent);
	218
1da177e4 LT	219	extern int device_power_down(pm_message_t state);
	220	extern void device_power_up(void);
	221	extern void device_resume(void);
	222
620b0327	223	#ifdef CONFIG_PM
74c7e2ef RD	224	extern suspend_disk_method_t pm_disk_mode;
74c7e2ef RD	225
620b0327	226	extern int device_suspend(pm_message_t state);
7c8265f5	227	extern int device_prepare_suspend(pm_message_t state);
0ac85241 DB	228
	229	#define device_set_wakeup_enable(dev,val) \
	230	((dev)->power.should_wakeup = !!(val))
	231	#define device_may_wakeup(dev) \
	232	(device_can_wakeup(dev) && (dev)->power.should_wakeup)
	233
9a7834d0 AM	234	extern int dpm_runtime_suspend(struct device *, pm_message_t);
9a7834d0 AM	235	extern void dpm_runtime_resume(struct device *);
02669492 AM	236	extern void __suspend_report_result(const char function, void fn, int ret);
	237
	238	#define suspend_report_result(fn, ret) \
	239	do { \
	240	__suspend_report_result(__FUNCTION__, fn, ret); \
	241	} while (0)
9a7834d0	242
0ac85241 DB	243	#else /* !CONFIG_PM */
0ac85241 DB	244
620b0327 PM	245	static inline int device_suspend(pm_message_t state)
	246	{
	247	return 0;
	248	}
0ac85241 DB	249
	250	#define device_set_wakeup_enable(dev,val) do{}while(0)
	251	#define device_may_wakeup(dev) (0)
	252
9a7834d0 AM	253	static inline int dpm_runtime_suspend(struct device * dev, pm_message_t state)
	254	{
	255	return 0;
	256	}
	257
	258	static inline void dpm_runtime_resume(struct device * dev)
	259	{
9a7834d0 AM	260	}
9a7834d0 AM	261
02669492 AM	262	#define suspend_report_result(fn, ret) do { } while (0)
02669492 AM	263
620b0327	264	#endif
1da177e4	265
0ac85241 DB	266	/* changes to device_may_wakeup take effect on the next pm state change.
	267	* by default, devices should wakeup if they can.
	268	*/
	269	#define device_can_wakeup(dev) \
	270	((dev)->power.can_wakeup)
	271	#define device_init_wakeup(dev,val) \
	272	do { \
	273	device_can_wakeup(dev) = !!(val); \
	274	device_set_wakeup_enable(dev,val); \
	275	} while(0)
	276
1da177e4 LT	277	#endif /* __KERNEL__ */
	278
	279	#endif /* _LINUX_PM_H */