acpica/hardware/hwsleep.c

0001 /******************************************************************************
0002  *
0003  * Name: hwsleep.c - ACPI Hardware Sleep/Wake Support functions for the
0004  *                   original/legacy sleep/PM registers.
0005  *
0006  *****************************************************************************/
0007
0008 /******************************************************************************
0009  *
0010  * 1. Copyright Notice
0011  *
0012  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0013  * All rights reserved.
0014  *
0015  * 2. License
0016  *
0017  * 2.1. This is your license from Intel Corp. under its intellectual property
0018  * rights. You may have additional license terms from the party that provided
0019  * you this software, covering your right to use that party's intellectual
0020  * property rights.
0021  *
0022  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0023  * copy of the source code appearing in this file ("Covered Code") an
0024  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0025  * base code distributed originally by Intel ("Original Intel Code") to copy,
0026  * make derivatives, distribute, use and display any portion of the Covered
0027  * Code in any form, with the right to sublicense such rights; and
0028  *
0029  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0030  * license (with the right to sublicense), under only those claims of Intel
0031  * patents that are infringed by the Original Intel Code, to make, use, sell,
0032  * offer to sell, and import the Covered Code and derivative works thereof
0033  * solely to the minimum extent necessary to exercise the above copyright
0034  * license, and in no event shall the patent license extend to any additions
0035  * to or modifications of the Original Intel Code. No other license or right
0036  * is granted directly or by implication, estoppel or otherwise;
0037  *
0038  * The above copyright and patent license is granted only if the following
0039  * conditions are met:
0040  *
0041  * 3. Conditions
0042  *
0043  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0044  * Redistribution of source code of any substantial portion of the Covered
0045  * Code or modification with rights to further distribute source must include
0046  * the above Copyright Notice, the above License, this list of Conditions,
0047  * and the following Disclaimer and Export Compliance provision. In addition,
0048  * Licensee must cause all Covered Code to which Licensee contributes to
0049  * contain a file documenting the changes Licensee made to create that Covered
0050  * Code and the date of any change. Licensee must include in that file the
0051  * documentation of any changes made by any predecessor Licensee. Licensee
0052  * must include a prominent statement that the modification is derived,
0053  * directly or indirectly, from Original Intel Code.
0054  *
0055  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0056  * Redistribution of source code of any substantial portion of the Covered
0057  * Code or modification without rights to further distribute source must
0058  * include the following Disclaimer and Export Compliance provision in the
0059  * documentation and/or other materials provided with distribution. In
0060  * addition, Licensee may not authorize further sublicense of source of any
0061  * portion of the Covered Code, and must include terms to the effect that the
0062  * license from Licensee to its licensee is limited to the intellectual
0063  * property embodied in the software Licensee provides to its licensee, and
0064  * not to intellectual property embodied in modifications its licensee may
0065  * make.
0066  *
0067  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0068  * substantial portion of the Covered Code or modification must reproduce the
0069  * above Copyright Notice, and the following Disclaimer and Export Compliance
0070  * provision in the documentation and/or other materials provided with the
0071  * distribution.
0072  *
0073  * 3.4. Intel retains all right, title, and interest in and to the Original
0074  * Intel Code.
0075  *
0076  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0077  * Intel shall be used in advertising or otherwise to promote the sale, use or
0078  * other dealings in products derived from or relating to the Covered Code
0079  * without prior written authorization from Intel.
0080  *
0081  * 4. Disclaimer and Export Compliance
0082  *
0083  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0084  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0085  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0086  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0087  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0088  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0089  * PARTICULAR PURPOSE.
0090  *
0091  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0092  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0093  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0094  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0095  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0096  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0097  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0098  * LIMITED REMEDY.
0099  *
0100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0101  * software or system incorporating such software without first obtaining any
0102  * required license or other approval from the U. S. Department of Commerce or
0103  * any other agency or department of the United States Government. In the
0104  * event Licensee exports any such software from the United States or
0105  * re-exports any such software from a foreign destination, Licensee shall
0106  * ensure that the distribution and export/re-export of the software is in
0107  * compliance with all laws, regulations, orders, or other restrictions of the
0108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0109  * any of its subsidiaries will export/re-export any technical data, process,
0110  * software, or service, directly or indirectly, to any country for which the
0111  * United States government or any agency thereof requires an export license,
0112  * other governmental approval, or letter of assurance, without first obtaining
0113  * such license, approval or letter.
0114  *
0115  *****************************************************************************
0116  *
0117  * Alternatively, you may choose to be licensed under the terms of the
0118  * following license:
0119  *
0120  * Redistribution and use in source and binary forms, with or without
0121  * modification, are permitted provided that the following conditions
0122  * are met:
0123  * 1. Redistributions of source code must retain the above copyright
0124  *    notice, this list of conditions, and the following disclaimer,
0125  *    without modification.
0126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0127  *    substantially similar to the "NO WARRANTY" disclaimer below
0128  *    ("Disclaimer") and any redistribution must be conditioned upon
0129  *    including a substantially similar Disclaimer requirement for further
0130  *    binary redistribution.
0131  * 3. Neither the names of the above-listed copyright holders nor the names
0132  *    of any contributors may be used to endorse or promote products derived
0133  *    from this software without specific prior written permission.
0134  *
0135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0146  *
0147  * Alternatively, you may choose to be licensed under the terms of the
0148  * GNU General Public License ("GPL") version 2 as published by the Free
0149  * Software Foundation.
0150  *
0151  *****************************************************************************/
0152
0153 #include "acpi.h"
0154 #include "accommon.h"
0155
0156 #define _COMPONENT          ACPI_HARDWARE
0157         ACPI_MODULE_NAME    ("hwsleep")
0158
0159
0160 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
0161 /*******************************************************************************
0162  *
0163  * FUNCTION:    AcpiHwLegacySleep
0164  *
0165  * PARAMETERS:  SleepState          - Which sleep state to enter
0166  *
0167  * RETURN:      Status
0168  *
0169  * DESCRIPTION: Enter a system sleep state via the legacy FADT PM registers
0170  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
0171  *
0172  ******************************************************************************/
0173
0174 ACPI_STATUS
0175 AcpiHwLegacySleep (
0176     UINT8                   SleepState)
0177 {
0178     ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
0179     ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
0180     UINT32                  Pm1aControl;
0181     UINT32                  Pm1bControl;
0182     UINT32                  InValue;
0183     ACPI_STATUS             Status;
0184
0185
0186     ACPI_FUNCTION_TRACE (HwLegacySleep);
0187
0188
0189     SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
0190     SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
0191
0192     /* Clear wake status */
0193
0194     Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS,
0195         ACPI_CLEAR_STATUS);
0196     if (ACPI_FAILURE (Status))
0197     {
0198         return_ACPI_STATUS (Status);
0199     }
0200
0201     /* Disable all GPEs */
0202
0203     Status = AcpiHwDisableAllGpes ();
0204     if (ACPI_FAILURE (Status))
0205     {
0206         return_ACPI_STATUS (Status);
0207     }
0208     Status = AcpiHwClearAcpiStatus();
0209     if (ACPI_FAILURE(Status))
0210     {
0211         return_ACPI_STATUS(Status);
0212     }
0213     AcpiGbl_SystemAwakeAndRunning = FALSE;
0214
0215     /* Enable all wakeup GPEs */
0216
0217     Status = AcpiHwEnableAllWakeupGpes ();
0218     if (ACPI_FAILURE (Status))
0219     {
0220         return_ACPI_STATUS (Status);
0221     }
0222
0223     /* Get current value of PM1A control */
0224
0225     Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
0226         &Pm1aControl);
0227     if (ACPI_FAILURE (Status))
0228     {
0229         return_ACPI_STATUS (Status);
0230     }
0231     ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
0232         "Entering sleep state [S%u]\n", SleepState));
0233
0234     /* Clear the SLP_EN and SLP_TYP fields */
0235
0236     Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
0237          SleepEnableRegInfo->AccessBitMask);
0238     Pm1bControl = Pm1aControl;
0239
0240     /* Insert the SLP_TYP bits */
0241
0242     Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
0243     Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
0244
0245     /*
0246      * We split the writes of SLP_TYP and SLP_EN to workaround
0247      * poorly implemented hardware.
0248      */
0249
0250     /* Write #1: write the SLP_TYP data to the PM1 Control registers */
0251
0252     Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
0253     if (ACPI_FAILURE (Status))
0254     {
0255         return_ACPI_STATUS (Status);
0256     }
0257
0258     /* Insert the sleep enable (SLP_EN) bit */
0259
0260     Pm1aControl |= SleepEnableRegInfo->AccessBitMask;
0261     Pm1bControl |= SleepEnableRegInfo->AccessBitMask;
0262
0263     /* Flush caches, as per ACPI specification */
0264
0265     if (SleepState < ACPI_STATE_S4)
0266     {
0267         ACPI_FLUSH_CPU_CACHE ();
0268     }
0269
0270     Status = AcpiOsEnterSleep (SleepState, Pm1aControl, Pm1bControl);
0271     if (Status == AE_CTRL_TERMINATE)
0272     {
0273         return_ACPI_STATUS (AE_OK);
0274     }
0275     if (ACPI_FAILURE (Status))
0276     {
0277         return_ACPI_STATUS (Status);
0278     }
0279
0280     /* Write #2: Write both SLP_TYP + SLP_EN */
0281
0282     Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
0283     if (ACPI_FAILURE (Status))
0284     {
0285         return_ACPI_STATUS (Status);
0286     }
0287
0288     if (SleepState > ACPI_STATE_S3)
0289     {
0290         /*
0291          * We wanted to sleep > S3, but it didn't happen (by virtue of the
0292          * fact that we are still executing!)
0293          *
0294          * Wait ten seconds, then try again. This is to get S4/S5 to work on
0295          * all machines.
0296          *
0297          * We wait so long to allow chipsets that poll this reg very slowly
0298          * to still read the right value. Ideally, this block would go
0299          * away entirely.
0300          */
0301         AcpiOsStall (10 * ACPI_USEC_PER_SEC);
0302
0303         Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL,
0304             SleepEnableRegInfo->AccessBitMask);
0305         if (ACPI_FAILURE (Status))
0306         {
0307             return_ACPI_STATUS (Status);
0308         }
0309     }
0310
0311     /* Wait for transition back to Working State */
0312
0313     do
0314     {
0315         Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
0316         if (ACPI_FAILURE (Status))
0317         {
0318             return_ACPI_STATUS (Status);
0319         }
0320
0321     } while (!InValue);
0322
0323     return_ACPI_STATUS (AE_OK);
0324 }
0325
0326
0327 /*******************************************************************************
0328  *
0329  * FUNCTION:    AcpiHwLegacyWakePrep
0330  *
0331  * PARAMETERS:  SleepState          - Which sleep state we just exited
0332  *
0333  * RETURN:      Status
0334  *
0335  * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
0336  *              sleep.
0337  *              Called with interrupts ENABLED.
0338  *
0339  ******************************************************************************/
0340
0341 ACPI_STATUS
0342 AcpiHwLegacyWakePrep (
0343     UINT8                   SleepState)
0344 {
0345     ACPI_STATUS             Status = AE_OK;
0346     ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
0347     ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
0348     UINT32                  Pm1aControl;
0349     UINT32                  Pm1bControl;
0350
0351
0352     ACPI_FUNCTION_TRACE (HwLegacyWakePrep);
0353
0354     /*
0355      * Set SLP_TYPE and SLP_EN to state S0.
0356      * This is unclear from the ACPI Spec, but it is required
0357      * by some machines.
0358      */
0359     if (AcpiGbl_SleepTypeAS0 != ACPI_SLEEP_TYPE_INVALID)
0360     {
0361         SleepTypeRegInfo =
0362             AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
0363         SleepEnableRegInfo =
0364             AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
0365
0366         /* Get current value of PM1A control */
0367
0368         Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
0369             &Pm1aControl);
0370         if (ACPI_SUCCESS (Status))
0371         {
0372             /* Clear the SLP_EN and SLP_TYP fields */
0373
0374             Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
0375                 SleepEnableRegInfo->AccessBitMask);
0376             Pm1bControl = Pm1aControl;
0377
0378             /* Insert the SLP_TYP bits */
0379
0380             Pm1aControl |= (AcpiGbl_SleepTypeAS0 <<
0381                 SleepTypeRegInfo->BitPosition);
0382             Pm1bControl |= (AcpiGbl_SleepTypeBS0 <<
0383                 SleepTypeRegInfo->BitPosition);
0384
0385             /* Write the control registers and ignore any errors */
0386
0387             (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
0388         }
0389     }
0390
0391     return_ACPI_STATUS (Status);
0392 }
0393
0394
0395 /*******************************************************************************
0396  *
0397  * FUNCTION:    AcpiHwLegacyWake
0398  *
0399  * PARAMETERS:  SleepState          - Which sleep state we just exited
0400  *
0401  * RETURN:      Status
0402  *
0403  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
0404  *              Called with interrupts ENABLED.
0405  *
0406  ******************************************************************************/
0407
0408 ACPI_STATUS
0409 AcpiHwLegacyWake (
0410     UINT8                   SleepState)
0411 {
0412     ACPI_STATUS             Status;
0413
0414
0415     ACPI_FUNCTION_TRACE (HwLegacyWake);
0416
0417
0418     /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
0419
0420     AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
0421     AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING);
0422
0423     /*
0424      * GPEs must be enabled before _WAK is called as GPEs
0425      * might get fired there
0426      *
0427      * Restore the GPEs:
0428      * 1) Disable all GPEs
0429      * 2) Enable all runtime GPEs
0430      */
0431     Status = AcpiHwDisableAllGpes ();
0432     if (ACPI_FAILURE (Status))
0433     {
0434         return_ACPI_STATUS (Status);
0435     }
0436
0437     Status = AcpiHwEnableAllRuntimeGpes ();
0438     if (ACPI_FAILURE (Status))
0439     {
0440         return_ACPI_STATUS (Status);
0441     }
0442
0443     /*
0444      * Now we can execute _WAK, etc. Some machines require that the GPEs
0445      * are enabled before the wake methods are executed.
0446      */
0447     AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState);
0448
0449     /*
0450      * Some BIOS code assumes that WAK_STS will be cleared on resume
0451      * and use it to determine whether the system is rebooting or
0452      * resuming. Clear WAK_STS for compatibility.
0453      */
0454     (void) AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS,
0455         ACPI_CLEAR_STATUS);
0456     AcpiGbl_SystemAwakeAndRunning = TRUE;
0457
0458     /* Enable power button */
0459
0460     (void) AcpiWriteBitRegister(
0461             AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
0462             ACPI_ENABLE_EVENT);
0463
0464     (void) AcpiWriteBitRegister(
0465             AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
0466             ACPI_CLEAR_STATUS);
0467
0468     /* Enable sleep button */
0469
0470     (void) AcpiWriteBitRegister (
0471             AcpiGbl_FixedEventInfo[ACPI_EVENT_SLEEP_BUTTON].EnableRegisterId,
0472             ACPI_ENABLE_EVENT);
0473
0474     (void) AcpiWriteBitRegister (
0475             AcpiGbl_FixedEventInfo[ACPI_EVENT_SLEEP_BUTTON].StatusRegisterId,
0476             ACPI_CLEAR_STATUS);
0477
0478     AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING);
0479     return_ACPI_STATUS (Status);
0480 }
0481
0482 #endif /* !ACPI_REDUCED_HARDWARE */