2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #include "accommon.h"
120 #define _COMPONENT ACPI_HARDWARE
121 ACPI_MODULE_NAME ("hwsleep")
124 /*******************************************************************************
126 * FUNCTION: AcpiSetFirmwareWakingVector
128 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
133 * DESCRIPTION: Sets the 32-bit FirmwareWakingVector field of the FACS
135 ******************************************************************************/
138 AcpiSetFirmwareWakingVector (
139 UINT32 PhysicalAddress
)
141 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector
);
144 /* Set the 32-bit vector */
146 AcpiGbl_FACS
->FirmwareWakingVector
= PhysicalAddress
;
148 /* Clear the 64-bit vector if it exists */
150 if ((AcpiGbl_FACS
->Length
> 32) && (AcpiGbl_FACS
->Version
>= 1))
152 AcpiGbl_FACS
->XFirmwareWakingVector
= 0;
155 return_ACPI_STATUS (AE_OK
);
158 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector
)
161 #if ACPI_MACHINE_WIDTH == 64
162 /*******************************************************************************
164 * FUNCTION: AcpiSetFirmwareWakingVector64
166 * PARAMETERS: PhysicalAddress - 64-bit physical address of ACPI protected
171 * DESCRIPTION: Sets the 64-bit X_FirmwareWakingVector field of the FACS, if
172 * it exists in the table. This function is intended for use with
173 * 64-bit host operating systems.
175 ******************************************************************************/
178 AcpiSetFirmwareWakingVector64 (
179 UINT64 PhysicalAddress
)
181 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector64
);
184 /* Determine if the 64-bit vector actually exists */
186 if ((AcpiGbl_FACS
->Length
<= 32) || (AcpiGbl_FACS
->Version
< 1))
188 return_ACPI_STATUS (AE_NOT_EXIST
);
191 /* Clear 32-bit vector, set the 64-bit X_ vector */
193 AcpiGbl_FACS
->FirmwareWakingVector
= 0;
194 AcpiGbl_FACS
->XFirmwareWakingVector
= PhysicalAddress
;
195 return_ACPI_STATUS (AE_OK
);
198 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector64
)
201 /*******************************************************************************
203 * FUNCTION: AcpiEnterSleepStatePrep
205 * PARAMETERS: SleepState - Which sleep state to enter
209 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
210 * This function must execute with interrupts enabled.
211 * We break sleeping into 2 stages so that OSPM can handle
212 * various OS-specific tasks between the two steps.
214 ******************************************************************************/
217 AcpiEnterSleepStatePrep (
221 ACPI_OBJECT_LIST ArgList
;
225 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep
);
228 /* _PSW methods could be run here to enable wake-on keyboard, LAN, etc. */
230 Status
= AcpiGetSleepTypeData (SleepState
,
231 &AcpiGbl_SleepTypeA
, &AcpiGbl_SleepTypeB
);
232 if (ACPI_FAILURE (Status
))
234 return_ACPI_STATUS (Status
);
237 /* Execute the _PTS method (Prepare To Sleep) */
240 ArgList
.Pointer
= &Arg
;
241 Arg
.Type
= ACPI_TYPE_INTEGER
;
242 Arg
.Integer
.Value
= SleepState
;
244 Status
= AcpiEvaluateObject (NULL
, METHOD_NAME__PTS
, &ArgList
, NULL
);
245 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
247 return_ACPI_STATUS (Status
);
250 /* Setup the argument to the _SST method (System STatus) */
255 Arg
.Integer
.Value
= ACPI_SST_WORKING
;
261 Arg
.Integer
.Value
= ACPI_SST_SLEEPING
;
265 Arg
.Integer
.Value
= ACPI_SST_SLEEP_CONTEXT
;
269 Arg
.Integer
.Value
= ACPI_SST_INDICATOR_OFF
; /* Default is off */
274 * Set the system indicators to show the desired sleep state.
275 * _SST is an optional method (return no error if not found)
277 Status
= AcpiEvaluateObject (NULL
, METHOD_NAME__SST
, &ArgList
, NULL
);
278 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
280 ACPI_EXCEPTION ((AE_INFO
, Status
, "While executing method _SST"));
283 return_ACPI_STATUS (AE_OK
);
286 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep
)
289 /*******************************************************************************
291 * FUNCTION: AcpiEnterSleepState
293 * PARAMETERS: SleepState - Which sleep state to enter
297 * DESCRIPTION: Enter a system sleep state
298 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
300 ******************************************************************************/
303 AcpiEnterSleepState (
308 ACPI_BIT_REGISTER_INFO
*SleepTypeRegInfo
;
309 ACPI_BIT_REGISTER_INFO
*SleepEnableRegInfo
;
311 ACPI_OBJECT_LIST ArgList
;
316 ACPI_FUNCTION_TRACE (AcpiEnterSleepState
);
319 if ((AcpiGbl_SleepTypeA
> ACPI_SLEEP_TYPE_MAX
) ||
320 (AcpiGbl_SleepTypeB
> ACPI_SLEEP_TYPE_MAX
))
322 ACPI_ERROR ((AE_INFO
, "Sleep values out of range: A=0x%X B=0x%X",
323 AcpiGbl_SleepTypeA
, AcpiGbl_SleepTypeB
));
324 return_ACPI_STATUS (AE_AML_OPERAND_VALUE
);
327 SleepTypeRegInfo
= AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE
);
328 SleepEnableRegInfo
= AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE
);
330 /* Clear wake status */
332 Status
= AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS
, ACPI_CLEAR_STATUS
);
333 if (ACPI_FAILURE (Status
))
335 return_ACPI_STATUS (Status
);
338 /* Clear all fixed and general purpose status bits */
340 Status
= AcpiHwClearAcpiStatus ();
341 if (ACPI_FAILURE (Status
))
343 return_ACPI_STATUS (Status
);
346 if (SleepState
!= ACPI_STATE_S5
)
349 * Disable BM arbitration. This feature is contained within an
350 * optional register (PM2 Control), so ignore a BAD_ADDRESS
353 Status
= AcpiWriteBitRegister (ACPI_BITREG_ARB_DISABLE
, 1);
354 if (ACPI_FAILURE (Status
) && (Status
!= AE_BAD_ADDRESS
))
356 return_ACPI_STATUS (Status
);
361 * 1) Disable/Clear all GPEs
362 * 2) Enable all wakeup GPEs
364 Status
= AcpiHwDisableAllGpes ();
365 if (ACPI_FAILURE (Status
))
367 return_ACPI_STATUS (Status
);
369 AcpiGbl_SystemAwakeAndRunning
= FALSE
;
371 Status
= AcpiHwEnableAllWakeupGpes ();
372 if (ACPI_FAILURE (Status
))
374 return_ACPI_STATUS (Status
);
377 /* Execute the _GTS method (Going To Sleep) */
380 ArgList
.Pointer
= &Arg
;
381 Arg
.Type
= ACPI_TYPE_INTEGER
;
382 Arg
.Integer
.Value
= SleepState
;
384 Status
= AcpiEvaluateObject (NULL
, METHOD_NAME__GTS
, &ArgList
, NULL
);
385 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
387 return_ACPI_STATUS (Status
);
390 /* Get current value of PM1A control */
392 Status
= AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL
,
394 if (ACPI_FAILURE (Status
))
396 return_ACPI_STATUS (Status
);
398 ACPI_DEBUG_PRINT ((ACPI_DB_INIT
,
399 "Entering sleep state [S%u]\n", SleepState
));
401 /* Clear the SLP_EN and SLP_TYP fields */
403 Pm1aControl
&= ~(SleepTypeRegInfo
->AccessBitMask
|
404 SleepEnableRegInfo
->AccessBitMask
);
405 Pm1bControl
= Pm1aControl
;
407 /* Insert the SLP_TYP bits */
409 Pm1aControl
|= (AcpiGbl_SleepTypeA
<< SleepTypeRegInfo
->BitPosition
);
410 Pm1bControl
|= (AcpiGbl_SleepTypeB
<< SleepTypeRegInfo
->BitPosition
);
413 * We split the writes of SLP_TYP and SLP_EN to workaround
414 * poorly implemented hardware.
417 /* Write #1: write the SLP_TYP data to the PM1 Control registers */
419 Status
= AcpiHwWritePm1Control (Pm1aControl
, Pm1bControl
);
420 if (ACPI_FAILURE (Status
))
422 return_ACPI_STATUS (Status
);
425 /* Insert the sleep enable (SLP_EN) bit */
427 Pm1aControl
|= SleepEnableRegInfo
->AccessBitMask
;
428 Pm1bControl
|= SleepEnableRegInfo
->AccessBitMask
;
430 /* Flush caches, as per ACPI specification */
432 ACPI_FLUSH_CPU_CACHE ();
434 /* Write #2: Write both SLP_TYP + SLP_EN */
436 Status
= AcpiHwWritePm1Control (Pm1aControl
, Pm1bControl
);
437 if (ACPI_FAILURE (Status
))
439 return_ACPI_STATUS (Status
);
442 if (SleepState
> ACPI_STATE_S3
)
445 * We wanted to sleep > S3, but it didn't happen (by virtue of the
446 * fact that we are still executing!)
448 * Wait ten seconds, then try again. This is to get S4/S5 to work on
451 * We wait so long to allow chipsets that poll this reg very slowly
452 * to still read the right value. Ideally, this block would go
455 AcpiOsStall (10000000);
457 Status
= AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL
,
458 SleepEnableRegInfo
->AccessBitMask
);
459 if (ACPI_FAILURE (Status
))
461 return_ACPI_STATUS (Status
);
465 /* Wait until we enter sleep state */
469 Status
= AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS
, &InValue
);
470 if (ACPI_FAILURE (Status
))
472 return_ACPI_STATUS (Status
);
475 /* Spin until we wake */
479 return_ACPI_STATUS (AE_OK
);
482 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState
)
485 /*******************************************************************************
487 * FUNCTION: AcpiEnterSleepStateS4bios
493 * DESCRIPTION: Perform a S4 bios request.
494 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
496 ******************************************************************************/
499 AcpiEnterSleepStateS4bios (
506 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios
);
509 /* Clear the wake status bit (PM1) */
511 Status
= AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS
, ACPI_CLEAR_STATUS
);
512 if (ACPI_FAILURE (Status
))
514 return_ACPI_STATUS (Status
);
517 Status
= AcpiHwClearAcpiStatus ();
518 if (ACPI_FAILURE (Status
))
520 return_ACPI_STATUS (Status
);
524 * 1) Disable/Clear all GPEs
525 * 2) Enable all wakeup GPEs
527 Status
= AcpiHwDisableAllGpes ();
528 if (ACPI_FAILURE (Status
))
530 return_ACPI_STATUS (Status
);
532 AcpiGbl_SystemAwakeAndRunning
= FALSE
;
534 Status
= AcpiHwEnableAllWakeupGpes ();
535 if (ACPI_FAILURE (Status
))
537 return_ACPI_STATUS (Status
);
540 ACPI_FLUSH_CPU_CACHE ();
542 Status
= AcpiHwWritePort (AcpiGbl_FADT
.SmiCommand
,
543 (UINT32
) AcpiGbl_FADT
.S4BiosRequest
, 8);
547 Status
= AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS
, &InValue
);
548 if (ACPI_FAILURE (Status
))
550 return_ACPI_STATUS (Status
);
554 return_ACPI_STATUS (AE_OK
);
557 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios
)
560 /*******************************************************************************
562 * FUNCTION: AcpiLeaveSleepState
564 * PARAMETERS: SleepState - Which sleep state we just exited
568 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
569 * Called with interrupts ENABLED.
571 ******************************************************************************/
574 AcpiLeaveSleepState (
577 ACPI_OBJECT_LIST ArgList
;
580 ACPI_BIT_REGISTER_INFO
*SleepTypeRegInfo
;
581 ACPI_BIT_REGISTER_INFO
*SleepEnableRegInfo
;
586 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState
);
590 * Set SLP_TYPE and SLP_EN to state S0.
591 * This is unclear from the ACPI Spec, but it is required
594 Status
= AcpiGetSleepTypeData (ACPI_STATE_S0
,
595 &AcpiGbl_SleepTypeA
, &AcpiGbl_SleepTypeB
);
596 if (ACPI_SUCCESS (Status
))
599 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE
);
601 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE
);
603 /* Get current value of PM1A control */
605 Status
= AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL
,
607 if (ACPI_SUCCESS (Status
))
609 /* Clear the SLP_EN and SLP_TYP fields */
611 Pm1aControl
&= ~(SleepTypeRegInfo
->AccessBitMask
|
612 SleepEnableRegInfo
->AccessBitMask
);
613 Pm1bControl
= Pm1aControl
;
615 /* Insert the SLP_TYP bits */
617 Pm1aControl
|= (AcpiGbl_SleepTypeA
<<
618 SleepTypeRegInfo
->BitPosition
);
619 Pm1bControl
|= (AcpiGbl_SleepTypeB
<<
620 SleepTypeRegInfo
->BitPosition
);
622 /* Write the control registers and ignore any errors */
624 (void) AcpiHwWritePm1Control (Pm1aControl
, Pm1bControl
);
628 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
630 AcpiGbl_SleepTypeA
= ACPI_SLEEP_TYPE_INVALID
;
632 /* Setup parameter object */
635 ArgList
.Pointer
= &Arg
;
636 Arg
.Type
= ACPI_TYPE_INTEGER
;
638 /* Ignore any errors from these methods */
640 Arg
.Integer
.Value
= ACPI_SST_WAKING
;
641 Status
= AcpiEvaluateObject (NULL
, METHOD_NAME__SST
, &ArgList
, NULL
);
642 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
644 ACPI_EXCEPTION ((AE_INFO
, Status
, "During Method _SST"));
647 Arg
.Integer
.Value
= SleepState
;
648 Status
= AcpiEvaluateObject (NULL
, METHOD_NAME__BFS
, &ArgList
, NULL
);
649 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
651 ACPI_EXCEPTION ((AE_INFO
, Status
, "During Method _BFS"));
654 Status
= AcpiEvaluateObject (NULL
, METHOD_NAME__WAK
, &ArgList
, NULL
);
655 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
657 ACPI_EXCEPTION ((AE_INFO
, Status
, "During Method _WAK"));
659 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
663 * 1) Disable/Clear all GPEs
664 * 2) Enable all runtime GPEs
666 Status
= AcpiHwDisableAllGpes ();
667 if (ACPI_FAILURE (Status
))
669 return_ACPI_STATUS (Status
);
671 AcpiGbl_SystemAwakeAndRunning
= TRUE
;
673 Status
= AcpiHwEnableAllRuntimeGpes ();
674 if (ACPI_FAILURE (Status
))
676 return_ACPI_STATUS (Status
);
679 /* Enable power button */
681 (void) AcpiWriteBitRegister(
682 AcpiGbl_FixedEventInfo
[ACPI_EVENT_POWER_BUTTON
].EnableRegisterId
,
685 (void) AcpiWriteBitRegister(
686 AcpiGbl_FixedEventInfo
[ACPI_EVENT_POWER_BUTTON
].StatusRegisterId
,
690 * Enable BM arbitration. This feature is contained within an
691 * optional register (PM2 Control), so ignore a BAD_ADDRESS
694 Status
= AcpiWriteBitRegister (ACPI_BITREG_ARB_DISABLE
, 0);
695 if (ACPI_FAILURE (Status
) && (Status
!= AE_BAD_ADDRESS
))
697 return_ACPI_STATUS (Status
);
700 Arg
.Integer
.Value
= ACPI_SST_WORKING
;
701 Status
= AcpiEvaluateObject (NULL
, METHOD_NAME__SST
, &ArgList
, NULL
);
702 if (ACPI_FAILURE (Status
) && Status
!= AE_NOT_FOUND
)
704 ACPI_EXCEPTION ((AE_INFO
, Status
, "During Method _SST"));
707 return_ACPI_STATUS (Status
);
710 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState
)