1 /******************************************************************************
3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #define EXPORT_ACPI_INTERFACES
155 #include "accommon.h"
157 #define _COMPONENT ACPI_HARDWARE
158 ACPI_MODULE_NAME ("hwxfsleep")
160 /* Local prototypes */
162 #if (!ACPI_REDUCED_HARDWARE)
164 AcpiHwSetFirmwareWakingVector (
165 ACPI_TABLE_FACS *Facs,
166 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
167 ACPI_PHYSICAL_ADDRESS PhysicalAddress64);
171 AcpiHwSleepDispatch (
176 * Dispatch table used to efficiently branch to the various sleep
179 #define ACPI_SLEEP_FUNCTION_ID 0
180 #define ACPI_WAKE_PREP_FUNCTION_ID 1
181 #define ACPI_WAKE_FUNCTION_ID 2
183 /* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
185 static ACPI_SLEEP_FUNCTIONS AcpiSleepDispatch[] =
187 {ACPI_STRUCT_INIT (LegacyFunction,
188 ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep)),
189 ACPI_STRUCT_INIT (ExtendedFunction,
190 AcpiHwExtendedSleep) },
191 {ACPI_STRUCT_INIT (LegacyFunction,
192 ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep)),
193 ACPI_STRUCT_INIT (ExtendedFunction,
194 AcpiHwExtendedWakePrep) },
195 {ACPI_STRUCT_INIT (LegacyFunction,
196 ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake)),
197 ACPI_STRUCT_INIT (ExtendedFunction,
198 AcpiHwExtendedWake) }
203 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
204 * AcpiSetFirmwareWakingVector
205 * AcpiEnterSleepStateS4bios
208 #if (!ACPI_REDUCED_HARDWARE)
209 /*******************************************************************************
211 * FUNCTION: AcpiHwSetFirmwareWakingVector
213 * PARAMETERS: Facs - Pointer to FACS table
214 * PhysicalAddress - 32-bit physical address of ACPI real mode
216 * PhysicalAddress64 - 64-bit physical address of ACPI protected
221 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
223 ******************************************************************************/
226 AcpiHwSetFirmwareWakingVector (
227 ACPI_TABLE_FACS *Facs,
228 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
229 ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
231 ACPI_FUNCTION_TRACE (AcpiHwSetFirmwareWakingVector);
235 * According to the ACPI specification 2.0c and later, the 64-bit
236 * waking vector should be cleared and the 32-bit waking vector should
237 * be used, unless we want the wake-up code to be called by the BIOS in
238 * Protected Mode. Some systems (for example HP dv5-1004nr) are known
239 * to fail to resume if the 64-bit vector is used.
242 /* Set the 32-bit vector */
244 Facs->FirmwareWakingVector = (UINT32) PhysicalAddress;
246 if (Facs->Length > 32)
248 if (Facs->Version >= 1)
250 /* Set the 64-bit vector */
252 Facs->XFirmwareWakingVector = PhysicalAddress64;
256 /* Clear the 64-bit vector if it exists */
258 Facs->XFirmwareWakingVector = 0;
262 return_ACPI_STATUS (AE_OK);
266 /*******************************************************************************
268 * FUNCTION: AcpiSetFirmwareWakingVector
270 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
272 * PhysicalAddress64 - 64-bit physical address of ACPI protected
277 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
279 ******************************************************************************/
282 AcpiSetFirmwareWakingVector (
283 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
284 ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
287 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
291 (void) AcpiHwSetFirmwareWakingVector (AcpiGbl_FACS,
292 PhysicalAddress, PhysicalAddress64);
295 return_ACPI_STATUS (AE_OK);
298 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector)
301 /*******************************************************************************
303 * FUNCTION: AcpiEnterSleepStateS4bios
309 * DESCRIPTION: Perform a S4 bios request.
310 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
312 ******************************************************************************/
315 AcpiEnterSleepStateS4bios (
322 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios);
325 /* Clear the wake status bit (PM1) */
327 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
328 if (ACPI_FAILURE (Status))
330 return_ACPI_STATUS (Status);
333 Status = AcpiHwClearAcpiStatus ();
334 if (ACPI_FAILURE (Status))
336 return_ACPI_STATUS (Status);
340 * 1) Disable all GPEs
341 * 2) Enable all wakeup GPEs
343 Status = AcpiHwDisableAllGpes ();
344 if (ACPI_FAILURE (Status))
346 return_ACPI_STATUS (Status);
348 AcpiGbl_SystemAwakeAndRunning = FALSE;
350 Status = AcpiHwEnableAllWakeupGpes ();
351 if (ACPI_FAILURE (Status))
353 return_ACPI_STATUS (Status);
356 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
357 (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
358 if (ACPI_FAILURE (Status))
360 return_ACPI_STATUS (Status);
364 AcpiOsStall (ACPI_USEC_PER_MSEC);
365 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
366 if (ACPI_FAILURE (Status))
368 return_ACPI_STATUS (Status);
373 return_ACPI_STATUS (AE_OK);
376 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios)
378 #endif /* !ACPI_REDUCED_HARDWARE */
381 /*******************************************************************************
383 * FUNCTION: AcpiHwSleepDispatch
385 * PARAMETERS: SleepState - Which sleep state to enter/exit
386 * FunctionId - Sleep, WakePrep, or Wake
388 * RETURN: Status from the invoked sleep handling function.
390 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
393 ******************************************************************************/
396 AcpiHwSleepDispatch (
401 ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId];
404 #if (!ACPI_REDUCED_HARDWARE)
406 * If the Hardware Reduced flag is set (from the FADT), we must
407 * use the extended sleep registers (FADT). Note: As per the ACPI
408 * specification, these extended registers are to be used for HW-reduced
409 * platforms only. They are not general-purpose replacements for the
410 * legacy PM register sleep support.
412 if (AcpiGbl_ReducedHardware)
414 Status = SleepFunctions->ExtendedFunction (SleepState);
420 Status = SleepFunctions->LegacyFunction (SleepState);
427 * For the case where reduced-hardware-only code is being generated,
428 * we know that only the extended sleep registers are available
430 Status = SleepFunctions->ExtendedFunction (SleepState);
433 #endif /* !ACPI_REDUCED_HARDWARE */
437 /*******************************************************************************
439 * FUNCTION: AcpiEnterSleepStatePrep
441 * PARAMETERS: SleepState - Which sleep state to enter
445 * DESCRIPTION: Prepare to enter a system sleep state.
446 * This function must execute with interrupts enabled.
447 * We break sleeping into 2 stages so that OSPM can handle
448 * various OS-specific tasks between the two steps.
450 ******************************************************************************/
453 AcpiEnterSleepStatePrep (
457 ACPI_OBJECT_LIST ArgList;
462 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep);
465 Status = AcpiGetSleepTypeData (SleepState,
466 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
467 if (ACPI_FAILURE (Status))
469 return_ACPI_STATUS (Status);
472 Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
473 &AcpiGbl_SleepTypeAS0, &AcpiGbl_SleepTypeBS0);
474 if (ACPI_FAILURE (Status)) {
475 AcpiGbl_SleepTypeAS0 = ACPI_SLEEP_TYPE_INVALID;
478 /* Execute the _PTS method (Prepare To Sleep) */
481 ArgList.Pointer = &Arg;
482 Arg.Type = ACPI_TYPE_INTEGER;
483 Arg.Integer.Value = SleepState;
485 Status = AcpiEvaluateObject (NULL, METHOD_PATHNAME__PTS, &ArgList, NULL);
486 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
488 return_ACPI_STATUS (Status);
491 /* Setup the argument to the _SST method (System STatus) */
497 SstValue = ACPI_SST_WORKING;
504 SstValue = ACPI_SST_SLEEPING;
509 SstValue = ACPI_SST_SLEEP_CONTEXT;
514 SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */
519 * Set the system indicators to show the desired sleep state.
520 * _SST is an optional method (return no error if not found)
522 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, SstValue);
523 return_ACPI_STATUS (AE_OK);
526 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep)
529 /*******************************************************************************
531 * FUNCTION: AcpiEnterSleepState
533 * PARAMETERS: SleepState - Which sleep state to enter
537 * DESCRIPTION: Enter a system sleep state
538 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
540 ******************************************************************************/
543 AcpiEnterSleepState (
549 ACPI_FUNCTION_TRACE (AcpiEnterSleepState);
552 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
553 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
555 ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
556 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
557 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
560 Status = AcpiHwSleepDispatch (SleepState, ACPI_SLEEP_FUNCTION_ID);
561 return_ACPI_STATUS (Status);
564 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState)
567 /*******************************************************************************
569 * FUNCTION: AcpiLeaveSleepStatePrep
571 * PARAMETERS: SleepState - Which sleep state we are exiting
575 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
576 * sleep. Called with interrupts DISABLED.
577 * We break wake/resume into 2 stages so that OSPM can handle
578 * various OS-specific tasks between the two steps.
580 ******************************************************************************/
583 AcpiLeaveSleepStatePrep (
589 ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep);
592 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_PREP_FUNCTION_ID);
593 return_ACPI_STATUS (Status);
596 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep)
599 /*******************************************************************************
601 * FUNCTION: AcpiLeaveSleepState
603 * PARAMETERS: SleepState - Which sleep state we are exiting
607 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
608 * Called with interrupts ENABLED.
610 ******************************************************************************/
613 AcpiLeaveSleepState (
619 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState);
622 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_FUNCTION_ID);
623 return_ACPI_STATUS (Status);
626 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)