2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2011, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <contrib/dev/acpica/include/acpi.h>
46 #include <contrib/dev/acpica/include/accommon.h>
48 #define _COMPONENT ACPI_HARDWARE
49 ACPI_MODULE_NAME ("hwsleep")
52 /*******************************************************************************
54 * FUNCTION: AcpiSetFirmwareWakingVector
56 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
61 * DESCRIPTION: Sets the 32-bit FirmwareWakingVector field of the FACS
63 ******************************************************************************/
66 AcpiSetFirmwareWakingVector (
67 UINT32 PhysicalAddress)
69 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
72 /* Set the 32-bit vector */
74 AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress;
76 /* Clear the 64-bit vector if it exists */
78 if ((AcpiGbl_FACS->Length > 32) && (AcpiGbl_FACS->Version >= 1))
80 AcpiGbl_FACS->XFirmwareWakingVector = 0;
83 return_ACPI_STATUS (AE_OK);
86 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector)
89 #if ACPI_MACHINE_WIDTH == 64
90 /*******************************************************************************
92 * FUNCTION: AcpiSetFirmwareWakingVector64
94 * PARAMETERS: PhysicalAddress - 64-bit physical address of ACPI protected
99 * DESCRIPTION: Sets the 64-bit X_FirmwareWakingVector field of the FACS, if
100 * it exists in the table. This function is intended for use with
101 * 64-bit host operating systems.
103 ******************************************************************************/
106 AcpiSetFirmwareWakingVector64 (
107 UINT64 PhysicalAddress)
109 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector64);
112 /* Determine if the 64-bit vector actually exists */
114 if ((AcpiGbl_FACS->Length <= 32) || (AcpiGbl_FACS->Version < 1))
116 return_ACPI_STATUS (AE_NOT_EXIST);
119 /* Clear 32-bit vector, set the 64-bit X_ vector */
121 AcpiGbl_FACS->FirmwareWakingVector = 0;
122 AcpiGbl_FACS->XFirmwareWakingVector = PhysicalAddress;
123 return_ACPI_STATUS (AE_OK);
126 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector64)
129 /*******************************************************************************
131 * FUNCTION: AcpiEnterSleepStatePrep
133 * PARAMETERS: SleepState - Which sleep state to enter
137 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
138 * This function must execute with interrupts enabled.
139 * We break sleeping into 2 stages so that OSPM can handle
140 * various OS-specific tasks between the two steps.
142 ******************************************************************************/
145 AcpiEnterSleepStatePrep (
149 ACPI_OBJECT_LIST ArgList;
153 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep);
156 /* _PSW methods could be run here to enable wake-on keyboard, LAN, etc. */
158 Status = AcpiGetSleepTypeData (SleepState,
159 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
160 if (ACPI_FAILURE (Status))
162 return_ACPI_STATUS (Status);
165 /* Execute the _PTS method (Prepare To Sleep) */
168 ArgList.Pointer = &Arg;
169 Arg.Type = ACPI_TYPE_INTEGER;
170 Arg.Integer.Value = SleepState;
172 Status = AcpiEvaluateObject (NULL, METHOD_NAME__PTS, &ArgList, NULL);
173 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
175 return_ACPI_STATUS (Status);
178 /* Setup the argument to the _SST method (System STatus) */
183 Arg.Integer.Value = ACPI_SST_WORKING;
189 Arg.Integer.Value = ACPI_SST_SLEEPING;
193 Arg.Integer.Value = ACPI_SST_SLEEP_CONTEXT;
197 Arg.Integer.Value = ACPI_SST_INDICATOR_OFF; /* Default is off */
202 * Set the system indicators to show the desired sleep state.
203 * _SST is an optional method (return no error if not found)
205 Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
206 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
208 ACPI_EXCEPTION ((AE_INFO, Status, "While executing method _SST"));
211 return_ACPI_STATUS (AE_OK);
214 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep)
217 /*******************************************************************************
219 * FUNCTION: AcpiEnterSleepState
221 * PARAMETERS: SleepState - Which sleep state to enter
225 * DESCRIPTION: Enter a system sleep state
226 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
228 ******************************************************************************/
231 AcpiEnterSleepState (
236 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
237 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
239 ACPI_OBJECT_LIST ArgList;
245 ACPI_FUNCTION_TRACE (AcpiEnterSleepState);
248 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
249 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
251 ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
252 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
253 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
256 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
257 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
259 /* Clear wake status */
261 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
262 if (ACPI_FAILURE (Status))
264 return_ACPI_STATUS (Status);
267 /* Clear all fixed and general purpose status bits */
269 Status = AcpiHwClearAcpiStatus ();
270 if (ACPI_FAILURE (Status))
272 return_ACPI_STATUS (Status);
275 if (SleepState != ACPI_STATE_S5)
278 * Disable BM arbitration. This feature is contained within an
279 * optional register (PM2 Control), so ignore a BAD_ADDRESS
282 Status = AcpiWriteBitRegister (ACPI_BITREG_ARB_DISABLE, 1);
283 if (ACPI_FAILURE (Status) && (Status != AE_BAD_ADDRESS))
285 return_ACPI_STATUS (Status);
290 * 1) Disable/Clear all GPEs
291 * 2) Enable all wakeup GPEs
293 Status = AcpiHwDisableAllGpes ();
294 if (ACPI_FAILURE (Status))
296 return_ACPI_STATUS (Status);
298 AcpiGbl_SystemAwakeAndRunning = FALSE;
300 Status = AcpiHwEnableAllWakeupGpes ();
301 if (ACPI_FAILURE (Status))
303 return_ACPI_STATUS (Status);
306 /* Execute the _GTS method (Going To Sleep) */
309 ArgList.Pointer = &Arg;
310 Arg.Type = ACPI_TYPE_INTEGER;
311 Arg.Integer.Value = SleepState;
313 Status = AcpiEvaluateObject (NULL, METHOD_NAME__GTS, &ArgList, NULL);
314 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
316 return_ACPI_STATUS (Status);
319 /* Get current value of PM1A control */
321 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
323 if (ACPI_FAILURE (Status))
325 return_ACPI_STATUS (Status);
327 ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
328 "Entering sleep state [S%u]\n", SleepState));
330 /* Clear the SLP_EN and SLP_TYP fields */
332 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
333 SleepEnableRegInfo->AccessBitMask);
334 Pm1bControl = Pm1aControl;
336 /* Insert the SLP_TYP bits */
338 Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
339 Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
342 * We split the writes of SLP_TYP and SLP_EN to workaround
343 * poorly implemented hardware.
346 /* Write #1: write the SLP_TYP data to the PM1 Control registers */
348 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
349 if (ACPI_FAILURE (Status))
351 return_ACPI_STATUS (Status);
354 /* Insert the sleep enable (SLP_EN) bit */
356 Pm1aControl |= SleepEnableRegInfo->AccessBitMask;
357 Pm1bControl |= SleepEnableRegInfo->AccessBitMask;
359 /* Flush caches, as per ACPI specification */
361 ACPI_FLUSH_CPU_CACHE ();
363 /* Write #2: Write both SLP_TYP + SLP_EN */
365 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
366 if (ACPI_FAILURE (Status))
368 return_ACPI_STATUS (Status);
371 if (SleepState > ACPI_STATE_S3)
374 * We wanted to sleep > S3, but it didn't happen (by virtue of the
375 * fact that we are still executing!)
377 * Wait ten seconds, then try again. This is to get S4/S5 to work on
380 * We wait so long to allow chipsets that poll this reg very slowly
381 * to still read the right value. Ideally, this block would go
384 AcpiOsStall (10000000);
386 Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL,
387 SleepEnableRegInfo->AccessBitMask);
388 if (ACPI_FAILURE (Status))
390 return_ACPI_STATUS (Status);
394 /* Wait until we enter sleep state */
399 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
400 if (ACPI_FAILURE (Status))
402 return_ACPI_STATUS (Status);
405 if (AcpiGbl_EnableInterpreterSlack)
408 * Some BIOSs don't set WAK_STS at all. Give up waiting after
409 * 1000 retries if it still isn't set.
417 /* Spin until we wake */
421 return_ACPI_STATUS (AE_OK);
424 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState)
427 /*******************************************************************************
429 * FUNCTION: AcpiEnterSleepStateS4bios
435 * DESCRIPTION: Perform a S4 bios request.
436 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
438 ******************************************************************************/
441 AcpiEnterSleepStateS4bios (
448 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios);
451 /* Clear the wake status bit (PM1) */
453 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
454 if (ACPI_FAILURE (Status))
456 return_ACPI_STATUS (Status);
459 Status = AcpiHwClearAcpiStatus ();
460 if (ACPI_FAILURE (Status))
462 return_ACPI_STATUS (Status);
466 * 1) Disable/Clear all GPEs
467 * 2) Enable all wakeup GPEs
469 Status = AcpiHwDisableAllGpes ();
470 if (ACPI_FAILURE (Status))
472 return_ACPI_STATUS (Status);
474 AcpiGbl_SystemAwakeAndRunning = FALSE;
476 Status = AcpiHwEnableAllWakeupGpes ();
477 if (ACPI_FAILURE (Status))
479 return_ACPI_STATUS (Status);
482 ACPI_FLUSH_CPU_CACHE ();
484 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
485 (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
489 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
490 if (ACPI_FAILURE (Status))
492 return_ACPI_STATUS (Status);
496 return_ACPI_STATUS (AE_OK);
499 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios)
502 /*******************************************************************************
504 * FUNCTION: AcpiLeaveSleepState
506 * PARAMETERS: SleepState - Which sleep state we just exited
510 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
511 * Called with interrupts ENABLED.
513 ******************************************************************************/
516 AcpiLeaveSleepState (
519 ACPI_OBJECT_LIST ArgList;
522 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
523 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
528 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState);
532 * Set SLP_TYPE and SLP_EN to state S0.
533 * This is unclear from the ACPI Spec, but it is required
536 Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
537 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
538 if (ACPI_SUCCESS (Status))
541 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
543 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
545 /* Get current value of PM1A control */
547 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
549 if (ACPI_SUCCESS (Status))
551 /* Clear the SLP_EN and SLP_TYP fields */
553 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
554 SleepEnableRegInfo->AccessBitMask);
555 Pm1bControl = Pm1aControl;
557 /* Insert the SLP_TYP bits */
559 Pm1aControl |= (AcpiGbl_SleepTypeA <<
560 SleepTypeRegInfo->BitPosition);
561 Pm1bControl |= (AcpiGbl_SleepTypeB <<
562 SleepTypeRegInfo->BitPosition);
564 /* Write the control registers and ignore any errors */
566 (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
570 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
572 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
574 /* Setup parameter object */
577 ArgList.Pointer = &Arg;
578 Arg.Type = ACPI_TYPE_INTEGER;
580 /* Ignore any errors from these methods */
582 Arg.Integer.Value = ACPI_SST_WAKING;
583 Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
584 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
586 ACPI_EXCEPTION ((AE_INFO, Status, "During Method _SST"));
589 Arg.Integer.Value = SleepState;
590 Status = AcpiEvaluateObject (NULL, METHOD_NAME__BFS, &ArgList, NULL);
591 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
593 ACPI_EXCEPTION ((AE_INFO, Status, "During Method _BFS"));
596 Status = AcpiEvaluateObject (NULL, METHOD_NAME__WAK, &ArgList, NULL);
597 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
599 ACPI_EXCEPTION ((AE_INFO, Status, "During Method _WAK"));
601 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
605 * 1) Disable/Clear all GPEs
606 * 2) Enable all runtime GPEs
608 Status = AcpiHwDisableAllGpes ();
609 if (ACPI_FAILURE (Status))
611 return_ACPI_STATUS (Status);
613 AcpiGbl_SystemAwakeAndRunning = TRUE;
615 Status = AcpiHwEnableAllRuntimeGpes ();
616 if (ACPI_FAILURE (Status))
618 return_ACPI_STATUS (Status);
621 /* Enable power button */
623 (void) AcpiWriteBitRegister(
624 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
627 (void) AcpiWriteBitRegister(
628 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
632 * Enable BM arbitration. This feature is contained within an
633 * optional register (PM2 Control), so ignore a BAD_ADDRESS
636 Status = AcpiWriteBitRegister (ACPI_BITREG_ARB_DISABLE, 0);
637 if (ACPI_FAILURE (Status) && (Status != AE_BAD_ADDRESS))
639 return_ACPI_STATUS (Status);
642 Arg.Integer.Value = ACPI_SST_WORKING;
643 Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
644 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
646 ACPI_EXCEPTION ((AE_INFO, Status, "During Method _SST"));
649 return_ACPI_STATUS (Status);
652 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)