[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / acpi / hardware / hwsleep.c


/******************************************************************************
 *
 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2006, R. Byron Moore
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <linux/module.h>
#include <acpi/acpi.h>

#define _COMPONENT          ACPI_HARDWARE
ACPI_MODULE_NAME("hwsleep")

/*******************************************************************************
 *
 * FUNCTION:    acpi_set_firmware_waking_vector
 *
 * PARAMETERS:  physical_address    - Physical address of ACPI real mode
 *                                    entry point.
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
 *
 ******************************************************************************/
acpi_status
acpi_set_firmware_waking_vector(acpi_physical_address physical_address)
{

	ACPI_FUNCTION_TRACE("acpi_set_firmware_waking_vector");

	/* Set the vector */

	if (acpi_gbl_common_fACS.vector_width == 32) {
		*(ACPI_CAST_PTR
		  (u32, acpi_gbl_common_fACS.firmware_waking_vector))
		    = (u32) physical_address;
	} else {
		*acpi_gbl_common_fACS.firmware_waking_vector = physical_address;
	}

	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_get_firmware_waking_vector
 *
 * PARAMETERS:  *physical_address   - Where the contents of
 *                                    the firmware_waking_vector field of
 *                                    the FACS will be returned.
 *
 * RETURN:      Status, vector
 *
 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
 *
 ******************************************************************************/

#ifdef ACPI_FUTURE_USAGE
acpi_status
acpi_get_firmware_waking_vector(acpi_physical_address * physical_address)
{

	ACPI_FUNCTION_TRACE("acpi_get_firmware_waking_vector");

	if (!physical_address) {
		return_ACPI_STATUS(AE_BAD_PARAMETER);
	}

	/* Get the vector */

	if (acpi_gbl_common_fACS.vector_width == 32) {
		*physical_address = (acpi_physical_address)
		    *
		    (ACPI_CAST_PTR
		     (u32, acpi_gbl_common_fACS.firmware_waking_vector));
	} else {
		*physical_address =
		    *acpi_gbl_common_fACS.firmware_waking_vector;
	}

	return_ACPI_STATUS(AE_OK);
}
#endif

/*******************************************************************************
 *
 * FUNCTION:    acpi_enter_sleep_state_prep
 *
 * PARAMETERS:  sleep_state         - Which sleep state to enter
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
 *              This function must execute with interrupts enabled.
 *              We break sleeping into 2 stages so that OSPM can handle
 *              various OS-specific tasks between the two steps.
 *
 ******************************************************************************/

acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
{
	acpi_status status;
	struct acpi_object_list arg_list;
	union acpi_object arg;

	ACPI_FUNCTION_TRACE("acpi_enter_sleep_state_prep");

	/*
	 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
	 */
	status = acpi_get_sleep_type_data(sleep_state,
					  &acpi_gbl_sleep_type_a,
					  &acpi_gbl_sleep_type_b);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Setup parameter object */

	arg_list.count = 1;
	arg_list.pointer = &arg;

	arg.type = ACPI_TYPE_INTEGER;
	arg.integer.value = sleep_state;

	/* Run the _PTS and _GTS methods */

	status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		return_ACPI_STATUS(status);
	}

	status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		return_ACPI_STATUS(status);
	}

	/* Setup the argument to _SST */

	switch (sleep_state) {
	case ACPI_STATE_S0:
		arg.integer.value = ACPI_SST_WORKING;
		break;

	case ACPI_STATE_S1:
	case ACPI_STATE_S2:
	case ACPI_STATE_S3:
		arg.integer.value = ACPI_SST_SLEEPING;
		break;

	case ACPI_STATE_S4:
		arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
		break;

	default:
		arg.integer.value = ACPI_SST_INDICATOR_OFF;	/* Default is off */
		break;
	}

	/* Set the system indicators to show the desired sleep state. */

	status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		ACPI_EXCEPTION((AE_INFO, status,
				"While executing method _SST"));
	}

	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_enter_sleep_state
 *
 * PARAMETERS:  sleep_state         - Which sleep state to enter
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
 *
 ******************************************************************************/

acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
{
	u32 PM1Acontrol;
	u32 PM1Bcontrol;
	struct acpi_bit_register_info *sleep_type_reg_info;
	struct acpi_bit_register_info *sleep_enable_reg_info;
	u32 in_value;
	acpi_status status;

	ACPI_FUNCTION_TRACE("acpi_enter_sleep_state");

	if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
	    (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
		ACPI_ERROR((AE_INFO, "Sleep values out of range: A=%X B=%X",
			    acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
		return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
	}

	sleep_type_reg_info =
	    acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
	sleep_enable_reg_info =
	    acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);

	/* Clear wake status */

	status =
	    acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Clear all fixed and general purpose status bits */

	status = acpi_hw_clear_acpi_status(ACPI_MTX_DO_NOT_LOCK);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/*
	 * 1) Disable/Clear all GPEs
	 * 2) Enable all wakeup GPEs
	 */
	status = acpi_hw_disable_all_gpes();
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}
	acpi_gbl_system_awake_and_running = FALSE;

	status = acpi_hw_enable_all_wakeup_gpes();
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Get current value of PM1A control */

	status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
				       ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}
	ACPI_DEBUG_PRINT((ACPI_DB_INIT,
			  "Entering sleep state [S%d]\n", sleep_state));

	/* Clear SLP_EN and SLP_TYP fields */

	PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
			 sleep_enable_reg_info->access_bit_mask);
	PM1Bcontrol = PM1Acontrol;

	/* Insert SLP_TYP bits */

	PM1Acontrol |=
	    (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
	PM1Bcontrol |=
	    (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);

	/*
	 * We split the writes of SLP_TYP and SLP_EN to workaround
	 * poorly implemented hardware.
	 */

	/* Write #1: fill in SLP_TYP data */

	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
					ACPI_REGISTER_PM1A_CONTROL,
					PM1Acontrol);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
					ACPI_REGISTER_PM1B_CONTROL,
					PM1Bcontrol);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Insert SLP_ENABLE bit */

	PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
	PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;

	/* Write #2: SLP_TYP + SLP_EN */

	ACPI_FLUSH_CPU_CACHE();

	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
					ACPI_REGISTER_PM1A_CONTROL,
					PM1Acontrol);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
					ACPI_REGISTER_PM1B_CONTROL,
					PM1Bcontrol);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	if (sleep_state > ACPI_STATE_S3) {
		/*
		 * We wanted to sleep > S3, but it didn't happen (by virtue of the
		 * fact that we are still executing!)
		 *
		 * Wait ten seconds, then try again. This is to get S4/S5 to work on
		 * all machines.
		 *
		 * We wait so long to allow chipsets that poll this reg very slowly to
		 * still read the right value. Ideally, this block would go
		 * away entirely.
		 */
		acpi_os_stall(10000000);

		status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
						ACPI_REGISTER_PM1_CONTROL,
						sleep_enable_reg_info->
						access_bit_mask);
		if (ACPI_FAILURE(status)) {
			return_ACPI_STATUS(status);
		}
	}

	/* Wait until we enter sleep state */

	do {
		status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value,
					   ACPI_MTX_DO_NOT_LOCK);
		if (ACPI_FAILURE(status)) {
			return_ACPI_STATUS(status);
		}

		/* Spin until we wake */

	} while (!in_value);

	return_ACPI_STATUS(AE_OK);
}

EXPORT_SYMBOL(acpi_enter_sleep_state);

/*******************************************************************************
 *
 * FUNCTION:    acpi_enter_sleep_state_s4bios
 *
 * PARAMETERS:  None
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Perform a S4 bios request.
 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
 *
 ******************************************************************************/

acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
{
	u32 in_value;
	acpi_status status;

	ACPI_FUNCTION_TRACE("acpi_enter_sleep_state_s4bios");

	status =
	    acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	status = acpi_hw_clear_acpi_status(ACPI_MTX_DO_NOT_LOCK);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/*
	 * 1) Disable/Clear all GPEs
	 * 2) Enable all wakeup GPEs
	 */
	status = acpi_hw_disable_all_gpes();
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}
	acpi_gbl_system_awake_and_running = FALSE;

	status = acpi_hw_enable_all_wakeup_gpes();
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	ACPI_FLUSH_CPU_CACHE();

	status = acpi_os_write_port(acpi_gbl_FADT->smi_cmd,
				    (u32) acpi_gbl_FADT->S4bios_req, 8);

	do {
		acpi_os_stall(1000);
		status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value,
					   ACPI_MTX_DO_NOT_LOCK);
		if (ACPI_FAILURE(status)) {
			return_ACPI_STATUS(status);
		}
	} while (!in_value);

	return_ACPI_STATUS(AE_OK);
}

EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios);

/*******************************************************************************
 *
 * FUNCTION:    acpi_leave_sleep_state
 *
 * PARAMETERS:  sleep_state         - Which sleep state we just exited
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
 *              Called with interrupts ENABLED.
 *
 ******************************************************************************/

acpi_status acpi_leave_sleep_state(u8 sleep_state)
{
	struct acpi_object_list arg_list;
	union acpi_object arg;
	acpi_status status;
	struct acpi_bit_register_info *sleep_type_reg_info;
	struct acpi_bit_register_info *sleep_enable_reg_info;
	u32 PM1Acontrol;
	u32 PM1Bcontrol;

	ACPI_FUNCTION_TRACE("acpi_leave_sleep_state");

	/*
	 * Set SLP_TYPE and SLP_EN to state S0.
	 * This is unclear from the ACPI Spec, but it is required
	 * by some machines.
	 */
	status = acpi_get_sleep_type_data(ACPI_STATE_S0,
					  &acpi_gbl_sleep_type_a,
					  &acpi_gbl_sleep_type_b);
	if (ACPI_SUCCESS(status)) {
		sleep_type_reg_info =
		    acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
		sleep_enable_reg_info =
		    acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);

		/* Get current value of PM1A control */

		status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
					       ACPI_REGISTER_PM1_CONTROL,
					       &PM1Acontrol);
		if (ACPI_SUCCESS(status)) {
			/* Clear SLP_EN and SLP_TYP fields */

			PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
					 sleep_enable_reg_info->
					 access_bit_mask);
			PM1Bcontrol = PM1Acontrol;

			/* Insert SLP_TYP bits */

			PM1Acontrol |=
			    (acpi_gbl_sleep_type_a << sleep_type_reg_info->
			     bit_position);
			PM1Bcontrol |=
			    (acpi_gbl_sleep_type_b << sleep_type_reg_info->
			     bit_position);

			/* Just ignore any errors */

			(void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
						     ACPI_REGISTER_PM1A_CONTROL,
						     PM1Acontrol);
			(void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
						     ACPI_REGISTER_PM1B_CONTROL,
						     PM1Bcontrol);
		}
	}

	/* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */

	acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;

	/* Setup parameter object */

	arg_list.count = 1;
	arg_list.pointer = &arg;
	arg.type = ACPI_TYPE_INTEGER;

	/* Ignore any errors from these methods */

	arg.integer.value = ACPI_SST_WAKING;
	status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
	}

	arg.integer.value = sleep_state;
	status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
	}

	status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
	}
	/* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */

	/*
	 * Restore the GPEs:
	 * 1) Disable/Clear all GPEs
	 * 2) Enable all runtime GPEs
	 */
	status = acpi_hw_disable_all_gpes();
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}
	acpi_gbl_system_awake_and_running = TRUE;

	status = acpi_hw_enable_all_runtime_gpes();
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Enable power button */

	(void)
	    acpi_set_register(acpi_gbl_fixed_event_info
			      [ACPI_EVENT_POWER_BUTTON].enable_register_id, 1,
			      ACPI_MTX_DO_NOT_LOCK);

	(void)
	    acpi_set_register(acpi_gbl_fixed_event_info
			      [ACPI_EVENT_POWER_BUTTON].status_register_id, 1,
			      ACPI_MTX_DO_NOT_LOCK);

	arg.integer.value = ACPI_SST_WORKING;
	status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
		ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
	}

	return_ACPI_STATUS(status);
}
Commit	Line	Data
1da177e4 LT	1
	2	/******************************************************************************
	3	*
	4	* Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
	5	*
	6	*****************************************************************************/
	7
	8	/*
4a90c7e8	9	* Copyright (C) 2000 - 2006, R. Byron Moore
1da177e4 LT	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
	45	#include <linux/module.h>
1da177e4 LT	46	#include <acpi/acpi.h>
	47
	48	#define _COMPONENT ACPI_HARDWARE
4be44fcd	49	ACPI_MODULE_NAME("hwsleep")
1da177e4	50
44f6c012	51	/*******************************************************************************
1da177e4 LT	52	*
	53	* FUNCTION: acpi_set_firmware_waking_vector
	54	*
	55	* PARAMETERS: physical_address - Physical address of ACPI real mode
	56	* entry point.
	57	*
	58	* RETURN: Status
	59	*
44f6c012	60	* DESCRIPTION: Access function for the firmware_waking_vector field in FACS
1da177e4 LT	61	*
1da177e4 LT	62	******************************************************************************/
1da177e4	63	acpi_status
4be44fcd	64	acpi_set_firmware_waking_vector(acpi_physical_address physical_address)
1da177e4 LT	65	{
1da177e4 LT	66
4be44fcd	67	ACPI_FUNCTION_TRACE("acpi_set_firmware_waking_vector");
1da177e4 LT	68
	69	/* Set the vector */
	70
	71	if (acpi_gbl_common_fACS.vector_width == 32) {
4be44fcd LB	72	*(ACPI_CAST_PTR
	73	(u32, acpi_gbl_common_fACS.firmware_waking_vector))
	74	= (u32) physical_address;
	75	} else {
	76	*acpi_gbl_common_fACS.firmware_waking_vector = physical_address;
1da177e4 LT	77	}
1da177e4 LT	78
4be44fcd	79	return_ACPI_STATUS(AE_OK);
1da177e4 LT	80	}
1da177e4 LT	81
44f6c012	82	/*******************************************************************************
1da177e4 LT	83	*
	84	* FUNCTION: acpi_get_firmware_waking_vector
	85	*
44f6c012	86	* PARAMETERS: *physical_address - Where the contents of
1da177e4	87	* the firmware_waking_vector field of
44f6c012	88	* the FACS will be returned.
1da177e4	89	*
44f6c012	90	* RETURN: Status, vector
1da177e4	91	*
44f6c012	92	* DESCRIPTION: Access function for the firmware_waking_vector field in FACS
1da177e4 LT	93	*
1da177e4 LT	94	******************************************************************************/
44f6c012	95
1da177e4 LT	96	#ifdef ACPI_FUTURE_USAGE
1da177e4 LT	97	acpi_status
4be44fcd	98	acpi_get_firmware_waking_vector(acpi_physical_address * physical_address)
1da177e4 LT	99	{
1da177e4 LT	100
4be44fcd	101	ACPI_FUNCTION_TRACE("acpi_get_firmware_waking_vector");
1da177e4 LT	102
1da177e4 LT	103	if (!physical_address) {
4be44fcd	104	return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4 LT	105	}
	106
	107	/* Get the vector */
	108
	109	if (acpi_gbl_common_fACS.vector_width == 32) {
	110	*physical_address = (acpi_physical_address)
4be44fcd LB	111	*
	112	(ACPI_CAST_PTR
	113	(u32, acpi_gbl_common_fACS.firmware_waking_vector));
	114	} else {
1da177e4	115	*physical_address =
4be44fcd	116	*acpi_gbl_common_fACS.firmware_waking_vector;
1da177e4 LT	117	}
1da177e4 LT	118
4be44fcd	119	return_ACPI_STATUS(AE_OK);
1da177e4 LT	120	}
	121	#endif
	122
44f6c012	123	/*******************************************************************************
1da177e4 LT	124	*
	125	* FUNCTION: acpi_enter_sleep_state_prep
	126	*
	127	* PARAMETERS: sleep_state - Which sleep state to enter
	128	*
	129	* RETURN: Status
	130	*
	131	* DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
	132	* This function must execute with interrupts enabled.
	133	* We break sleeping into 2 stages so that OSPM can handle
	134	* various OS-specific tasks between the two steps.
	135	*
	136	******************************************************************************/
	137
4be44fcd	138	acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
1da177e4	139	{
4be44fcd LB	140	acpi_status status;
	141	struct acpi_object_list arg_list;
	142	union acpi_object arg;
1da177e4	143
4be44fcd	144	ACPI_FUNCTION_TRACE("acpi_enter_sleep_state_prep");
1da177e4 LT	145
	146	/*
	147	* _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
	148	*/
4be44fcd LB	149	status = acpi_get_sleep_type_data(sleep_state,
	150	&acpi_gbl_sleep_type_a,
	151	&acpi_gbl_sleep_type_b);
	152	if (ACPI_FAILURE(status)) {
	153	return_ACPI_STATUS(status);
1da177e4 LT	154	}
	155
	156	/* Setup parameter object */
	157
	158	arg_list.count = 1;
	159	arg_list.pointer = &arg;
	160
	161	arg.type = ACPI_TYPE_INTEGER;
	162	arg.integer.value = sleep_state;
	163
	164	/* Run the _PTS and _GTS methods */
	165
4be44fcd LB	166	status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
	167	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
	168	return_ACPI_STATUS(status);
1da177e4 LT	169	}
1da177e4 LT	170
4be44fcd LB	171	status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
	172	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
	173	return_ACPI_STATUS(status);
1da177e4 LT	174	}
	175
	176	/* Setup the argument to _SST */
	177
	178	switch (sleep_state) {
	179	case ACPI_STATE_S0:
	180	arg.integer.value = ACPI_SST_WORKING;
	181	break;
	182
	183	case ACPI_STATE_S1:
	184	case ACPI_STATE_S2:
	185	case ACPI_STATE_S3:
	186	arg.integer.value = ACPI_SST_SLEEPING;
	187	break;
	188
	189	case ACPI_STATE_S4:
	190	arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
	191	break;
	192
	193	default:
4be44fcd	194	arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is off */
1da177e4 LT	195	break;
	196	}
	197
	198	/* Set the system indicators to show the desired sleep state. */
	199
4be44fcd LB	200	status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
4be44fcd LB	201	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
b8e4d893 BM	202	ACPI_EXCEPTION((AE_INFO, status,
b8e4d893 BM	203	"While executing method _SST"));
1da177e4 LT	204	}
1da177e4 LT	205
4be44fcd	206	return_ACPI_STATUS(AE_OK);
1da177e4 LT	207	}
1da177e4 LT	208
44f6c012	209	/*******************************************************************************
1da177e4 LT	210	*
	211	* FUNCTION: acpi_enter_sleep_state
	212	*
	213	* PARAMETERS: sleep_state - Which sleep state to enter
	214	*
	215	* RETURN: Status
	216	*
	217	* DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
	218	* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
	219	*
	220	******************************************************************************/
	221
4be44fcd	222	acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
1da177e4	223	{
4be44fcd LB	224	u32 PM1Acontrol;
	225	u32 PM1Bcontrol;
	226	struct acpi_bit_register_info *sleep_type_reg_info;
	227	struct acpi_bit_register_info *sleep_enable_reg_info;
	228	u32 in_value;
	229	acpi_status status;
1da177e4	230
4be44fcd	231	ACPI_FUNCTION_TRACE("acpi_enter_sleep_state");
1da177e4 LT	232
1da177e4 LT	233	if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) \|\|
4be44fcd	234	(acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
b8e4d893 BM	235	ACPI_ERROR((AE_INFO, "Sleep values out of range: A=%X B=%X",
b8e4d893 BM	236	acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
4be44fcd	237	return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
1da177e4 LT	238	}
1da177e4 LT	239
4be44fcd LB	240	sleep_type_reg_info =
	241	acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
	242	sleep_enable_reg_info =
	243	acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
1da177e4 LT	244
	245	/* Clear wake status */
	246
4be44fcd LB	247	status =
	248	acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
	249	if (ACPI_FAILURE(status)) {
	250	return_ACPI_STATUS(status);
1da177e4 LT	251	}
	252
	253	/* Clear all fixed and general purpose status bits */
	254
4be44fcd LB	255	status = acpi_hw_clear_acpi_status(ACPI_MTX_DO_NOT_LOCK);
	256	if (ACPI_FAILURE(status)) {
	257	return_ACPI_STATUS(status);
1da177e4 LT	258	}
	259
	260	/*
	261	* 1) Disable/Clear all GPEs
	262	* 2) Enable all wakeup GPEs
	263	*/
4be44fcd LB	264	status = acpi_hw_disable_all_gpes();
	265	if (ACPI_FAILURE(status)) {
	266	return_ACPI_STATUS(status);
1da177e4 LT	267	}
	268	acpi_gbl_system_awake_and_running = FALSE;
	269
4be44fcd LB	270	status = acpi_hw_enable_all_wakeup_gpes();
	271	if (ACPI_FAILURE(status)) {
	272	return_ACPI_STATUS(status);
1da177e4 LT	273	}
	274
	275	/* Get current value of PM1A control */
	276
4be44fcd LB	277	status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
	278	ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
	279	if (ACPI_FAILURE(status)) {
	280	return_ACPI_STATUS(status);
1da177e4	281	}
4be44fcd LB	282	ACPI_DEBUG_PRINT((ACPI_DB_INIT,
4be44fcd LB	283	"Entering sleep state [S%d]\n", sleep_state));
1da177e4 LT	284
	285	/* Clear SLP_EN and SLP_TYP fields */
	286
44f6c012	287	PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask \|
4be44fcd	288	sleep_enable_reg_info->access_bit_mask);
1da177e4 LT	289	PM1Bcontrol = PM1Acontrol;
	290
	291	/* Insert SLP_TYP bits */
	292
4be44fcd LB	293	PM1Acontrol \|=
	294	(acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
	295	PM1Bcontrol \|=
	296	(acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
1da177e4 LT	297
	298	/*
	299	* We split the writes of SLP_TYP and SLP_EN to workaround
	300	* poorly implemented hardware.
	301	*/
	302
	303	/* Write #1: fill in SLP_TYP data */
	304
4be44fcd LB	305	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
	306	ACPI_REGISTER_PM1A_CONTROL,
	307	PM1Acontrol);
	308	if (ACPI_FAILURE(status)) {
	309	return_ACPI_STATUS(status);
1da177e4 LT	310	}
1da177e4 LT	311
4be44fcd LB	312	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
	313	ACPI_REGISTER_PM1B_CONTROL,
	314	PM1Bcontrol);
	315	if (ACPI_FAILURE(status)) {
	316	return_ACPI_STATUS(status);
1da177e4 LT	317	}
	318
	319	/* Insert SLP_ENABLE bit */
	320
	321	PM1Acontrol \|= sleep_enable_reg_info->access_bit_mask;
	322	PM1Bcontrol \|= sleep_enable_reg_info->access_bit_mask;
	323
	324	/* Write #2: SLP_TYP + SLP_EN */
	325
4be44fcd	326	ACPI_FLUSH_CPU_CACHE();
1da177e4	327
4be44fcd LB	328	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
	329	ACPI_REGISTER_PM1A_CONTROL,
	330	PM1Acontrol);
	331	if (ACPI_FAILURE(status)) {
	332	return_ACPI_STATUS(status);
1da177e4 LT	333	}
1da177e4 LT	334
4be44fcd LB	335	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
	336	ACPI_REGISTER_PM1B_CONTROL,
	337	PM1Bcontrol);
	338	if (ACPI_FAILURE(status)) {
	339	return_ACPI_STATUS(status);
1da177e4 LT	340	}
	341
	342	if (sleep_state > ACPI_STATE_S3) {
	343	/*
44f6c012 RM	344	* We wanted to sleep > S3, but it didn't happen (by virtue of the
44f6c012 RM	345	* fact that we are still executing!)
1da177e4	346	*
44f6c012 RM	347	* Wait ten seconds, then try again. This is to get S4/S5 to work on
44f6c012 RM	348	* all machines.
1da177e4 LT	349	*
	350	* We wait so long to allow chipsets that poll this reg very slowly to
	351	* still read the right value. Ideally, this block would go
	352	* away entirely.
	353	*/
4be44fcd LB	354	acpi_os_stall(10000000);
	355
	356	status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
	357	ACPI_REGISTER_PM1_CONTROL,
	358	sleep_enable_reg_info->
	359	access_bit_mask);
	360	if (ACPI_FAILURE(status)) {
	361	return_ACPI_STATUS(status);
1da177e4 LT	362	}
	363	}
	364
	365	/* Wait until we enter sleep state */
	366
	367	do {
4be44fcd LB	368	status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value,
	369	ACPI_MTX_DO_NOT_LOCK);
	370	if (ACPI_FAILURE(status)) {
	371	return_ACPI_STATUS(status);
1da177e4 LT	372	}
	373
	374	/* Spin until we wake */
	375
	376	} while (!in_value);
	377
4be44fcd	378	return_ACPI_STATUS(AE_OK);
1da177e4	379	}
1da177e4	380
4be44fcd	381	EXPORT_SYMBOL(acpi_enter_sleep_state);
1da177e4	382
44f6c012	383	/*******************************************************************************
1da177e4 LT	384	*
	385	* FUNCTION: acpi_enter_sleep_state_s4bios
	386	*
	387	* PARAMETERS: None
	388	*
	389	* RETURN: Status
	390	*
	391	* DESCRIPTION: Perform a S4 bios request.
	392	* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
	393	*
	394	******************************************************************************/
	395
4be44fcd	396	acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
1da177e4	397	{
4be44fcd LB	398	u32 in_value;
4be44fcd LB	399	acpi_status status;
1da177e4	400
4be44fcd	401	ACPI_FUNCTION_TRACE("acpi_enter_sleep_state_s4bios");
1da177e4	402
4be44fcd LB	403	status =
	404	acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
	405	if (ACPI_FAILURE(status)) {
	406	return_ACPI_STATUS(status);
1da177e4 LT	407	}
1da177e4 LT	408
4be44fcd LB	409	status = acpi_hw_clear_acpi_status(ACPI_MTX_DO_NOT_LOCK);
	410	if (ACPI_FAILURE(status)) {
	411	return_ACPI_STATUS(status);
1da177e4 LT	412	}
	413
	414	/*
	415	* 1) Disable/Clear all GPEs
	416	* 2) Enable all wakeup GPEs
	417	*/
4be44fcd LB	418	status = acpi_hw_disable_all_gpes();
	419	if (ACPI_FAILURE(status)) {
	420	return_ACPI_STATUS(status);
1da177e4 LT	421	}
	422	acpi_gbl_system_awake_and_running = FALSE;
	423
4be44fcd LB	424	status = acpi_hw_enable_all_wakeup_gpes();
	425	if (ACPI_FAILURE(status)) {
	426	return_ACPI_STATUS(status);
1da177e4 LT	427	}
1da177e4 LT	428
4be44fcd	429	ACPI_FLUSH_CPU_CACHE();
1da177e4	430
4be44fcd LB	431	status = acpi_os_write_port(acpi_gbl_FADT->smi_cmd,
4be44fcd LB	432	(u32) acpi_gbl_FADT->S4bios_req, 8);
1da177e4 LT	433
	434	do {
	435	acpi_os_stall(1000);
4be44fcd LB	436	status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value,
	437	ACPI_MTX_DO_NOT_LOCK);
	438	if (ACPI_FAILURE(status)) {
	439	return_ACPI_STATUS(status);
1da177e4 LT	440	}
	441	} while (!in_value);
	442
4be44fcd	443	return_ACPI_STATUS(AE_OK);
1da177e4	444	}
1da177e4	445
4be44fcd	446	EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios);
1da177e4	447
44f6c012	448	/*******************************************************************************
1da177e4 LT	449	*
	450	* FUNCTION: acpi_leave_sleep_state
	451	*
	452	* PARAMETERS: sleep_state - Which sleep state we just exited
	453	*
	454	* RETURN: Status
	455	*
	456	* DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
	457	* Called with interrupts ENABLED.
	458	*
	459	******************************************************************************/
	460
4be44fcd	461	acpi_status acpi_leave_sleep_state(u8 sleep_state)
1da177e4	462	{
4be44fcd LB	463	struct acpi_object_list arg_list;
	464	union acpi_object arg;
	465	acpi_status status;
	466	struct acpi_bit_register_info *sleep_type_reg_info;
	467	struct acpi_bit_register_info *sleep_enable_reg_info;
	468	u32 PM1Acontrol;
	469	u32 PM1Bcontrol;
1da177e4	470
4be44fcd	471	ACPI_FUNCTION_TRACE("acpi_leave_sleep_state");
1da177e4 LT	472
	473	/*
	474	* Set SLP_TYPE and SLP_EN to state S0.
	475	* This is unclear from the ACPI Spec, but it is required
	476	* by some machines.
	477	*/
4be44fcd LB	478	status = acpi_get_sleep_type_data(ACPI_STATE_S0,
	479	&acpi_gbl_sleep_type_a,
	480	&acpi_gbl_sleep_type_b);
	481	if (ACPI_SUCCESS(status)) {
	482	sleep_type_reg_info =
	483	acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
	484	sleep_enable_reg_info =
	485	acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
1da177e4 LT	486
	487	/* Get current value of PM1A control */
	488
4be44fcd LB	489	status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
	490	ACPI_REGISTER_PM1_CONTROL,
	491	&PM1Acontrol);
	492	if (ACPI_SUCCESS(status)) {
1da177e4 LT	493	/* Clear SLP_EN and SLP_TYP fields */
	494
	495	PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask \|
4be44fcd LB	496	sleep_enable_reg_info->
4be44fcd LB	497	access_bit_mask);
1da177e4 LT	498	PM1Bcontrol = PM1Acontrol;
	499
	500	/* Insert SLP_TYP bits */
	501
4be44fcd LB	502	PM1Acontrol \|=
	503	(acpi_gbl_sleep_type_a << sleep_type_reg_info->
	504	bit_position);
	505	PM1Bcontrol \|=
	506	(acpi_gbl_sleep_type_b << sleep_type_reg_info->
	507	bit_position);
1da177e4 LT	508
	509	/* Just ignore any errors */
	510
4be44fcd LB	511	(void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
	512	ACPI_REGISTER_PM1A_CONTROL,
	513	PM1Acontrol);
	514	(void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
	515	ACPI_REGISTER_PM1B_CONTROL,
	516	PM1Bcontrol);
1da177e4 LT	517	}
	518	}
	519
	520	/* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
	521
	522	acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
	523
	524	/* Setup parameter object */
	525
	526	arg_list.count = 1;
	527	arg_list.pointer = &arg;
	528	arg.type = ACPI_TYPE_INTEGER;
	529
	530	/* Ignore any errors from these methods */
	531
	532	arg.integer.value = ACPI_SST_WAKING;
4be44fcd LB	533	status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
4be44fcd LB	534	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
b8e4d893	535	ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
1da177e4 LT	536	}
	537
	538	arg.integer.value = sleep_state;
4be44fcd LB	539	status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
4be44fcd LB	540	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
b8e4d893	541	ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
1da177e4 LT	542	}
1da177e4 LT	543
4be44fcd LB	544	status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
4be44fcd LB	545	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
b8e4d893	546	ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
1da177e4 LT	547	}
	548	/* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
	549
	550	/*
	551	* Restore the GPEs:
	552	* 1) Disable/Clear all GPEs
	553	* 2) Enable all runtime GPEs
	554	*/
4be44fcd LB	555	status = acpi_hw_disable_all_gpes();
	556	if (ACPI_FAILURE(status)) {
	557	return_ACPI_STATUS(status);
1da177e4 LT	558	}
	559	acpi_gbl_system_awake_and_running = TRUE;
	560
4be44fcd LB	561	status = acpi_hw_enable_all_runtime_gpes();
	562	if (ACPI_FAILURE(status)) {
	563	return_ACPI_STATUS(status);
1da177e4 LT	564	}
	565
	566	/* Enable power button */
	567
4be44fcd LB	568	(void)
	569	acpi_set_register(acpi_gbl_fixed_event_info
	570	[ACPI_EVENT_POWER_BUTTON].enable_register_id, 1,
	571	ACPI_MTX_DO_NOT_LOCK);
44f6c012	572
4be44fcd LB	573	(void)
	574	acpi_set_register(acpi_gbl_fixed_event_info
	575	[ACPI_EVENT_POWER_BUTTON].status_register_id, 1,
	576	ACPI_MTX_DO_NOT_LOCK);
1da177e4 LT	577
1da177e4 LT	578	arg.integer.value = ACPI_SST_WORKING;
4be44fcd LB	579	status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
4be44fcd LB	580	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
b8e4d893	581	ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
1da177e4 LT	582	}
1da177e4 LT	583
4be44fcd	584	return_ACPI_STATUS(status);
1da177e4	585	}