1 /******************************************************************************
3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, 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 #define EXPORT_ACPI_INTERFACES
119 #include "accommon.h"
121 #define _COMPONENT ACPI_HARDWARE
122 ACPI_MODULE_NAME ("hwxfsleep")
124 /* Local prototypes */
127 AcpiHwSleepDispatch (
132 * Dispatch table used to efficiently branch to the various sleep
135 #define ACPI_SLEEP_FUNCTION_ID 0
136 #define ACPI_WAKE_PREP_FUNCTION_ID 1
137 #define ACPI_WAKE_FUNCTION_ID 2
139 /* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
141 static ACPI_SLEEP_FUNCTIONS AcpiSleepDispatch
[] =
143 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep
), AcpiHwExtendedSleep
},
144 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep
), AcpiHwExtendedWakePrep
},
145 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake
), AcpiHwExtendedWake
}
150 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
151 * AcpiSetFirmwareWakingVector
152 * AcpiSetFirmwareWakingVector64
153 * AcpiEnterSleepStateS4bios
156 #if (!ACPI_REDUCED_HARDWARE)
157 /*******************************************************************************
159 * FUNCTION: AcpiSetFirmwareWakingVector
161 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
166 * DESCRIPTION: Sets the 32-bit FirmwareWakingVector field of the FACS
168 ******************************************************************************/
171 AcpiSetFirmwareWakingVector (
172 UINT32 PhysicalAddress
)
174 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector
);
178 * According to the ACPI specification 2.0c and later, the 64-bit
179 * waking vector should be cleared and the 32-bit waking vector should
180 * be used, unless we want the wake-up code to be called by the BIOS in
181 * Protected Mode. Some systems (for example HP dv5-1004nr) are known
182 * to fail to resume if the 64-bit vector is used.
185 /* Set the 32-bit vector */
187 AcpiGbl_FACS
->FirmwareWakingVector
= PhysicalAddress
;
189 /* Clear the 64-bit vector if it exists */
191 if ((AcpiGbl_FACS
->Length
> 32) && (AcpiGbl_FACS
->Version
>= 1))
193 AcpiGbl_FACS
->XFirmwareWakingVector
= 0;
196 return_ACPI_STATUS (AE_OK
);
199 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector
)
202 #if ACPI_MACHINE_WIDTH == 64
203 /*******************************************************************************
205 * FUNCTION: AcpiSetFirmwareWakingVector64
207 * PARAMETERS: PhysicalAddress - 64-bit physical address of ACPI protected
212 * DESCRIPTION: Sets the 64-bit X_FirmwareWakingVector field of the FACS, if
213 * it exists in the table. This function is intended for use with
214 * 64-bit host operating systems.
216 ******************************************************************************/
219 AcpiSetFirmwareWakingVector64 (
220 UINT64 PhysicalAddress
)
222 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector64
);
225 /* Determine if the 64-bit vector actually exists */
227 if ((AcpiGbl_FACS
->Length
<= 32) || (AcpiGbl_FACS
->Version
< 1))
229 return_ACPI_STATUS (AE_NOT_EXIST
);
232 /* Clear 32-bit vector, set the 64-bit X_ vector */
234 AcpiGbl_FACS
->FirmwareWakingVector
= 0;
235 AcpiGbl_FACS
->XFirmwareWakingVector
= PhysicalAddress
;
236 return_ACPI_STATUS (AE_OK
);
239 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector64
)
243 /*******************************************************************************
245 * FUNCTION: AcpiEnterSleepStateS4bios
251 * DESCRIPTION: Perform a S4 bios request.
252 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
254 ******************************************************************************/
257 AcpiEnterSleepStateS4bios (
264 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios
);
267 /* Clear the wake status bit (PM1) */
269 Status
= AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS
, ACPI_CLEAR_STATUS
);
270 if (ACPI_FAILURE (Status
))
272 return_ACPI_STATUS (Status
);
275 Status
= AcpiHwClearAcpiStatus ();
276 if (ACPI_FAILURE (Status
))
278 return_ACPI_STATUS (Status
);
282 * 1) Disable/Clear all GPEs
283 * 2) Enable all wakeup GPEs
285 Status
= AcpiHwDisableAllGpes ();
286 if (ACPI_FAILURE (Status
))
288 return_ACPI_STATUS (Status
);
290 AcpiGbl_SystemAwakeAndRunning
= FALSE
;
292 Status
= AcpiHwEnableAllWakeupGpes ();
293 if (ACPI_FAILURE (Status
))
295 return_ACPI_STATUS (Status
);
298 ACPI_FLUSH_CPU_CACHE ();
300 Status
= AcpiHwWritePort (AcpiGbl_FADT
.SmiCommand
,
301 (UINT32
) AcpiGbl_FADT
.S4BiosRequest
, 8);
304 AcpiOsStall (ACPI_USEC_PER_MSEC
);
305 Status
= AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS
, &InValue
);
306 if (ACPI_FAILURE (Status
))
308 return_ACPI_STATUS (Status
);
312 return_ACPI_STATUS (AE_OK
);
315 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios
)
317 #endif /* !ACPI_REDUCED_HARDWARE */
320 /*******************************************************************************
322 * FUNCTION: AcpiHwSleepDispatch
324 * PARAMETERS: SleepState - Which sleep state to enter/exit
325 * FunctionId - Sleep, WakePrep, or Wake
327 * RETURN: Status from the invoked sleep handling function.
329 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
332 ******************************************************************************/
335 AcpiHwSleepDispatch (
340 ACPI_SLEEP_FUNCTIONS
*SleepFunctions
= &AcpiSleepDispatch
[FunctionId
];
343 #if (!ACPI_REDUCED_HARDWARE)
345 * If the Hardware Reduced flag is set (from the FADT), we must
346 * use the extended sleep registers (FADT). Note: As per the ACPI
347 * specification, these extended registers are to be used for HW-reduced
348 * platforms only. They are not general-purpose replacements for the
349 * legacy PM register sleep support.
351 if (AcpiGbl_ReducedHardware
)
353 Status
= SleepFunctions
->ExtendedFunction (SleepState
);
359 Status
= SleepFunctions
->LegacyFunction (SleepState
);
366 * For the case where reduced-hardware-only code is being generated,
367 * we know that only the extended sleep registers are available
369 Status
= SleepFunctions
->ExtendedFunction (SleepState
);
372 #endif /* !ACPI_REDUCED_HARDWARE */
376 /*******************************************************************************
378 * FUNCTION: AcpiEnterSleepStatePrep
380 * PARAMETERS: SleepState - Which sleep state to enter
384 * DESCRIPTION: Prepare to enter a system sleep state.
385 * This function must execute with interrupts enabled.
386 * We break sleeping into 2 stages so that OSPM can handle
387 * various OS-specific tasks between the two steps.
389 ******************************************************************************/
392 AcpiEnterSleepStatePrep (
396 ACPI_OBJECT_LIST ArgList
;
401 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep
);
404 Status
= AcpiGetSleepTypeData (SleepState
,
405 &AcpiGbl_SleepTypeA
, &AcpiGbl_SleepTypeB
);
406 if (ACPI_FAILURE (Status
))
408 return_ACPI_STATUS (Status
);
411 /* Execute the _PTS method (Prepare To Sleep) */
414 ArgList
.Pointer
= &Arg
;
415 Arg
.Type
= ACPI_TYPE_INTEGER
;
416 Arg
.Integer
.Value
= SleepState
;
418 Status
= AcpiEvaluateObject (NULL
, METHOD_PATHNAME__PTS
, &ArgList
, NULL
);
419 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
421 return_ACPI_STATUS (Status
);
424 /* Setup the argument to the _SST method (System STatus) */
430 SstValue
= ACPI_SST_WORKING
;
437 SstValue
= ACPI_SST_SLEEPING
;
442 SstValue
= ACPI_SST_SLEEP_CONTEXT
;
447 SstValue
= ACPI_SST_INDICATOR_OFF
; /* Default is off */
452 * Set the system indicators to show the desired sleep state.
453 * _SST is an optional method (return no error if not found)
455 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST
, SstValue
);
456 return_ACPI_STATUS (AE_OK
);
459 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep
)
462 /*******************************************************************************
464 * FUNCTION: AcpiEnterSleepState
466 * PARAMETERS: SleepState - Which sleep state to enter
470 * DESCRIPTION: Enter a system sleep state
471 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
473 ******************************************************************************/
476 AcpiEnterSleepState (
482 ACPI_FUNCTION_TRACE (AcpiEnterSleepState
);
485 if ((AcpiGbl_SleepTypeA
> ACPI_SLEEP_TYPE_MAX
) ||
486 (AcpiGbl_SleepTypeB
> ACPI_SLEEP_TYPE_MAX
))
488 ACPI_ERROR ((AE_INFO
, "Sleep values out of range: A=0x%X B=0x%X",
489 AcpiGbl_SleepTypeA
, AcpiGbl_SleepTypeB
));
490 return_ACPI_STATUS (AE_AML_OPERAND_VALUE
);
493 Status
= AcpiHwSleepDispatch (SleepState
, ACPI_SLEEP_FUNCTION_ID
);
494 return_ACPI_STATUS (Status
);
497 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState
)
500 /*******************************************************************************
502 * FUNCTION: AcpiLeaveSleepStatePrep
504 * PARAMETERS: SleepState - Which sleep state we are exiting
508 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
509 * sleep. Called with interrupts DISABLED.
510 * We break wake/resume into 2 stages so that OSPM can handle
511 * various OS-specific tasks between the two steps.
513 ******************************************************************************/
516 AcpiLeaveSleepStatePrep (
522 ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep
);
525 Status
= AcpiHwSleepDispatch (SleepState
, ACPI_WAKE_PREP_FUNCTION_ID
);
526 return_ACPI_STATUS (Status
);
529 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep
)
532 /*******************************************************************************
534 * FUNCTION: AcpiLeaveSleepState
536 * PARAMETERS: SleepState - Which sleep state we are exiting
540 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
541 * Called with interrupts ENABLED.
543 ******************************************************************************/
546 AcpiLeaveSleepState (
552 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState
);
555 Status
= AcpiHwSleepDispatch (SleepState
, ACPI_WAKE_FUNCTION_ID
);
556 return_ACPI_STATUS (Status
);
559 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState
)