hwsleep.c revision 77424
171867Smsmith 271867Smsmith/****************************************************************************** 371867Smsmith * 471867Smsmith * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface 571867Smsmith * $Revision: 11 $ 671867Smsmith * 771867Smsmith *****************************************************************************/ 871867Smsmith 971867Smsmith/****************************************************************************** 1071867Smsmith * 1171867Smsmith * 1. Copyright Notice 12193267Sjkim * 1371867Smsmith * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 1471867Smsmith * All rights reserved. 1571867Smsmith * 1671867Smsmith * 2. License 1771867Smsmith * 1871867Smsmith * 2.1. This is your license from Intel Corp. under its intellectual property 1971867Smsmith * rights. You may have additional license terms from the party that provided 2071867Smsmith * you this software, covering your right to use that party's intellectual 2171867Smsmith * property rights. 2271867Smsmith * 2371867Smsmith * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2471867Smsmith * copy of the source code appearing in this file ("Covered Code") an 2571867Smsmith * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2671867Smsmith * base code distributed originally by Intel ("Original Intel Code") to copy, 2771867Smsmith * make derivatives, distribute, use and display any portion of the Covered 2871867Smsmith * Code in any form, with the right to sublicense such rights; and 2971867Smsmith * 3071867Smsmith * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3171867Smsmith * license (with the right to sublicense), under only those claims of Intel 3271867Smsmith * patents that are infringed by the Original Intel Code, to make, use, sell, 3371867Smsmith * offer to sell, and import the Covered Code and derivative works thereof 3471867Smsmith * solely to the minimum extent necessary to exercise the above copyright 3571867Smsmith * license, and in no event shall the patent license extend to any additions 3671867Smsmith * to or modifications of the Original Intel Code. No other license or right 3771867Smsmith * is granted directly or by implication, estoppel or otherwise; 3871867Smsmith * 3971867Smsmith * The above copyright and patent license is granted only if the following 4071867Smsmith * conditions are met: 4171867Smsmith * 4271867Smsmith * 3. Conditions 4371867Smsmith * 4471867Smsmith * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4571867Smsmith * Redistribution of source code of any substantial portion of the Covered 4671867Smsmith * Code or modification with rights to further distribute source must include 4771867Smsmith * the above Copyright Notice, the above License, this list of Conditions, 4871867Smsmith * and the following Disclaimer and Export Compliance provision. In addition, 4971867Smsmith * Licensee must cause all Covered Code to which Licensee contributes to 5071867Smsmith * contain a file documenting the changes Licensee made to create that Covered 5171867Smsmith * Code and the date of any change. Licensee must include in that file the 5271867Smsmith * documentation of any changes made by any predecessor Licensee. Licensee 5371867Smsmith * must include a prominent statement that the modification is derived, 5471867Smsmith * directly or indirectly, from Original Intel Code. 5571867Smsmith * 5671867Smsmith * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5771867Smsmith * Redistribution of source code of any substantial portion of the Covered 5871867Smsmith * Code or modification without rights to further distribute source must 5971867Smsmith * include the following Disclaimer and Export Compliance provision in the 6071867Smsmith * documentation and/or other materials provided with distribution. In 6171867Smsmith * addition, Licensee may not authorize further sublicense of source of any 6271867Smsmith * portion of the Covered Code, and must include terms to the effect that the 6371867Smsmith * license from Licensee to its licensee is limited to the intellectual 6471867Smsmith * property embodied in the software Licensee provides to its licensee, and 6571867Smsmith * not to intellectual property embodied in modifications its licensee may 6671867Smsmith * make. 6771867Smsmith * 6871867Smsmith * 3.3. Redistribution of Executable. Redistribution in executable form of any 6971867Smsmith * substantial portion of the Covered Code or modification must reproduce the 7071867Smsmith * above Copyright Notice, and the following Disclaimer and Export Compliance 7171867Smsmith * provision in the documentation and/or other materials provided with the 7271867Smsmith * distribution. 7371867Smsmith * 7471867Smsmith * 3.4. Intel retains all right, title, and interest in and to the Original 7571867Smsmith * Intel Code. 7671867Smsmith * 7771867Smsmith * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7871867Smsmith * Intel shall be used in advertising or otherwise to promote the sale, use or 7971867Smsmith * other dealings in products derived from or relating to the Covered Code 8071867Smsmith * without prior written authorization from Intel. 8171867Smsmith * 8271867Smsmith * 4. Disclaimer and Export Compliance 8371867Smsmith * 8471867Smsmith * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8571867Smsmith * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8671867Smsmith * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8771867Smsmith * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8871867Smsmith * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8971867Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 9071867Smsmith * PARTICULAR PURPOSE. 9171867Smsmith * 9271867Smsmith * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9371867Smsmith * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9471867Smsmith * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9571867Smsmith * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9671867Smsmith * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9771867Smsmith * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9871867Smsmith * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9971867Smsmith * LIMITED REMEDY. 10071867Smsmith * 10171867Smsmith * 4.3. Licensee shall not export, either directly or indirectly, any of this 10271867Smsmith * software or system incorporating such software without first obtaining any 10371867Smsmith * required license or other approval from the U. S. Department of Commerce or 10471867Smsmith * any other agency or department of the United States Government. In the 10571867Smsmith * event Licensee exports any such software from the United States or 10671867Smsmith * re-exports any such software from a foreign destination, Licensee shall 10771867Smsmith * ensure that the distribution and export/re-export of the software is in 10871867Smsmith * compliance with all laws, regulations, orders, or other restrictions of the 10971867Smsmith * U.S. Export Administration Regulations. Licensee agrees that neither it nor 11071867Smsmith * any of its subsidiaries will export/re-export any technical data, process, 11171867Smsmith * software, or service, directly or indirectly, to any country for which the 11271867Smsmith * United States government or any agency thereof requires an export license, 11371867Smsmith * other governmental approval, or letter of assurance, without first obtaining 11471867Smsmith * such license, approval or letter. 11571867Smsmith * 11671867Smsmith *****************************************************************************/ 117193251Sjkim 118193267Sjkim#include "acpi.h" 11971867Smsmith#include "acnamesp.h" 12077424Smsmith#include "achware.h" 12191116Smsmith 12271867Smsmith#define _COMPONENT ACPI_HARDWARE 12371867Smsmith MODULE_NAME ("hwsleep") 124151937Sjkim 12571867Smsmith 12671867Smsmith/****************************************************************************** 12771867Smsmith * 128193267Sjkim * FUNCTION: AcpiSetFirmwareWakingVector 12971867Smsmith * 13071867Smsmith * PARAMETERS: PhysicalAddress - Physical address of ACPI real mode 13191116Smsmith * entry point. 13271867Smsmith * 133193267Sjkim * RETURN: AE_OK or AE_ERROR 13471867Smsmith * 13571867Smsmith * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 13671867Smsmith * 13771867Smsmith ******************************************************************************/ 13871867Smsmith 139193267SjkimACPI_STATUS 14071867SmsmithAcpiSetFirmwareWakingVector ( 141193267Sjkim ACPI_PHYSICAL_ADDRESS PhysicalAddress) 14271867Smsmith{ 14371867Smsmith 144193267Sjkim FUNCTION_TRACE ("AcpiSetFirmwareWakingVector"); 14571867Smsmith 146193267Sjkim 147167802Sjkim /* Make sure that we have an FACS */ 148193267Sjkim 149167802Sjkim if (!AcpiGbl_FACS) 150193267Sjkim { 15171867Smsmith return_ACPI_STATUS (AE_NO_ACPI_TABLES); 152193267Sjkim } 15371867Smsmith 15471867Smsmith /* Set the vector */ 15571867Smsmith 15671867Smsmith if (AcpiGbl_FACS->VectorWidth == 32) 15771867Smsmith { 158167802Sjkim * (UINT32 *) AcpiGbl_FACS->FirmwareWakingVector = (UINT32) PhysicalAddress; 15971867Smsmith } 160167802Sjkim else 161193267Sjkim { 162151937Sjkim *AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress; 16371867Smsmith } 164193267Sjkim 16571867Smsmith return_ACPI_STATUS (AE_OK); 166193267Sjkim} 167193267Sjkim 16871867Smsmith 169193267Sjkim/****************************************************************************** 17071867Smsmith * 171193267Sjkim * FUNCTION: AcpiGetFirmwareWakingVector 172193267Sjkim * 173193267Sjkim * PARAMETERS: *PhysicalAddress - Output buffer where contents of 17471867Smsmith * the FirmwareWakingVector field of 17571867Smsmith * the FACS will be stored. 17671867Smsmith * 17771867Smsmith * RETURN: Status 178193267Sjkim * 179193267Sjkim * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 18071867Smsmith * 181193267Sjkim ******************************************************************************/ 18271867Smsmith 18371867SmsmithACPI_STATUS 184193267SjkimAcpiGetFirmwareWakingVector ( 18571867Smsmith ACPI_PHYSICAL_ADDRESS *PhysicalAddress) 186193267Sjkim{ 18771867Smsmith 188193267Sjkim FUNCTION_TRACE ("AcpiGetFirmwareWakingVector"); 18971867Smsmith 19071867Smsmith 191193267Sjkim if (!PhysicalAddress) 192167802Sjkim { 193193267Sjkim return_ACPI_STATUS (AE_BAD_PARAMETER); 194193267Sjkim } 19571867Smsmith 19671867Smsmith /* Make sure that we have an FACS */ 19771867Smsmith 198193267Sjkim if (!AcpiGbl_FACS) 199193267Sjkim { 20087031Smsmith return_ACPI_STATUS (AE_NO_ACPI_TABLES); 201151937Sjkim } 20271867Smsmith 20387031Smsmith /* Get the vector */ 20471867Smsmith 20571867Smsmith if (AcpiGbl_FACS->VectorWidth == 32) 20671867Smsmith { 20771867Smsmith *PhysicalAddress = * (UINT32 *) AcpiGbl_FACS->FirmwareWakingVector; 20871867Smsmith } 20987031Smsmith else 21087031Smsmith { 21187031Smsmith *PhysicalAddress = *AcpiGbl_FACS->FirmwareWakingVector; 21287031Smsmith } 21371867Smsmith 21471867Smsmith return_ACPI_STATUS (AE_OK); 21571867Smsmith} 21671867Smsmith 21787031Smsmith/****************************************************************************** 218193267Sjkim * 21971867Smsmith * FUNCTION: AcpiEnterSleepState 220193267Sjkim * 221193267Sjkim * PARAMETERS: SleepState - Which sleep state to enter 222193267Sjkim * 22371867Smsmith * RETURN: Status 22477424Smsmith * 225167802Sjkim * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231) 22691116Smsmith * 22791116Smsmith ******************************************************************************/ 228193267Sjkim 229193267SjkimACPI_STATUS 23099679SiwasakiAcpiEnterSleepState ( 23191116Smsmith UINT8 SleepState) 23291116Smsmith{ 23371867Smsmith ACPI_STATUS Status; 23487031Smsmith ACPI_OBJECT_LIST ArgList; 23571867Smsmith ACPI_OBJECT Arg; 23671867Smsmith UINT8 TypeA; 237193267Sjkim UINT8 TypeB; 23877424Smsmith UINT16 PM1AControl; 23971867Smsmith UINT16 PM1BControl; 24071867Smsmith 24171867Smsmith 24271867Smsmith FUNCTION_TRACE ("AcpiEnterSleepState"); 24371867Smsmith 244126372Snjl 24591116Smsmith /* 24691116Smsmith * _PSW methods could be run here to enable wake-on keyboard, LAN, etc. 24791116Smsmith */ 24891116Smsmith 24991116Smsmith Status = AcpiHwObtainSleepTypeRegisterData (SleepState, &TypeA, &TypeB); 250193267Sjkim if (!ACPI_SUCCESS (Status)) 25191116Smsmith { 252126372Snjl return Status; 253126372Snjl } 254126372Snjl 255126372Snjl /* run the _PTS and _GTS methods */ 256126372Snjl 257126372Snjl MEMSET(&ArgList, 0, sizeof(ArgList)); 258126372Snjl ArgList.Count = 1; 259126372Snjl ArgList.Pointer = &Arg; 260126372Snjl 261126372Snjl MEMSET(&Arg, 0, sizeof(Arg)); 262126372Snjl Arg.Type = ACPI_TYPE_INTEGER; 263126372Snjl Arg.Integer.Value = SleepState; 264126372Snjl 265126372Snjl AcpiEvaluateObject(NULL, "\\_PTS", &ArgList, NULL); 266126372Snjl AcpiEvaluateObject(NULL, "\\_GTS", &ArgList, NULL); 267126372Snjl 268126372Snjl /* clear wake status */ 269151937Sjkim 270126372Snjl AcpiHwRegisterBitAccess(ACPI_WRITE, ACPI_MTX_LOCK, WAK_STS, 1); 271126372Snjl 272126372Snjl PM1AControl = (UINT16) AcpiHwRegisterRead(ACPI_MTX_LOCK, PM1_CONTROL); 273193267Sjkim 274193267Sjkim /* mask off SLP_EN and SLP_TYP fields */ 275193267Sjkim 276193267Sjkim PM1AControl &= 0xC3FF; 277126372Snjl 278123315Snjl /* mask in SLP_EN */ 279123315Snjl 280167802Sjkim PM1AControl |= (1 << AcpiHwGetBitShift (SLP_EN_MASK)); 281123315Snjl 282123315Snjl PM1BControl = PM1AControl; 28387031Smsmith 28487031Smsmith /* mask in SLP_TYP */ 28587031Smsmith 286167802Sjkim PM1AControl |= (TypeA << AcpiHwGetBitShift (SLP_TYPE_X_MASK)); 28787031Smsmith PM1BControl |= (TypeB << AcpiHwGetBitShift (SLP_TYPE_X_MASK)); 288167802Sjkim 289151937Sjkim DEBUG_PRINT(ACPI_OK, ("Entering S%d\n", SleepState)); 29087031Smsmith 29187031Smsmith disable(); 29287031Smsmith 29387031Smsmith AcpiHwRegisterWrite(ACPI_MTX_LOCK, PM1A_CONTROL, PM1AControl); 29487031Smsmith AcpiHwRegisterWrite(ACPI_MTX_LOCK, PM1B_CONTROL, PM1BControl); 29587031Smsmith 29687031Smsmith /* one system won't work with this, one won't work without */ 297193267Sjkim /*AcpiHwRegisterWrite(ACPI_MTX_LOCK, PM1_CONTROL, 29887031Smsmith (1 << AcpiHwGetBitShift (SLP_EN_MASK)));*/ 29987031Smsmith 30087031Smsmith enable(); 30187031Smsmith 30287031Smsmith return_ACPI_STATUS (AE_OK); 30387031Smsmith} 30491116Smsmith