sys/contrib/dev/acpica/hardware/hwsleep.c

   1
   2 /******************************************************************************
   3  *
   4  * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  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
  20  * property rights.
  21  *
  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
  28  *
  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;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  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.
  54  *
  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
  65  * make.
  66  *
  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
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  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.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  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
  89  * PARTICULAR PURPOSE.
  90  *
  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
  98  * LIMITED REMEDY.
  99  *
 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.
 114  *
 115  *****************************************************************************/
 116
 117 #include <contrib/dev/acpica/include/acpi.h>
 118 #include <contrib/dev/acpica/include/accommon.h>
 119
 120 #define _COMPONENT          ACPI_HARDWARE
 121         ACPI_MODULE_NAME    ("hwsleep")
 122
 123
 124 /*******************************************************************************
 125  *
 126  * FUNCTION:    AcpiSetFirmwareWakingVector
 127  *
 128  * PARAMETERS:  PhysicalAddress     - 32-bit physical address of ACPI real mode
 129  *                                    entry point.
 130  *
 131  * RETURN:      Status
 132  *
 133  * DESCRIPTION: Sets the 32-bit FirmwareWakingVector field of the FACS
 134  *
 135  ******************************************************************************/
 136
 137 ACPI_STATUS
 138 AcpiSetFirmwareWakingVector (
 139     UINT32                  PhysicalAddress)
 140 {
 141     ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
 142
 143
 144     /* Set the 32-bit vector */
 145
 146     AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress;
 147
 148     /* Clear the 64-bit vector if it exists */
 149
 150     if ((AcpiGbl_FACS->Length > 32) && (AcpiGbl_FACS->Version >= 1))
 151     {
 152         AcpiGbl_FACS->XFirmwareWakingVector = 0;
 153     }
 154
 155     return_ACPI_STATUS (AE_OK);
 156 }
 157
 158 ACPI_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
 177 ACPI_STATUS
 178 AcpiSetFirmwareWakingVector64 (
 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
 198 ACPI_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
 216 ACPI_STATUS
 217 AcpiEnterSleepStatePrep (
 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
 286 ACPI_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
 302 ACPI_STATUS
 303 AcpiEnterSleepState (
 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%d]\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
 496 ACPI_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
 512 ACPI_STATUS
 513 AcpiEnterSleepStateS4bios (
 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
 571 ACPI_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
 587 ACPI_STATUS
 588 AcpiLeaveSleepState (
 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
 724 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)
 725