[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 <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>
#include "sleep.h"

u8 sleep_states[ACPI_S_STATE_COUNT];

static struct pm_ops acpi_pm_ops;

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

static int init_8259A_after_S1;

extern int acpi_sleep_prepare(u32 acpi_state);
extern void acpi_power_off(void);

static u32 acpi_target_sleep_state = ACPI_STATE_S0;

/**
 *	acpi_pm_set_target - Set the target system sleep state to the state
 *		associated with given @pm_state, if supported.
 */

static int acpi_pm_set_target(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_pm_prepare - Do preliminary suspend work.
 *	@pm_state: ignored
 *
 *	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(suspend_state_t pm_state)
{
	int error = acpi_sleep_prepare(acpi_target_sleep_state);

	if (error)
		acpi_target_sleep_state = ACPI_STATE_S0;

	return error;
}

/**
 *	acpi_pm_enter - Actually enter a sleep state.
 *	@pm_state: ignored
 *
 *	Flush caches and go to sleep. For STR or S2, 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_pm_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_S2 || acpi_state == ACPI_STATE_S3) {
		int error = acpi_save_state_mem();

		if (error) {
			acpi_target_sleep_state = ACPI_STATE_S0;
			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_S2:
	case ACPI_STATE_S3:
		do_suspend_lowlevel();
		break;
	}

	/* ACPI 3.0 specs (P62) says that it's the responsabilty
	 * 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);

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

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

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

/**
 *	acpi_pm_finish - Finish up suspend sequence.
 *	@pm_state: ignored
 *
 *	This is called after we wake back up (or if entering the sleep state
 *	failed). 
 */

static int acpi_pm_finish(suspend_state_t pm_state)
{
	u32 acpi_state = acpi_target_sleep_state;

	acpi_leave_sleep_state(acpi_state);
	acpi_disable_wakeup_device(acpi_state);

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

	acpi_target_sleep_state = ACPI_STATE_S0;

	if (init_8259A_after_S1) {
		printk("Broken toshiba laptop -> kicking interrupts\n");
		init_8259A(0);
	}
	return 0;
}

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

static int acpi_pm_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 pm_ops acpi_pm_ops = {
	.valid = acpi_pm_state_valid,
	.set_target = acpi_pm_set_target,
	.prepare = acpi_pm_prepare,
	.enter = acpi_pm_enter,
	.finish = acpi_pm_finish,
};

#ifdef CONFIG_SOFTWARE_SUSPEND
static int acpi_hibernation_prepare(void)
{
	return acpi_sleep_prepare(ACPI_STATE_S4);
}

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);
	local_irq_restore(flags);

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

static void acpi_hibernation_finish(void)
{
	acpi_leave_sleep_state(ACPI_STATE_S4);
	acpi_disable_wakeup_device(ACPI_STATE_S4);

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

	if (init_8259A_after_S1) {
		printk("Broken toshiba laptop -> kicking interrupts\n");
		init_8259A(0);
	}
}

static int acpi_hibernation_pre_restore(void)
{
	acpi_status status;

	status = acpi_hw_disable_all_gpes();

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

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

static struct hibernation_ops acpi_hibernation_ops = {
	.prepare = acpi_hibernation_prepare,
	.enter = acpi_hibernation_enter,
	.finish = acpi_hibernation_finish,
	.pre_restore = acpi_hibernation_pre_restore,
	.restore_cleanup = acpi_hibernation_restore_cleanup,
};
#endif				/* CONFIG_SOFTWARE_SUSPEND */

/*
 * Toshiba fails to preserve interrupts over S1, reinitialization
 * of 8259 is needed after S1 resume.
 */
static int __init init_ints_after_s1(struct dmi_system_id *d)
{
	printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
	init_8259A_after_S1 = 1;
	return 0;
}

static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
	{
	 .callback = init_ints_after_s1,
	 .ident = "Toshiba Satellite 4030cdt",
	 .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
	 },
	{},
};

int __init acpi_sleep_init(void)
{
	int i = 0;

	dmi_check_system(acpisleep_dmi_table);

	if (acpi_disabled)
		return 0;

	printk(KERN_INFO PREFIX "(supports");
	for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
		acpi_status status;
		u8 type_a, type_b;
		status = acpi_get_sleep_type_data(i, &type_a, &type_b);
		if (ACPI_SUCCESS(status)) {
			sleep_states[i] = 1;
			printk(" S%d", i);
		}
	}
	printk(")\n");

	pm_set_ops(&acpi_pm_ops);

#ifdef CONFIG_SOFTWARE_SUSPEND
	if (sleep_states[ACPI_STATE_S4])
		hibernation_set_ops(&acpi_hibernation_ops);
#else
	sleep_states[ACPI_STATE_S4] = 0;
#endif

	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>
1da177e4 LT	18	#include <acpi/acpi_bus.h>
	19	#include <acpi/acpi_drivers.h>
	20	#include "sleep.h"
	21
	22	u8 sleep_states[ACPI_S_STATE_COUNT];
	23
	24	static struct pm_ops acpi_pm_ops;
	25
1da177e4 LT	26	extern void do_suspend_lowlevel(void);
	27
	28	static u32 acpi_suspend_states[] = {
e2a5b420 AS	29	[PM_SUSPEND_ON] = ACPI_STATE_S0,
	30	[PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
	31	[PM_SUSPEND_MEM] = ACPI_STATE_S3,
e2a5b420	32	[PM_SUSPEND_MAX] = ACPI_STATE_S5
1da177e4 LT	33	};
	34
	35	static int init_8259A_after_S1;
	36
e9b3aba8 RW	37	extern int acpi_sleep_prepare(u32 acpi_state);
	38	extern void acpi_power_off(void);
	39
	40	static u32 acpi_target_sleep_state = ACPI_STATE_S0;
	41
	42	/**
	43	* acpi_pm_set_target - Set the target system sleep state to the state
	44	* associated with given @pm_state, if supported.
	45	*/
	46
	47	static int acpi_pm_set_target(suspend_state_t pm_state)
	48	{
	49	u32 acpi_state = acpi_suspend_states[pm_state];
	50	int error = 0;
	51
	52	if (sleep_states[acpi_state]) {
	53	acpi_target_sleep_state = acpi_state;
	54	} else {
	55	printk(KERN_ERR "ACPI does not support this state: %d\n",
	56	pm_state);
	57	error = -ENOSYS;
	58	}
	59	return error;
	60	}
	61
1da177e4 LT	62	/**
1da177e4 LT	63	* acpi_pm_prepare - Do preliminary suspend work.
e9b3aba8	64	* @pm_state: ignored
1da177e4	65	*
e9b3aba8 RW	66	* If necessary, set the firmware waking vector and do arch-specific
e9b3aba8 RW	67	* nastiness to get the wakeup code to the waking vector.
1da177e4 LT	68	*/
	69
	70	static int acpi_pm_prepare(suspend_state_t pm_state)
	71	{
e9b3aba8	72	int error = acpi_sleep_prepare(acpi_target_sleep_state);
1da177e4	73
e9b3aba8 RW	74	if (error)
	75	acpi_target_sleep_state = ACPI_STATE_S0;
	76
	77	return error;
1da177e4 LT	78	}
1da177e4 LT	79
1da177e4 LT	80	/**
1da177e4 LT	81	* acpi_pm_enter - Actually enter a sleep state.
e9b3aba8	82	* @pm_state: ignored
1da177e4	83	*
e9b3aba8	84	* Flush caches and go to sleep. For STR or S2, we have to call
1da177e4 LT	85	* arch-specific assembly, which in turn call acpi_enter_sleep_state().
	86	* It's unfortunate, but it works. Please fix if you're feeling frisky.
	87	*/
	88
	89	static int acpi_pm_enter(suspend_state_t pm_state)
	90	{
	91	acpi_status status = AE_OK;
	92	unsigned long flags = 0;
e9b3aba8	93	u32 acpi_state = acpi_target_sleep_state;
1da177e4 LT	94
	95	ACPI_FLUSH_CPU_CACHE();
	96
	97	/* Do arch specific saving of state. */
e9b3aba8	98	if (acpi_state == ACPI_STATE_S2 \|\| acpi_state == ACPI_STATE_S3) {
1da177e4	99	int error = acpi_save_state_mem();
e9b3aba8 RW	100
	101	if (error) {
	102	acpi_target_sleep_state = ACPI_STATE_S0;
1da177e4	103	return error;
e9b3aba8	104	}
1da177e4 LT	105	}
1da177e4 LT	106
1da177e4 LT	107	local_irq_save(flags);
1da177e4 LT	108	acpi_enable_wakeup_device(acpi_state);
e9b3aba8 RW	109	switch (acpi_state) {
e9b3aba8 RW	110	case ACPI_STATE_S1:
1da177e4 LT	111	barrier();
	112	status = acpi_enter_sleep_state(acpi_state);
	113	break;
	114
e9b3aba8 RW	115	case ACPI_STATE_S2:
e9b3aba8 RW	116	case ACPI_STATE_S3:
1da177e4 LT	117	do_suspend_lowlevel();
1da177e4 LT	118	break;
1da177e4	119	}
872d83d0 AP	120
	121	/* ACPI 3.0 specs (P62) says that it's the responsabilty
	122	* of the OSPM to clear the status bit [ implying that the
	123	* POWER_BUTTON event should not reach userspace ]
	124	*/
	125	if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
	126	acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
	127
1da177e4 LT	128	local_irq_restore(flags);
	129	printk(KERN_DEBUG "Back to C!\n");
	130
e9b3aba8 RW	131	/* restore processor state */
e9b3aba8 RW	132	if (acpi_state == ACPI_STATE_S2 \|\| acpi_state == ACPI_STATE_S3)
1da177e4 LT	133	acpi_restore_state_mem();
1da177e4 LT	134
1da177e4 LT	135	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
	136	}
	137
1da177e4 LT	138	/**
1da177e4 LT	139	* acpi_pm_finish - Finish up suspend sequence.
e9b3aba8	140	* @pm_state: ignored
1da177e4 LT	141	*
	142	* This is called after we wake back up (or if entering the sleep state
	143	* failed).
	144	*/
	145
	146	static int acpi_pm_finish(suspend_state_t pm_state)
	147	{
e9b3aba8	148	u32 acpi_state = acpi_target_sleep_state;
1da177e4 LT	149
	150	acpi_leave_sleep_state(acpi_state);
	151	acpi_disable_wakeup_device(acpi_state);
	152
	153	/* reset firmware waking vector */
	154	acpi_set_firmware_waking_vector((acpi_physical_address) 0);
	155
e9b3aba8 RW	156	acpi_target_sleep_state = ACPI_STATE_S0;
e9b3aba8 RW	157
1da177e4 LT	158	if (init_8259A_after_S1) {
	159	printk("Broken toshiba laptop -> kicking interrupts\n");
	160	init_8259A(0);
	161	}
	162	return 0;
	163	}
	164
1da177e4 LT	165	int acpi_suspend(u32 acpi_state)
	166	{
	167	suspend_state_t states[] = {
e2a5b420 AS	168	[1] = PM_SUSPEND_STANDBY,
e2a5b420 AS	169	[3] = PM_SUSPEND_MEM,
e2a5b420	170	[5] = PM_SUSPEND_MAX
1da177e4 LT	171	};
1da177e4 LT	172
e2a5b420	173	if (acpi_state < 6 && states[acpi_state])
1da177e4	174	return pm_suspend(states[acpi_state]);
a3d25c27 RW	175	if (acpi_state == 4)
a3d25c27 RW	176	return hibernate();
1da177e4 LT	177	return -EINVAL;
	178	}
	179
eb9289eb SL	180	static int acpi_pm_state_valid(suspend_state_t pm_state)
eb9289eb SL	181	{
e8c9c502	182	u32 acpi_state;
eb9289eb	183
e8c9c502 JB	184	switch (pm_state) {
	185	case PM_SUSPEND_ON:
	186	case PM_SUSPEND_STANDBY:
	187	case PM_SUSPEND_MEM:
	188	acpi_state = acpi_suspend_states[pm_state];
	189
	190	return sleep_states[acpi_state];
	191	default:
	192	return 0;
	193	}
eb9289eb SL	194	}
eb9289eb SL	195
1da177e4	196	static struct pm_ops acpi_pm_ops = {
eb9289eb	197	.valid = acpi_pm_state_valid,
e9b3aba8	198	.set_target = acpi_pm_set_target,
e2a5b420 AS	199	.prepare = acpi_pm_prepare,
	200	.enter = acpi_pm_enter,
	201	.finish = acpi_pm_finish,
1da177e4 LT	202	};
1da177e4 LT	203
a3d25c27 RW	204	#ifdef CONFIG_SOFTWARE_SUSPEND
	205	static int acpi_hibernation_prepare(void)
	206	{
	207	return acpi_sleep_prepare(ACPI_STATE_S4);
	208	}
	209
	210	static int acpi_hibernation_enter(void)
	211	{
	212	acpi_status status = AE_OK;
	213	unsigned long flags = 0;
	214
	215	ACPI_FLUSH_CPU_CACHE();
	216
	217	local_irq_save(flags);
	218	acpi_enable_wakeup_device(ACPI_STATE_S4);
	219	/* This shouldn't return. If it returns, we have a problem */
	220	status = acpi_enter_sleep_state(ACPI_STATE_S4);
	221	local_irq_restore(flags);
	222
	223	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
	224	}
	225
	226	static void acpi_hibernation_finish(void)
	227	{
	228	acpi_leave_sleep_state(ACPI_STATE_S4);
	229	acpi_disable_wakeup_device(ACPI_STATE_S4);
	230
	231	/* reset firmware waking vector */
	232	acpi_set_firmware_waking_vector((acpi_physical_address) 0);
	233
	234	if (init_8259A_after_S1) {
	235	printk("Broken toshiba laptop -> kicking interrupts\n");
	236	init_8259A(0);
	237	}
	238	}
	239
a634cc10 RW	240	static int acpi_hibernation_pre_restore(void)
	241	{
	242	acpi_status status;
	243
	244	status = acpi_hw_disable_all_gpes();
	245
	246	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
	247	}
	248
	249	static void acpi_hibernation_restore_cleanup(void)
	250	{
	251	acpi_hw_enable_all_runtime_gpes();
	252	}
	253
a3d25c27 RW	254	static struct hibernation_ops acpi_hibernation_ops = {
	255	.prepare = acpi_hibernation_prepare,
	256	.enter = acpi_hibernation_enter,
	257	.finish = acpi_hibernation_finish,
a634cc10 RW	258	.pre_restore = acpi_hibernation_pre_restore,
a634cc10 RW	259	.restore_cleanup = acpi_hibernation_restore_cleanup,
a3d25c27	260	};
fd350943	261	#endif /* CONFIG_SOFTWARE_SUSPEND */
a3d25c27	262
1da177e4 LT	263	/*
	264	* Toshiba fails to preserve interrupts over S1, reinitialization
	265	* of 8259 is needed after S1 resume.
	266	*/
	267	static int __init init_ints_after_s1(struct dmi_system_id *d)
	268	{
	269	printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
	270	init_8259A_after_S1 = 1;
	271	return 0;
	272	}
	273
	274	static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
	275	{
e2a5b420 AS	276	.callback = init_ints_after_s1,
	277	.ident = "Toshiba Satellite 4030cdt",
	278	.matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
	279	},
	280	{},
1da177e4 LT	281	};
1da177e4 LT	282
aafbcd16	283	int __init acpi_sleep_init(void)
1da177e4	284	{
e2a5b420	285	int i = 0;
1da177e4 LT	286
	287	dmi_check_system(acpisleep_dmi_table);
	288
	289	if (acpi_disabled)
	290	return 0;
	291
	292	printk(KERN_INFO PREFIX "(supports");
e2a5b420	293	for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1da177e4 LT	294	acpi_status status;
	295	u8 type_a, type_b;
	296	status = acpi_get_sleep_type_data(i, &type_a, &type_b);
	297	if (ACPI_SUCCESS(status)) {
	298	sleep_states[i] = 1;
	299	printk(" S%d", i);
	300	}
1da177e4 LT	301	}
	302	printk(")\n");
	303
	304	pm_set_ops(&acpi_pm_ops);
a3d25c27 RW	305
	306	#ifdef CONFIG_SOFTWARE_SUSPEND
	307	if (sleep_states[ACPI_STATE_S4])
	308	hibernation_set_ops(&acpi_hibernation_ops);
	309	#else
	310	sleep_states[ACPI_STATE_S4] = 0;
	311	#endif
	312
1da177e4 LT	313	return 0;
1da177e4 LT	314	}