Linux Audio

Check our new training course

Loading...
v3.5.6
 
  1/******************************************************************************
  2 *
  3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
  4 *
 
 
  5 *****************************************************************************/
  6
  7/*
  8 * Copyright (C) 2000 - 2012, Intel Corp.
  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
 44#include <acpi/acpi.h>
 45#include "accommon.h"
 46#include <linux/module.h>
 47
 48#define _COMPONENT          ACPI_HARDWARE
 49ACPI_MODULE_NAME("hwxfsleep")
 50
 51/* Local prototypes */
 
 52static acpi_status
 53acpi_hw_sleep_dispatch(u8 sleep_state, u8 flags, u32 function_id);
 54
 55/*
 56 * Dispatch table used to efficiently branch to the various sleep
 57 * functions.
 58 */
 59#define ACPI_SLEEP_FUNCTION_ID         0
 60#define ACPI_WAKE_PREP_FUNCTION_ID     1
 61#define ACPI_WAKE_FUNCTION_ID          2
 62
 63/* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
 64
 65static struct acpi_sleep_functions acpi_sleep_dispatch[] = {
 66	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_sleep),
 67	 acpi_hw_extended_sleep},
 68	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake_prep),
 69	 acpi_hw_extended_wake_prep},
 70	{ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake), acpi_hw_extended_wake}
 71};
 72
 73/*
 74 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
 75 *      acpi_set_firmware_waking_vector
 76 *      acpi_set_firmware_waking_vector64
 77 *      acpi_enter_sleep_state_s4bios
 78 */
 79
 80#if (!ACPI_REDUCED_HARDWARE)
 81/*******************************************************************************
 82 *
 83 * FUNCTION:    acpi_set_firmware_waking_vector
 84 *
 85 * PARAMETERS:  physical_address    - 32-bit physical address of ACPI real mode
 86 *                                    entry point.
 
 
 
 87 *
 88 * RETURN:      Status
 89 *
 90 * DESCRIPTION: Sets the 32-bit firmware_waking_vector field of the FACS
 91 *
 92 ******************************************************************************/
 93
 94acpi_status acpi_set_firmware_waking_vector(u32 physical_address)
 
 
 
 95{
 96	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
 97
 98
 99	/*
100	 * According to the ACPI specification 2.0c and later, the 64-bit
101	 * waking vector should be cleared and the 32-bit waking vector should
102	 * be used, unless we want the wake-up code to be called by the BIOS in
103	 * Protected Mode.  Some systems (for example HP dv5-1004nr) are known
104	 * to fail to resume if the 64-bit vector is used.
105	 */
106
107	/* Set the 32-bit vector */
108
109	acpi_gbl_FACS->firmware_waking_vector = physical_address;
 
 
 
110
111	/* Clear the 64-bit vector if it exists */
112
113	if ((acpi_gbl_FACS->length > 32) && (acpi_gbl_FACS->version >= 1)) {
114		acpi_gbl_FACS->xfirmware_waking_vector = 0;
 
 
 
 
115	}
116
117	return_ACPI_STATUS(AE_OK);
118}
119
120ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
121
122#if ACPI_MACHINE_WIDTH == 64
123/*******************************************************************************
124 *
125 * FUNCTION:    acpi_set_firmware_waking_vector64
126 *
127 * PARAMETERS:  physical_address    - 64-bit physical address of ACPI protected
128 *                                    mode entry point.
 
 
129 *
130 * RETURN:      Status
131 *
132 * DESCRIPTION: Sets the 64-bit X_firmware_waking_vector field of the FACS, if
133 *              it exists in the table. This function is intended for use with
134 *              64-bit host operating systems.
135 *
136 ******************************************************************************/
137acpi_status acpi_set_firmware_waking_vector64(u64 physical_address)
138{
139	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector64);
140
 
 
 
 
141
142	/* Determine if the 64-bit vector actually exists */
143
144	if ((acpi_gbl_FACS->length <= 32) || (acpi_gbl_FACS->version < 1)) {
145		return_ACPI_STATUS(AE_NOT_EXIST);
 
 
146	}
147
148	/* Clear 32-bit vector, set the 64-bit X_ vector */
149
150	acpi_gbl_FACS->firmware_waking_vector = 0;
151	acpi_gbl_FACS->xfirmware_waking_vector = physical_address;
152	return_ACPI_STATUS(AE_OK);
153}
154
155ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector64)
156#endif
157
158/*******************************************************************************
159 *
160 * FUNCTION:    acpi_enter_sleep_state_s4bios
161 *
162 * PARAMETERS:  None
163 *
164 * RETURN:      Status
165 *
166 * DESCRIPTION: Perform a S4 bios request.
167 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
168 *
169 ******************************************************************************/
170acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
171{
172	u32 in_value;
173	acpi_status status;
174
175	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
176
177	/* Clear the wake status bit (PM1) */
178
179	status =
180	    acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
181	if (ACPI_FAILURE(status)) {
182		return_ACPI_STATUS(status);
183	}
184
185	status = acpi_hw_clear_acpi_status();
186	if (ACPI_FAILURE(status)) {
187		return_ACPI_STATUS(status);
188	}
189
190	/*
191	 * 1) Disable/Clear all GPEs
192	 * 2) Enable all wakeup GPEs
193	 */
194	status = acpi_hw_disable_all_gpes();
195	if (ACPI_FAILURE(status)) {
196		return_ACPI_STATUS(status);
197	}
198	acpi_gbl_system_awake_and_running = FALSE;
199
200	status = acpi_hw_enable_all_wakeup_gpes();
201	if (ACPI_FAILURE(status)) {
202		return_ACPI_STATUS(status);
203	}
204
205	ACPI_FLUSH_CPU_CACHE();
206
207	status = acpi_hw_write_port(acpi_gbl_FADT.smi_command,
208				    (u32)acpi_gbl_FADT.S4bios_request, 8);
 
 
 
209
210	do {
211		acpi_os_stall(1000);
212		status =
213		    acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
214		if (ACPI_FAILURE(status)) {
215			return_ACPI_STATUS(status);
216		}
 
217	} while (!in_value);
218
219	return_ACPI_STATUS(AE_OK);
220}
221
222ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
223#endif				/* !ACPI_REDUCED_HARDWARE */
224/*******************************************************************************
225 *
226 * FUNCTION:    acpi_hw_sleep_dispatch
227 *
228 * PARAMETERS:  sleep_state         - Which sleep state to enter/exit
229 *              function_id         - Sleep, wake_prep, or Wake
230 *
231 * RETURN:      Status from the invoked sleep handling function.
232 *
233 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
234 *              function.
235 *
236 ******************************************************************************/
237static acpi_status
238acpi_hw_sleep_dispatch(u8 sleep_state, u8 flags, u32 function_id)
239{
240	acpi_status status;
241	struct acpi_sleep_functions *sleep_functions =
242	    &acpi_sleep_dispatch[function_id];
243
244#if (!ACPI_REDUCED_HARDWARE)
245
246	/*
247	 * If the Hardware Reduced flag is set (from the FADT), we must
248	 * use the extended sleep registers
249	 */
250	if (acpi_gbl_reduced_hardware || acpi_gbl_FADT.sleep_control.address) {
251		status = sleep_functions->extended_function(sleep_state, flags);
252	} else {
253		/* Legacy sleep */
254
255		status = sleep_functions->legacy_function(sleep_state, flags);
256	}
257
258	return (status);
259
260#else
261	/*
262	 * For the case where reduced-hardware-only code is being generated,
263	 * we know that only the extended sleep registers are available
264	 */
265	status = sleep_functions->extended_function(sleep_state, flags);
266	return (status);
267
268#endif				/* !ACPI_REDUCED_HARDWARE */
269}
270
271/*******************************************************************************
272 *
273 * FUNCTION:    acpi_enter_sleep_state_prep
274 *
275 * PARAMETERS:  sleep_state         - Which sleep state to enter
276 *
277 * RETURN:      Status
278 *
279 * DESCRIPTION: Prepare to enter a system sleep state.
280 *              This function must execute with interrupts enabled.
281 *              We break sleeping into 2 stages so that OSPM can handle
282 *              various OS-specific tasks between the two steps.
283 *
284 ******************************************************************************/
285
286acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
287{
288	acpi_status status;
289	struct acpi_object_list arg_list;
290	union acpi_object arg;
291	u32 sst_value;
292
293	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
294
295	status = acpi_get_sleep_type_data(sleep_state,
296					  &acpi_gbl_sleep_type_a,
297					  &acpi_gbl_sleep_type_b);
298	if (ACPI_FAILURE(status)) {
299		return_ACPI_STATUS(status);
300	}
301
 
 
 
 
 
 
 
302	/* Execute the _PTS method (Prepare To Sleep) */
303
304	arg_list.count = 1;
305	arg_list.pointer = &arg;
306	arg.type = ACPI_TYPE_INTEGER;
307	arg.integer.value = sleep_state;
308
309	status =
310	    acpi_evaluate_object(NULL, METHOD_PATHNAME__PTS, &arg_list, NULL);
311	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
312		return_ACPI_STATUS(status);
313	}
314
315	/* Setup the argument to the _SST method (System STatus) */
316
317	switch (sleep_state) {
318	case ACPI_STATE_S0:
 
319		sst_value = ACPI_SST_WORKING;
320		break;
321
322	case ACPI_STATE_S1:
323	case ACPI_STATE_S2:
324	case ACPI_STATE_S3:
 
325		sst_value = ACPI_SST_SLEEPING;
326		break;
327
328	case ACPI_STATE_S4:
 
329		sst_value = ACPI_SST_SLEEP_CONTEXT;
330		break;
331
332	default:
 
333		sst_value = ACPI_SST_INDICATOR_OFF;	/* Default is off */
334		break;
335	}
336
337	/*
338	 * Set the system indicators to show the desired sleep state.
339	 * _SST is an optional method (return no error if not found)
340	 */
341	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, sst_value);
342	return_ACPI_STATUS(AE_OK);
343}
344
345ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
346
347/*******************************************************************************
348 *
349 * FUNCTION:    acpi_enter_sleep_state
350 *
351 * PARAMETERS:  sleep_state         - Which sleep state to enter
352 *              Flags               - ACPI_EXECUTE_GTS to run optional method
353 *
354 * RETURN:      Status
355 *
356 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
357 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
358 *
359 ******************************************************************************/
360acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state, u8 flags)
361{
362	acpi_status status;
363
364	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
365
366	if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
367	    (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
368		ACPI_ERROR((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
369			    acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
370		return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
371	}
372
373	status =
374	    acpi_hw_sleep_dispatch(sleep_state, flags, ACPI_SLEEP_FUNCTION_ID);
 
 
 
 
375	return_ACPI_STATUS(status);
376}
377
378ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
379
380/*******************************************************************************
381 *
382 * FUNCTION:    acpi_leave_sleep_state_prep
383 *
384 * PARAMETERS:  sleep_state         - Which sleep state we are exiting
385 *              Flags               - ACPI_EXECUTE_BFS to run optional method
386 *
387 * RETURN:      Status
388 *
389 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
390 *              sleep.
391 *              Called with interrupts DISABLED.
 
392 *
393 ******************************************************************************/
394acpi_status acpi_leave_sleep_state_prep(u8 sleep_state, u8 flags)
395{
396	acpi_status status;
397
398	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
399
400	status =
401	    acpi_hw_sleep_dispatch(sleep_state, flags,
402				   ACPI_WAKE_PREP_FUNCTION_ID);
 
 
 
403	return_ACPI_STATUS(status);
404}
405
406ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state_prep)
407
408/*******************************************************************************
409 *
410 * FUNCTION:    acpi_leave_sleep_state
411 *
412 * PARAMETERS:  sleep_state         - Which sleep state we are exiting
413 *
414 * RETURN:      Status
415 *
416 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
417 *              Called with interrupts ENABLED.
418 *
419 ******************************************************************************/
420acpi_status acpi_leave_sleep_state(u8 sleep_state)
421{
422	acpi_status status;
423
424	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
425
426
427	status = acpi_hw_sleep_dispatch(sleep_state, 0, ACPI_WAKE_FUNCTION_ID);
 
 
 
 
428	return_ACPI_STATUS(status);
429}
430
431ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)
v6.9.4
  1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
  2/******************************************************************************
  3 *
  4 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
  5 *
  6 * Copyright (C) 2000 - 2023, Intel Corp.
  7 *
  8 *****************************************************************************/
  9
 10#define EXPORT_ACPI_INTERFACES
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 11
 12#include <acpi/acpi.h>
 13#include "accommon.h"
 
 14
 15#define _COMPONENT          ACPI_HARDWARE
 16ACPI_MODULE_NAME("hwxfsleep")
 17
 18/* Local prototypes */
 19#if (!ACPI_REDUCED_HARDWARE)
 20static acpi_status
 21acpi_hw_set_firmware_waking_vector(struct acpi_table_facs *facs,
 22				   acpi_physical_address physical_address,
 23				   acpi_physical_address physical_address64);
 24#endif
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 25
 26/*
 27 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
 28 *      acpi_set_firmware_waking_vector
 
 29 *      acpi_enter_sleep_state_s4bios
 30 */
 31
 32#if (!ACPI_REDUCED_HARDWARE)
 33/*******************************************************************************
 34 *
 35 * FUNCTION:    acpi_hw_set_firmware_waking_vector
 36 *
 37 * PARAMETERS:  facs                - Pointer to FACS table
 38 *              physical_address    - 32-bit physical address of ACPI real mode
 39 *                                    entry point
 40 *              physical_address64  - 64-bit physical address of ACPI protected
 41 *                                    mode entry point
 42 *
 43 * RETURN:      Status
 44 *
 45 * DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
 46 *
 47 ******************************************************************************/
 48
 49static acpi_status
 50acpi_hw_set_firmware_waking_vector(struct acpi_table_facs *facs,
 51				   acpi_physical_address physical_address,
 52				   acpi_physical_address physical_address64)
 53{
 54	ACPI_FUNCTION_TRACE(acpi_hw_set_firmware_waking_vector);
 55
 56
 57	/*
 58	 * According to the ACPI specification 2.0c and later, the 64-bit
 59	 * waking vector should be cleared and the 32-bit waking vector should
 60	 * be used, unless we want the wake-up code to be called by the BIOS in
 61	 * Protected Mode.  Some systems (for example HP dv5-1004nr) are known
 62	 * to fail to resume if the 64-bit vector is used.
 63	 */
 64
 65	/* Set the 32-bit vector */
 66
 67	facs->firmware_waking_vector = (u32)physical_address;
 68
 69	if (facs->length > 32) {
 70		if (facs->version >= 1) {
 71
 72			/* Set the 64-bit vector */
 73
 74			facs->xfirmware_waking_vector = physical_address64;
 75		} else {
 76			/* Clear the 64-bit vector if it exists */
 77
 78			facs->xfirmware_waking_vector = 0;
 79		}
 80	}
 81
 82	return_ACPI_STATUS(AE_OK);
 83}
 84
 
 
 
 85/*******************************************************************************
 86 *
 87 * FUNCTION:    acpi_set_firmware_waking_vector
 88 *
 89 * PARAMETERS:  physical_address    - 32-bit physical address of ACPI real mode
 90 *                                    entry point
 91 *              physical_address64  - 64-bit physical address of ACPI protected
 92 *                                    mode entry point
 93 *
 94 * RETURN:      Status
 95 *
 96 * DESCRIPTION: Sets the firmware_waking_vector fields of the FACS
 
 
 97 *
 98 ******************************************************************************/
 
 
 
 99
100acpi_status
101acpi_set_firmware_waking_vector(acpi_physical_address physical_address,
102				acpi_physical_address physical_address64)
103{
104
105	ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
106
107	if (acpi_gbl_FACS) {
108		(void)acpi_hw_set_firmware_waking_vector(acpi_gbl_FACS,
109							 physical_address,
110							 physical_address64);
111	}
112
 
 
 
 
113	return_ACPI_STATUS(AE_OK);
114}
115
116ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
 
117
118/*******************************************************************************
119 *
120 * FUNCTION:    acpi_enter_sleep_state_s4bios
121 *
122 * PARAMETERS:  None
123 *
124 * RETURN:      Status
125 *
126 * DESCRIPTION: Perform a S4 bios request.
127 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
128 *
129 ******************************************************************************/
130acpi_status acpi_enter_sleep_state_s4bios(void)
131{
132	u32 in_value;
133	acpi_status status;
134
135	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
136
137	/* Clear the wake status bit (PM1) */
138
139	status =
140	    acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
141	if (ACPI_FAILURE(status)) {
142		return_ACPI_STATUS(status);
143	}
144
145	status = acpi_hw_clear_acpi_status();
146	if (ACPI_FAILURE(status)) {
147		return_ACPI_STATUS(status);
148	}
149
150	/*
151	 * 1) Disable all GPEs
152	 * 2) Enable all wakeup GPEs
153	 */
154	status = acpi_hw_disable_all_gpes();
155	if (ACPI_FAILURE(status)) {
156		return_ACPI_STATUS(status);
157	}
158	acpi_gbl_system_awake_and_running = FALSE;
159
160	status = acpi_hw_enable_all_wakeup_gpes();
161	if (ACPI_FAILURE(status)) {
162		return_ACPI_STATUS(status);
163	}
164
 
 
165	status = acpi_hw_write_port(acpi_gbl_FADT.smi_command,
166				    (u32)acpi_gbl_FADT.s4_bios_request, 8);
167	if (ACPI_FAILURE(status)) {
168		return_ACPI_STATUS(status);
169	}
170
171	do {
172		acpi_os_stall(ACPI_USEC_PER_MSEC);
173		status =
174		    acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
175		if (ACPI_FAILURE(status)) {
176			return_ACPI_STATUS(status);
177		}
178
179	} while (!in_value);
180
181	return_ACPI_STATUS(AE_OK);
182}
183
184ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
185#endif				/* !ACPI_REDUCED_HARDWARE */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
186
187/*******************************************************************************
188 *
189 * FUNCTION:    acpi_enter_sleep_state_prep
190 *
191 * PARAMETERS:  sleep_state         - Which sleep state to enter
192 *
193 * RETURN:      Status
194 *
195 * DESCRIPTION: Prepare to enter a system sleep state.
196 *              This function must execute with interrupts enabled.
197 *              We break sleeping into 2 stages so that OSPM can handle
198 *              various OS-specific tasks between the two steps.
199 *
200 ******************************************************************************/
201
202acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
203{
204	acpi_status status;
205	struct acpi_object_list arg_list;
206	union acpi_object arg;
207	u32 sst_value;
208
209	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
210
211	status = acpi_get_sleep_type_data(sleep_state,
212					  &acpi_gbl_sleep_type_a,
213					  &acpi_gbl_sleep_type_b);
214	if (ACPI_FAILURE(status)) {
215		return_ACPI_STATUS(status);
216	}
217
218	status = acpi_get_sleep_type_data(ACPI_STATE_S0,
219					  &acpi_gbl_sleep_type_a_s0,
220					  &acpi_gbl_sleep_type_b_s0);
221	if (ACPI_FAILURE(status)) {
222		acpi_gbl_sleep_type_a_s0 = ACPI_SLEEP_TYPE_INVALID;
223	}
224
225	/* Execute the _PTS method (Prepare To Sleep) */
226
227	arg_list.count = 1;
228	arg_list.pointer = &arg;
229	arg.type = ACPI_TYPE_INTEGER;
230	arg.integer.value = sleep_state;
231
232	status =
233	    acpi_evaluate_object(NULL, METHOD_PATHNAME__PTS, &arg_list, NULL);
234	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
235		return_ACPI_STATUS(status);
236	}
237
238	/* Setup the argument to the _SST method (System STatus) */
239
240	switch (sleep_state) {
241	case ACPI_STATE_S0:
242
243		sst_value = ACPI_SST_WORKING;
244		break;
245
246	case ACPI_STATE_S1:
247	case ACPI_STATE_S2:
248	case ACPI_STATE_S3:
249
250		sst_value = ACPI_SST_SLEEPING;
251		break;
252
253	case ACPI_STATE_S4:
254
255		sst_value = ACPI_SST_SLEEP_CONTEXT;
256		break;
257
258	default:
259
260		sst_value = ACPI_SST_INDICATOR_OFF;	/* Default is off */
261		break;
262	}
263
264	/*
265	 * Set the system indicators to show the desired sleep state.
266	 * _SST is an optional method (return no error if not found)
267	 */
268	acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, sst_value);
269	return_ACPI_STATUS(AE_OK);
270}
271
272ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
273
274/*******************************************************************************
275 *
276 * FUNCTION:    acpi_enter_sleep_state
277 *
278 * PARAMETERS:  sleep_state         - Which sleep state to enter
 
279 *
280 * RETURN:      Status
281 *
282 * DESCRIPTION: Enter a system sleep state
283 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
284 *
285 ******************************************************************************/
286acpi_status acpi_enter_sleep_state(u8 sleep_state)
287{
288	acpi_status status;
289
290	ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
291
292	if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
293	    (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
294		ACPI_ERROR((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
295			    acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
296		return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
297	}
298
299#if !ACPI_REDUCED_HARDWARE
300	if (!acpi_gbl_reduced_hardware)
301		status = acpi_hw_legacy_sleep(sleep_state);
302	else
303#endif
304		status = acpi_hw_extended_sleep(sleep_state);
305	return_ACPI_STATUS(status);
306}
307
308ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
309
310/*******************************************************************************
311 *
312 * FUNCTION:    acpi_leave_sleep_state_prep
313 *
314 * PARAMETERS:  sleep_state         - Which sleep state we are exiting
 
315 *
316 * RETURN:      Status
317 *
318 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
319 *              sleep. Called with interrupts DISABLED.
320 *              We break wake/resume into 2 stages so that OSPM can handle
321 *              various OS-specific tasks between the two steps.
322 *
323 ******************************************************************************/
324acpi_status acpi_leave_sleep_state_prep(u8 sleep_state)
325{
326	acpi_status status;
327
328	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
329
330#if !ACPI_REDUCED_HARDWARE
331	if (!acpi_gbl_reduced_hardware)
332		status = acpi_hw_legacy_wake_prep(sleep_state);
333	else
334#endif
335		status = acpi_hw_extended_wake_prep(sleep_state);
336	return_ACPI_STATUS(status);
337}
338
339ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state_prep)
340
341/*******************************************************************************
342 *
343 * FUNCTION:    acpi_leave_sleep_state
344 *
345 * PARAMETERS:  sleep_state         - Which sleep state we are exiting
346 *
347 * RETURN:      Status
348 *
349 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
350 *              Called with interrupts ENABLED.
351 *
352 ******************************************************************************/
353acpi_status acpi_leave_sleep_state(u8 sleep_state)
354{
355	acpi_status status;
356
357	ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
358
359#if !ACPI_REDUCED_HARDWARE
360	if (!acpi_gbl_reduced_hardware)
361		status = acpi_hw_legacy_wake(sleep_state);
362	else
363#endif
364		status = acpi_hw_extended_wake(sleep_state);
365	return_ACPI_STATUS(status);
366}
367
368ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)