hwsleep.c revision 151600
195212Sbde
264880Sphk/******************************************************************************
364880Sphk *
464880Sphk * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
564880Sphk *              $Revision: 70 $
6100206Sdd *
7100206Sdd *****************************************************************************/
864880Sphk
964880Sphk/******************************************************************************
1064880Sphk *
1164880Sphk * 1. Copyright Notice
1264880Sphk *
1364880Sphk * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
1464880Sphk * All rights reserved.
1564880Sphk *
1664880Sphk * 2. License
1764880Sphk *
1864880Sphk * 2.1. This is your license from Intel Corp. under its intellectual property
1964880Sphk * rights.  You may have additional license terms from the party that provided
2064880Sphk * you this software, covering your right to use that party's intellectual
2164880Sphk * property rights.
2264880Sphk *
2364880Sphk * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
2464880Sphk * copy of the source code appearing in this file ("Covered Code") an
2564880Sphk * irrevocable, perpetual, worldwide license under Intel's copyrights in the
2664880Sphk * base code distributed originally by Intel ("Original Intel Code") to copy,
2764880Sphk * make derivatives, distribute, use and display any portion of the Covered
2864880Sphk * Code in any form, with the right to sublicense such rights; and
2964880Sphk *
3064880Sphk * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
3164880Sphk * license (with the right to sublicense), under only those claims of Intel
3264880Sphk * patents that are infringed by the Original Intel Code, to make, use, sell,
3364880Sphk * offer to sell, and import the Covered Code and derivative works thereof
3464880Sphk * solely to the minimum extent necessary to exercise the above copyright
3564880Sphk * license, and in no event shall the patent license extend to any additions
3664880Sphk * to or modifications of the Original Intel Code.  No other license or right
3764880Sphk * is granted directly or by implication, estoppel or otherwise;
3864880Sphk *
3965515Sphk * The above copyright and patent license is granted only if the following
4095212Sbde * conditions are met:
4164880Sphk *
42100206Sdd * 3. Conditions
4364880Sphk *
4465515Sphk * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45100206Sdd * Redistribution of source code of any substantial portion of the Covered
46100206Sdd * Code or modification with rights to further distribute source must include
47100206Sdd * the above Copyright Notice, the above License, this list of Conditions,
48100206Sdd * and the following Disclaimer and Export Compliance provision.  In addition,
49100206Sdd * Licensee must cause all Covered Code to which Licensee contributes to
50100206Sdd * contain a file documenting the changes Licensee made to create that Covered
51100206Sdd * Code and the date of any change.  Licensee must include in that file the
52100206Sdd * documentation of any changes made by any predecessor Licensee.  Licensee
53100206Sdd * must include a prominent statement that the modification is derived,
54100206Sdd * directly or indirectly, from Original Intel Code.
55100206Sdd *
56100206Sdd * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57100206Sdd * Redistribution of source code of any substantial portion of the Covered
58100206Sdd * Code or modification without rights to further distribute source must
59100206Sdd * include the following Disclaimer and Export Compliance provision in the
60100206Sdd * documentation and/or other materials provided with distribution.  In
61100206Sdd * addition, Licensee may not authorize further sublicense of source of any
62100206Sdd * portion of the Covered Code, and must include terms to the effect that the
63100206Sdd * license from Licensee to its licensee is limited to the intellectual
64100206Sdd * property embodied in the software Licensee provides to its licensee, and
65100206Sdd * not to intellectual property embodied in modifications its licensee may
66100206Sdd * make.
67100206Sdd *
68100206Sdd * 3.3. Redistribution of Executable. Redistribution in executable form of any
69100206Sdd * substantial portion of the Covered Code or modification must reproduce the
70100206Sdd * above Copyright Notice, and the following Disclaimer and Export Compliance
71100206Sdd * provision in the documentation and/or other materials provided with the
72100206Sdd * distribution.
73100206Sdd *
74100206Sdd * 3.4. Intel retains all right, title, and interest in and to the Original
75100206Sdd * Intel Code.
76100206Sdd *
77100206Sdd * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78100206Sdd * Intel shall be used in advertising or otherwise to promote the sale, use or
79100206Sdd * other dealings in products derived from or relating to the Covered Code
80100206Sdd * without prior written authorization from Intel.
81100206Sdd *
82100206Sdd * 4. Disclaimer and Export Compliance
83100206Sdd *
84100206Sdd * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85100206Sdd * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86100206Sdd * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
87100206Sdd * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
88100206Sdd * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89100206Sdd * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90100206Sdd * PARTICULAR PURPOSE.
91100206Sdd *
92100206Sdd * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93100804Sdd * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94100206Sdd * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95100206Sdd * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96100206Sdd * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97100206Sdd * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98100206Sdd * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99100206Sdd * LIMITED REMEDY.
100100206Sdd *
101100206Sdd * 4.3. Licensee shall not export, either directly or indirectly, any of this
102100206Sdd * software or system incorporating such software without first obtaining any
103100206Sdd * required license or other approval from the U. S. Department of Commerce or
104100206Sdd * any other agency or department of the United States Government.  In the
105100206Sdd * event Licensee exports any such software from the United States or
106100206Sdd * re-exports any such software from a foreign destination, Licensee shall
107100206Sdd * ensure that the distribution and export/re-export of the software is in
108100206Sdd * compliance with all laws, regulations, orders, or other restrictions of the
109100206Sdd * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110100206Sdd * any of its subsidiaries will export/re-export any technical data, process,
111100206Sdd * software, or service, directly or indirectly, to any country for which the
112100206Sdd * United States government or any agency thereof requires an export license,
113100206Sdd * other governmental approval, or letter of assurance, without first obtaining
114100206Sdd * such license, approval or letter.
115100206Sdd *
116100206Sdd *****************************************************************************/
117100206Sdd
118100206Sdd#include <contrib/dev/acpica/acpi.h>
119100206Sdd
120100206Sdd#define _COMPONENT          ACPI_HARDWARE
121100206Sdd        ACPI_MODULE_NAME    ("hwsleep")
122100206Sdd
123100206Sdd
12465515Sphk#define METHOD_NAME__BFS        "\\_BFS"
12565515Sphk#define METHOD_NAME__GTS        "\\_GTS"
12665515Sphk#define METHOD_NAME__PTS        "\\_PTS"
12765515Sphk#define METHOD_NAME__SST        "\\_SI._SST"
12865515Sphk#define METHOD_NAME__WAK        "\\_WAK"
12965515Sphk
13065515Sphk#define ACPI_SST_INDICATOR_OFF  0
13165515Sphk#define ACPI_SST_WORKING        1
13264880Sphk#define ACPI_SST_WAKING         2
13365515Sphk#define ACPI_SST_SLEEPING       3
13465515Sphk#define ACPI_SST_SLEEP_CONTEXT  4
13565515Sphk
13665515Sphk
13765515Sphk/******************************************************************************
13865515Sphk *
13965515Sphk * FUNCTION:    AcpiSetFirmwareWakingVector
14065515Sphk *
14165515Sphk * PARAMETERS:  PhysicalAddress     - Physical address of ACPI real mode
14265515Sphk *                                    entry point.
14365515Sphk *
14495212Sbde * RETURN:      Status
14564880Sphk *
14695212Sbde * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS
14764880Sphk *
14864880Sphk ******************************************************************************/
14964880Sphk
15065051SphkACPI_STATUS
15177050SphkAcpiSetFirmwareWakingVector (
15265051Sphk    ACPI_PHYSICAL_ADDRESS PhysicalAddress)
15365051Sphk{
15464880Sphk
15564880Sphk    ACPI_FUNCTION_TRACE ("AcpiSetFirmwareWakingVector");
15665051Sphk
15765051Sphk
15865051Sphk    /* Set the vector */
15964880Sphk
16064880Sphk    if (AcpiGbl_CommonFACS.VectorWidth == 32)
16164880Sphk    {
16264880Sphk        *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector))
16364880Sphk                = (UINT32) PhysicalAddress;
16464880Sphk    }
16564880Sphk    else
16664880Sphk    {
16764880Sphk        *AcpiGbl_CommonFACS.FirmwareWakingVector
16864880Sphk                = PhysicalAddress;
16964880Sphk    }
17064880Sphk
17165051Sphk    return_ACPI_STATUS (AE_OK);
17265051Sphk}
17364880Sphk
17465515Sphk
17565515Sphk/******************************************************************************
17664880Sphk *
17765515Sphk * FUNCTION:    AcpiGetFirmwareWakingVector
178100206Sdd *
17964880Sphk * PARAMETERS:  *PhysicalAddress    - Output buffer where contents of
18064880Sphk *                                    the FirmwareWakingVector field of
18165515Sphk *                                    the FACS will be stored.
18265515Sphk *
18365515Sphk * RETURN:      Status
18465515Sphk *
18564880Sphk * DESCRIPTION: Access function for FirmwareWakingVector field in FACS
18664880Sphk *
18764880Sphk ******************************************************************************/
18864880Sphk
18964880SphkACPI_STATUS
19065051SphkAcpiGetFirmwareWakingVector (
191100206Sdd    ACPI_PHYSICAL_ADDRESS *PhysicalAddress)
192100206Sdd{
193100206Sdd
194100206Sdd    ACPI_FUNCTION_TRACE ("AcpiGetFirmwareWakingVector");
19583366Sjulian
19665515Sphk
19765515Sphk    if (!PhysicalAddress)
19865515Sphk    {
19965515Sphk        return_ACPI_STATUS (AE_BAD_PARAMETER);
20065515Sphk    }
20165515Sphk
20265515Sphk    /* Get the vector */
20364880Sphk
20495212Sbde    if (AcpiGbl_CommonFACS.VectorWidth == 32)
20595212Sbde    {
206        *PhysicalAddress = (ACPI_PHYSICAL_ADDRESS)
207            *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector));
208    }
209    else
210    {
211        *PhysicalAddress =
212            *AcpiGbl_CommonFACS.FirmwareWakingVector;
213    }
214
215    return_ACPI_STATUS (AE_OK);
216}
217
218
219/******************************************************************************
220 *
221 * FUNCTION:    AcpiEnterSleepStatePrep
222 *
223 * PARAMETERS:  SleepState          - Which sleep state to enter
224 *
225 * RETURN:      Status
226 *
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.
231 *
232 ******************************************************************************/
233
234ACPI_STATUS
235AcpiEnterSleepStatePrep (
236    UINT8               SleepState)
237{
238    ACPI_STATUS         Status;
239    ACPI_OBJECT_LIST    ArgList;
240    ACPI_OBJECT         Arg;
241
242
243    ACPI_FUNCTION_TRACE ("AcpiEnterSleepStatePrep");
244
245
246    /*
247     * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
248     */
249    Status = AcpiGetSleepTypeData (SleepState,
250                    &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
251    if (ACPI_FAILURE (Status))
252    {
253        return_ACPI_STATUS (Status);
254    }
255
256    /* Setup parameter object */
257
258    ArgList.Count = 1;
259    ArgList.Pointer = &Arg;
260
261    Arg.Type = ACPI_TYPE_INTEGER;
262    Arg.Integer.Value = SleepState;
263
264    /* Run the _PTS and _GTS methods */
265
266    Status = AcpiEvaluateObject (NULL, METHOD_NAME__PTS, &ArgList, NULL);
267    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
268    {
269        return_ACPI_STATUS (Status);
270    }
271
272    Status = AcpiEvaluateObject (NULL, METHOD_NAME__GTS, &ArgList, NULL);
273    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
274    {
275        return_ACPI_STATUS (Status);
276    }
277
278    /* Setup the argument to _SST */
279
280    switch (SleepState)
281    {
282    case ACPI_STATE_S0:
283        Arg.Integer.Value = ACPI_SST_WORKING;
284        break;
285
286    case ACPI_STATE_S1:
287    case ACPI_STATE_S2:
288    case ACPI_STATE_S3:
289        Arg.Integer.Value = ACPI_SST_SLEEPING;
290        break;
291
292    case ACPI_STATE_S4:
293        Arg.Integer.Value = ACPI_SST_SLEEP_CONTEXT;
294        break;
295
296    default:
297        Arg.Integer.Value = ACPI_SST_INDICATOR_OFF; /* Default is indicator off */
298        break;
299    }
300
301    /* Set the system indicators to show the desired sleep state. */
302
303    Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
304    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
305    {
306         ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status)));
307    }
308
309    return_ACPI_STATUS (AE_OK);
310}
311
312
313/******************************************************************************
314 *
315 * FUNCTION:    AcpiEnterSleepState
316 *
317 * PARAMETERS:  SleepState          - Which sleep state to enter
318 *
319 * RETURN:      Status
320 *
321 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
322 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
323 *
324 ******************************************************************************/
325
326ACPI_STATUS
327AcpiEnterSleepState (
328    UINT8                   SleepState)
329{
330    UINT32                  PM1AControl;
331    UINT32                  PM1BControl;
332    ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
333    ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
334    UINT32                  InValue;
335    ACPI_STATUS             Status;
336
337
338    ACPI_FUNCTION_TRACE ("AcpiEnterSleepState");
339
340
341    if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
342        (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
343    {
344        ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n",
345            AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
346        return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
347    }
348
349    SleepTypeRegInfo   = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A);
350    SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
351
352    /* Clear wake status */
353
354    Status = AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
355    if (ACPI_FAILURE (Status))
356    {
357        return_ACPI_STATUS (Status);
358    }
359
360    /* Clear all fixed and general purpose status bits */
361
362    Status = AcpiHwClearAcpiStatus (ACPI_MTX_DO_NOT_LOCK);
363    if (ACPI_FAILURE (Status))
364    {
365        return_ACPI_STATUS (Status);
366    }
367
368    if (SleepState != ACPI_STATE_S5)
369    {
370        /* Disable BM arbitration */
371
372        Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 1, ACPI_MTX_DO_NOT_LOCK);
373        if (ACPI_FAILURE (Status))
374        {
375            return_ACPI_STATUS (Status);
376        }
377    }
378
379    /*
380     * 1) Disable/Clear all GPEs
381     * 2) Enable all wakeup GPEs
382     */
383    Status = AcpiHwDisableAllGpes (ACPI_ISR);
384    if (ACPI_FAILURE (Status))
385    {
386        return_ACPI_STATUS (Status);
387    }
388    AcpiGbl_SystemAwakeAndRunning = FALSE;
389
390    Status = AcpiHwEnableAllWakeupGpes (ACPI_ISR);
391    if (ACPI_FAILURE (Status))
392    {
393        return_ACPI_STATUS (Status);
394    }
395
396    /* Get current value of PM1A control */
397
398    Status = AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL, &PM1AControl);
399    if (ACPI_FAILURE (Status))
400    {
401        return_ACPI_STATUS (Status);
402    }
403    ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Entering sleep state [S%d]\n", SleepState));
404
405    /* Clear SLP_EN and SLP_TYP fields */
406
407    PM1AControl &= ~(SleepTypeRegInfo->AccessBitMask | SleepEnableRegInfo->AccessBitMask);
408    PM1BControl = PM1AControl;
409
410    /* Insert SLP_TYP bits */
411
412    PM1AControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
413    PM1BControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
414
415    /*
416     * We split the writes of SLP_TYP and SLP_EN to workaround
417     * poorly implemented hardware.
418     */
419
420    /* Write #1: fill in SLP_TYP data */
421
422    Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
423    if (ACPI_FAILURE (Status))
424    {
425        return_ACPI_STATUS (Status);
426    }
427
428    Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
429    if (ACPI_FAILURE (Status))
430    {
431        return_ACPI_STATUS (Status);
432    }
433
434    /* Insert SLP_ENABLE bit */
435
436    PM1AControl |= SleepEnableRegInfo->AccessBitMask;
437    PM1BControl |= SleepEnableRegInfo->AccessBitMask;
438
439    /* Write #2: SLP_TYP + SLP_EN */
440
441    ACPI_FLUSH_CPU_CACHE ();
442
443    Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
444    if (ACPI_FAILURE (Status))
445    {
446        return_ACPI_STATUS (Status);
447    }
448
449    Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
450    if (ACPI_FAILURE (Status))
451    {
452        return_ACPI_STATUS (Status);
453    }
454
455    if (SleepState > ACPI_STATE_S3)
456    {
457        /*
458         * We wanted to sleep > S3, but it didn't happen (by virtue of the fact that
459         * we are still executing!)
460         *
461         * Wait ten seconds, then try again. This is to get S4/S5 to work on all machines.
462         *
463         * We wait so long to allow chipsets that poll this reg very slowly to
464         * still read the right value. Ideally, this block would go
465         * away entirely.
466         */
467        AcpiOsStall (10000000);
468
469        Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL,
470                    SleepEnableRegInfo->AccessBitMask);
471        if (ACPI_FAILURE (Status))
472        {
473            return_ACPI_STATUS (Status);
474        }
475    }
476
477    /* Wait until we enter sleep state */
478
479    do
480    {
481        Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK);
482        if (ACPI_FAILURE (Status))
483        {
484            return_ACPI_STATUS (Status);
485        }
486
487        /* Spin until we wake */
488
489    } while (!InValue);
490
491    return_ACPI_STATUS (AE_OK);
492}
493
494
495/******************************************************************************
496 *
497 * FUNCTION:    AcpiEnterSleepStateS4bios
498 *
499 * PARAMETERS:  None
500 *
501 * RETURN:      Status
502 *
503 * DESCRIPTION: Perform a S4 bios request.
504 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
505 *
506 ******************************************************************************/
507
508ACPI_STATUS
509AcpiEnterSleepStateS4bios (
510    void)
511{
512    UINT32                  InValue;
513    ACPI_STATUS             Status;
514
515
516    ACPI_FUNCTION_TRACE ("AcpiEnterSleepStateS4bios");
517
518
519    Status = AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
520    if (ACPI_FAILURE (Status))
521    {
522        return_ACPI_STATUS (Status);
523    }
524
525    Status = AcpiHwClearAcpiStatus (ACPI_MTX_DO_NOT_LOCK);
526    if (ACPI_FAILURE (Status))
527    {
528        return_ACPI_STATUS (Status);
529    }
530
531    /*
532     * 1) Disable/Clear all GPEs
533     * 2) Enable all wakeup GPEs
534     */
535    Status = AcpiHwDisableAllGpes (ACPI_ISR);
536    if (ACPI_FAILURE (Status))
537    {
538        return_ACPI_STATUS (Status);
539    }
540    AcpiGbl_SystemAwakeAndRunning = FALSE;
541
542    Status = AcpiHwEnableAllWakeupGpes (ACPI_ISR);
543    if (ACPI_FAILURE (Status))
544    {
545        return_ACPI_STATUS (Status);
546    }
547
548    ACPI_FLUSH_CPU_CACHE ();
549
550    Status = AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, (UINT32) AcpiGbl_FADT->S4BiosReq, 8);
551
552    do {
553        AcpiOsStall(1000);
554        Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK);
555        if (ACPI_FAILURE (Status))
556        {
557            return_ACPI_STATUS (Status);
558        }
559    } while (!InValue);
560
561    return_ACPI_STATUS (AE_OK);
562}
563
564
565/******************************************************************************
566 *
567 * FUNCTION:    AcpiLeaveSleepState
568 *
569 * PARAMETERS:  SleepState          - Which sleep state we just exited
570 *
571 * RETURN:      Status
572 *
573 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
574 *              Called with interrupts ENABLED.
575 *
576 ******************************************************************************/
577
578ACPI_STATUS
579AcpiLeaveSleepState (
580    UINT8                   SleepState)
581{
582    ACPI_OBJECT_LIST        ArgList;
583    ACPI_OBJECT             Arg;
584    ACPI_STATUS             Status;
585    ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
586    ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
587    UINT32                  PM1AControl;
588    UINT32                  PM1BControl;
589
590
591    ACPI_FUNCTION_TRACE ("AcpiLeaveSleepState");
592
593
594    /*
595     * Set SLP_TYPE and SLP_EN to state S0.
596     * This is unclear from the ACPI Spec, but it is required
597     * by some machines.
598     */
599    Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
600                    &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
601    if (ACPI_SUCCESS (Status))
602    {
603        SleepTypeRegInfo   = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A);
604        SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
605
606        /* Get current value of PM1A control */
607
608        Status = AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK,
609                    ACPI_REGISTER_PM1_CONTROL, &PM1AControl);
610        if (ACPI_SUCCESS (Status))
611        {
612            /* Clear SLP_EN and SLP_TYP fields */
613
614            PM1AControl &= ~(SleepTypeRegInfo->AccessBitMask |
615                             SleepEnableRegInfo->AccessBitMask);
616            PM1BControl = PM1AControl;
617
618            /* Insert SLP_TYP bits */
619
620            PM1AControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
621            PM1BControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
622
623            /* Just ignore any errors */
624
625            (void) AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK,
626                            ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
627            (void) AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK,
628                            ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
629        }
630    }
631
632    /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
633
634    AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
635
636    /* Setup parameter object */
637
638    ArgList.Count = 1;
639    ArgList.Pointer = &Arg;
640    Arg.Type = ACPI_TYPE_INTEGER;
641
642    /* Ignore any errors from these methods */
643
644    Arg.Integer.Value = ACPI_SST_WAKING;
645    Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
646    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
647    {
648        ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status)));
649    }
650
651    Arg.Integer.Value = SleepState;
652    Status = AcpiEvaluateObject (NULL, METHOD_NAME__BFS, &ArgList, NULL);
653    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
654    {
655        ACPI_REPORT_ERROR (("Method _BFS failed, %s\n", AcpiFormatException (Status)));
656    }
657
658    Status = AcpiEvaluateObject (NULL, METHOD_NAME__WAK, &ArgList, NULL);
659    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
660    {
661        ACPI_REPORT_ERROR (("Method _WAK failed, %s\n", AcpiFormatException (Status)));
662    }
663    /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
664
665    /*
666     * Restore the GPEs:
667     * 1) Disable/Clear all GPEs
668     * 2) Enable all runtime GPEs
669     */
670    Status = AcpiHwDisableAllGpes (ACPI_NOT_ISR);
671    if (ACPI_FAILURE (Status))
672    {
673        return_ACPI_STATUS (Status);
674    }
675    AcpiGbl_SystemAwakeAndRunning = TRUE;
676
677    Status = AcpiHwEnableAllRuntimeGpes (ACPI_NOT_ISR);
678    if (ACPI_FAILURE (Status))
679    {
680        return_ACPI_STATUS (Status);
681    }
682
683    /* Enable power button */
684
685    (void) AcpiSetRegister(AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
686            1, ACPI_MTX_DO_NOT_LOCK);
687    (void) AcpiSetRegister(AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
688            1, ACPI_MTX_DO_NOT_LOCK);
689
690    /* Enable BM arbitration */
691
692    Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 0, ACPI_MTX_LOCK);
693    if (ACPI_FAILURE (Status))
694    {
695        return_ACPI_STATUS (Status);
696    }
697
698    Arg.Integer.Value = ACPI_SST_WORKING;
699    Status = AcpiEvaluateObject (NULL, METHOD_NAME__SST, &ArgList, NULL);
700    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
701    {
702        ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status)));
703    }
704
705    return_ACPI_STATUS (Status);
706}
707