[linux-2.6-block.git] / drivers / acpi / acpica / hwxfsleep.c

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

/*
 * Copyright (C) 2000 - 2018, 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_vector(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_STRUCT_INIT(legacy_function,
			  ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_sleep)),
	 ACPI_STRUCT_INIT(extended_function,
			  acpi_hw_extended_sleep)},
	{ACPI_STRUCT_INIT(legacy_function,
			  ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake_prep)),
	 ACPI_STRUCT_INIT(extended_function,
			  acpi_hw_extended_wake_prep)},
	{ACPI_STRUCT_INIT(legacy_function,
			  ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake)),
	 ACPI_STRUCT_INIT(extended_function,
			  acpi_hw_extended_wake)}
};

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

#if (!ACPI_REDUCED_HARDWARE)
/*******************************************************************************
 *
 * FUNCTION:    acpi_hw_set_firmware_waking_vector
 *
 * 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_vector(struct acpi_table_facs *facs,
				   acpi_physical_address physical_address,
				   acpi_physical_address physical_address64)
{
	ACPI_FUNCTION_TRACE(acpi_hw_set_firmware_waking_vector);


	/*
	 * 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_vector
 *
 * 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_vector(acpi_physical_address physical_address,
				acpi_physical_address physical_address64)
{

	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);

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

	return_ACPI_STATUS(AE_OK);
}

ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)

/*******************************************************************************
 *
 * 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 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	/*
da6f8320	8	* Copyright (C) 2000 - 2018, 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)
f06147f9 LZ	54	static acpi_status
e3e9b577 RW	55	acpi_hw_set_firmware_waking_vector(struct acpi_table_facs *facs,
	56	acpi_physical_address physical_address,
	57	acpi_physical_address physical_address64);
f06147f9 LZ	58	#endif
f06147f9 LZ	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[] = {
3d867f6c KC	73	{ACPI_STRUCT_INIT(legacy_function,
3d867f6c KC	74	ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_sleep)),
99e597ad KC	75	ACPI_STRUCT_INIT(extended_function,
99e597ad KC	76	acpi_hw_extended_sleep)},
3d867f6c KC	77	{ACPI_STRUCT_INIT(legacy_function,
3d867f6c KC	78	ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake_prep)),
99e597ad KC	79	ACPI_STRUCT_INIT(extended_function,
99e597ad KC	80	acpi_hw_extended_wake_prep)},
3d867f6c KC	81	{ACPI_STRUCT_INIT(legacy_function,
3d867f6c KC	82	ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake)),
99e597ad KC	83	ACPI_STRUCT_INIT(extended_function,
99e597ad KC	84	acpi_hw_extended_wake)}
72a8887a BM	85	};
	86
	87	/*
	88	* These functions are removed for the ACPI_REDUCED_HARDWARE case:
	89	* acpi_set_firmware_waking_vector
72a8887a BM	90	* acpi_enter_sleep_state_s4bios
	91	*/
	92
33620c54	93	#if (!ACPI_REDUCED_HARDWARE)
2feec47d BM	94	/*******************************************************************************
2feec47d BM	95	*
e3e9b577	96	* FUNCTION: acpi_hw_set_firmware_waking_vector
2feec47d	97	*
f06147f9 LZ	98	* PARAMETERS: facs - Pointer to FACS table
f06147f9 LZ	99	* physical_address - 32-bit physical address of ACPI real mode
e3e9b577	100	* entry point
aca2a5d3	101	* physical_address64 - 64-bit physical address of ACPI protected
e3e9b577	102	* mode entry point
2feec47d BM	103	*
	104	* RETURN: Status
	105	*
aca2a5d3	106	* DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
2feec47d BM	107	*
2feec47d BM	108	******************************************************************************/
72a8887a	109
f06147f9	110	static acpi_status
e3e9b577 RW	111	acpi_hw_set_firmware_waking_vector(struct acpi_table_facs *facs,
	112	acpi_physical_address physical_address,
	113	acpi_physical_address physical_address64)
2feec47d	114	{
e3e9b577	115	ACPI_FUNCTION_TRACE(acpi_hw_set_firmware_waking_vector);
2feec47d BM	116
	117
	118	/*
	119	* According to the ACPI specification 2.0c and later, the 64-bit
	120	* waking vector should be cleared and the 32-bit waking vector should
	121	* be used, unless we want the wake-up code to be called by the BIOS in
	122	* Protected Mode. Some systems (for example HP dv5-1004nr) are known
	123	* to fail to resume if the 64-bit vector is used.
	124	*/
	125
	126	/* Set the 32-bit vector */
	127
f06147f9	128	facs->firmware_waking_vector = (u32)physical_address;
2feec47d	129
f06147f9 LZ	130	if (facs->length > 32) {
f06147f9 LZ	131	if (facs->version >= 1) {
2feec47d	132
aca2a5d3 LZ	133	/* Set the 64-bit vector */
aca2a5d3 LZ	134
f06147f9	135	facs->xfirmware_waking_vector = physical_address64;
aca2a5d3 LZ	136	} else {
	137	/* Clear the 64-bit vector if it exists */
	138
f06147f9	139	facs->xfirmware_waking_vector = 0;
aca2a5d3	140	}
2feec47d BM	141	}
	142
	143	return_ACPI_STATUS(AE_OK);
	144	}
	145
f06147f9 LZ	146	/*******************************************************************************
f06147f9 LZ	147	*
e3e9b577	148	* FUNCTION: acpi_set_firmware_waking_vector
f06147f9 LZ	149	*
f06147f9 LZ	150	* PARAMETERS: physical_address - 32-bit physical address of ACPI real mode
e3e9b577	151	* entry point
f06147f9	152	* physical_address64 - 64-bit physical address of ACPI protected
e3e9b577	153	* mode entry point
f06147f9 LZ	154	*
	155	* RETURN: Status
	156	*
	157	* DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
	158	*
	159	******************************************************************************/
	160
	161	acpi_status
e3e9b577 RW	162	acpi_set_firmware_waking_vector(acpi_physical_address physical_address,
e3e9b577 RW	163	acpi_physical_address physical_address64)
f06147f9 LZ	164	{
f06147f9 LZ	165
e3e9b577	166	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
f06147f9	167
7484619b	168	if (acpi_gbl_FACS) {
e3e9b577 RW	169	(void)acpi_hw_set_firmware_waking_vector(acpi_gbl_FACS,
	170	physical_address,
	171	physical_address64);
f06147f9 LZ	172	}
	173
	174	return_ACPI_STATUS(AE_OK);
	175	}
	176
2feec47d BM	177	ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
2feec47d BM	178
2feec47d BM	179	/*******************************************************************************
	180	*
	181	* FUNCTION: acpi_enter_sleep_state_s4bios
	182	*
	183	* PARAMETERS: None
	184	*
	185	* RETURN: Status
	186	*
	187	* DESCRIPTION: Perform a S4 bios request.
	188	* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
	189	*
	190	******************************************************************************/
40bce100	191	acpi_status acpi_enter_sleep_state_s4bios(void)
2feec47d BM	192	{
	193	u32 in_value;
	194	acpi_status status;
	195
	196	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
	197
	198	/* Clear the wake status bit (PM1) */
	199
	200	status =
	201	acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
	202	if (ACPI_FAILURE(status)) {
	203	return_ACPI_STATUS(status);
	204	}
	205
	206	status = acpi_hw_clear_acpi_status();
	207	if (ACPI_FAILURE(status)) {
	208	return_ACPI_STATUS(status);
	209	}
	210
	211	/*
18996f2d	212	* 1) Disable all GPEs
2feec47d BM	213	* 2) Enable all wakeup GPEs
	214	*/
	215	status = acpi_hw_disable_all_gpes();
	216	if (ACPI_FAILURE(status)) {
	217	return_ACPI_STATUS(status);
	218	}
	219	acpi_gbl_system_awake_and_running = FALSE;
	220
	221	status = acpi_hw_enable_all_wakeup_gpes();
	222	if (ACPI_FAILURE(status)) {
	223	return_ACPI_STATUS(status);
	224	}
	225
	226	ACPI_FLUSH_CPU_CACHE();
	227
	228	status = acpi_hw_write_port(acpi_gbl_FADT.smi_command,
ba494bee	229	(u32)acpi_gbl_FADT.s4_bios_request, 8);
2feec47d BM	230
2feec47d BM	231	do {
c41679a4	232	acpi_os_stall(ACPI_USEC_PER_MSEC);
2feec47d BM	233	status =
	234	acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
	235	if (ACPI_FAILURE(status)) {
	236	return_ACPI_STATUS(status);
	237	}
1fad8738	238
2feec47d BM	239	} while (!in_value);
	240
	241	return_ACPI_STATUS(AE_OK);
	242	}
	243
	244	ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
33620c54	245	#endif /* !ACPI_REDUCED_HARDWARE */
72a8887a BM	246	/*******************************************************************************
	247	*
	248	* FUNCTION: acpi_hw_sleep_dispatch
	249	*
	250	* PARAMETERS: sleep_state - Which sleep state to enter/exit
	251	* function_id - Sleep, wake_prep, or Wake
	252	*
	253	* RETURN: Status from the invoked sleep handling function.
	254	*
	255	* DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
	256	* function.
	257	*
	258	******************************************************************************/
1f86e8c1	259	static acpi_status acpi_hw_sleep_dispatch(u8 sleep_state, u32 function_id)
72a8887a BM	260	{
	261	acpi_status status;
	262	struct acpi_sleep_functions *sleep_functions =
	263	&acpi_sleep_dispatch[function_id];
	264
	265	#if (!ACPI_REDUCED_HARDWARE)
72a8887a BM	266	/*
72a8887a BM	267	* If the Hardware Reduced flag is set (from the FADT), we must
7cec7048 LZ	268	* use the extended sleep registers (FADT). Note: As per the ACPI
	269	* specification, these extended registers are to be used for HW-reduced
	270	* platforms only. They are not general-purpose replacements for the
	271	* legacy PM register sleep support.
72a8887a	272	*/
7cec7048	273	if (acpi_gbl_reduced_hardware) {
3f6f49c7	274	status = sleep_functions->extended_function(sleep_state);
72a8887a BM	275	} else {
	276	/* Legacy sleep */
	277
3f6f49c7	278	status = sleep_functions->legacy_function(sleep_state);
72a8887a BM	279	}
	280
	281	return (status);
	282
	283	#else
	284	/*
	285	* For the case where reduced-hardware-only code is being generated,
	286	* we know that only the extended sleep registers are available
	287	*/
3f6f49c7	288	status = sleep_functions->extended_function(sleep_state);
72a8887a BM	289	return (status);
	290
	291	#endif /* !ACPI_REDUCED_HARDWARE */
	292	}
	293
2feec47d BM	294	/*******************************************************************************
	295	*
	296	* FUNCTION: acpi_enter_sleep_state_prep
	297	*
	298	* PARAMETERS: sleep_state - Which sleep state to enter
	299	*
	300	* RETURN: Status
	301	*
72a8887a	302	* DESCRIPTION: Prepare to enter a system sleep state.
2feec47d BM	303	* This function must execute with interrupts enabled.
	304	* We break sleeping into 2 stages so that OSPM can handle
	305	* various OS-specific tasks between the two steps.
	306	*
	307	******************************************************************************/
72a8887a	308
2feec47d BM	309	acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
	310	{
	311	acpi_status status;
	312	struct acpi_object_list arg_list;
	313	union acpi_object arg;
	314	u32 sst_value;
	315
	316	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
	317
2feec47d BM	318	status = acpi_get_sleep_type_data(sleep_state,
	319	&acpi_gbl_sleep_type_a,
	320	&acpi_gbl_sleep_type_b);
	321	if (ACPI_FAILURE(status)) {
	322	return_ACPI_STATUS(status);
	323	}
	324
	325	/* Execute the _PTS method (Prepare To Sleep) */
	326
	327	arg_list.count = 1;
	328	arg_list.pointer = &arg;
	329	arg.type = ACPI_TYPE_INTEGER;
	330	arg.integer.value = sleep_state;
	331
4efeeecd BM	332	status =
4efeeecd BM	333	acpi_evaluate_object(NULL, METHOD_PATHNAME__PTS, &arg_list, NULL);
2feec47d BM	334	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
	335	return_ACPI_STATUS(status);
	336	}
	337
	338	/* Setup the argument to the _SST method (System STatus) */
	339
	340	switch (sleep_state) {
	341	case ACPI_STATE_S0:
1d1ea1b7	342
2feec47d BM	343	sst_value = ACPI_SST_WORKING;
	344	break;
	345
	346	case ACPI_STATE_S1:
	347	case ACPI_STATE_S2:
	348	case ACPI_STATE_S3:
1d1ea1b7	349
2feec47d BM	350	sst_value = ACPI_SST_SLEEPING;
	351	break;
	352
	353	case ACPI_STATE_S4:
1d1ea1b7	354
2feec47d BM	355	sst_value = ACPI_SST_SLEEP_CONTEXT;
	356	break;
	357
	358	default:
1d1ea1b7	359
2feec47d BM	360	sst_value = ACPI_SST_INDICATOR_OFF; /* Default is off */
	361	break;
	362	}
	363
	364	/*
	365	* Set the system indicators to show the desired sleep state.
	366	* _SST is an optional method (return no error if not found)
	367	*/
4efeeecd	368	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, sst_value);
2feec47d BM	369	return_ACPI_STATUS(AE_OK);
	370	}
	371
	372	ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
	373
	374	/*******************************************************************************
	375	*
	376	* FUNCTION: acpi_enter_sleep_state
	377	*
	378	* PARAMETERS: sleep_state - Which sleep state to enter
	379	*
	380	* RETURN: Status
	381	*
75c8044f	382	* DESCRIPTION: Enter a system sleep state
2feec47d BM	383	* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
	384	*
	385	******************************************************************************/
40bce100	386	acpi_status acpi_enter_sleep_state(u8 sleep_state)
2feec47d BM	387	{
	388	acpi_status status;
	389
	390	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
	391
	392	if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) \|\|
	393	(acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
	394	ACPI_ERROR((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
	395	acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
	396	return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
	397	}
33620c54	398
1f86e8c1	399	status = acpi_hw_sleep_dispatch(sleep_state, ACPI_SLEEP_FUNCTION_ID);
2feec47d BM	400	return_ACPI_STATUS(status);
	401	}
	402
	403	ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
	404
	405	/*******************************************************************************
	406	*
	407	* FUNCTION: acpi_leave_sleep_state_prep
	408	*
	409	* PARAMETERS: sleep_state - Which sleep state we are exiting
	410	*
	411	* RETURN: Status
	412	*
	413	* DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
75c8044f LZ	414	* sleep. Called with interrupts DISABLED.
	415	* We break wake/resume into 2 stages so that OSPM can handle
	416	* various OS-specific tasks between the two steps.
2feec47d BM	417	*
2feec47d BM	418	******************************************************************************/
3f6f49c7	419	acpi_status acpi_leave_sleep_state_prep(u8 sleep_state)
2feec47d BM	420	{
	421	acpi_status status;
	422
72a8887a	423	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
2feec47d	424
8a73b17e	425	status =
1f86e8c1	426	acpi_hw_sleep_dispatch(sleep_state, ACPI_WAKE_PREP_FUNCTION_ID);
2feec47d BM	427	return_ACPI_STATUS(status);
	428	}
	429
	430	ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state_prep)
	431
	432	/*******************************************************************************
	433	*
	434	* FUNCTION: acpi_leave_sleep_state
	435	*
72a8887a	436	* PARAMETERS: sleep_state - Which sleep state we are exiting
2feec47d BM	437	*
	438	* RETURN: Status
	439	*
	440	* DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
	441	* Called with interrupts ENABLED.
	442	*
	443	******************************************************************************/
	444	acpi_status acpi_leave_sleep_state(u8 sleep_state)
	445	{
	446	acpi_status status;
	447
	448	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
	449
3f6f49c7	450	status = acpi_hw_sleep_dispatch(sleep_state, ACPI_WAKE_FUNCTION_ID);
2feec47d BM	451	return_ACPI_STATUS(status);
	452	}
	453
	454	ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)