1 /******************************************************************************
3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
47 #define _COMPONENT ACPI_HARDWARE
48 ACPI_MODULE_NAME ("hwxfsleep")
50 /* Local prototypes */
59 * Dispatch table used to efficiently branch to the various sleep
62 #define ACPI_SLEEP_FUNCTION_ID 0
63 #define ACPI_WAKE_PREP_FUNCTION_ID 1
64 #define ACPI_WAKE_FUNCTION_ID 2
66 /* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
68 static ACPI_SLEEP_FUNCTIONS AcpiSleepDispatch[] =
70 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep), AcpiHwExtendedSleep},
71 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep), AcpiHwExtendedWakePrep},
72 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake), AcpiHwExtendedWake}
77 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
78 * AcpiSetFirmwareWakingVector
79 * AcpiSetFirmwareWakingVector64
80 * AcpiEnterSleepStateS4bios
83 #if (!ACPI_REDUCED_HARDWARE)
84 /*******************************************************************************
86 * FUNCTION: AcpiSetFirmwareWakingVector
88 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
93 * DESCRIPTION: Sets the 32-bit FirmwareWakingVector field of the FACS
95 ******************************************************************************/
98 AcpiSetFirmwareWakingVector (
99 UINT32 PhysicalAddress)
101 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
104 /* Set the 32-bit vector */
106 AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress;
108 /* Clear the 64-bit vector if it exists */
110 if ((AcpiGbl_FACS->Length > 32) && (AcpiGbl_FACS->Version >= 1))
112 AcpiGbl_FACS->XFirmwareWakingVector = 0;
115 return_ACPI_STATUS (AE_OK);
118 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector)
121 #if ACPI_MACHINE_WIDTH == 64
122 /*******************************************************************************
124 * FUNCTION: AcpiSetFirmwareWakingVector64
126 * PARAMETERS: PhysicalAddress - 64-bit physical address of ACPI protected
131 * DESCRIPTION: Sets the 64-bit X_FirmwareWakingVector field of the FACS, if
132 * it exists in the table. This function is intended for use with
133 * 64-bit host operating systems.
135 ******************************************************************************/
138 AcpiSetFirmwareWakingVector64 (
139 UINT64 PhysicalAddress)
141 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector64);
144 /* Determine if the 64-bit vector actually exists */
146 if ((AcpiGbl_FACS->Length <= 32) || (AcpiGbl_FACS->Version < 1))
148 return_ACPI_STATUS (AE_NOT_EXIST);
151 /* Clear 32-bit vector, set the 64-bit X_ vector */
153 AcpiGbl_FACS->FirmwareWakingVector = 0;
154 AcpiGbl_FACS->XFirmwareWakingVector = PhysicalAddress;
155 return_ACPI_STATUS (AE_OK);
158 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector64)
162 /*******************************************************************************
164 * FUNCTION: AcpiEnterSleepStateS4bios
170 * DESCRIPTION: Perform a S4 bios request.
171 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
173 ******************************************************************************/
176 AcpiEnterSleepStateS4bios (
183 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios);
186 /* Clear the wake status bit (PM1) */
188 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
189 if (ACPI_FAILURE (Status))
191 return_ACPI_STATUS (Status);
194 Status = AcpiHwClearAcpiStatus ();
195 if (ACPI_FAILURE (Status))
197 return_ACPI_STATUS (Status);
201 * 1) Disable/Clear all GPEs
202 * 2) Enable all wakeup GPEs
204 Status = AcpiHwDisableAllGpes ();
205 if (ACPI_FAILURE (Status))
207 return_ACPI_STATUS (Status);
209 AcpiGbl_SystemAwakeAndRunning = FALSE;
211 Status = AcpiHwEnableAllWakeupGpes ();
212 if (ACPI_FAILURE (Status))
214 return_ACPI_STATUS (Status);
217 ACPI_FLUSH_CPU_CACHE ();
219 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
220 (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
224 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
225 if (ACPI_FAILURE (Status))
227 return_ACPI_STATUS (Status);
231 return_ACPI_STATUS (AE_OK);
234 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios)
236 #endif /* !ACPI_REDUCED_HARDWARE */
239 /*******************************************************************************
241 * FUNCTION: AcpiHwSleepDispatch
243 * PARAMETERS: SleepState - Which sleep state to enter/exit
244 * FunctionId - Sleep, WakePrep, or Wake
246 * RETURN: Status from the invoked sleep handling function.
248 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
251 ******************************************************************************/
254 AcpiHwSleepDispatch (
260 ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId];
263 #if (!ACPI_REDUCED_HARDWARE)
266 * If the Hardware Reduced flag is set (from the FADT), we must
267 * use the extended sleep registers
269 if (AcpiGbl_ReducedHardware ||
270 AcpiGbl_FADT.SleepControl.Address)
272 Status = SleepFunctions->ExtendedFunction (SleepState, Flags);
278 Status = SleepFunctions->LegacyFunction (SleepState, Flags);
285 * For the case where reduced-hardware-only code is being generated,
286 * we know that only the extended sleep registers are available
288 Status = SleepFunctions->ExtendedFunction (SleepState, Flags);
291 #endif /* !ACPI_REDUCED_HARDWARE */
295 /*******************************************************************************
297 * FUNCTION: AcpiEnterSleepStatePrep
299 * PARAMETERS: SleepState - Which sleep state to enter
303 * DESCRIPTION: Prepare to enter a system sleep state.
304 * This function must execute with interrupts enabled.
305 * We break sleeping into 2 stages so that OSPM can handle
306 * various OS-specific tasks between the two steps.
308 ******************************************************************************/
311 AcpiEnterSleepStatePrep (
315 ACPI_OBJECT_LIST ArgList;
320 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep);
323 Status = AcpiGetSleepTypeData (SleepState,
324 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
325 if (ACPI_FAILURE (Status))
327 return_ACPI_STATUS (Status);
330 /* Execute the _PTS method (Prepare To Sleep) */
333 ArgList.Pointer = &Arg;
334 Arg.Type = ACPI_TYPE_INTEGER;
335 Arg.Integer.Value = SleepState;
337 Status = AcpiEvaluateObject (NULL, METHOD_PATHNAME__PTS, &ArgList, NULL);
338 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
340 return_ACPI_STATUS (Status);
343 /* Setup the argument to the _SST method (System STatus) */
348 SstValue = ACPI_SST_WORKING;
354 SstValue = ACPI_SST_SLEEPING;
358 SstValue = ACPI_SST_SLEEP_CONTEXT;
362 SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */
367 * Set the system indicators to show the desired sleep state.
368 * _SST is an optional method (return no error if not found)
370 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, SstValue);
371 return_ACPI_STATUS (AE_OK);
374 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep)
377 /*******************************************************************************
379 * FUNCTION: AcpiEnterSleepState
381 * PARAMETERS: SleepState - Which sleep state to enter
382 * Flags - ACPI_EXECUTE_GTS to run optional method
386 * DESCRIPTION: Enter a system sleep state
387 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
389 ******************************************************************************/
392 AcpiEnterSleepState (
399 ACPI_FUNCTION_TRACE (AcpiEnterSleepState);
402 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
403 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
405 ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
406 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
407 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
410 Status = AcpiHwSleepDispatch (SleepState, Flags, ACPI_SLEEP_FUNCTION_ID);
411 return_ACPI_STATUS (Status);
414 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState)
417 /*******************************************************************************
419 * FUNCTION: AcpiLeaveSleepStatePrep
421 * PARAMETERS: SleepState - Which sleep state we are exiting
422 * Flags - ACPI_EXECUTE_BFS to run optional method
426 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
427 * sleep. Called with interrupts DISABLED.
428 * We break wake/resume into 2 stages so that OSPM can handle
429 * various OS-specific tasks between the two steps.
431 ******************************************************************************/
434 AcpiLeaveSleepStatePrep (
441 ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep);
444 Status = AcpiHwSleepDispatch (SleepState, Flags, ACPI_WAKE_PREP_FUNCTION_ID);
445 return_ACPI_STATUS (Status);
448 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep)
451 /*******************************************************************************
453 * FUNCTION: AcpiLeaveSleepState
455 * PARAMETERS: SleepState - Which sleep state we are exiting
459 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
460 * Called with interrupts ENABLED.
462 ******************************************************************************/
465 AcpiLeaveSleepState (
471 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState);
474 Status = AcpiHwSleepDispatch (SleepState, 0, ACPI_WAKE_FUNCTION_ID);
475 return_ACPI_STATUS (Status);
478 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)