hwsleep.c revision 84491
1 2/****************************************************************************** 3 * 4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface 5 * $Revision: 22 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118#include "acpi.h" 119#include "acnamesp.h" 120#include "achware.h" 121 122#define _COMPONENT ACPI_HARDWARE 123 MODULE_NAME ("hwsleep") 124 125 126/****************************************************************************** 127 * 128 * FUNCTION: AcpiSetFirmwareWakingVector 129 * 130 * PARAMETERS: PhysicalAddress - Physical address of ACPI real mode 131 * entry point. 132 * 133 * RETURN: AE_OK or AE_ERROR 134 * 135 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 136 * 137 ******************************************************************************/ 138 139ACPI_STATUS 140AcpiSetFirmwareWakingVector ( 141 ACPI_PHYSICAL_ADDRESS PhysicalAddress) 142{ 143 144 FUNCTION_TRACE ("AcpiSetFirmwareWakingVector"); 145 146 147 /* Make sure that we have an FACS */ 148 149 if (!AcpiGbl_FACS) 150 { 151 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 152 } 153 154 /* Set the vector */ 155 156 if (AcpiGbl_FACS->VectorWidth == 32) 157 { 158 * (UINT32 *) AcpiGbl_FACS->FirmwareWakingVector = (UINT32) PhysicalAddress; 159 } 160 else 161 { 162 *AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress; 163 } 164 165 return_ACPI_STATUS (AE_OK); 166} 167 168 169/****************************************************************************** 170 * 171 * FUNCTION: AcpiGetFirmwareWakingVector 172 * 173 * PARAMETERS: *PhysicalAddress - Output buffer where contents of 174 * the FirmwareWakingVector field of 175 * the FACS will be stored. 176 * 177 * RETURN: Status 178 * 179 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 180 * 181 ******************************************************************************/ 182 183ACPI_STATUS 184AcpiGetFirmwareWakingVector ( 185 ACPI_PHYSICAL_ADDRESS *PhysicalAddress) 186{ 187 188 FUNCTION_TRACE ("AcpiGetFirmwareWakingVector"); 189 190 191 if (!PhysicalAddress) 192 { 193 return_ACPI_STATUS (AE_BAD_PARAMETER); 194 } 195 196 /* Make sure that we have an FACS */ 197 198 if (!AcpiGbl_FACS) 199 { 200 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 201 } 202 203 /* Get the vector */ 204 205 if (AcpiGbl_FACS->VectorWidth == 32) 206 { 207 *PhysicalAddress = * (UINT32 *) AcpiGbl_FACS->FirmwareWakingVector; 208 } 209 else 210 { 211 *PhysicalAddress = *AcpiGbl_FACS->FirmwareWakingVector; 212 } 213 214 return_ACPI_STATUS (AE_OK); 215} 216 217/****************************************************************************** 218 * 219 * FUNCTION: AcpiEnterSleepState 220 * 221 * PARAMETERS: SleepState - Which sleep state to enter 222 * 223 * RETURN: Status 224 * 225 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231) 226 * 227 ******************************************************************************/ 228 229ACPI_STATUS 230AcpiEnterSleepState ( 231 UINT8 SleepState) 232{ 233 ACPI_STATUS Status; 234 ACPI_OBJECT_LIST ArgList; 235 ACPI_OBJECT Arg; 236 UINT8 TypeA; 237 UINT8 TypeB; 238 UINT16 PM1AControl; 239 UINT16 PM1BControl; 240 241 242 FUNCTION_TRACE ("AcpiEnterSleepState"); 243 244 245 /* 246 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc. 247 */ 248 Status = AcpiHwObtainSleepTypeRegisterData (SleepState, &TypeA, &TypeB); 249 if (!ACPI_SUCCESS (Status)) 250 { 251 return Status; 252 } 253 254 /* run the _PTS and _GTS methods */ 255 256 MEMSET(&ArgList, 0, sizeof(ArgList)); 257 ArgList.Count = 1; 258 ArgList.Pointer = &Arg; 259 260 MEMSET(&Arg, 0, sizeof(Arg)); 261 Arg.Type = ACPI_TYPE_INTEGER; 262 Arg.Integer.Value = SleepState; 263 264 AcpiEvaluateObject (NULL, "\\_PTS", &ArgList, NULL); 265 AcpiEvaluateObject (NULL, "\\_GTS", &ArgList, NULL); 266 267 /* clear wake status */ 268 269 AcpiHwRegisterBitAccess (ACPI_WRITE, ACPI_MTX_LOCK, WAK_STS, 1); 270 271 disable (); 272 273 AcpiHwDisableNonWakeupGpes(); 274 275 PM1AControl = (UINT16) AcpiHwRegisterRead (ACPI_MTX_LOCK, PM1_CONTROL); 276 277 ACPI_DEBUG_PRINT ((ACPI_DB_OK, "Entering S%d\n", SleepState)); 278 279 /* mask off SLP_EN and SLP_TYP fields */ 280 281 PM1AControl &= ~(SLP_TYPE_X_MASK | SLP_EN_MASK); 282 PM1BControl = PM1AControl; 283 284 /* mask in SLP_TYP */ 285 286 PM1AControl |= (TypeA << AcpiHwGetBitShift (SLP_TYPE_X_MASK)); 287 PM1BControl |= (TypeB << AcpiHwGetBitShift (SLP_TYPE_X_MASK)); 288 289 /* write #1: fill in SLP_TYP data */ 290 291 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1A_CONTROL, PM1AControl); 292 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1B_CONTROL, PM1BControl); 293 294 /* mask in SLP_EN */ 295 296 PM1AControl |= (1 << AcpiHwGetBitShift (SLP_EN_MASK)); 297 PM1BControl |= (1 << AcpiHwGetBitShift (SLP_EN_MASK)); 298 299 /* flush caches */ 300 301 wbinvd(); 302 303 /* write #2: SLP_TYP + SLP_EN */ 304 305 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1A_CONTROL, PM1AControl); 306 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1B_CONTROL, PM1BControl); 307 308 /* 309 * Wait a second, then try again. This is to get S4/5 to work on all machines. 310 */ 311 if (SleepState > ACPI_STATE_S3) 312 { 313 AcpiOsStall(1000000); 314 315 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1_CONTROL, 316 (1 << AcpiHwGetBitShift (SLP_EN_MASK))); 317 } 318 319 /* wait until we enter sleep state */ 320 321 do 322 { 323 AcpiOsStall(10000); 324 } 325 while (!AcpiHwRegisterBitAccess (ACPI_READ, ACPI_MTX_LOCK, WAK_STS)); 326 327 AcpiHwEnableNonWakeupGpes(); 328 329 enable (); 330 331 return_ACPI_STATUS (AE_OK); 332} 333 334/****************************************************************************** 335 * 336 * FUNCTION: AcpiLeaveSleepState 337 * 338 * PARAMETERS: SleepState - Which sleep state we just exited 339 * 340 * RETURN: Status 341 * 342 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 343 * 344 ******************************************************************************/ 345 346ACPI_STATUS 347AcpiLeaveSleepState ( 348 UINT8 SleepState) 349{ 350 ACPI_OBJECT_LIST ArgList; 351 ACPI_OBJECT Arg; 352 353 354 FUNCTION_TRACE ("AcpiLeaveSleepState"); 355 356 357 MEMSET (&ArgList, 0, sizeof(ArgList)); 358 ArgList.Count = 1; 359 ArgList.Pointer = &Arg; 360 361 MEMSET (&Arg, 0, sizeof(Arg)); 362 Arg.Type = ACPI_TYPE_INTEGER; 363 Arg.Integer.Value = SleepState; 364 365 AcpiEvaluateObject (NULL, "\\_BFS", &ArgList, NULL); 366 AcpiEvaluateObject (NULL, "\\_WAK", &ArgList, NULL); 367 368 /* _WAK returns stuff - do we want to look at it? */ 369 370 AcpiHwEnableNonWakeupGpes(); 371 372 return_ACPI_STATUS (AE_OK); 373} 374