hwsleep.c revision 7c478bd95313f5f23a4c958a745db2134aa03244
/******************************************************************************
*
* $Revision: 74 $
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
* All rights reserved.
*
* 2. License
*
* 2.1. This is your license from Intel Corp. under its intellectual property
* rights. You may have additional license terms from the party that provided
* you this software, covering your right to use that party's intellectual
* property rights.
*
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
* copy of the source code appearing in this file ("Covered Code") an
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
* base code distributed originally by Intel ("Original Intel Code") to copy,
* make derivatives, distribute, use and display any portion of the Covered
* Code in any form, with the right to sublicense such rights; and
*
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
* license (with the right to sublicense), under only those claims of Intel
* patents that are infringed by the Original Intel Code, to make, use, sell,
* offer to sell, and import the Covered Code and derivative works thereof
* solely to the minimum extent necessary to exercise the above copyright
* license, and in no event shall the patent license extend to any additions
* to or modifications of the Original Intel Code. No other license or right
* is granted directly or by implication, estoppel or otherwise;
*
* The above copyright and patent license is granted only if the following
* conditions are met:
*
* 3. Conditions
*
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification with rights to further distribute source must include
* the above Copyright Notice, the above License, this list of Conditions,
* and the following Disclaimer and Export Compliance provision. In addition,
* Licensee must cause all Covered Code to which Licensee contributes to
* contain a file documenting the changes Licensee made to create that Covered
* Code and the date of any change. Licensee must include in that file the
* documentation of any changes made by any predecessor Licensee. Licensee
* must include a prominent statement that the modification is derived,
* directly or indirectly, from Original Intel Code.
*
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification without rights to further distribute source must
* include the following Disclaimer and Export Compliance provision in the
* addition, Licensee may not authorize further sublicense of source of any
* portion of the Covered Code, and must include terms to the effect that the
* license from Licensee to its licensee is limited to the intellectual
* property embodied in the software Licensee provides to its licensee, and
* not to intellectual property embodied in modifications its licensee may
* make.
*
* 3.3. Redistribution of Executable. Redistribution in executable form of any
* substantial portion of the Covered Code or modification must reproduce the
* above Copyright Notice, and the following Disclaimer and Export Compliance
* distribution.
*
* 3.4. Intel retains all right, title, and interest in and to the Original
* Intel Code.
*
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
* Intel shall be used in advertising or otherwise to promote the sale, use or
* other dealings in products derived from or relating to the Covered Code
* without prior written authorization from Intel.
*
* 4. Disclaimer and Export Compliance
*
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
* LIMITED REMEDY.
*
* 4.3. Licensee shall not export, either directly or indirectly, any of this
* software or system incorporating such software without first obtaining any
* required license or other approval from the U. S. Department of Commerce or
* any other agency or department of the United States Government. In the
* event Licensee exports any such software from the United States or
* re-exports any such software from a foreign destination, Licensee shall
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* software, or service, directly or indirectly, to any country for which the
* United States government or any agency thereof requires an export license,
* other governmental approval, or letter of assurance, without first obtaining
* such license, approval or letter.
*
*****************************************************************************/
#include "acpi.h"
#define _COMPONENT ACPI_HARDWARE
ACPI_MODULE_NAME ("hwsleep")
/*******************************************************************************
*
* FUNCTION: AcpiSetFirmwareWakingVector
*
* PARAMETERS: PhysicalAddress - Physical address of ACPI real mode
* entry point.
*
* RETURN: Status
*
* DESCRIPTION: Access function for the FirmwareWakingVector field in FACS
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiSetFirmwareWakingVector");
/* Set the vector */
{
= (UINT32) PhysicalAddress;
}
else
{
}
}
/*******************************************************************************
*
* FUNCTION: AcpiGetFirmwareWakingVector
*
* PARAMETERS: *PhysicalAddress - Where the contents of
* the FirmwareWakingVector field of
* the FACS will be returned.
*
* RETURN: Status, vector
*
* DESCRIPTION: Access function for the FirmwareWakingVector field in FACS
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiGetFirmwareWakingVector");
if (!PhysicalAddress)
{
}
/* Get the vector */
{
}
else
{
}
}
/*******************************************************************************
*
* FUNCTION: AcpiEnterSleepStatePrep
*
* PARAMETERS: SleepState - Which sleep state to enter
*
* RETURN: Status
*
* DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
* This function must execute with interrupts enabled.
* We break sleeping into 2 stages so that OSPM can handle
* various OS-specific tasks between the two steps.
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiEnterSleepStatePrep");
/*
* _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
*/
if (ACPI_FAILURE (Status))
{
}
/* Setup parameter object */
/* Run the _PTS and _GTS methods */
{
}
{
}
/* Setup the argument to _SST */
switch (SleepState)
{
case ACPI_STATE_S0:
break;
case ACPI_STATE_S1:
case ACPI_STATE_S2:
case ACPI_STATE_S3:
break;
case ACPI_STATE_S4:
break;
default:
break;
}
/* Set the system indicators to show the desired sleep state. */
{
ACPI_REPORT_ERROR (("Method _SST failed, %s\n",
}
}
/*******************************************************************************
*
* FUNCTION: AcpiEnterSleepState
*
* PARAMETERS: SleepState - Which sleep state to enter
*
* RETURN: Status
*
* DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiEnterSleepState");
if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
{
ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n",
}
/* Clear wake status */
if (ACPI_FAILURE (Status))
{
}
/* Clear all fixed and general purpose status bits */
if (ACPI_FAILURE (Status))
{
}
if (SleepState != ACPI_STATE_S5)
{
/* Disable BM arbitration */
1, ACPI_MTX_DO_NOT_LOCK);
if (ACPI_FAILURE (Status))
{
}
}
/*
* 2) Enable all wakeup GPEs
*/
if (ACPI_FAILURE (Status))
{
}
if (ACPI_FAILURE (Status))
{
}
/* Get current value of PM1A control */
if (ACPI_FAILURE (Status))
{
}
"Entering sleep state [S%d]\n", SleepState));
/* Clear SLP_EN and SLP_TYP fields */
/* Insert SLP_TYP bits */
/*
* We split the writes of SLP_TYP and SLP_EN to workaround
* poorly implemented hardware.
*/
/* Write #1: fill in SLP_TYP data */
if (ACPI_FAILURE (Status))
{
}
if (ACPI_FAILURE (Status))
{
}
/* Insert SLP_ENABLE bit */
/* Write #2: SLP_TYP + SLP_EN */
if (ACPI_FAILURE (Status))
{
}
if (ACPI_FAILURE (Status))
{
}
if (SleepState > ACPI_STATE_S3)
{
/*
* We wanted to sleep > S3, but it didn't happen (by virtue of the
* fact that we are still executing!)
*
* all machines.
*
* We wait so long to allow chipsets that poll this reg very slowly to
* still read the right value. Ideally, this block would go
* away entirely.
*/
AcpiOsStall (10000000);
if (ACPI_FAILURE (Status))
{
}
}
/* Wait until we enter sleep state */
do
{
if (ACPI_FAILURE (Status))
{
}
/* Spin until we wake */
} while (!InValue);
}
/*******************************************************************************
*
* FUNCTION: AcpiEnterSleepStateS4bios
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: Perform a S4 bios request.
* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
*
******************************************************************************/
void)
{
ACPI_FUNCTION_TRACE ("AcpiEnterSleepStateS4bios");
if (ACPI_FAILURE (Status))
{
}
if (ACPI_FAILURE (Status))
{
}
/*
* 2) Enable all wakeup GPEs
*/
if (ACPI_FAILURE (Status))
{
}
if (ACPI_FAILURE (Status))
{
}
do {
AcpiOsStall(1000);
if (ACPI_FAILURE (Status))
{
}
} while (!InValue);
}
/*******************************************************************************
*
* FUNCTION: AcpiLeaveSleepState
*
* PARAMETERS: SleepState - Which sleep state we just exited
*
* RETURN: Status
*
* DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
* Called with interrupts ENABLED.
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiLeaveSleepState");
/*
* Set SLP_TYPE and SLP_EN to state S0.
* This is unclear from the ACPI Spec, but it is required
* by some machines.
*/
if (ACPI_SUCCESS (Status))
{
/* Get current value of PM1A control */
if (ACPI_SUCCESS (Status))
{
/* Clear SLP_EN and SLP_TYP fields */
/* Insert SLP_TYP bits */
/* Just ignore any errors */
(void) AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK,
(void) AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK,
}
}
/* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
/* Setup parameter object */
/* Ignore any errors from these methods */
{
ACPI_REPORT_ERROR (("Method _SST failed, %s\n",
}
{
ACPI_REPORT_ERROR (("Method _BFS failed, %s\n",
}
{
ACPI_REPORT_ERROR (("Method _WAK failed, %s\n",
}
/* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
/*
* Restore the GPEs:
* 2) Enable all runtime GPEs
*/
if (ACPI_FAILURE (Status))
{
}
if (ACPI_FAILURE (Status))
{
}
/* Enable power button */
(void) AcpiSetRegister(
1, ACPI_MTX_DO_NOT_LOCK);
(void) AcpiSetRegister(
1, ACPI_MTX_DO_NOT_LOCK);
/* Enable BM arbitration */
if (ACPI_FAILURE (Status))
{
}
{
ACPI_REPORT_ERROR (("Method _SST failed, %s\n",
}
}