1 /******************************************************************************
3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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
154 #include <contrib/dev/acpica/include/acpi.h>
155 #include <contrib/dev/acpica/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_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep), AcpiHwExtendedSleep},
188 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep), AcpiHwExtendedWakePrep},
189 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake), AcpiHwExtendedWake}
194 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
195 * AcpiSetFirmwareWakingVector
196 * AcpiEnterSleepStateS4bios
199 #if (!ACPI_REDUCED_HARDWARE)
200 /*******************************************************************************
202 * FUNCTION: AcpiHwSetFirmwareWakingVector
204 * PARAMETERS: Facs - Pointer to FACS table
205 * PhysicalAddress - 32-bit physical address of ACPI real mode
207 * PhysicalAddress64 - 64-bit physical address of ACPI protected
212 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
214 ******************************************************************************/
217 AcpiHwSetFirmwareWakingVector (
218 ACPI_TABLE_FACS *Facs,
219 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
220 ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
222 ACPI_FUNCTION_TRACE (AcpiHwSetFirmwareWakingVector);
226 * According to the ACPI specification 2.0c and later, the 64-bit
227 * waking vector should be cleared and the 32-bit waking vector should
228 * be used, unless we want the wake-up code to be called by the BIOS in
229 * Protected Mode. Some systems (for example HP dv5-1004nr) are known
230 * to fail to resume if the 64-bit vector is used.
233 /* Set the 32-bit vector */
235 Facs->FirmwareWakingVector = (UINT32) PhysicalAddress;
237 if (Facs->Length > 32)
239 if (Facs->Version >= 1)
241 /* Set the 64-bit vector */
243 Facs->XFirmwareWakingVector = PhysicalAddress64;
247 /* Clear the 64-bit vector if it exists */
249 Facs->XFirmwareWakingVector = 0;
253 return_ACPI_STATUS (AE_OK);
257 /*******************************************************************************
259 * FUNCTION: AcpiSetFirmwareWakingVector
261 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
263 * PhysicalAddress64 - 64-bit physical address of ACPI protected
268 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
270 ******************************************************************************/
273 AcpiSetFirmwareWakingVector (
274 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
275 ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
278 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
282 (void) AcpiHwSetFirmwareWakingVector (AcpiGbl_FACS,
283 PhysicalAddress, PhysicalAddress64);
286 return_ACPI_STATUS (AE_OK);
289 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector)
292 /*******************************************************************************
294 * FUNCTION: AcpiEnterSleepStateS4bios
300 * DESCRIPTION: Perform a S4 bios request.
301 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
303 ******************************************************************************/
306 AcpiEnterSleepStateS4bios (
313 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios);
316 /* Clear the wake status bit (PM1) */
318 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
319 if (ACPI_FAILURE (Status))
321 return_ACPI_STATUS (Status);
324 Status = AcpiHwClearAcpiStatus ();
325 if (ACPI_FAILURE (Status))
327 return_ACPI_STATUS (Status);
331 * 1) Disable/Clear all GPEs
332 * 2) Enable all wakeup GPEs
334 Status = AcpiHwDisableAllGpes ();
335 if (ACPI_FAILURE (Status))
337 return_ACPI_STATUS (Status);
339 AcpiGbl_SystemAwakeAndRunning = FALSE;
341 Status = AcpiHwEnableAllWakeupGpes ();
342 if (ACPI_FAILURE (Status))
344 return_ACPI_STATUS (Status);
347 ACPI_FLUSH_CPU_CACHE ();
349 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
350 (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
353 AcpiOsStall (ACPI_USEC_PER_MSEC);
354 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
355 if (ACPI_FAILURE (Status))
357 return_ACPI_STATUS (Status);
362 return_ACPI_STATUS (AE_OK);
365 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios)
367 #endif /* !ACPI_REDUCED_HARDWARE */
370 /*******************************************************************************
372 * FUNCTION: AcpiHwSleepDispatch
374 * PARAMETERS: SleepState - Which sleep state to enter/exit
375 * FunctionId - Sleep, WakePrep, or Wake
377 * RETURN: Status from the invoked sleep handling function.
379 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
382 ******************************************************************************/
385 AcpiHwSleepDispatch (
390 ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId];
393 #if (!ACPI_REDUCED_HARDWARE)
395 * If the Hardware Reduced flag is set (from the FADT), we must
396 * use the extended sleep registers (FADT). Note: As per the ACPI
397 * specification, these extended registers are to be used for HW-reduced
398 * platforms only. They are not general-purpose replacements for the
399 * legacy PM register sleep support.
401 if (AcpiGbl_ReducedHardware)
403 Status = SleepFunctions->ExtendedFunction (SleepState);
409 Status = SleepFunctions->LegacyFunction (SleepState);
416 * For the case where reduced-hardware-only code is being generated,
417 * we know that only the extended sleep registers are available
419 Status = SleepFunctions->ExtendedFunction (SleepState);
422 #endif /* !ACPI_REDUCED_HARDWARE */
426 /*******************************************************************************
428 * FUNCTION: AcpiEnterSleepStatePrep
430 * PARAMETERS: SleepState - Which sleep state to enter
434 * DESCRIPTION: Prepare to enter a system sleep state.
435 * This function must execute with interrupts enabled.
436 * We break sleeping into 2 stages so that OSPM can handle
437 * various OS-specific tasks between the two steps.
439 ******************************************************************************/
442 AcpiEnterSleepStatePrep (
446 ACPI_OBJECT_LIST ArgList;
451 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep);
454 Status = AcpiGetSleepTypeData (SleepState,
455 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
456 if (ACPI_FAILURE (Status))
458 return_ACPI_STATUS (Status);
461 /* Execute the _PTS method (Prepare To Sleep) */
464 ArgList.Pointer = &Arg;
465 Arg.Type = ACPI_TYPE_INTEGER;
466 Arg.Integer.Value = SleepState;
468 Status = AcpiEvaluateObject (NULL, METHOD_PATHNAME__PTS, &ArgList, NULL);
469 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
471 return_ACPI_STATUS (Status);
474 /* Setup the argument to the _SST method (System STatus) */
480 SstValue = ACPI_SST_WORKING;
487 SstValue = ACPI_SST_SLEEPING;
492 SstValue = ACPI_SST_SLEEP_CONTEXT;
497 SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */
502 * Set the system indicators to show the desired sleep state.
503 * _SST is an optional method (return no error if not found)
505 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, SstValue);
506 return_ACPI_STATUS (AE_OK);
509 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep)
512 /*******************************************************************************
514 * FUNCTION: AcpiEnterSleepState
516 * PARAMETERS: SleepState - Which sleep state to enter
520 * DESCRIPTION: Enter a system sleep state
521 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
523 ******************************************************************************/
526 AcpiEnterSleepState (
532 ACPI_FUNCTION_TRACE (AcpiEnterSleepState);
535 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
536 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
538 ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
539 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
540 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
543 Status = AcpiHwSleepDispatch (SleepState, ACPI_SLEEP_FUNCTION_ID);
544 return_ACPI_STATUS (Status);
547 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState)
550 /*******************************************************************************
552 * FUNCTION: AcpiLeaveSleepStatePrep
554 * PARAMETERS: SleepState - Which sleep state we are exiting
558 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
559 * sleep. Called with interrupts DISABLED.
560 * We break wake/resume into 2 stages so that OSPM can handle
561 * various OS-specific tasks between the two steps.
563 ******************************************************************************/
566 AcpiLeaveSleepStatePrep (
572 ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep);
575 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_PREP_FUNCTION_ID);
576 return_ACPI_STATUS (Status);
579 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep)
582 /*******************************************************************************
584 * FUNCTION: AcpiLeaveSleepState
586 * PARAMETERS: SleepState - Which sleep state we are exiting
590 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
591 * Called with interrupts ENABLED.
593 ******************************************************************************/
596 AcpiLeaveSleepState (
602 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState);
605 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_FUNCTION_ID);
606 return_ACPI_STATUS (Status);
609 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)