[deliverable/linux.git] / drivers / acpi / acpica / hwxfsleep.c

/******************************************************************************
 *
 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2015, Intel Corp.
 * 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.
 */

#define EXPORT_ACPI_INTERFACES

#include <acpi/acpi.h>
#include "accommon.h"

#define _COMPONENT          ACPI_HARDWARE
ACPI_MODULE_NAME("hwxfsleep")

/* Local prototypes */
#if (!ACPI_REDUCED_HARDWARE)
static acpi_status
acpi_hw_set_firmware_waking_vectors(struct acpi_table_facs *facs,
				    acpi_physical_address physical_address,
				    acpi_physical_address physical_address64);
#endif

static acpi_status acpi_hw_sleep_dispatch(u8 sleep_state, u32 function_id);

/*
 * Dispatch table used to efficiently branch to the various sleep
 * functions.
 */
#define ACPI_SLEEP_FUNCTION_ID         0
#define ACPI_WAKE_PREP_FUNCTION_ID     1
#define ACPI_WAKE_FUNCTION_ID          2

/* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */

static struct acpi_sleep_functions acpi_sleep_dispatch[] = {
	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_sleep),
	 acpi_hw_extended_sleep},
	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake_prep),
	 acpi_hw_extended_wake_prep},
	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake), acpi_hw_extended_wake}
};

/*
 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
 *      acpi_set_firmware_waking_vectors
 *      acpi_set_firmware_waking_vector
 *      acpi_set_firmware_waking_vector64
 *      acpi_enter_sleep_state_s4bios
 */

#if (!ACPI_REDUCED_HARDWARE)
/*******************************************************************************
 *
 * FUNCTION:    acpi_hw_set_firmware_waking_vectors
 *
 * PARAMETERS:  facs                - Pointer to FACS table
 *              physical_address    - 32-bit physical address of ACPI real mode
 *                                    entry point.
 *              physical_address64  - 64-bit physical address of ACPI protected
 *                                    mode entry point.
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
 *
 ******************************************************************************/

static acpi_status
acpi_hw_set_firmware_waking_vectors(struct acpi_table_facs *facs,
				    acpi_physical_address physical_address,
				    acpi_physical_address physical_address64)
{
	ACPI_FUNCTION_TRACE(acpi_hw_set_firmware_waking_vectors);


	/*
	 * According to the ACPI specification 2.0c and later, the 64-bit
	 * waking vector should be cleared and the 32-bit waking vector should
	 * be used, unless we want the wake-up code to be called by the BIOS in
	 * Protected Mode.  Some systems (for example HP dv5-1004nr) are known
	 * to fail to resume if the 64-bit vector is used.
	 */

	/* Set the 32-bit vector */

	facs->firmware_waking_vector = (u32)physical_address;

	if (facs->length > 32) {
		if (facs->version >= 1) {

			/* Set the 64-bit vector */

			facs->xfirmware_waking_vector = physical_address64;
		} else {
			/* Clear the 64-bit vector if it exists */

			facs->xfirmware_waking_vector = 0;
		}
	}

	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_set_firmware_waking_vectors
 *
 * PARAMETERS:  physical_address    - 32-bit physical address of ACPI real mode
 *                                    entry point.
 *              physical_address64  - 64-bit physical address of ACPI protected
 *                                    mode entry point.
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
 *
 ******************************************************************************/

acpi_status
acpi_set_firmware_waking_vectors(acpi_physical_address physical_address,
				 acpi_physical_address physical_address64)
{

	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vectors);

	if (acpi_gbl_FACS) {
		(void)acpi_hw_set_firmware_waking_vectors(acpi_gbl_FACS,
							  physical_address,
							  physical_address64);
	}

	return_ACPI_STATUS(AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vectors)

/*******************************************************************************
 *
 * FUNCTION:    acpi_set_firmware_waking_vector
 *
 * PARAMETERS:  physical_address    - 32-bit physical address of ACPI real mode
 *                                    entry point.
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Sets the 32-bit firmware_waking_vector field of the FACS
 *
 ******************************************************************************/
acpi_status acpi_set_firmware_waking_vector(u32 physical_address)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);

	status = acpi_set_firmware_waking_vectors((acpi_physical_address)
						  physical_address, 0);

	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)

#if ACPI_MACHINE_WIDTH == 64
/*******************************************************************************
 *
 * FUNCTION:    acpi_set_firmware_waking_vector64
 *
 * PARAMETERS:  physical_address    - 64-bit physical address of ACPI protected
 *                                    mode entry point.
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Sets the 64-bit X_firmware_waking_vector field of the FACS, if
 *              it exists in the table. This function is intended for use with
 *              64-bit host operating systems.
 *
 ******************************************************************************/
acpi_status acpi_set_firmware_waking_vector64(u64 physical_address)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector64);

	status = acpi_set_firmware_waking_vectors(0,
						  (acpi_physical_address)
						  physical_address);

	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector64)
#endif
/*******************************************************************************
 *
 * 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 acpi_enter_sleep_state_s4bios(void)
{
	u32 in_value;
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);

	/* Clear the wake status bit (PM1) */

	status =
	    acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	status = acpi_hw_clear_acpi_status();
	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_hw_write_port(acpi_gbl_FADT.smi_command,
				    (u32)acpi_gbl_FADT.s4_bios_request, 8);

	do {
		acpi_os_stall(ACPI_USEC_PER_MSEC);
		status =
		    acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
		if (ACPI_FAILURE(status)) {
			return_ACPI_STATUS(status);
		}

	} while (!in_value);

	return_ACPI_STATUS(AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
#endif				/* !ACPI_REDUCED_HARDWARE */
/*******************************************************************************
 *
 * FUNCTION:    acpi_hw_sleep_dispatch
 *
 * PARAMETERS:  sleep_state         - Which sleep state to enter/exit
 *              function_id         - Sleep, wake_prep, or Wake
 *
 * RETURN:      Status from the invoked sleep handling function.
 *
 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
 *              function.
 *
 ******************************************************************************/
static acpi_status acpi_hw_sleep_dispatch(u8 sleep_state, u32 function_id)
{
	acpi_status status;
	struct acpi_sleep_functions *sleep_functions =
	    &acpi_sleep_dispatch[function_id];

#if (!ACPI_REDUCED_HARDWARE)
	/*
	 * If the Hardware Reduced flag is set (from the FADT), we must
	 * use the extended sleep registers (FADT). Note: As per the ACPI
	 * specification, these extended registers are to be used for HW-reduced
	 * platforms only. They are not general-purpose replacements for the
	 * legacy PM register sleep support.
	 */
	if (acpi_gbl_reduced_hardware) {
		status = sleep_functions->extended_function(sleep_state);
	} else {
		/* Legacy sleep */

		status = sleep_functions->legacy_function(sleep_state);
	}

	return (status);

#else
	/*
	 * For the case where reduced-hardware-only code is being generated,
	 * we know that only the extended sleep registers are available
	 */
	status = sleep_functions->extended_function(sleep_state);
	return (status);

#endif				/* !ACPI_REDUCED_HARDWARE */
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_enter_sleep_state_prep
 *
 * PARAMETERS:  sleep_state         - Which sleep state to enter
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Prepare to enter a system sleep state.
 *              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;
	u32 sst_value;

	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);

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

	/* Execute the _PTS method (Prepare To Sleep) */

	arg_list.count = 1;
	arg_list.pointer = &arg;
	arg.type = ACPI_TYPE_INTEGER;
	arg.integer.value = sleep_state;

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

	/* Setup the argument to the _SST method (System STatus) */

	switch (sleep_state) {
	case ACPI_STATE_S0:

		sst_value = ACPI_SST_WORKING;
		break;

	case ACPI_STATE_S1:
	case ACPI_STATE_S2:
	case ACPI_STATE_S3:

		sst_value = ACPI_SST_SLEEPING;
		break;

	case ACPI_STATE_S4:

		sst_value = ACPI_SST_SLEEP_CONTEXT;
		break;

	default:

		sst_value = ACPI_SST_INDICATOR_OFF;	/* Default is off */
		break;
	}

	/*
	 * Set the system indicators to show the desired sleep state.
	 * _SST is an optional method (return no error if not found)
	 */
	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, sst_value);
	return_ACPI_STATUS(AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)

/*******************************************************************************
 *
 * FUNCTION:    acpi_enter_sleep_state
 *
 * PARAMETERS:  sleep_state         - Which sleep state to enter
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Enter a system sleep state
 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
 *
 ******************************************************************************/
acpi_status acpi_enter_sleep_state(u8 sleep_state)
{
	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=0x%X B=0x%X",
			    acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
		return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
	}

	status = acpi_hw_sleep_dispatch(sleep_state, ACPI_SLEEP_FUNCTION_ID);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)

/*******************************************************************************
 *
 * FUNCTION:    acpi_leave_sleep_state_prep
 *
 * PARAMETERS:  sleep_state         - Which sleep state we are exiting
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
 *              sleep. Called with interrupts DISABLED.
 *              We break wake/resume into 2 stages so that OSPM can handle
 *              various OS-specific tasks between the two steps.
 *
 ******************************************************************************/
acpi_status acpi_leave_sleep_state_prep(u8 sleep_state)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);

	status =
	    acpi_hw_sleep_dispatch(sleep_state, ACPI_WAKE_PREP_FUNCTION_ID);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state_prep)

/*******************************************************************************
 *
 * FUNCTION:    acpi_leave_sleep_state
 *
 * PARAMETERS:  sleep_state         - Which sleep state we are exiting
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
 *              Called with interrupts ENABLED.
 *
 ******************************************************************************/
acpi_status acpi_leave_sleep_state(u8 sleep_state)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);

	status = acpi_hw_sleep_dispatch(sleep_state, ACPI_WAKE_FUNCTION_ID);
	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)
Commit	Line	Data
2feec47d BM	1	/******************************************************************************
	2	*
	3	* Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
	4	*
	5	*****************************************************************************/
	6
	7	/*
82a80941	8	* Copyright (C) 2000 - 2015, Intel Corp.
2feec47d BM	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	14	* 1. Redistributions of source code must retain the above copyright
	15	* notice, this list of conditions, and the following disclaimer,
	16	* without modification.
	17	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	18	* substantially similar to the "NO WARRANTY" disclaimer below
	19	* ("Disclaimer") and any redistribution must be conditioned upon
	20	* including a substantially similar Disclaimer requirement for further
	21	* binary redistribution.
	22	* 3. Neither the names of the above-listed copyright holders nor the names
	23	* of any contributors may be used to endorse or promote products derived
	24	* from this software without specific prior written permission.
	25	*
	26	* Alternatively, this software may be distributed under the terms of the
	27	* GNU General Public License ("GPL") version 2 as published by the Free
	28	* Software Foundation.
	29	*
	30	* NO WARRANTY
	31	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	32	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	33	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	34	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	35	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	36	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	37	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	38	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	39	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	40	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	41	* POSSIBILITY OF SUCH DAMAGES.
	42	*/
	43
839e928f LZ	44	#define EXPORT_ACPI_INTERFACES
839e928f LZ	45
2feec47d BM	46	#include <acpi/acpi.h>
2feec47d BM	47	#include "accommon.h"
2feec47d BM	48
	49	#define _COMPONENT ACPI_HARDWARE
	50	ACPI_MODULE_NAME("hwxfsleep")
	51
72a8887a	52	/* Local prototypes */
f06147f9 LZ	53	#if (!ACPI_REDUCED_HARDWARE)
	54	static acpi_status
	55	acpi_hw_set_firmware_waking_vectors(struct acpi_table_facs *facs,
	56	acpi_physical_address physical_address,
	57	acpi_physical_address physical_address64);
	58	#endif
	59
1f86e8c1	60	static acpi_status acpi_hw_sleep_dispatch(u8 sleep_state, u32 function_id);
72a8887a BM	61
	62	/*
	63	* Dispatch table used to efficiently branch to the various sleep
	64	* functions.
	65	*/
8a73b17e LM	66	#define ACPI_SLEEP_FUNCTION_ID 0
	67	#define ACPI_WAKE_PREP_FUNCTION_ID 1
	68	#define ACPI_WAKE_FUNCTION_ID 2
72a8887a BM	69
	70	/* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
	71
	72	static struct acpi_sleep_functions acpi_sleep_dispatch[] = {
	73	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_sleep),
	74	acpi_hw_extended_sleep},
	75	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake_prep),
	76	acpi_hw_extended_wake_prep},
	77	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake), acpi_hw_extended_wake}
	78	};
	79
	80	/*
	81	* These functions are removed for the ACPI_REDUCED_HARDWARE case:
aca2a5d3	82	* acpi_set_firmware_waking_vectors
72a8887a BM	83	* acpi_set_firmware_waking_vector
	84	* acpi_set_firmware_waking_vector64
	85	* acpi_enter_sleep_state_s4bios
	86	*/
	87
33620c54	88	#if (!ACPI_REDUCED_HARDWARE)
2feec47d BM	89	/*******************************************************************************
2feec47d BM	90	*
f06147f9	91	* FUNCTION: acpi_hw_set_firmware_waking_vectors
2feec47d	92	*
f06147f9 LZ	93	* PARAMETERS: facs - Pointer to FACS table
f06147f9 LZ	94	* physical_address - 32-bit physical address of ACPI real mode
2feec47d	95	* entry point.
aca2a5d3 LZ	96	* physical_address64 - 64-bit physical address of ACPI protected
aca2a5d3 LZ	97	* mode entry point.
2feec47d BM	98	*
	99	* RETURN: Status
	100	*
aca2a5d3	101	* DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
2feec47d BM	102	*
2feec47d BM	103	******************************************************************************/
72a8887a	104
f06147f9 LZ	105	static acpi_status
	106	acpi_hw_set_firmware_waking_vectors(struct acpi_table_facs *facs,
	107	acpi_physical_address physical_address,
	108	acpi_physical_address physical_address64)
2feec47d	109	{
f06147f9	110	ACPI_FUNCTION_TRACE(acpi_hw_set_firmware_waking_vectors);
2feec47d BM	111
	112
	113	/*
	114	* According to the ACPI specification 2.0c and later, the 64-bit
	115	* waking vector should be cleared and the 32-bit waking vector should
	116	* be used, unless we want the wake-up code to be called by the BIOS in
	117	* Protected Mode. Some systems (for example HP dv5-1004nr) are known
	118	* to fail to resume if the 64-bit vector is used.
	119	*/
	120
	121	/* Set the 32-bit vector */
	122
f06147f9	123	facs->firmware_waking_vector = (u32)physical_address;
2feec47d	124
f06147f9 LZ	125	if (facs->length > 32) {
f06147f9 LZ	126	if (facs->version >= 1) {
2feec47d	127
aca2a5d3 LZ	128	/* Set the 64-bit vector */
aca2a5d3 LZ	129
f06147f9	130	facs->xfirmware_waking_vector = physical_address64;
aca2a5d3 LZ	131	} else {
	132	/* Clear the 64-bit vector if it exists */
	133
f06147f9	134	facs->xfirmware_waking_vector = 0;
aca2a5d3	135	}
2feec47d BM	136	}
	137
	138	return_ACPI_STATUS(AE_OK);
	139	}
	140
f06147f9 LZ	141	/*******************************************************************************
	142	*
	143	* FUNCTION: acpi_set_firmware_waking_vectors
	144	*
	145	* PARAMETERS: physical_address - 32-bit physical address of ACPI real mode
	146	* entry point.
	147	* physical_address64 - 64-bit physical address of ACPI protected
	148	* mode entry point.
	149	*
	150	* RETURN: Status
	151	*
	152	* DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
	153	*
	154	******************************************************************************/
	155
	156	acpi_status
	157	acpi_set_firmware_waking_vectors(acpi_physical_address physical_address,
	158	acpi_physical_address physical_address64)
	159	{
	160
	161	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vectors);
	162
7484619b LZ	163	if (acpi_gbl_FACS) {
7484619b LZ	164	(void)acpi_hw_set_firmware_waking_vectors(acpi_gbl_FACS,
f06147f9 LZ	165	physical_address,
	166	physical_address64);
	167	}
	168
	169	return_ACPI_STATUS(AE_OK);
	170	}
	171
aca2a5d3 LZ	172	ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vectors)
	173
	174	/*******************************************************************************
	175	*
	176	* FUNCTION: acpi_set_firmware_waking_vector
	177	*
	178	* PARAMETERS: physical_address - 32-bit physical address of ACPI real mode
	179	* entry point.
	180	*
	181	* RETURN: Status
	182	*
	183	* DESCRIPTION: Sets the 32-bit firmware_waking_vector field of the FACS
	184	*
	185	******************************************************************************/
	186	acpi_status acpi_set_firmware_waking_vector(u32 physical_address)
	187	{
	188	acpi_status status;
	189
	190	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
	191
	192	status = acpi_set_firmware_waking_vectors((acpi_physical_address)
	193	physical_address, 0);
	194
	195	return_ACPI_STATUS(status);
	196	}
	197
2feec47d BM	198	ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
	199
	200	#if ACPI_MACHINE_WIDTH == 64
	201	/*******************************************************************************
	202	*
	203	* FUNCTION: acpi_set_firmware_waking_vector64
	204	*
	205	* PARAMETERS: physical_address - 64-bit physical address of ACPI protected
	206	* mode entry point.
	207	*
	208	* RETURN: Status
	209	*
	210	* DESCRIPTION: Sets the 64-bit X_firmware_waking_vector field of the FACS, if
	211	* it exists in the table. This function is intended for use with
	212	* 64-bit host operating systems.
	213	*
	214	******************************************************************************/
	215	acpi_status acpi_set_firmware_waking_vector64(u64 physical_address)
	216	{
aca2a5d3	217	acpi_status status;
2feec47d	218
aca2a5d3	219	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector64);
2feec47d	220
aca2a5d3 LZ	221	status = acpi_set_firmware_waking_vectors(0,
	222	(acpi_physical_address)
	223	physical_address);
2feec47d	224
aca2a5d3	225	return_ACPI_STATUS(status);
2feec47d BM	226	}
	227
	228	ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector64)
	229	#endif
2feec47d BM	230	/*******************************************************************************
	231	*
	232	* FUNCTION: acpi_enter_sleep_state_s4bios
	233	*
	234	* PARAMETERS: None
	235	*
	236	* RETURN: Status
	237	*
	238	* DESCRIPTION: Perform a S4 bios request.
	239	* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
	240	*
	241	******************************************************************************/
40bce100	242	acpi_status acpi_enter_sleep_state_s4bios(void)
2feec47d BM	243	{
	244	u32 in_value;
	245	acpi_status status;
	246
	247	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
	248
	249	/* Clear the wake status bit (PM1) */
	250
	251	status =
	252	acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
	253	if (ACPI_FAILURE(status)) {
	254	return_ACPI_STATUS(status);
	255	}
	256
	257	status = acpi_hw_clear_acpi_status();
	258	if (ACPI_FAILURE(status)) {
	259	return_ACPI_STATUS(status);
	260	}
	261
	262	/*
	263	* 1) Disable/Clear all GPEs
	264	* 2) Enable all wakeup GPEs
	265	*/
	266	status = acpi_hw_disable_all_gpes();
	267	if (ACPI_FAILURE(status)) {
	268	return_ACPI_STATUS(status);
	269	}
	270	acpi_gbl_system_awake_and_running = FALSE;
	271
	272	status = acpi_hw_enable_all_wakeup_gpes();
	273	if (ACPI_FAILURE(status)) {
	274	return_ACPI_STATUS(status);
	275	}
	276
	277	ACPI_FLUSH_CPU_CACHE();
	278
	279	status = acpi_hw_write_port(acpi_gbl_FADT.smi_command,
ba494bee	280	(u32)acpi_gbl_FADT.s4_bios_request, 8);
2feec47d BM	281
2feec47d BM	282	do {
c41679a4	283	acpi_os_stall(ACPI_USEC_PER_MSEC);
2feec47d BM	284	status =
	285	acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
	286	if (ACPI_FAILURE(status)) {
	287	return_ACPI_STATUS(status);
	288	}
1fad8738	289
2feec47d BM	290	} while (!in_value);
	291
	292	return_ACPI_STATUS(AE_OK);
	293	}
	294
	295	ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
33620c54	296	#endif /* !ACPI_REDUCED_HARDWARE */
72a8887a BM	297	/*******************************************************************************
	298	*
	299	* FUNCTION: acpi_hw_sleep_dispatch
	300	*
	301	* PARAMETERS: sleep_state - Which sleep state to enter/exit
	302	* function_id - Sleep, wake_prep, or Wake
	303	*
	304	* RETURN: Status from the invoked sleep handling function.
	305	*
	306	* DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
	307	* function.
	308	*
	309	******************************************************************************/
1f86e8c1	310	static acpi_status acpi_hw_sleep_dispatch(u8 sleep_state, u32 function_id)
72a8887a BM	311	{
	312	acpi_status status;
	313	struct acpi_sleep_functions *sleep_functions =
	314	&acpi_sleep_dispatch[function_id];
	315
	316	#if (!ACPI_REDUCED_HARDWARE)
72a8887a BM	317	/*
72a8887a BM	318	* If the Hardware Reduced flag is set (from the FADT), we must
7cec7048 LZ	319	* use the extended sleep registers (FADT). Note: As per the ACPI
	320	* specification, these extended registers are to be used for HW-reduced
	321	* platforms only. They are not general-purpose replacements for the
	322	* legacy PM register sleep support.
72a8887a	323	*/
7cec7048	324	if (acpi_gbl_reduced_hardware) {
3f6f49c7	325	status = sleep_functions->extended_function(sleep_state);
72a8887a BM	326	} else {
	327	/* Legacy sleep */
	328
3f6f49c7	329	status = sleep_functions->legacy_function(sleep_state);
72a8887a BM	330	}
	331
	332	return (status);
	333
	334	#else
	335	/*
	336	* For the case where reduced-hardware-only code is being generated,
	337	* we know that only the extended sleep registers are available
	338	*/
3f6f49c7	339	status = sleep_functions->extended_function(sleep_state);
72a8887a BM	340	return (status);
	341
	342	#endif /* !ACPI_REDUCED_HARDWARE */
	343	}
	344
2feec47d BM	345	/*******************************************************************************
	346	*
	347	* FUNCTION: acpi_enter_sleep_state_prep
	348	*
	349	* PARAMETERS: sleep_state - Which sleep state to enter
	350	*
	351	* RETURN: Status
	352	*
72a8887a	353	* DESCRIPTION: Prepare to enter a system sleep state.
2feec47d BM	354	* This function must execute with interrupts enabled.
	355	* We break sleeping into 2 stages so that OSPM can handle
	356	* various OS-specific tasks between the two steps.
	357	*
	358	******************************************************************************/
72a8887a	359
2feec47d BM	360	acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
	361	{
	362	acpi_status status;
	363	struct acpi_object_list arg_list;
	364	union acpi_object arg;
	365	u32 sst_value;
	366
	367	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
	368
2feec47d BM	369	status = acpi_get_sleep_type_data(sleep_state,
	370	&acpi_gbl_sleep_type_a,
	371	&acpi_gbl_sleep_type_b);
	372	if (ACPI_FAILURE(status)) {
	373	return_ACPI_STATUS(status);
	374	}
	375
	376	/* Execute the _PTS method (Prepare To Sleep) */
	377
	378	arg_list.count = 1;
	379	arg_list.pointer = &arg;
	380	arg.type = ACPI_TYPE_INTEGER;
	381	arg.integer.value = sleep_state;
	382
4efeeecd BM	383	status =
4efeeecd BM	384	acpi_evaluate_object(NULL, METHOD_PATHNAME__PTS, &arg_list, NULL);
2feec47d BM	385	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
	386	return_ACPI_STATUS(status);
	387	}
	388
	389	/* Setup the argument to the _SST method (System STatus) */
	390
	391	switch (sleep_state) {
	392	case ACPI_STATE_S0:
1d1ea1b7	393
2feec47d BM	394	sst_value = ACPI_SST_WORKING;
	395	break;
	396
	397	case ACPI_STATE_S1:
	398	case ACPI_STATE_S2:
	399	case ACPI_STATE_S3:
1d1ea1b7	400
2feec47d BM	401	sst_value = ACPI_SST_SLEEPING;
	402	break;
	403
	404	case ACPI_STATE_S4:
1d1ea1b7	405
2feec47d BM	406	sst_value = ACPI_SST_SLEEP_CONTEXT;
	407	break;
	408
	409	default:
1d1ea1b7	410
2feec47d BM	411	sst_value = ACPI_SST_INDICATOR_OFF; /* Default is off */
	412	break;
	413	}
	414
	415	/*
	416	* Set the system indicators to show the desired sleep state.
	417	* _SST is an optional method (return no error if not found)
	418	*/
4efeeecd	419	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, sst_value);
2feec47d BM	420	return_ACPI_STATUS(AE_OK);
	421	}
	422
	423	ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
	424
	425	/*******************************************************************************
	426	*
	427	* FUNCTION: acpi_enter_sleep_state
	428	*
	429	* PARAMETERS: sleep_state - Which sleep state to enter
	430	*
	431	* RETURN: Status
	432	*
75c8044f	433	* DESCRIPTION: Enter a system sleep state
2feec47d BM	434	* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
	435	*
	436	******************************************************************************/
40bce100	437	acpi_status acpi_enter_sleep_state(u8 sleep_state)
2feec47d BM	438	{
	439	acpi_status status;
	440
	441	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
	442
	443	if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) \|\|
	444	(acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
	445	ACPI_ERROR((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
	446	acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
	447	return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
	448	}
33620c54	449
1f86e8c1	450	status = acpi_hw_sleep_dispatch(sleep_state, ACPI_SLEEP_FUNCTION_ID);
2feec47d BM	451	return_ACPI_STATUS(status);
	452	}
	453
	454	ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
	455
	456	/*******************************************************************************
	457	*
	458	* FUNCTION: acpi_leave_sleep_state_prep
	459	*
	460	* PARAMETERS: sleep_state - Which sleep state we are exiting
	461	*
	462	* RETURN: Status
	463	*
	464	* DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
75c8044f LZ	465	* sleep. Called with interrupts DISABLED.
	466	* We break wake/resume into 2 stages so that OSPM can handle
	467	* various OS-specific tasks between the two steps.
2feec47d BM	468	*
2feec47d BM	469	******************************************************************************/
3f6f49c7	470	acpi_status acpi_leave_sleep_state_prep(u8 sleep_state)
2feec47d BM	471	{
	472	acpi_status status;
	473
72a8887a	474	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
2feec47d	475
8a73b17e	476	status =
1f86e8c1	477	acpi_hw_sleep_dispatch(sleep_state, ACPI_WAKE_PREP_FUNCTION_ID);
2feec47d BM	478	return_ACPI_STATUS(status);
	479	}
	480
	481	ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state_prep)
	482
	483	/*******************************************************************************
	484	*
	485	* FUNCTION: acpi_leave_sleep_state
	486	*
72a8887a	487	* PARAMETERS: sleep_state - Which sleep state we are exiting
2feec47d BM	488	*
	489	* RETURN: Status
	490	*
	491	* DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
	492	* Called with interrupts ENABLED.
	493	*
	494	******************************************************************************/
	495	acpi_status acpi_leave_sleep_state(u8 sleep_state)
	496	{
	497	acpi_status status;
	498
	499	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
	500
3f6f49c7	501	status = acpi_hw_sleep_dispatch(sleep_state, ACPI_WAKE_FUNCTION_ID);
2feec47d BM	502	return_ACPI_STATUS(status);
	503	}
	504
	505	ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)