2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
120 #define _COMPONENT ACPI_HARDWARE
121 ACPI_MODULE_NAME ("hwsleep")
124 #define METHOD_NAME__BFS "\\_BFS"
125 #define METHOD_NAME__GTS "\\_GTS"
126 #define METHOD_NAME__PTS "\\_PTS"
127 #define METHOD_NAME__SST "\\_SI._SST"
128 #define METHOD_NAME__WAK "\\_WAK"
130 #define ACPI_SST_INDICATOR_OFF 0
131 #define ACPI_SST_WORKING 1
132 #define ACPI_SST_WAKING 2
133 #define ACPI_SST_SLEEPING 3
134 #define ACPI_SST_SLEEP_CONTEXT 4
137 /******************************************************************************
139 * FUNCTION: AcpiSetFirmwareWakingVector
141 * PARAMETERS: PhysicalAddress - Physical address of ACPI real mode
146 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS
148 ******************************************************************************/
151 AcpiSetFirmwareWakingVector (
152 ACPI_PHYSICAL_ADDRESS PhysicalAddress)
155 ACPI_FUNCTION_TRACE ("AcpiSetFirmwareWakingVector");
160 if (AcpiGbl_CommonFACS.VectorWidth == 32)
162 *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector))
163 = (UINT32) PhysicalAddress;
167 *AcpiGbl_CommonFACS.FirmwareWakingVector
171 return_ACPI_STATUS (AE_OK);
175 /******************************************************************************
177 * FUNCTION: AcpiGetFirmwareWakingVector
179 * PARAMETERS: *PhysicalAddress - Output buffer where contents of
180 * the FirmwareWakingVector field of
181 * the FACS will be stored.
185 * DESCRIPTION: Access function for FirmwareWakingVector field in FACS
187 ******************************************************************************/
190 AcpiGetFirmwareWakingVector (
191 ACPI_PHYSICAL_ADDRESS *PhysicalAddress)
194 ACPI_FUNCTION_TRACE ("AcpiGetFirmwareWakingVector");
197 if (!PhysicalAddress)
199 return_ACPI_STATUS (AE_BAD_PARAMETER);
204 if (AcpiGbl_CommonFACS.VectorWidth == 32)
206 *PhysicalAddress = (ACPI_PHYSICAL_ADDRESS)
207 *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector));
212 *AcpiGbl_CommonFACS.FirmwareWakingVector;
215 return_ACPI_STATUS (AE_OK);
219 /******************************************************************************
221 * FUNCTION: AcpiEnterSleepStatePrep
223 * PARAMETERS: SleepState - Which sleep state to enter
227 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
228 * This function must execute with interrupts enabled.
229 * We break sleeping into 2 stages so that OSPM can handle
230 * various OS-specific tasks between the two steps.
232 ******************************************************************************/
235 AcpiEnterSleepStatePrep (
239 ACPI_OBJECT_LIST ArgList;
243 ACPI_FUNCTION_TRACE ("AcpiEnterSleepStatePrep");
247 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
249 Status = AcpiGetSleepTypeData (SleepState,
250 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
251 if (ACPI_FAILURE (Status))
253 return_ACPI_STATUS (Status);
256 /* Setup parameter object */
259 ArgList.Pointer = &Arg;
261 Arg.Type = ACPI_TYPE_INTEGER;
262 Arg.Integer.Value = SleepState;
264 /* Run the _PTS and _GTS methods */
266 Status = AcpiEvaluateObject (NULL, METHOD_NAME__PTS, &ArgList, NULL);
267 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
269 return_ACPI_STATUS (Status);
272 Status = AcpiEvaluateObject (NULL, METHOD_NAME__GTS, &ArgList, NULL);
273 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
275 return_ACPI_STATUS (Status);
278 /* Setup the argument to _SST */
283 Arg.Integer.Value = ACPI_SST_WORKING;
289 Arg.Integer.Value = ACPI_SST_SLEEPING;
293 Arg.Integer.Value = ACPI_SST_SLEEP_CONTEXT;
297 Arg.Integer.Value = ACPI_SST_INDICATOR_OFF; /* Default is indicator off */
301 /* Set the system indicators to show the desired sleep state. */
303 Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
304 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
306 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status)));
309 return_ACPI_STATUS (AE_OK);
313 /******************************************************************************
315 * FUNCTION: AcpiEnterSleepState
317 * PARAMETERS: SleepState - Which sleep state to enter
321 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
322 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
324 ******************************************************************************/
327 AcpiEnterSleepState (
332 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
333 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
339 ACPI_FUNCTION_TRACE ("AcpiEnterSleepState");
342 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
343 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
345 ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n",
346 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
347 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
350 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A);
351 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
353 /* Clear wake status */
355 Status = AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
356 if (ACPI_FAILURE (Status))
358 return_ACPI_STATUS (Status);
361 /* Clear all fixed and general purpose status bits */
363 Status = AcpiHwClearAcpiStatus (ACPI_MTX_DO_NOT_LOCK);
364 if (ACPI_FAILURE (Status))
366 return_ACPI_STATUS (Status);
369 if (SleepState != ACPI_STATE_S5)
371 /* Disable BM arbitration */
373 Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 1, ACPI_MTX_DO_NOT_LOCK);
374 if (ACPI_FAILURE (Status))
376 return_ACPI_STATUS (Status);
381 * 1) Disable/Clear all GPEs
382 * 2) Enable all wakeup GPEs
384 Status = AcpiHwDisableAllGpes (ACPI_ISR);
385 if (ACPI_FAILURE (Status))
387 return_ACPI_STATUS (Status);
389 AcpiGbl_SystemAwakeAndRunning = FALSE;
391 Status = AcpiHwEnableAllWakeupGpes (ACPI_ISR);
392 if (ACPI_FAILURE (Status))
394 return_ACPI_STATUS (Status);
397 /* Get current value of PM1A control */
399 Status = AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL, &PM1AControl);
400 if (ACPI_FAILURE (Status))
402 return_ACPI_STATUS (Status);
404 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Entering sleep state [S%d]\n", SleepState));
406 /* Clear SLP_EN and SLP_TYP fields */
408 PM1AControl &= ~(SleepTypeRegInfo->AccessBitMask | SleepEnableRegInfo->AccessBitMask);
409 PM1BControl = PM1AControl;
411 /* Insert SLP_TYP bits */
413 PM1AControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
414 PM1BControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
417 * We split the writes of SLP_TYP and SLP_EN to workaround
418 * poorly implemented hardware.
421 /* Write #1: fill in SLP_TYP data */
423 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
424 if (ACPI_FAILURE (Status))
426 return_ACPI_STATUS (Status);
429 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
430 if (ACPI_FAILURE (Status))
432 return_ACPI_STATUS (Status);
435 /* Insert SLP_ENABLE bit */
437 PM1AControl |= SleepEnableRegInfo->AccessBitMask;
438 PM1BControl |= SleepEnableRegInfo->AccessBitMask;
440 /* Write #2: SLP_TYP + SLP_EN */
442 ACPI_FLUSH_CPU_CACHE ();
444 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
445 if (ACPI_FAILURE (Status))
447 return_ACPI_STATUS (Status);
450 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
451 if (ACPI_FAILURE (Status))
453 return_ACPI_STATUS (Status);
456 if (SleepState > ACPI_STATE_S3)
459 * We wanted to sleep > S3, but it didn't happen (by virtue of the fact that
460 * we are still executing!)
462 * Wait ten seconds, then try again. This is to get S4/S5 to work on all machines.
464 * We wait so long to allow chipsets that poll this reg very slowly to
465 * still read the right value. Ideally, this block would go
468 AcpiOsStall (10000000);
470 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL,
471 SleepEnableRegInfo->AccessBitMask);
472 if (ACPI_FAILURE (Status))
474 return_ACPI_STATUS (Status);
478 /* Wait until we enter sleep state */
483 Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK);
484 if (ACPI_FAILURE (Status))
486 return_ACPI_STATUS (Status);
490 * Some BIOSs don't set WAK_STS at all. Give up waiting after
491 * 1000 retries if it still isn't set.
498 /* Spin until we wake */
502 return_ACPI_STATUS (AE_OK);
506 /******************************************************************************
508 * FUNCTION: AcpiEnterSleepStateS4bios
514 * DESCRIPTION: Perform a S4 bios request.
515 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
517 ******************************************************************************/
520 AcpiEnterSleepStateS4bios (
527 ACPI_FUNCTION_TRACE ("AcpiEnterSleepStateS4bios");
530 Status = AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
531 if (ACPI_FAILURE (Status))
533 return_ACPI_STATUS (Status);
536 Status = AcpiHwClearAcpiStatus (ACPI_MTX_DO_NOT_LOCK);
537 if (ACPI_FAILURE (Status))
539 return_ACPI_STATUS (Status);
543 * 1) Disable/Clear all GPEs
544 * 2) Enable all wakeup GPEs
546 Status = AcpiHwDisableAllGpes (ACPI_ISR);
547 if (ACPI_FAILURE (Status))
549 return_ACPI_STATUS (Status);
551 AcpiGbl_SystemAwakeAndRunning = FALSE;
553 Status = AcpiHwEnableAllWakeupGpes (ACPI_ISR);
554 if (ACPI_FAILURE (Status))
556 return_ACPI_STATUS (Status);
559 ACPI_FLUSH_CPU_CACHE ();
561 Status = AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, (UINT32) AcpiGbl_FADT->S4BiosReq, 8);
565 Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK);
566 if (ACPI_FAILURE (Status))
568 return_ACPI_STATUS (Status);
572 return_ACPI_STATUS (AE_OK);
576 /******************************************************************************
578 * FUNCTION: AcpiLeaveSleepState
580 * PARAMETERS: SleepState - Which sleep state we just exited
584 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
585 * Called with interrupts ENABLED.
587 ******************************************************************************/
590 AcpiLeaveSleepState (
593 ACPI_OBJECT_LIST ArgList;
596 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
597 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
602 ACPI_FUNCTION_TRACE ("AcpiLeaveSleepState");
606 * Set SLP_TYPE and SLP_EN to state S0.
607 * This is unclear from the ACPI Spec, but it is required
610 Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
611 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
612 if (ACPI_SUCCESS (Status))
614 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A);
615 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
617 /* Get current value of PM1A control */
619 Status = AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK,
620 ACPI_REGISTER_PM1_CONTROL, &PM1AControl);
621 if (ACPI_SUCCESS (Status))
623 /* Clear SLP_EN and SLP_TYP fields */
625 PM1AControl &= ~(SleepTypeRegInfo->AccessBitMask |
626 SleepEnableRegInfo->AccessBitMask);
627 PM1BControl = PM1AControl;
629 /* Insert SLP_TYP bits */
631 PM1AControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
632 PM1BControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
634 /* Just ignore any errors */
636 (void) AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK,
637 ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
638 (void) AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK,
639 ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
643 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
645 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
647 /* Setup parameter object */
650 ArgList.Pointer = &Arg;
651 Arg.Type = ACPI_TYPE_INTEGER;
653 /* Ignore any errors from these methods */
655 Arg.Integer.Value = ACPI_SST_WAKING;
656 Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
657 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
659 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status)));
662 Arg.Integer.Value = SleepState;
663 Status = AcpiEvaluateObject (NULL, METHOD_NAME__BFS, &ArgList, NULL);
664 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
666 ACPI_REPORT_ERROR (("Method _BFS failed, %s\n", AcpiFormatException (Status)));
669 Status = AcpiEvaluateObject (NULL, METHOD_NAME__WAK, &ArgList, NULL);
670 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
672 ACPI_REPORT_ERROR (("Method _WAK failed, %s\n", AcpiFormatException (Status)));
674 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
678 * 1) Disable/Clear all GPEs
679 * 2) Enable all runtime GPEs
681 Status = AcpiHwDisableAllGpes (ACPI_NOT_ISR);
682 if (ACPI_FAILURE (Status))
684 return_ACPI_STATUS (Status);
686 AcpiGbl_SystemAwakeAndRunning = TRUE;
688 Status = AcpiHwEnableAllRuntimeGpes (ACPI_NOT_ISR);
689 if (ACPI_FAILURE (Status))
691 return_ACPI_STATUS (Status);
694 /* Enable power button */
696 (void) AcpiSetRegister(AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
697 1, ACPI_MTX_DO_NOT_LOCK);
698 (void) AcpiSetRegister(AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
699 1, ACPI_MTX_DO_NOT_LOCK);
701 /* Enable BM arbitration */
703 Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 0, ACPI_MTX_LOCK);
704 if (ACPI_FAILURE (Status))
706 return_ACPI_STATUS (Status);
709 Arg.Integer.Value = ACPI_SST_WORKING;
710 Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
711 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
713 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status)));
716 return_ACPI_STATUS (Status);