hwsleep.c revision 209746
18813Srgallard
212442Smfang/******************************************************************************
312442Smfang *
412442Smfang * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
512442Smfang *
612442Smfang *****************************************************************************/
712442Smfang
812442Smfang/******************************************************************************
912442Smfang *
1012442Smfang * 1. Copyright Notice
1112442Smfang *
1212442Smfang * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
1312442Smfang * All rights reserved.
1412442Smfang *
1512442Smfang * 2. License
1612442Smfang *
1712442Smfang * 2.1. This is your license from Intel Corp. under its intellectual property
1812442Smfang * rights.  You may have additional license terms from the party that provided
1912442Smfang * you this software, covering your right to use that party's intellectual
2012442Smfang * property rights.
2112442Smfang *
2212442Smfang * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
238813Srgallard * copy of the source code appearing in this file ("Covered Code") an
248813Srgallard * irrevocable, perpetual, worldwide license under Intel's copyrights in the
258813Srgallard * base code distributed originally by Intel ("Original Intel Code") to copy,
268813Srgallard * make derivatives, distribute, use and display any portion of the Covered
278813Srgallard * Code in any form, with the right to sublicense such rights; and
288813Srgallard *
298813Srgallard * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
308813Srgallard * license (with the right to sublicense), under only those claims of Intel
3112442Smfang * patents that are infringed by the Original Intel Code, to make, use, sell,
3212442Smfang * offer to sell, and import the Covered Code and derivative works thereof
3312442Smfang * solely to the minimum extent necessary to exercise the above copyright
3412442Smfang * license, and in no event shall the patent license extend to any additions
3512442Smfang * to or modifications of the Original Intel Code.  No other license or right
3612442Smfang * is granted directly or by implication, estoppel or otherwise;
3712442Smfang *
3812442Smfang * The above copyright and patent license is granted only if the following
3912442Smfang * conditions are met:
4012442Smfang *
4112442Smfang * 3. Conditions
4212442Smfang *
4312442Smfang * 3.1. Redistribution of Source with Rights to Further Distribute Source.
4412442Smfang * Redistribution of source code of any substantial portion of the Covered
4512442Smfang * Code or modification with rights to further distribute source must include
4612442Smfang * the above Copyright Notice, the above License, this list of Conditions,
4712442Smfang * and the following Disclaimer and Export Compliance provision.  In addition,
4812442Smfang * Licensee must cause all Covered Code to which Licensee contributes to
4912442Smfang * contain a file documenting the changes Licensee made to create that Covered
505116Smichaelm * Code and the date of any change.  Licensee must include in that file the
518813Srgallard * documentation of any changes made by any predecessor Licensee.  Licensee
528813Srgallard * must include a prominent statement that the modification is derived,
538813Srgallard * directly or indirectly, from Original Intel Code.
548813Srgallard *
558813Srgallard * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
565116Smichaelm * Redistribution of source code of any substantial portion of the Covered
578813Srgallard * Code or modification without rights to further distribute source must
588813Srgallard * include the following Disclaimer and Export Compliance provision in the
598813Srgallard * documentation and/or other materials provided with distribution.  In
608813Srgallard * addition, Licensee may not authorize further sublicense of source of any
618813Srgallard * portion of the Covered Code, and must include terms to the effect that the
628813Srgallard * license from Licensee to its licensee is limited to the intellectual
638813Srgallard * property embodied in the software Licensee provides to its licensee, and
648813Srgallard * not to intellectual property embodied in modifications its licensee may
658813Srgallard * make.
668813Srgallard *
678813Srgallard * 3.3. Redistribution of Executable. Redistribution in executable form of any
688813Srgallard * substantial portion of the Covered Code or modification must reproduce the
698813Srgallard * above Copyright Notice, and the following Disclaimer and Export Compliance
708813Srgallard * provision in the documentation and/or other materials provided with the
718813Srgallard * distribution.
728813Srgallard *
738813Srgallard * 3.4. Intel retains all right, title, and interest in and to the Original
748813Srgallard * Intel Code.
758813Srgallard *
768813Srgallard * 3.5. Neither the name Intel nor any other trademark owned or controlled by
778813Srgallard * Intel shall be used in advertising or otherwise to promote the sale, use or
788813Srgallard * other dealings in products derived from or relating to the Covered Code
798813Srgallard * without prior written authorization from Intel.
808813Srgallard *
818813Srgallard * 4. Disclaimer and Export Compliance
828813Srgallard *
838813Srgallard * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
848813Srgallard * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
858813Srgallard * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
868813Srgallard * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
878813Srgallard * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
888813Srgallard * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
898813Srgallard * PARTICULAR PURPOSE.
908813Srgallard *
918813Srgallard * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
928813Srgallard * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
938813Srgallard * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
948813Srgallard * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
958813Srgallard * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
968813Srgallard * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
978813Srgallard * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
988813Srgallard * LIMITED REMEDY.
998813Srgallard *
1008813Srgallard * 4.3. Licensee shall not export, either directly or indirectly, any of this
1018813Srgallard * software or system incorporating such software without first obtaining any
1028813Srgallard * required license or other approval from the U. S. Department of Commerce or
1038813Srgallard * any other agency or department of the United States Government.  In the
1048813Srgallard * event Licensee exports any such software from the United States or
1055116Smichaelm * re-exports any such software from a foreign destination, Licensee shall
1068813Srgallard * ensure that the distribution and export/re-export of the software is in
1078813Srgallard * compliance with all laws, regulations, orders, or other restrictions of the
1088813Srgallard * U.S. Export Administration Regulations. Licensee agrees that neither it nor
1098813Srgallard * any of its subsidiaries will export/re-export any technical data, process,
1108813Srgallard * software, or service, directly or indirectly, to any country for which the
1118813Srgallard * United States government or any agency thereof requires an export license,
1128813Srgallard * other governmental approval, or letter of assurance, without first obtaining
1138813Srgallard * such license, approval or letter.
1148813Srgallard *
1158813Srgallard *****************************************************************************/
1168813Srgallard
1178813Srgallard#include <contrib/dev/acpica/include/acpi.h>
1188813Srgallard#include <contrib/dev/acpica/include/accommon.h>
1198813Srgallard
1208813Srgallard#define _COMPONENT          ACPI_HARDWARE
1215116Smichaelm        ACPI_MODULE_NAME    ("hwsleep")
1228813Srgallard
1238813Srgallard
1248813Srgallard/*******************************************************************************
1258813Srgallard *
1268813Srgallard * FUNCTION:    AcpiSetFirmwareWakingVector
1278813Srgallard *
1288813Srgallard * PARAMETERS:  PhysicalAddress     - 32-bit physical address of ACPI real mode
1298813Srgallard *                                    entry point.
1308813Srgallard *
1318813Srgallard * RETURN:      Status
1328813Srgallard *
1338813Srgallard * DESCRIPTION: Sets the 32-bit FirmwareWakingVector field of the FACS
1348813Srgallard *
1358813Srgallard ******************************************************************************/
1368813Srgallard
1378813SrgallardACPI_STATUS
1388813SrgallardAcpiSetFirmwareWakingVector (
1398813Srgallard    UINT32                  PhysicalAddress)
1408813Srgallard{
1418813Srgallard    ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
1428813Srgallard
1438813Srgallard
1448813Srgallard    /* Set the 32-bit vector */
1458813Srgallard
1468813Srgallard    AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress;
1478813Srgallard
1488813Srgallard    /* Clear the 64-bit vector if it exists */
1498813Srgallard
1508813Srgallard    if ((AcpiGbl_FACS->Length > 32) && (AcpiGbl_FACS->Version >= 1))
1518813Srgallard    {
1528813Srgallard        AcpiGbl_FACS->XFirmwareWakingVector = 0;
1538813Srgallard    }
1548813Srgallard
15512442Smfang    return_ACPI_STATUS (AE_OK);
15612442Smfang}
15712442Smfang
15812442SmfangACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector)
159
160
161#if ACPI_MACHINE_WIDTH == 64
162/*******************************************************************************
163 *
164 * FUNCTION:    AcpiSetFirmwareWakingVector64
165 *
166 * PARAMETERS:  PhysicalAddress     - 64-bit physical address of ACPI protected
167 *                                    mode entry point.
168 *
169 * RETURN:      Status
170 *
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.
174 *
175 ******************************************************************************/
176
177ACPI_STATUS
178AcpiSetFirmwareWakingVector64 (
179    UINT64                  PhysicalAddress)
180{
181    ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector64);
182
183
184    /* Determine if the 64-bit vector actually exists */
185
186    if ((AcpiGbl_FACS->Length <= 32) || (AcpiGbl_FACS->Version < 1))
187    {
188        return_ACPI_STATUS (AE_NOT_EXIST);
189    }
190
191    /* Clear 32-bit vector, set the 64-bit X_ vector */
192
193    AcpiGbl_FACS->FirmwareWakingVector = 0;
194    AcpiGbl_FACS->XFirmwareWakingVector = PhysicalAddress;
195    return_ACPI_STATUS (AE_OK);
196}
197
198ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector64)
199#endif
200
201/*******************************************************************************
202 *
203 * FUNCTION:    AcpiEnterSleepStatePrep
204 *
205 * PARAMETERS:  SleepState          - Which sleep state to enter
206 *
207 * RETURN:      Status
208 *
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.
213 *
214 ******************************************************************************/
215
216ACPI_STATUS
217AcpiEnterSleepStatePrep (
218    UINT8                   SleepState)
219{
220    ACPI_STATUS             Status;
221    ACPI_OBJECT_LIST        ArgList;
222    ACPI_OBJECT             Arg;
223
224
225    ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep);
226
227
228    /* _PSW methods could be run here to enable wake-on keyboard, LAN, etc. */
229
230    Status = AcpiGetSleepTypeData (SleepState,
231                    &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
232    if (ACPI_FAILURE (Status))
233    {
234        return_ACPI_STATUS (Status);
235    }
236
237    /* Execute the _PTS method (Prepare To Sleep) */
238
239    ArgList.Count = 1;
240    ArgList.Pointer = &Arg;
241    Arg.Type = ACPI_TYPE_INTEGER;
242    Arg.Integer.Value = SleepState;
243
244    Status = AcpiEvaluateObject (NULL, METHOD_NAME__PTS, &ArgList, NULL);
245    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
246    {
247        return_ACPI_STATUS (Status);
248    }
249
250    /* Setup the argument to the _SST method (System STatus) */
251
252    switch (SleepState)
253    {
254    case ACPI_STATE_S0:
255        Arg.Integer.Value = ACPI_SST_WORKING;
256        break;
257
258    case ACPI_STATE_S1:
259    case ACPI_STATE_S2:
260    case ACPI_STATE_S3:
261        Arg.Integer.Value = ACPI_SST_SLEEPING;
262        break;
263
264    case ACPI_STATE_S4:
265        Arg.Integer.Value = ACPI_SST_SLEEP_CONTEXT;
266        break;
267
268    default:
269        Arg.Integer.Value = ACPI_SST_INDICATOR_OFF; /* Default is off */
270        break;
271    }
272
273    /*
274     * Set the system indicators to show the desired sleep state.
275     * _SST is an optional method (return no error if not found)
276     */
277    Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
278    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
279    {
280        ACPI_EXCEPTION ((AE_INFO, Status, "While executing method _SST"));
281    }
282
283    return_ACPI_STATUS (AE_OK);
284}
285
286ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep)
287
288
289/*******************************************************************************
290 *
291 * FUNCTION:    AcpiEnterSleepState
292 *
293 * PARAMETERS:  SleepState          - Which sleep state to enter
294 *
295 * RETURN:      Status
296 *
297 * DESCRIPTION: Enter a system sleep state
298 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
299 *
300 ******************************************************************************/
301
302ACPI_STATUS
303AcpiEnterSleepState (
304    UINT8                   SleepState)
305{
306    UINT32                  Pm1aControl;
307    UINT32                  Pm1bControl;
308    ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
309    ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
310    UINT32                  InValue;
311    ACPI_OBJECT_LIST        ArgList;
312    ACPI_OBJECT             Arg;
313    UINT32                  Retry;
314    ACPI_STATUS             Status;
315
316
317    ACPI_FUNCTION_TRACE (AcpiEnterSleepState);
318
319
320    if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
321        (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
322    {
323        ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
324            AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
325        return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
326    }
327
328    SleepTypeRegInfo   = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
329    SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
330
331    /* Clear wake status */
332
333    Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
334    if (ACPI_FAILURE (Status))
335    {
336        return_ACPI_STATUS (Status);
337    }
338
339    /* Clear all fixed and general purpose status bits */
340
341    Status = AcpiHwClearAcpiStatus ();
342    if (ACPI_FAILURE (Status))
343    {
344        return_ACPI_STATUS (Status);
345    }
346
347    if (SleepState != ACPI_STATE_S5)
348    {
349        /*
350         * Disable BM arbitration. This feature is contained within an
351         * optional register (PM2 Control), so ignore a BAD_ADDRESS
352         * exception.
353         */
354        Status = AcpiWriteBitRegister (ACPI_BITREG_ARB_DISABLE, 1);
355        if (ACPI_FAILURE (Status) && (Status != AE_BAD_ADDRESS))
356        {
357            return_ACPI_STATUS (Status);
358        }
359    }
360
361    /*
362     * 1) Disable/Clear all GPEs
363     * 2) Enable all wakeup GPEs
364     */
365    Status = AcpiHwDisableAllGpes ();
366    if (ACPI_FAILURE (Status))
367    {
368        return_ACPI_STATUS (Status);
369    }
370    AcpiGbl_SystemAwakeAndRunning = FALSE;
371
372    Status = AcpiHwEnableAllWakeupGpes ();
373    if (ACPI_FAILURE (Status))
374    {
375        return_ACPI_STATUS (Status);
376    }
377
378    /* Execute the _GTS method (Going To Sleep) */
379
380    ArgList.Count = 1;
381    ArgList.Pointer = &Arg;
382    Arg.Type = ACPI_TYPE_INTEGER;
383    Arg.Integer.Value = SleepState;
384
385    Status = AcpiEvaluateObject (NULL, METHOD_NAME__GTS, &ArgList, NULL);
386    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
387    {
388        return_ACPI_STATUS (Status);
389    }
390
391    /* Get current value of PM1A control */
392
393    Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
394                &Pm1aControl);
395    if (ACPI_FAILURE (Status))
396    {
397        return_ACPI_STATUS (Status);
398    }
399    ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
400        "Entering sleep state [S%u]\n", SleepState));
401
402    /* Clear the SLP_EN and SLP_TYP fields */
403
404    Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
405                     SleepEnableRegInfo->AccessBitMask);
406    Pm1bControl = Pm1aControl;
407
408    /* Insert the SLP_TYP bits */
409
410    Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
411    Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
412
413    /*
414     * We split the writes of SLP_TYP and SLP_EN to workaround
415     * poorly implemented hardware.
416     */
417
418    /* Write #1: write the SLP_TYP data to the PM1 Control registers */
419
420    Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
421    if (ACPI_FAILURE (Status))
422    {
423        return_ACPI_STATUS (Status);
424    }
425
426    /* Insert the sleep enable (SLP_EN) bit */
427
428    Pm1aControl |= SleepEnableRegInfo->AccessBitMask;
429    Pm1bControl |= SleepEnableRegInfo->AccessBitMask;
430
431    /* Flush caches, as per ACPI specification */
432
433    ACPI_FLUSH_CPU_CACHE ();
434
435    /* Write #2: Write both SLP_TYP + SLP_EN */
436
437    Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
438    if (ACPI_FAILURE (Status))
439    {
440        return_ACPI_STATUS (Status);
441    }
442
443    if (SleepState > ACPI_STATE_S3)
444    {
445        /*
446         * We wanted to sleep > S3, but it didn't happen (by virtue of the
447         * fact that we are still executing!)
448         *
449         * Wait ten seconds, then try again. This is to get S4/S5 to work on
450         * all machines.
451         *
452         * We wait so long to allow chipsets that poll this reg very slowly
453         * to still read the right value. Ideally, this block would go
454         * away entirely.
455         */
456        AcpiOsStall (10000000);
457
458        Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL,
459                    SleepEnableRegInfo->AccessBitMask);
460        if (ACPI_FAILURE (Status))
461        {
462            return_ACPI_STATUS (Status);
463        }
464    }
465
466    /* Wait until we enter sleep state */
467
468    Retry = 1000;
469    do
470    {
471        Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
472        if (ACPI_FAILURE (Status))
473        {
474            return_ACPI_STATUS (Status);
475        }
476
477        if (AcpiGbl_EnableInterpreterSlack)
478        {
479            /*
480             * Some BIOSs don't set WAK_STS at all.  Give up waiting after
481             * 1000 retries if it still isn't set.
482             */
483            if (Retry-- == 0)
484            {
485                break;
486            }
487        }
488
489        /* Spin until we wake */
490
491    } while (!InValue);
492
493    return_ACPI_STATUS (AE_OK);
494}
495
496ACPI_EXPORT_SYMBOL (AcpiEnterSleepState)
497
498
499/*******************************************************************************
500 *
501 * FUNCTION:    AcpiEnterSleepStateS4bios
502 *
503 * PARAMETERS:  None
504 *
505 * RETURN:      Status
506 *
507 * DESCRIPTION: Perform a S4 bios request.
508 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
509 *
510 ******************************************************************************/
511
512ACPI_STATUS
513AcpiEnterSleepStateS4bios (
514    void)
515{
516    UINT32                  InValue;
517    ACPI_STATUS             Status;
518
519
520    ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios);
521
522
523    /* Clear the wake status bit (PM1) */
524
525    Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
526    if (ACPI_FAILURE (Status))
527    {
528        return_ACPI_STATUS (Status);
529    }
530
531    Status = AcpiHwClearAcpiStatus ();
532    if (ACPI_FAILURE (Status))
533    {
534        return_ACPI_STATUS (Status);
535    }
536
537    /*
538     * 1) Disable/Clear all GPEs
539     * 2) Enable all wakeup GPEs
540     */
541    Status = AcpiHwDisableAllGpes ();
542    if (ACPI_FAILURE (Status))
543    {
544        return_ACPI_STATUS (Status);
545    }
546    AcpiGbl_SystemAwakeAndRunning = FALSE;
547
548    Status = AcpiHwEnableAllWakeupGpes ();
549    if (ACPI_FAILURE (Status))
550    {
551        return_ACPI_STATUS (Status);
552    }
553
554    ACPI_FLUSH_CPU_CACHE ();
555
556    Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
557                (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
558
559    do {
560        AcpiOsStall(1000);
561        Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
562        if (ACPI_FAILURE (Status))
563        {
564            return_ACPI_STATUS (Status);
565        }
566    } while (!InValue);
567
568    return_ACPI_STATUS (AE_OK);
569}
570
571ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios)
572
573
574/*******************************************************************************
575 *
576 * FUNCTION:    AcpiLeaveSleepState
577 *
578 * PARAMETERS:  SleepState          - Which sleep state we just exited
579 *
580 * RETURN:      Status
581 *
582 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
583 *              Called with interrupts ENABLED.
584 *
585 ******************************************************************************/
586
587ACPI_STATUS
588AcpiLeaveSleepState (
589    UINT8                   SleepState)
590{
591    ACPI_OBJECT_LIST        ArgList;
592    ACPI_OBJECT             Arg;
593    ACPI_STATUS             Status;
594    ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
595    ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
596    UINT32                  Pm1aControl;
597    UINT32                  Pm1bControl;
598
599
600    ACPI_FUNCTION_TRACE (AcpiLeaveSleepState);
601
602
603    /*
604     * Set SLP_TYPE and SLP_EN to state S0.
605     * This is unclear from the ACPI Spec, but it is required
606     * by some machines.
607     */
608    Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
609                    &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
610    if (ACPI_SUCCESS (Status))
611    {
612        SleepTypeRegInfo =
613            AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
614        SleepEnableRegInfo =
615            AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
616
617        /* Get current value of PM1A control */
618
619        Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
620                    &Pm1aControl);
621        if (ACPI_SUCCESS (Status))
622        {
623            /* Clear the SLP_EN and SLP_TYP fields */
624
625            Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
626                SleepEnableRegInfo->AccessBitMask);
627            Pm1bControl = Pm1aControl;
628
629            /* Insert the SLP_TYP bits */
630
631            Pm1aControl |= (AcpiGbl_SleepTypeA <<
632                SleepTypeRegInfo->BitPosition);
633            Pm1bControl |= (AcpiGbl_SleepTypeB <<
634                SleepTypeRegInfo->BitPosition);
635
636            /* Write the control registers and ignore any errors */
637
638            (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
639        }
640    }
641
642    /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
643
644    AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
645
646    /* Setup parameter object */
647
648    ArgList.Count = 1;
649    ArgList.Pointer = &Arg;
650    Arg.Type = ACPI_TYPE_INTEGER;
651
652    /* Ignore any errors from these methods */
653
654    Arg.Integer.Value = ACPI_SST_WAKING;
655    Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
656    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
657    {
658        ACPI_EXCEPTION ((AE_INFO, Status, "During Method _SST"));
659    }
660
661    Arg.Integer.Value = SleepState;
662    Status = AcpiEvaluateObject (NULL, METHOD_NAME__BFS, &ArgList, NULL);
663    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
664    {
665        ACPI_EXCEPTION ((AE_INFO, Status, "During Method _BFS"));
666    }
667
668    Status = AcpiEvaluateObject (NULL, METHOD_NAME__WAK, &ArgList, NULL);
669    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
670    {
671        ACPI_EXCEPTION ((AE_INFO, Status, "During Method _WAK"));
672    }
673    /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
674
675    /*
676     * Restore the GPEs:
677     * 1) Disable/Clear all GPEs
678     * 2) Enable all runtime GPEs
679     */
680    Status = AcpiHwDisableAllGpes ();
681    if (ACPI_FAILURE (Status))
682    {
683        return_ACPI_STATUS (Status);
684    }
685    AcpiGbl_SystemAwakeAndRunning = TRUE;
686
687    Status = AcpiHwEnableAllRuntimeGpes ();
688    if (ACPI_FAILURE (Status))
689    {
690        return_ACPI_STATUS (Status);
691    }
692
693    /* Enable power button */
694
695    (void) AcpiWriteBitRegister(
696            AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
697            ACPI_ENABLE_EVENT);
698
699    (void) AcpiWriteBitRegister(
700            AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
701            ACPI_CLEAR_STATUS);
702
703    /*
704     * Enable BM arbitration. This feature is contained within an
705     * optional register (PM2 Control), so ignore a BAD_ADDRESS
706     * exception.
707     */
708    Status = AcpiWriteBitRegister (ACPI_BITREG_ARB_DISABLE, 0);
709    if (ACPI_FAILURE (Status) && (Status != AE_BAD_ADDRESS))
710    {
711        return_ACPI_STATUS (Status);
712    }
713
714    Arg.Integer.Value = ACPI_SST_WORKING;
715    Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
716    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
717    {
718        ACPI_EXCEPTION ((AE_INFO, Status, "During Method _SST"));
719    }
720
721    return_ACPI_STATUS (Status);
722}
723
724ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)
725
726