[mirror_ubuntu-bionic-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_DISK] = ACPI_STATE_S4,
	[PM_SUSPEND_MAX] = ACPI_STATE_S5
};

static int init_8259A_after_S1;

/**
 *	acpi_pm_prepare - Do preliminary suspend work.
 *	@pm_state:		suspend state we're entering.
 *
 *	Make sure we support the state. If we do, and we need it, set the
 *	firmware waking vector and do arch-specific nastiness to get the 
 *	wakeup code to the waking vector. 
 */

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

static int acpi_pm_prepare(suspend_state_t pm_state)
{
	u32 acpi_state = acpi_suspend_states[pm_state];

	if (!sleep_states[acpi_state]) {
		printk("acpi_pm_prepare does not support %d \n", pm_state);
		return -EPERM;
	}
	return acpi_sleep_prepare(acpi_state);
}

/**
 *	acpi_pm_enter - Actually enter a sleep state.
 *	@pm_state:		State we're entering.
 *
 *	Flush caches and go to sleep. For STR or STD, 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_suspend_states[pm_state];

	ACPI_FLUSH_CPU_CACHE();

	/* Do arch specific saving of state. */
	if (pm_state > PM_SUSPEND_STANDBY) {
		int error = acpi_save_state_mem();
		if (error)
			return error;
	}

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

	case PM_SUSPEND_MEM:
		do_suspend_lowlevel();
		break;

	case PM_SUSPEND_DISK:
		if (acpi_pm_ops.pm_disk_mode == PM_DISK_PLATFORM)
			status = acpi_enter_sleep_state(acpi_state);
		break;
	case PM_SUSPEND_MAX:
		acpi_power_off();
		break;

	default:
		return -EINVAL;
	}

	/* 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
	 * We should only be here if we're coming back from STR or STD.
	 * And, in the case of the latter, the memory image should have already
	 * been loaded from disk.
	 */
	if (pm_state > PM_SUSPEND_STANDBY)
		acpi_restore_state_mem();

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

/**
 *	acpi_pm_finish - Finish up suspend sequence.
 *	@pm_state:		State we're coming out of.
 *
 *	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_suspend_states[pm_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);

	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,
		[4] = PM_SUSPEND_DISK,
		[5] = PM_SUSPEND_MAX
	};

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

static int acpi_pm_state_valid(suspend_state_t pm_state)
{
	u32 acpi_state = acpi_suspend_states[pm_state];

	return sleep_states[acpi_state];
}

static struct pm_ops acpi_pm_ops = {
	.valid = acpi_pm_state_valid,
	.prepare = acpi_pm_prepare,
	.enter = acpi_pm_enter,
	.finish = acpi_pm_finish,
};

/*
 * 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);
		}
		if (i == ACPI_STATE_S4) {
			if (sleep_states[i])
				acpi_pm_ops.pm_disk_mode = PM_DISK_PLATFORM;
		}
	}
	printk(")\n");

	pm_set_ops(&acpi_pm_ops);
	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,
	32	[PM_SUSPEND_DISK] = ACPI_STATE_S4,
	33	[PM_SUSPEND_MAX] = ACPI_STATE_S5
1da177e4 LT	34	};
	35
	36	static int init_8259A_after_S1;
	37
	38	/**
	39	* acpi_pm_prepare - Do preliminary suspend work.
	40	* @pm_state: suspend state we're entering.
	41	*
	42	* Make sure we support the state. If we do, and we need it, set the
	43	* firmware waking vector and do arch-specific nastiness to get the
	44	* wakeup code to the waking vector.
	45	*/
	46
e2a5b420 AS	47	extern int acpi_sleep_prepare(u32 acpi_state);
	48	extern void acpi_power_off(void);
	49
1da177e4 LT	50	static int acpi_pm_prepare(suspend_state_t pm_state)
	51	{
	52	u32 acpi_state = acpi_suspend_states[pm_state];
	53
e2a5b420 AS	54	if (!sleep_states[acpi_state]) {
e2a5b420 AS	55	printk("acpi_pm_prepare does not support %d \n", pm_state);
1da177e4	56	return -EPERM;
1da177e4	57	}
e2a5b420	58	return acpi_sleep_prepare(acpi_state);
1da177e4 LT	59	}
1da177e4 LT	60
1da177e4 LT	61	/**
	62	* acpi_pm_enter - Actually enter a sleep state.
	63	* @pm_state: State we're entering.
	64	*
	65	* Flush caches and go to sleep. For STR or STD, we have to call
	66	* arch-specific assembly, which in turn call acpi_enter_sleep_state().
	67	* It's unfortunate, but it works. Please fix if you're feeling frisky.
	68	*/
	69
	70	static int acpi_pm_enter(suspend_state_t pm_state)
	71	{
	72	acpi_status status = AE_OK;
	73	unsigned long flags = 0;
	74	u32 acpi_state = acpi_suspend_states[pm_state];
	75
	76	ACPI_FLUSH_CPU_CACHE();
	77
	78	/* Do arch specific saving of state. */
	79	if (pm_state > PM_SUSPEND_STANDBY) {
	80	int error = acpi_save_state_mem();
	81	if (error)
	82	return error;
	83	}
	84
1da177e4 LT	85	local_irq_save(flags);
1da177e4 LT	86	acpi_enable_wakeup_device(acpi_state);
e2a5b420	87	switch (pm_state) {
1da177e4 LT	88	case PM_SUSPEND_STANDBY:
	89	barrier();
	90	status = acpi_enter_sleep_state(acpi_state);
	91	break;
	92
	93	case PM_SUSPEND_MEM:
	94	do_suspend_lowlevel();
	95	break;
	96
	97	case PM_SUSPEND_DISK:
	98	if (acpi_pm_ops.pm_disk_mode == PM_DISK_PLATFORM)
	99	status = acpi_enter_sleep_state(acpi_state);
1da177e4	100	break;
e2a5b420 AS	101	case PM_SUSPEND_MAX:
	102	acpi_power_off();
	103	break;
	104
1da177e4 LT	105	default:
	106	return -EINVAL;
	107	}
872d83d0 AP	108
	109	/* ACPI 3.0 specs (P62) says that it's the responsabilty
	110	* of the OSPM to clear the status bit [ implying that the
	111	* POWER_BUTTON event should not reach userspace ]
	112	*/
	113	if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
	114	acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
	115
1da177e4 LT	116	local_irq_restore(flags);
	117	printk(KERN_DEBUG "Back to C!\n");
	118
	119	/* restore processor state
	120	* We should only be here if we're coming back from STR or STD.
	121	* And, in the case of the latter, the memory image should have already
	122	* been loaded from disk.
	123	*/
	124	if (pm_state > PM_SUSPEND_STANDBY)
	125	acpi_restore_state_mem();
	126
1da177e4 LT	127	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
	128	}
	129
1da177e4 LT	130	/**
	131	* acpi_pm_finish - Finish up suspend sequence.
	132	* @pm_state: State we're coming out of.
	133	*
	134	* This is called after we wake back up (or if entering the sleep state
	135	* failed).
	136	*/
	137
	138	static int acpi_pm_finish(suspend_state_t pm_state)
	139	{
	140	u32 acpi_state = acpi_suspend_states[pm_state];
	141
	142	acpi_leave_sleep_state(acpi_state);
	143	acpi_disable_wakeup_device(acpi_state);
	144
	145	/* reset firmware waking vector */
	146	acpi_set_firmware_waking_vector((acpi_physical_address) 0);
	147
	148	if (init_8259A_after_S1) {
	149	printk("Broken toshiba laptop -> kicking interrupts\n");
	150	init_8259A(0);
	151	}
	152	return 0;
	153	}
	154
1da177e4 LT	155	int acpi_suspend(u32 acpi_state)
	156	{
	157	suspend_state_t states[] = {
e2a5b420 AS	158	[1] = PM_SUSPEND_STANDBY,
	159	[3] = PM_SUSPEND_MEM,
	160	[4] = PM_SUSPEND_DISK,
	161	[5] = PM_SUSPEND_MAX
1da177e4 LT	162	};
1da177e4 LT	163
e2a5b420	164	if (acpi_state < 6 && states[acpi_state])
1da177e4 LT	165	return pm_suspend(states[acpi_state]);
	166	return -EINVAL;
	167	}
	168
eb9289eb SL	169	static int acpi_pm_state_valid(suspend_state_t pm_state)
	170	{
	171	u32 acpi_state = acpi_suspend_states[pm_state];
	172
	173	return sleep_states[acpi_state];
	174	}
	175
1da177e4	176	static struct pm_ops acpi_pm_ops = {
eb9289eb	177	.valid = acpi_pm_state_valid,
e2a5b420 AS	178	.prepare = acpi_pm_prepare,
	179	.enter = acpi_pm_enter,
	180	.finish = acpi_pm_finish,
1da177e4 LT	181	};
1da177e4 LT	182
1da177e4 LT	183	/*
	184	* Toshiba fails to preserve interrupts over S1, reinitialization
	185	* of 8259 is needed after S1 resume.
	186	*/
	187	static int __init init_ints_after_s1(struct dmi_system_id *d)
	188	{
	189	printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
	190	init_8259A_after_S1 = 1;
	191	return 0;
	192	}
	193
	194	static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
	195	{
e2a5b420 AS	196	.callback = init_ints_after_s1,
	197	.ident = "Toshiba Satellite 4030cdt",
	198	.matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
	199	},
	200	{},
1da177e4 LT	201	};
1da177e4 LT	202
aafbcd16	203	int __init acpi_sleep_init(void)
1da177e4	204	{
e2a5b420	205	int i = 0;
1da177e4 LT	206
	207	dmi_check_system(acpisleep_dmi_table);
	208
	209	if (acpi_disabled)
	210	return 0;
	211
	212	printk(KERN_INFO PREFIX "(supports");
e2a5b420	213	for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1da177e4 LT	214	acpi_status status;
	215	u8 type_a, type_b;
	216	status = acpi_get_sleep_type_data(i, &type_a, &type_b);
	217	if (ACPI_SUCCESS(status)) {
	218	sleep_states[i] = 1;
	219	printk(" S%d", i);
	220	}
	221	if (i == ACPI_STATE_S4) {
1da177e4 LT	222	if (sleep_states[i])
	223	acpi_pm_ops.pm_disk_mode = PM_DISK_PLATFORM;
	224	}
	225	}
	226	printk(")\n");
	227
	228	pm_set_ops(&acpi_pm_ops);
	229	return 0;
	230	}
	231