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

/******************************************************************************
 *
 * Name: hwesleep.c - ACPI Hardware Sleep/Wake Support functions for the
 *                    extended FADT-V5 sleep registers.
 *
 *****************************************************************************/

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

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

#define _COMPONENT          ACPI_HARDWARE
ACPI_MODULE_NAME("hwesleep")

/*******************************************************************************
 *
 * FUNCTION:    acpi_hw_execute_sleep_method
 *
 * PARAMETERS:  method_pathname     - Pathname of method to execute
 *              integer_argument    - Argument to pass to the method
 *
 * RETURN:      None
 *
 * DESCRIPTION: Execute a sleep/wake related method with one integer argument
 *              and no return value.
 *
 ******************************************************************************/
void acpi_hw_execute_sleep_method(char *method_pathname, u32 integer_argument)
{
	struct acpi_object_list arg_list;
	union acpi_object arg;
	acpi_status status;

	ACPI_FUNCTION_TRACE(hw_execute_sleep_method);

	/* One argument, integer_argument; No return value expected */

	arg_list.count = 1;
	arg_list.pointer = &arg;
	arg.type = ACPI_TYPE_INTEGER;
	arg.integer.value = (u64)integer_argument;

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

	return_VOID;
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_hw_extended_sleep
 *
 * PARAMETERS:  sleep_state         - Which sleep state to enter
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Enter a system sleep state via the extended FADT sleep
 *              registers (V5 FADT).
 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
 *
 ******************************************************************************/

acpi_status acpi_hw_extended_sleep(u8 sleep_state)
{
	acpi_status status;
	u8 sleep_type_value;
	u64 sleep_status;

	ACPI_FUNCTION_TRACE(hw_extended_sleep);

	/* Extended sleep registers must be valid */

	if (!acpi_gbl_FADT.sleep_control.address ||
	    !acpi_gbl_FADT.sleep_status.address) {
		return_ACPI_STATUS(AE_NOT_EXIST);
	}

	/* Clear wake status (WAK_STS) */

	status = acpi_write((u64)ACPI_X_WAKE_STATUS,
			    &acpi_gbl_FADT.sleep_status);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	acpi_gbl_system_awake_and_running = FALSE;

	/* Flush caches, as per ACPI specification */

	ACPI_FLUSH_CPU_CACHE();

	status = acpi_os_prepare_extended_sleep(sleep_state,
						acpi_gbl_sleep_type_a,
						acpi_gbl_sleep_type_b);
	if (ACPI_SKIP(status))
		return_ACPI_STATUS(AE_OK);
	if (ACPI_FAILURE(status))
		return_ACPI_STATUS(status);

	/*
	 * Set the SLP_TYP and SLP_EN bits.
	 *
	 * Note: We only use the first value returned by the \_Sx method
	 * (acpi_gbl_sleep_type_a) - As per ACPI specification.
	 */
	ACPI_DEBUG_PRINT((ACPI_DB_INIT,
			  "Entering sleep state [S%u]\n", sleep_state));

	sleep_type_value =
	    ((acpi_gbl_sleep_type_a << ACPI_X_SLEEP_TYPE_POSITION) &
	     ACPI_X_SLEEP_TYPE_MASK);

	status = acpi_write((u64)(sleep_type_value | ACPI_X_SLEEP_ENABLE),
			    &acpi_gbl_FADT.sleep_control);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Wait for transition back to Working State */

	do {
		status = acpi_read(&sleep_status, &acpi_gbl_FADT.sleep_status);
		if (ACPI_FAILURE(status)) {
			return_ACPI_STATUS(status);
		}

	} while (!(((u8)sleep_status) & ACPI_X_WAKE_STATUS));

	return_ACPI_STATUS(AE_OK);
}

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

acpi_status acpi_hw_extended_wake_prep(u8 sleep_state)
{
	acpi_status status;
	u8 sleep_type_value;

	ACPI_FUNCTION_TRACE(hw_extended_wake_prep);

	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_value =
		    ((acpi_gbl_sleep_type_a << ACPI_X_SLEEP_TYPE_POSITION) &
		     ACPI_X_SLEEP_TYPE_MASK);

		(void)acpi_write((u64)(sleep_type_value | ACPI_X_SLEEP_ENABLE),
				 &acpi_gbl_FADT.sleep_control);
	}

	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_hw_extended_wake
 *
 * 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_hw_extended_wake(u8 sleep_state)
{
	ACPI_FUNCTION_TRACE(hw_extended_wake);

	/* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */

	acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;

	/* Execute the wake methods */

	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WAKING);
	acpi_hw_execute_sleep_method(METHOD_PATHNAME__WAK, sleep_state);

	/*
	 * Some BIOS code assumes that WAK_STS will be cleared on resume
	 * and use it to determine whether the system is rebooting or
	 * resuming. Clear WAK_STS for compatibility.
	 */
	(void)acpi_write((u64)ACPI_X_WAKE_STATUS, &acpi_gbl_FADT.sleep_status);
	acpi_gbl_system_awake_and_running = TRUE;

	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WORKING);
	return_ACPI_STATUS(AE_OK);
}
Commit	Line	Data
70958576 BM	1	/******************************************************************************
	2	*
	3	* Name: hwesleep.c - ACPI Hardware Sleep/Wake Support functions for the
	4	* extended FADT-V5 sleep registers.
	5	*
	6	*****************************************************************************/
	7
	8	/*
c8100dc4	9	* Copyright (C) 2000 - 2016, Intel Corp.
70958576 BM	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 <acpi/acpi.h>
d6b47b12	46	#include <linux/acpi.h>
70958576	47	#include "accommon.h"
70958576 BM	48
	49	#define _COMPONENT ACPI_HARDWARE
	50	ACPI_MODULE_NAME("hwesleep")
	51
70958576 BM	52	/*******************************************************************************
	53	*
	54	* FUNCTION: acpi_hw_execute_sleep_method
	55	*
4efeeecd	56	* PARAMETERS: method_pathname - Pathname of method to execute
70958576 BM	57	* integer_argument - Argument to pass to the method
	58	*
	59	* RETURN: None
	60	*
	61	* DESCRIPTION: Execute a sleep/wake related method with one integer argument
	62	* and no return value.
	63	*
	64	******************************************************************************/
4efeeecd	65	void acpi_hw_execute_sleep_method(char *method_pathname, u32 integer_argument)
70958576 BM	66	{
	67	struct acpi_object_list arg_list;
	68	union acpi_object arg;
	69	acpi_status status;
	70
	71	ACPI_FUNCTION_TRACE(hw_execute_sleep_method);
	72
70958576 BM	73	/* One argument, integer_argument; No return value expected */
	74
	75	arg_list.count = 1;
	76	arg_list.pointer = &arg;
	77	arg.type = ACPI_TYPE_INTEGER;
	78	arg.integer.value = (u64)integer_argument;
	79
4efeeecd	80	status = acpi_evaluate_object(NULL, method_pathname, &arg_list, NULL);
70958576 BM	81	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
70958576 BM	82	ACPI_EXCEPTION((AE_INFO, status, "While executing method %s",
4efeeecd	83	method_pathname));
70958576 BM	84	}
	85
	86	return_VOID;
	87	}
	88
	89	/*******************************************************************************
	90	*
	91	* FUNCTION: acpi_hw_extended_sleep
	92	*
	93	* PARAMETERS: sleep_state - Which sleep state to enter
	94	*
	95	* RETURN: Status
	96	*
	97	* DESCRIPTION: Enter a system sleep state via the extended FADT sleep
	98	* registers (V5 FADT).
	99	* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
	100	*
	101	******************************************************************************/
	102
3f6f49c7	103	acpi_status acpi_hw_extended_sleep(u8 sleep_state)
70958576 BM	104	{
	105	acpi_status status;
	106	u8 sleep_type_value;
	107	u64 sleep_status;
	108
	109	ACPI_FUNCTION_TRACE(hw_extended_sleep);
	110
	111	/* Extended sleep registers must be valid */
	112
	113	if (!acpi_gbl_FADT.sleep_control.address \|\|
	114	!acpi_gbl_FADT.sleep_status.address) {
	115	return_ACPI_STATUS(AE_NOT_EXIST);
	116	}
	117
	118	/* Clear wake status (WAK_STS) */
	119
1fad8738 BM	120	status = acpi_write((u64)ACPI_X_WAKE_STATUS,
1fad8738 BM	121	&acpi_gbl_FADT.sleep_status);
70958576 BM	122	if (ACPI_FAILURE(status)) {
	123	return_ACPI_STATUS(status);
	124	}
	125
	126	acpi_gbl_system_awake_and_running = FALSE;
	127
70958576 BM	128	/* Flush caches, as per ACPI specification */
	129
	130	ACPI_FLUSH_CPU_CACHE();
	131
d6b47b12 BG	132	status = acpi_os_prepare_extended_sleep(sleep_state,
	133	acpi_gbl_sleep_type_a,
	134	acpi_gbl_sleep_type_b);
	135	if (ACPI_SKIP(status))
	136	return_ACPI_STATUS(AE_OK);
	137	if (ACPI_FAILURE(status))
	138	return_ACPI_STATUS(status);
	139
70958576 BM	140	/*
	141	* Set the SLP_TYP and SLP_EN bits.
	142	*
	143	* Note: We only use the first value returned by the \_Sx method
	144	* (acpi_gbl_sleep_type_a) - As per ACPI specification.
	145	*/
	146	ACPI_DEBUG_PRINT((ACPI_DB_INIT,
	147	"Entering sleep state [S%u]\n", sleep_state));
	148
	149	sleep_type_value =
	150	((acpi_gbl_sleep_type_a << ACPI_X_SLEEP_TYPE_POSITION) &
	151	ACPI_X_SLEEP_TYPE_MASK);
	152
5134abfc	153	status = acpi_write((u64)(sleep_type_value \| ACPI_X_SLEEP_ENABLE),
70958576 BM	154	&acpi_gbl_FADT.sleep_control);
	155	if (ACPI_FAILURE(status)) {
	156	return_ACPI_STATUS(status);
	157	}
	158
	159	/* Wait for transition back to Working State */
	160
	161	do {
	162	status = acpi_read(&sleep_status, &acpi_gbl_FADT.sleep_status);
	163	if (ACPI_FAILURE(status)) {
	164	return_ACPI_STATUS(status);
	165	}
	166
	167	} while (!(((u8)sleep_status) & ACPI_X_WAKE_STATUS));
	168
	169	return_ACPI_STATUS(AE_OK);
	170	}
	171
	172	/*******************************************************************************
	173	*
	174	* FUNCTION: acpi_hw_extended_wake_prep
	175	*
	176	* PARAMETERS: sleep_state - Which sleep state we just exited
	177	*
	178	* RETURN: Status
	179	*
	180	* DESCRIPTION: Perform first part of OS-independent ACPI cleanup after
	181	* a sleep. Called with interrupts ENABLED.
	182	*
	183	******************************************************************************/
	184
3f6f49c7	185	acpi_status acpi_hw_extended_wake_prep(u8 sleep_state)
70958576 BM	186	{
	187	acpi_status status;
	188	u8 sleep_type_value;
	189
	190	ACPI_FUNCTION_TRACE(hw_extended_wake_prep);
	191
	192	status = acpi_get_sleep_type_data(ACPI_STATE_S0,
	193	&acpi_gbl_sleep_type_a,
	194	&acpi_gbl_sleep_type_b);
	195	if (ACPI_SUCCESS(status)) {
	196	sleep_type_value =
	197	((acpi_gbl_sleep_type_a << ACPI_X_SLEEP_TYPE_POSITION) &
	198	ACPI_X_SLEEP_TYPE_MASK);
	199
5134abfc	200	(void)acpi_write((u64)(sleep_type_value \| ACPI_X_SLEEP_ENABLE),
70958576 BM	201	&acpi_gbl_FADT.sleep_control);
	202	}
	203
70958576 BM	204	return_ACPI_STATUS(AE_OK);
	205	}
	206
	207	/*******************************************************************************
	208	*
	209	* FUNCTION: acpi_hw_extended_wake
	210	*
	211	* PARAMETERS: sleep_state - Which sleep state we just exited
	212	*
	213	* RETURN: Status
	214	*
	215	* DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
	216	* Called with interrupts ENABLED.
	217	*
	218	******************************************************************************/
	219
3f6f49c7	220	acpi_status acpi_hw_extended_wake(u8 sleep_state)
70958576 BM	221	{
	222	ACPI_FUNCTION_TRACE(hw_extended_wake);
	223
	224	/* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
	225
	226	acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
	227
	228	/* Execute the wake methods */
	229
4efeeecd BM	230	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WAKING);
4efeeecd BM	231	acpi_hw_execute_sleep_method(METHOD_PATHNAME__WAK, sleep_state);
70958576 BM	232
	233	/*
	234	* Some BIOS code assumes that WAK_STS will be cleared on resume
	235	* and use it to determine whether the system is rebooting or
	236	* resuming. Clear WAK_STS for compatibility.
	237	*/
5134abfc	238	(void)acpi_write((u64)ACPI_X_WAKE_STATUS, &acpi_gbl_FADT.sleep_status);
70958576 BM	239	acpi_gbl_system_awake_and_running = TRUE;
70958576 BM	240
4efeeecd	241	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WORKING);
70958576 BM	242	return_ACPI_STATUS(AE_OK);
70958576 BM	243	}