[mirror_ubuntu-artful-kernel.git] / drivers / acpi / sleep / main.c

/*
 * sleep.c - ACPI sleep support.
 *
 * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
 * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com>
 * Copyright (c) 2000-2003 Patrick Mochel
 * Copyright (c) 2003 Open Source Development Lab
 *
 * This file is released under the GPLv2.
 *
 */

#include <linux/delay.h>
#include <linux/irq.h>
#include <linux/dmi.h>
#include <linux/device.h>
#include <linux/suspend.h>

#include <asm/io.h>

#include <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>
#include "sleep.h"

u8 sleep_states[ACPI_S_STATE_COUNT];

static int acpi_sleep_prepare(u32 acpi_state)
{
#ifdef CONFIG_ACPI_SLEEP
	/* do we have a wakeup address for S2 and S3? */
	if (acpi_state == ACPI_STATE_S3) {
		if (!acpi_wakeup_address) {
			return -EFAULT;
		}
		acpi_set_firmware_waking_vector(
				(acpi_physical_address)acpi_wakeup_address);

	}
	ACPI_FLUSH_CPU_CACHE();
	acpi_enable_wakeup_device_prep(acpi_state);
#endif
	printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
		acpi_state);
	acpi_enter_sleep_state_prep(acpi_state);
	return 0;
}

#ifdef CONFIG_PM_SLEEP
static u32 acpi_target_sleep_state = ACPI_STATE_S0;

/*
 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
 * user to request that behavior by using the 'acpi_old_suspend_ordering'
 * kernel command line option that causes the following variable to be set.
 */
static bool old_suspend_ordering;

void __init acpi_old_suspend_ordering(void)
{
	old_suspend_ordering = true;
}

/**
 *	acpi_pm_disable_gpes - Disable the GPEs.
 */
static int acpi_pm_disable_gpes(void)
{
	acpi_hw_disable_all_gpes();
	return 0;
}

/**
 *	__acpi_pm_prepare - Prepare the platform to enter the target state.
 *
 *	If necessary, set the firmware waking vector and do arch-specific
 *	nastiness to get the wakeup code to the waking vector.
 */
static int __acpi_pm_prepare(void)
{
	int error = acpi_sleep_prepare(acpi_target_sleep_state);

	if (error)
		acpi_target_sleep_state = ACPI_STATE_S0;
	return error;
}

/**
 *	acpi_pm_prepare - Prepare the platform to enter the target sleep
 *		state and disable the GPEs.
 */
static int acpi_pm_prepare(void)
{
	int error = __acpi_pm_prepare();

	if (!error)
		acpi_hw_disable_all_gpes();
	return error;
}

/**
 *	acpi_pm_finish - Instruct the platform to leave a sleep state.
 *
 *	This is called after we wake back up (or if entering the sleep state
 *	failed).
 */
static void acpi_pm_finish(void)
{
	u32 acpi_state = acpi_target_sleep_state;

	if (acpi_state == ACPI_STATE_S0)
		return;

	printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
		acpi_state);
	acpi_disable_wakeup_device(acpi_state);
	acpi_leave_sleep_state(acpi_state);

	/* reset firmware waking vector */
	acpi_set_firmware_waking_vector((acpi_physical_address) 0);

	acpi_target_sleep_state = ACPI_STATE_S0;
}

/**
 *	acpi_pm_end - Finish up suspend sequence.
 */
static void acpi_pm_end(void)
{
	/*
	 * This is necessary in case acpi_pm_finish() is not called during a
	 * failing transition to a sleep state.
	 */
	acpi_target_sleep_state = ACPI_STATE_S0;
}
#endif /* CONFIG_PM_SLEEP */

#ifdef CONFIG_SUSPEND
extern void do_suspend_lowlevel(void);

static u32 acpi_suspend_states[] = {
	[PM_SUSPEND_ON] = ACPI_STATE_S0,
	[PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
	[PM_SUSPEND_MEM] = ACPI_STATE_S3,
	[PM_SUSPEND_MAX] = ACPI_STATE_S5
};

/**
 *	acpi_suspend_begin - Set the target system sleep state to the state
 *		associated with given @pm_state, if supported.
 */
static int acpi_suspend_begin(suspend_state_t pm_state)
{
	u32 acpi_state = acpi_suspend_states[pm_state];
	int error = 0;

	if (sleep_states[acpi_state]) {
		acpi_target_sleep_state = acpi_state;
	} else {
		printk(KERN_ERR "ACPI does not support this state: %d\n",
			pm_state);
		error = -ENOSYS;
	}
	return error;
}

/**
 *	acpi_suspend_enter - Actually enter a sleep state.
 *	@pm_state: ignored
 *
 *	Flush caches and go to sleep. For STR we have to call arch-specific
 *	assembly, which in turn call acpi_enter_sleep_state().
 *	It's unfortunate, but it works. Please fix if you're feeling frisky.
 */
static int acpi_suspend_enter(suspend_state_t pm_state)
{
	acpi_status status = AE_OK;
	unsigned long flags = 0;
	u32 acpi_state = acpi_target_sleep_state;

	ACPI_FLUSH_CPU_CACHE();

	/* Do arch specific saving of state. */
	if (acpi_state == ACPI_STATE_S3) {
		int error = acpi_save_state_mem();

		if (error)
			return error;
	}

	local_irq_save(flags);
	acpi_enable_wakeup_device(acpi_state);
	switch (acpi_state) {
	case ACPI_STATE_S1:
		barrier();
		status = acpi_enter_sleep_state(acpi_state);
		break;

	case ACPI_STATE_S3:
		do_suspend_lowlevel();
		break;
	}

	/* Reprogram control registers and execute _BFS */
	acpi_leave_sleep_state_prep(acpi_state);

	/* ACPI 3.0 specs (P62) says that it's the responsibility
	 * of the OSPM to clear the status bit [ implying that the
	 * POWER_BUTTON event should not reach userspace ]
	 */
	if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
		acpi_clear_event(ACPI_EVENT_POWER_BUTTON);

	/*
	 * Disable and clear GPE status before interrupt is enabled. Some GPEs
	 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
	 * acpi_leave_sleep_state will reenable specific GPEs later
	 */
	acpi_hw_disable_all_gpes();

	local_irq_restore(flags);
	printk(KERN_DEBUG "Back to C!\n");

	/* restore processor state */
	if (acpi_state == ACPI_STATE_S3)
		acpi_restore_state_mem();

	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
}

static int acpi_suspend_state_valid(suspend_state_t pm_state)
{
	u32 acpi_state;

	switch (pm_state) {
	case PM_SUSPEND_ON:
	case PM_SUSPEND_STANDBY:
	case PM_SUSPEND_MEM:
		acpi_state = acpi_suspend_states[pm_state];

		return sleep_states[acpi_state];
	default:
		return 0;
	}
}

static struct platform_suspend_ops acpi_suspend_ops = {
	.valid = acpi_suspend_state_valid,
	.begin = acpi_suspend_begin,
	.prepare = acpi_pm_prepare,
	.enter = acpi_suspend_enter,
	.finish = acpi_pm_finish,
	.end = acpi_pm_end,
};

/**
 *	acpi_suspend_begin_old - Set the target system sleep state to the
 *		state associated with given @pm_state, if supported, and
 *		execute the _PTS control method.  This function is used if the
 *		pre-ACPI 2.0 suspend ordering has been requested.
 */
static int acpi_suspend_begin_old(suspend_state_t pm_state)
{
	int error = acpi_suspend_begin(pm_state);

	if (!error)
		error = __acpi_pm_prepare();
	return error;
}

/*
 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
 * been requested.
 */
static struct platform_suspend_ops acpi_suspend_ops_old = {
	.valid = acpi_suspend_state_valid,
	.begin = acpi_suspend_begin_old,
	.prepare = acpi_pm_disable_gpes,
	.enter = acpi_suspend_enter,
	.finish = acpi_pm_finish,
	.end = acpi_pm_end,
	.recover = acpi_pm_finish,
};
#endif /* CONFIG_SUSPEND */

#ifdef CONFIG_HIBERNATION
static int acpi_hibernation_begin(void)
{
	acpi_target_sleep_state = ACPI_STATE_S4;
	return 0;
}

static int acpi_hibernation_enter(void)
{
	acpi_status status = AE_OK;
	unsigned long flags = 0;

	ACPI_FLUSH_CPU_CACHE();

	local_irq_save(flags);
	acpi_enable_wakeup_device(ACPI_STATE_S4);
	/* This shouldn't return.  If it returns, we have a problem */
	status = acpi_enter_sleep_state(ACPI_STATE_S4);
	/* Reprogram control registers and execute _BFS */
	acpi_leave_sleep_state_prep(ACPI_STATE_S4);
	local_irq_restore(flags);

	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
}

static void acpi_hibernation_leave(void)
{
	/*
	 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
	 * enable it here.
	 */
	acpi_enable();
	/* Reprogram control registers and execute _BFS */
	acpi_leave_sleep_state_prep(ACPI_STATE_S4);
}

static void acpi_pm_enable_gpes(void)
{
	acpi_hw_enable_all_runtime_gpes();
}

static struct platform_hibernation_ops acpi_hibernation_ops = {
	.begin = acpi_hibernation_begin,
	.end = acpi_pm_end,
	.pre_snapshot = acpi_pm_prepare,
	.finish = acpi_pm_finish,
	.prepare = acpi_pm_prepare,
	.enter = acpi_hibernation_enter,
	.leave = acpi_hibernation_leave,
	.pre_restore = acpi_pm_disable_gpes,
	.restore_cleanup = acpi_pm_enable_gpes,
};

/**
 *	acpi_hibernation_begin_old - Set the target system sleep state to
 *		ACPI_STATE_S4 and execute the _PTS control method.  This
 *		function is used if the pre-ACPI 2.0 suspend ordering has been
 *		requested.
 */
static int acpi_hibernation_begin_old(void)
{
	int error = acpi_sleep_prepare(ACPI_STATE_S4);

	if (!error)
		acpi_target_sleep_state = ACPI_STATE_S4;
	return error;
}

/*
 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
 * been requested.
 */
static struct platform_hibernation_ops acpi_hibernation_ops_old = {
	.begin = acpi_hibernation_begin_old,
	.end = acpi_pm_end,
	.pre_snapshot = acpi_pm_disable_gpes,
	.finish = acpi_pm_finish,
	.prepare = acpi_pm_disable_gpes,
	.enter = acpi_hibernation_enter,
	.leave = acpi_hibernation_leave,
	.pre_restore = acpi_pm_disable_gpes,
	.restore_cleanup = acpi_pm_enable_gpes,
	.recover = acpi_pm_finish,
};
#endif /* CONFIG_HIBERNATION */

int acpi_suspend(u32 acpi_state)
{
	suspend_state_t states[] = {
		[1] = PM_SUSPEND_STANDBY,
		[3] = PM_SUSPEND_MEM,
		[5] = PM_SUSPEND_MAX
	};

	if (acpi_state < 6 && states[acpi_state])
		return pm_suspend(states[acpi_state]);
	if (acpi_state == 4)
		return hibernate();
	return -EINVAL;
}

#ifdef CONFIG_PM_SLEEP
/**
 *	acpi_pm_device_sleep_state - return preferred power state of ACPI device
 *		in the system sleep state given by %acpi_target_sleep_state
 *	@dev: device to examine; its driver model wakeup flags control
 *		whether it should be able to wake up the system
 *	@d_min_p: used to store the upper limit of allowed states range
 *	Return value: preferred power state of the device on success, -ENODEV on
 *		failure (ie. if there's no 'struct acpi_device' for @dev)
 *
 *	Find the lowest power (highest number) ACPI device power state that
 *	device @dev can be in while the system is in the sleep state represented
 *	by %acpi_target_sleep_state.  If @wake is nonzero, the device should be
 *	able to wake up the system from this sleep state.  If @d_min_p is set,
 *	the highest power (lowest number) device power state of @dev allowed
 *	in this system sleep state is stored at the location pointed to by it.
 *
 *	The caller must ensure that @dev is valid before using this function.
 *	The caller is also responsible for figuring out if the device is
 *	supposed to be able to wake up the system and passing this information
 *	via @wake.
 */

int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
{
	acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
	struct acpi_device *adev;
	char acpi_method[] = "_SxD";
	unsigned long d_min, d_max;

	if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
		printk(KERN_DEBUG "ACPI handle has no context!\n");
		return -ENODEV;
	}

	acpi_method[2] = '0' + acpi_target_sleep_state;
	/*
	 * If the sleep state is S0, we will return D3, but if the device has
	 * _S0W, we will use the value from _S0W
	 */
	d_min = ACPI_STATE_D0;
	d_max = ACPI_STATE_D3;

	/*
	 * If present, _SxD methods return the minimum D-state (highest power
	 * state) we can use for the corresponding S-states.  Otherwise, the
	 * minimum D-state is D0 (ACPI 3.x).
	 *
	 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
	 * provided -- that's our fault recovery, we ignore retval.
	 */
	if (acpi_target_sleep_state > ACPI_STATE_S0)
		acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);

	/*
	 * If _PRW says we can wake up the system from the target sleep state,
	 * the D-state returned by _SxD is sufficient for that (we assume a
	 * wakeup-aware driver if wake is set).  Still, if _SxW exists
	 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
	 * can wake the system.  _S0W may be valid, too.
	 */
	if (acpi_target_sleep_state == ACPI_STATE_S0 ||
	    (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
	     adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
		acpi_status status;

		acpi_method[3] = 'W';
		status = acpi_evaluate_integer(handle, acpi_method, NULL,
						&d_max);
		if (ACPI_FAILURE(status)) {
			d_max = d_min;
		} else if (d_max < d_min) {
			/* Warn the user of the broken DSDT */
			printk(KERN_WARNING "ACPI: Wrong value from %s\n",
				acpi_method);
			/* Sanitize it */
			d_min = d_max;
		}
	}

	if (d_min_p)
		*d_min_p = d_min;
	return d_max;
}

/**
 *	acpi_pm_device_sleep_wake - enable or disable the system wake-up
 *                                  capability of given device
 *	@dev: device to handle
 *	@enable: 'true' - enable, 'false' - disable the wake-up capability
 */
int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
{
	acpi_handle handle;
	struct acpi_device *adev;

	if (!device_may_wakeup(dev))
		return -EINVAL;

	handle = DEVICE_ACPI_HANDLE(dev);
	if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
		printk(KERN_DEBUG "ACPI handle has no context!\n");
		return -ENODEV;
	}

	return enable ?
		acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
		acpi_disable_wakeup_device_power(adev);
}
#endif

static void acpi_power_off_prepare(void)
{
	/* Prepare to power off the system */
	acpi_sleep_prepare(ACPI_STATE_S5);
	acpi_hw_disable_all_gpes();
}

static void acpi_power_off(void)
{
	/* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
	printk("%s called\n", __func__);
	local_irq_disable();
	acpi_enable_wakeup_device(ACPI_STATE_S5);
	acpi_enter_sleep_state(ACPI_STATE_S5);
}

int __init acpi_sleep_init(void)
{
	acpi_status status;
	u8 type_a, type_b;
#ifdef CONFIG_SUSPEND
	int i = 0;
#endif

	if (acpi_disabled)
		return 0;

	sleep_states[ACPI_STATE_S0] = 1;
	printk(KERN_INFO PREFIX "(supports S0");

#ifdef CONFIG_SUSPEND
	for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
		status = acpi_get_sleep_type_data(i, &type_a, &type_b);
		if (ACPI_SUCCESS(status)) {
			sleep_states[i] = 1;
			printk(" S%d", i);
		}
	}

	suspend_set_ops(old_suspend_ordering ?
		&acpi_suspend_ops_old : &acpi_suspend_ops);
#endif

#ifdef CONFIG_HIBERNATION
	status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
	if (ACPI_SUCCESS(status)) {
		hibernation_set_ops(old_suspend_ordering ?
			&acpi_hibernation_ops_old : &acpi_hibernation_ops);
		sleep_states[ACPI_STATE_S4] = 1;
		printk(" S4");
	}
#endif
	status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
	if (ACPI_SUCCESS(status)) {
		sleep_states[ACPI_STATE_S5] = 1;
		printk(" S5");
		pm_power_off_prepare = acpi_power_off_prepare;
		pm_power_off = acpi_power_off;
	}
	printk(")\n");
	return 0;
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* sleep.c - ACPI sleep support.
	3	*
e2a5b420	4	* Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
1da177e4 LT	5	* Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com>
	6	* Copyright (c) 2000-2003 Patrick Mochel
	7	* Copyright (c) 2003 Open Source Development Lab
	8	*
	9	* This file is released under the GPLv2.
	10	*
	11	*/
	12
	13	#include <linux/delay.h>
	14	#include <linux/irq.h>
	15	#include <linux/dmi.h>
	16	#include <linux/device.h>
	17	#include <linux/suspend.h>
f216cc37 AS	18
	19	#include <asm/io.h>
	20
1da177e4 LT	21	#include <acpi/acpi_bus.h>
	22	#include <acpi/acpi_drivers.h>
	23	#include "sleep.h"
	24
	25	u8 sleep_states[ACPI_S_STATE_COUNT];
	26
c9b6c8f6	27	static int acpi_sleep_prepare(u32 acpi_state)
2f3f2226 AS	28	{
	29	#ifdef CONFIG_ACPI_SLEEP
	30	/* do we have a wakeup address for S2 and S3? */
	31	if (acpi_state == ACPI_STATE_S3) {
	32	if (!acpi_wakeup_address) {
	33	return -EFAULT;
	34	}
4b4f7280 PA	35	acpi_set_firmware_waking_vector(
4b4f7280 PA	36	(acpi_physical_address)acpi_wakeup_address);
2f3f2226 AS	37
	38	}
	39	ACPI_FLUSH_CPU_CACHE();
	40	acpi_enable_wakeup_device_prep(acpi_state);
	41	#endif
c9b6c8f6 RW	42	printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
c9b6c8f6 RW	43	acpi_state);
2f3f2226 AS	44	acpi_enter_sleep_state_prep(acpi_state);
	45	return 0;
	46	}
	47
d8f3de0d RW	48	#ifdef CONFIG_PM_SLEEP
	49	static u32 acpi_target_sleep_state = ACPI_STATE_S0;
	50
	51	/*
	52	* ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
	53	* user to request that behavior by using the 'acpi_old_suspend_ordering'
	54	* kernel command line option that causes the following variable to be set.
	55	*/
	56	static bool old_suspend_ordering;
	57
	58	void __init acpi_old_suspend_ordering(void)
	59	{
	60	old_suspend_ordering = true;
	61	}
	62
	63	/**
	64	* acpi_pm_disable_gpes - Disable the GPEs.
	65	*/
	66	static int acpi_pm_disable_gpes(void)
	67	{
	68	acpi_hw_disable_all_gpes();
	69	return 0;
	70	}
	71
	72	/**
	73	* __acpi_pm_prepare - Prepare the platform to enter the target state.
	74	*
	75	* If necessary, set the firmware waking vector and do arch-specific
	76	* nastiness to get the wakeup code to the waking vector.
	77	*/
	78	static int __acpi_pm_prepare(void)
	79	{
	80	int error = acpi_sleep_prepare(acpi_target_sleep_state);
	81
	82	if (error)
	83	acpi_target_sleep_state = ACPI_STATE_S0;
	84	return error;
	85	}
	86
	87	/**
	88	* acpi_pm_prepare - Prepare the platform to enter the target sleep
	89	* state and disable the GPEs.
	90	*/
	91	static int acpi_pm_prepare(void)
	92	{
	93	int error = __acpi_pm_prepare();
	94
	95	if (!error)
	96	acpi_hw_disable_all_gpes();
	97	return error;
	98	}
	99
	100	/**
	101	* acpi_pm_finish - Instruct the platform to leave a sleep state.
	102	*
	103	* This is called after we wake back up (or if entering the sleep state
	104	* failed).
	105	*/
	106	static void acpi_pm_finish(void)
	107	{
	108	u32 acpi_state = acpi_target_sleep_state;
	109
	110	if (acpi_state == ACPI_STATE_S0)
	111	return;
1da177e4	112
d8f3de0d RW	113	printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
	114	acpi_state);
	115	acpi_disable_wakeup_device(acpi_state);
	116	acpi_leave_sleep_state(acpi_state);
	117
	118	/* reset firmware waking vector */
	119	acpi_set_firmware_waking_vector((acpi_physical_address) 0);
	120
	121	acpi_target_sleep_state = ACPI_STATE_S0;
	122	}
	123
	124	/**
	125	* acpi_pm_end - Finish up suspend sequence.
	126	*/
	127	static void acpi_pm_end(void)
	128	{
	129	/*
	130	* This is necessary in case acpi_pm_finish() is not called during a
	131	* failing transition to a sleep state.
	132	*/
	133	acpi_target_sleep_state = ACPI_STATE_S0;
	134	}
	135	#endif /* CONFIG_PM_SLEEP */
1da177e4	136
d8f3de0d	137	#ifdef CONFIG_SUSPEND
1da177e4 LT	138	extern void do_suspend_lowlevel(void);
	139
	140	static u32 acpi_suspend_states[] = {
e2a5b420 AS	141	[PM_SUSPEND_ON] = ACPI_STATE_S0,
	142	[PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
	143	[PM_SUSPEND_MEM] = ACPI_STATE_S3,
e2a5b420	144	[PM_SUSPEND_MAX] = ACPI_STATE_S5
1da177e4 LT	145	};
1da177e4 LT	146
e9b3aba8	147	/**
2c6e33c3	148	* acpi_suspend_begin - Set the target system sleep state to the state
e9b3aba8 RW	149	* associated with given @pm_state, if supported.
e9b3aba8 RW	150	*/
2c6e33c3	151	static int acpi_suspend_begin(suspend_state_t pm_state)
e9b3aba8 RW	152	{
	153	u32 acpi_state = acpi_suspend_states[pm_state];
	154	int error = 0;
	155
	156	if (sleep_states[acpi_state]) {
	157	acpi_target_sleep_state = acpi_state;
	158	} else {
	159	printk(KERN_ERR "ACPI does not support this state: %d\n",
	160	pm_state);
	161	error = -ENOSYS;
	162	}
	163	return error;
	164	}
	165
1da177e4	166	/**
2c6e33c3	167	* acpi_suspend_enter - Actually enter a sleep state.
e9b3aba8	168	* @pm_state: ignored
1da177e4	169	*
50ad147a RW	170	* Flush caches and go to sleep. For STR we have to call arch-specific
50ad147a RW	171	* assembly, which in turn call acpi_enter_sleep_state().
1da177e4 LT	172	* It's unfortunate, but it works. Please fix if you're feeling frisky.
1da177e4 LT	173	*/
2c6e33c3	174	static int acpi_suspend_enter(suspend_state_t pm_state)
1da177e4 LT	175	{
	176	acpi_status status = AE_OK;
	177	unsigned long flags = 0;
e9b3aba8	178	u32 acpi_state = acpi_target_sleep_state;
1da177e4 LT	179
	180	ACPI_FLUSH_CPU_CACHE();
	181
	182	/* Do arch specific saving of state. */
50ad147a	183	if (acpi_state == ACPI_STATE_S3) {
1da177e4	184	int error = acpi_save_state_mem();
e9b3aba8	185
60417f59	186	if (error)
1da177e4 LT	187	return error;
	188	}
	189
1da177e4 LT	190	local_irq_save(flags);
1da177e4 LT	191	acpi_enable_wakeup_device(acpi_state);
e9b3aba8 RW	192	switch (acpi_state) {
e9b3aba8 RW	193	case ACPI_STATE_S1:
1da177e4 LT	194	barrier();
	195	status = acpi_enter_sleep_state(acpi_state);
	196	break;
	197
e9b3aba8	198	case ACPI_STATE_S3:
1da177e4 LT	199	do_suspend_lowlevel();
1da177e4 LT	200	break;
1da177e4	201	}
872d83d0	202
c95d47a8 RW	203	/* Reprogram control registers and execute _BFS */
	204	acpi_leave_sleep_state_prep(acpi_state);
	205
23b168d4	206	/* ACPI 3.0 specs (P62) says that it's the responsibility
872d83d0 AP	207	* of the OSPM to clear the status bit [ implying that the
	208	* POWER_BUTTON event should not reach userspace ]
	209	*/
	210	if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
	211	acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
	212
a3627f67 SL	213	/*
	214	* Disable and clear GPE status before interrupt is enabled. Some GPEs
	215	* (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
	216	* acpi_leave_sleep_state will reenable specific GPEs later
	217	*/
	218	acpi_hw_disable_all_gpes();
	219
1da177e4 LT	220	local_irq_restore(flags);
	221	printk(KERN_DEBUG "Back to C!\n");
	222
e9b3aba8	223	/* restore processor state */
50ad147a	224	if (acpi_state == ACPI_STATE_S3)
1da177e4 LT	225	acpi_restore_state_mem();
1da177e4 LT	226
1da177e4 LT	227	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
	228	}
	229
2c6e33c3	230	static int acpi_suspend_state_valid(suspend_state_t pm_state)
eb9289eb	231	{
e8c9c502	232	u32 acpi_state;
eb9289eb	233
e8c9c502 JB	234	switch (pm_state) {
	235	case PM_SUSPEND_ON:
	236	case PM_SUSPEND_STANDBY:
	237	case PM_SUSPEND_MEM:
	238	acpi_state = acpi_suspend_states[pm_state];
	239
	240	return sleep_states[acpi_state];
	241	default:
	242	return 0;
	243	}
eb9289eb SL	244	}
eb9289eb SL	245
2c6e33c3 LB	246	static struct platform_suspend_ops acpi_suspend_ops = {
	247	.valid = acpi_suspend_state_valid,
	248	.begin = acpi_suspend_begin,
d8f3de0d	249	.prepare = acpi_pm_prepare,
2c6e33c3	250	.enter = acpi_suspend_enter,
d8f3de0d RW	251	.finish = acpi_pm_finish,
	252	.end = acpi_pm_end,
	253	};
	254
	255	/**
	256	* acpi_suspend_begin_old - Set the target system sleep state to the
	257	* state associated with given @pm_state, if supported, and
	258	* execute the _PTS control method. This function is used if the
	259	* pre-ACPI 2.0 suspend ordering has been requested.
	260	*/
	261	static int acpi_suspend_begin_old(suspend_state_t pm_state)
	262	{
	263	int error = acpi_suspend_begin(pm_state);
	264
	265	if (!error)
	266	error = __acpi_pm_prepare();
	267	return error;
	268	}
	269
	270	/*
	271	* The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
	272	* been requested.
	273	*/
	274	static struct platform_suspend_ops acpi_suspend_ops_old = {
	275	.valid = acpi_suspend_state_valid,
	276	.begin = acpi_suspend_begin_old,
	277	.prepare = acpi_pm_disable_gpes,
2c6e33c3	278	.enter = acpi_suspend_enter,
d8f3de0d RW	279	.finish = acpi_pm_finish,
	280	.end = acpi_pm_end,
	281	.recover = acpi_pm_finish,
1da177e4	282	};
296699de RW	283	#endif /* CONFIG_SUSPEND */
296699de RW	284
b0cb1a19	285	#ifdef CONFIG_HIBERNATION
caea99ef	286	static int acpi_hibernation_begin(void)
74f270af RW	287	{
74f270af RW	288	acpi_target_sleep_state = ACPI_STATE_S4;
7731ce63	289	return 0;
74f270af RW	290	}
74f270af RW	291
a3d25c27 RW	292	static int acpi_hibernation_enter(void)
	293	{
	294	acpi_status status = AE_OK;
	295	unsigned long flags = 0;
	296
	297	ACPI_FLUSH_CPU_CACHE();
	298
	299	local_irq_save(flags);
	300	acpi_enable_wakeup_device(ACPI_STATE_S4);
	301	/* This shouldn't return. If it returns, we have a problem */
	302	status = acpi_enter_sleep_state(ACPI_STATE_S4);
c95d47a8 RW	303	/* Reprogram control registers and execute _BFS */
c95d47a8 RW	304	acpi_leave_sleep_state_prep(ACPI_STATE_S4);
a3d25c27 RW	305	local_irq_restore(flags);
	306
	307	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
	308	}
	309
c7e0831d RW	310	static void acpi_hibernation_leave(void)
	311	{
	312	/*
	313	* If ACPI is not enabled by the BIOS and the boot kernel, we need to
	314	* enable it here.
	315	*/
	316	acpi_enable();
c95d47a8 RW	317	/* Reprogram control registers and execute _BFS */
c95d47a8 RW	318	acpi_leave_sleep_state_prep(ACPI_STATE_S4);
c7e0831d RW	319	}
c7e0831d RW	320
d8f3de0d	321	static void acpi_pm_enable_gpes(void)
a3d25c27	322	{
d8f3de0d	323	acpi_hw_enable_all_runtime_gpes();
a3d25c27 RW	324	}
a3d25c27 RW	325
d8f3de0d RW	326	static struct platform_hibernation_ops acpi_hibernation_ops = {
	327	.begin = acpi_hibernation_begin,
	328	.end = acpi_pm_end,
	329	.pre_snapshot = acpi_pm_prepare,
	330	.finish = acpi_pm_finish,
	331	.prepare = acpi_pm_prepare,
	332	.enter = acpi_hibernation_enter,
	333	.leave = acpi_hibernation_leave,
	334	.pre_restore = acpi_pm_disable_gpes,
	335	.restore_cleanup = acpi_pm_enable_gpes,
	336	};
caea99ef	337
d8f3de0d RW	338	/**
	339	* acpi_hibernation_begin_old - Set the target system sleep state to
	340	* ACPI_STATE_S4 and execute the _PTS control method. This
	341	* function is used if the pre-ACPI 2.0 suspend ordering has been
	342	* requested.
	343	*/
	344	static int acpi_hibernation_begin_old(void)
a634cc10	345	{
d8f3de0d	346	int error = acpi_sleep_prepare(ACPI_STATE_S4);
a634cc10	347
d8f3de0d RW	348	if (!error)
	349	acpi_target_sleep_state = ACPI_STATE_S4;
	350	return error;
a634cc10 RW	351	}
a634cc10 RW	352
d8f3de0d RW	353	/*
	354	* The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
	355	* been requested.
	356	*/
	357	static struct platform_hibernation_ops acpi_hibernation_ops_old = {
	358	.begin = acpi_hibernation_begin_old,
	359	.end = acpi_pm_end,
	360	.pre_snapshot = acpi_pm_disable_gpes,
	361	.finish = acpi_pm_finish,
	362	.prepare = acpi_pm_disable_gpes,
a3d25c27	363	.enter = acpi_hibernation_enter,
c7e0831d	364	.leave = acpi_hibernation_leave,
d8f3de0d RW	365	.pre_restore = acpi_pm_disable_gpes,
	366	.restore_cleanup = acpi_pm_enable_gpes,
	367	.recover = acpi_pm_finish,
a3d25c27	368	};
d8f3de0d	369	#endif /* CONFIG_HIBERNATION */
a3d25c27	370
296699de RW	371	int acpi_suspend(u32 acpi_state)
	372	{
	373	suspend_state_t states[] = {
	374	[1] = PM_SUSPEND_STANDBY,
	375	[3] = PM_SUSPEND_MEM,
	376	[5] = PM_SUSPEND_MAX
	377	};
	378
	379	if (acpi_state < 6 && states[acpi_state])
	380	return pm_suspend(states[acpi_state]);
	381	if (acpi_state == 4)
	382	return hibernate();
	383	return -EINVAL;
	384	}
	385
853298bc	386	#ifdef CONFIG_PM_SLEEP
fd4aff1a SL	387	/**
	388	* acpi_pm_device_sleep_state - return preferred power state of ACPI device
	389	* in the system sleep state given by %acpi_target_sleep_state
2fe2de5f DB	390	* @dev: device to examine; its driver model wakeup flags control
2fe2de5f DB	391	* whether it should be able to wake up the system
fd4aff1a SL	392	* @d_min_p: used to store the upper limit of allowed states range
	393	* Return value: preferred power state of the device on success, -ENODEV on
	394	* failure (ie. if there's no 'struct acpi_device' for @dev)
	395	*
	396	* Find the lowest power (highest number) ACPI device power state that
	397	* device @dev can be in while the system is in the sleep state represented
	398	* by %acpi_target_sleep_state. If @wake is nonzero, the device should be
	399	* able to wake up the system from this sleep state. If @d_min_p is set,
	400	* the highest power (lowest number) device power state of @dev allowed
	401	* in this system sleep state is stored at the location pointed to by it.
	402	*
	403	* The caller must ensure that @dev is valid before using this function.
	404	* The caller is also responsible for figuring out if the device is
	405	* supposed to be able to wake up the system and passing this information
	406	* via @wake.
	407	*/
	408
2fe2de5f	409	int acpi_pm_device_sleep_state(struct device dev, int d_min_p)
fd4aff1a SL	410	{
	411	acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
	412	struct acpi_device *adev;
	413	char acpi_method[] = "_SxD";
	414	unsigned long d_min, d_max;
	415
	416	if (!handle \|\| ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
ead77594	417	printk(KERN_DEBUG "ACPI handle has no context!\n");
fd4aff1a SL	418	return -ENODEV;
	419	}
	420
	421	acpi_method[2] = '0' + acpi_target_sleep_state;
	422	/*
	423	* If the sleep state is S0, we will return D3, but if the device has
	424	* _S0W, we will use the value from _S0W
	425	*/
	426	d_min = ACPI_STATE_D0;
	427	d_max = ACPI_STATE_D3;
	428
	429	/*
	430	* If present, _SxD methods return the minimum D-state (highest power
	431	* state) we can use for the corresponding S-states. Otherwise, the
	432	* minimum D-state is D0 (ACPI 3.x).
	433	*
	434	* NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
	435	* provided -- that's our fault recovery, we ignore retval.
	436	*/
	437	if (acpi_target_sleep_state > ACPI_STATE_S0)
	438	acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
	439
	440	/*
	441	* If _PRW says we can wake up the system from the target sleep state,
	442	* the D-state returned by _SxD is sufficient for that (we assume a
	443	* wakeup-aware driver if wake is set). Still, if _SxW exists
	444	* (ACPI 3.x), it should return the maximum (lowest power) D-state that
	445	* can wake the system. _S0W may be valid, too.
	446	*/
	447	if (acpi_target_sleep_state == ACPI_STATE_S0 \|\|
2fe2de5f	448	(device_may_wakeup(dev) && adev->wakeup.state.enabled &&
fd4aff1a	449	adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
ad3399c3 RW	450	acpi_status status;
ad3399c3 RW	451
fd4aff1a	452	acpi_method[3] = 'W';
ad3399c3 RW	453	status = acpi_evaluate_integer(handle, acpi_method, NULL,
	454	&d_max);
	455	if (ACPI_FAILURE(status)) {
	456	d_max = d_min;
	457	} else if (d_max < d_min) {
	458	/* Warn the user of the broken DSDT */
	459	printk(KERN_WARNING "ACPI: Wrong value from %s\n",
	460	acpi_method);
	461	/* Sanitize it */
fd4aff1a	462	d_min = d_max;
ad3399c3	463	}
fd4aff1a SL	464	}
	465
	466	if (d_min_p)
	467	*d_min_p = d_min;
	468	return d_max;
	469	}
eb9d0fe4 RW	470
	471	/**
	472	* acpi_pm_device_sleep_wake - enable or disable the system wake-up
	473	* capability of given device
	474	* @dev: device to handle
	475	* @enable: 'true' - enable, 'false' - disable the wake-up capability
	476	*/
	477	int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
	478	{
	479	acpi_handle handle;
	480	struct acpi_device *adev;
	481
	482	if (!device_may_wakeup(dev))
	483	return -EINVAL;
	484
	485	handle = DEVICE_ACPI_HANDLE(dev);
	486	if (!handle \|\| ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
	487	printk(KERN_DEBUG "ACPI handle has no context!\n");
	488	return -ENODEV;
	489	}
	490
	491	return enable ?
	492	acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
	493	acpi_disable_wakeup_device_power(adev);
	494	}
853298bc	495	#endif
fd4aff1a	496
f216cc37 AS	497	static void acpi_power_off_prepare(void)
	498	{
	499	/* Prepare to power off the system */
	500	acpi_sleep_prepare(ACPI_STATE_S5);
3c1d2b60	501	acpi_hw_disable_all_gpes();
f216cc37 AS	502	}
	503
	504	static void acpi_power_off(void)
	505	{
	506	/* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
96b2dd1f	507	printk("%s called\n", __func__);
f216cc37	508	local_irq_disable();
9c1c6a1b	509	acpi_enable_wakeup_device(ACPI_STATE_S5);
f216cc37 AS	510	acpi_enter_sleep_state(ACPI_STATE_S5);
	511	}
	512
aafbcd16	513	int __init acpi_sleep_init(void)
1da177e4	514	{
296699de RW	515	acpi_status status;
	516	u8 type_a, type_b;
	517	#ifdef CONFIG_SUSPEND
e2a5b420	518	int i = 0;
296699de	519	#endif
1da177e4 LT	520
	521	if (acpi_disabled)
	522	return 0;
	523
5a50fe70 FP	524	sleep_states[ACPI_STATE_S0] = 1;
	525	printk(KERN_INFO PREFIX "(supports S0");
	526
296699de	527	#ifdef CONFIG_SUSPEND
5a50fe70	528	for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
1da177e4 LT	529	status = acpi_get_sleep_type_data(i, &type_a, &type_b);
	530	if (ACPI_SUCCESS(status)) {
	531	sleep_states[i] = 1;
	532	printk(" S%d", i);
	533	}
1da177e4	534	}
1da177e4	535
d8f3de0d RW	536	suspend_set_ops(old_suspend_ordering ?
d8f3de0d RW	537	&acpi_suspend_ops_old : &acpi_suspend_ops);
296699de	538	#endif
a3d25c27	539
b0cb1a19	540	#ifdef CONFIG_HIBERNATION
296699de RW	541	status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
296699de RW	542	if (ACPI_SUCCESS(status)) {
d8f3de0d RW	543	hibernation_set_ops(old_suspend_ordering ?
d8f3de0d RW	544	&acpi_hibernation_ops_old : &acpi_hibernation_ops);
296699de	545	sleep_states[ACPI_STATE_S4] = 1;
f216cc37	546	printk(" S4");
296699de	547	}
a3d25c27	548	#endif
f216cc37 AS	549	status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
	550	if (ACPI_SUCCESS(status)) {
	551	sleep_states[ACPI_STATE_S5] = 1;
	552	printk(" S5");
	553	pm_power_off_prepare = acpi_power_off_prepare;
	554	pm_power_off = acpi_power_off;
	555	}
	556	printk(")\n");
1da177e4 LT	557	return 0;
1da177e4 LT	558	}