hwsleep.c revision 87031
1 2/****************************************************************************** 3 * 4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface 5 * $Revision: 25 $ 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 125static UINT8 SleepTypeA; 126static UINT8 SleepTypeB; 127 128 129/****************************************************************************** 130 * 131 * FUNCTION: AcpiSetFirmwareWakingVector 132 * 133 * PARAMETERS: PhysicalAddress - Physical address of ACPI real mode 134 * entry point. 135 * 136 * RETURN: AE_OK or AE_ERROR 137 * 138 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 139 * 140 ******************************************************************************/ 141 142ACPI_STATUS 143AcpiSetFirmwareWakingVector ( 144 ACPI_PHYSICAL_ADDRESS PhysicalAddress) 145{ 146 147 FUNCTION_TRACE ("AcpiSetFirmwareWakingVector"); 148 149 150 /* Make sure that we have an FACS */ 151 152 if (!AcpiGbl_FACS) 153 { 154 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 155 } 156 157 /* Set the vector */ 158 159 if (AcpiGbl_FACS->VectorWidth == 32) 160 { 161 * (UINT32 *) AcpiGbl_FACS->FirmwareWakingVector = (UINT32) PhysicalAddress; 162 } 163 else 164 { 165 *AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress; 166 } 167 168 return_ACPI_STATUS (AE_OK); 169} 170 171 172/****************************************************************************** 173 * 174 * FUNCTION: AcpiGetFirmwareWakingVector 175 * 176 * PARAMETERS: *PhysicalAddress - Output buffer where contents of 177 * the FirmwareWakingVector field of 178 * the FACS will be stored. 179 * 180 * RETURN: Status 181 * 182 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 183 * 184 ******************************************************************************/ 185 186ACPI_STATUS 187AcpiGetFirmwareWakingVector ( 188 ACPI_PHYSICAL_ADDRESS *PhysicalAddress) 189{ 190 191 FUNCTION_TRACE ("AcpiGetFirmwareWakingVector"); 192 193 194 if (!PhysicalAddress) 195 { 196 return_ACPI_STATUS (AE_BAD_PARAMETER); 197 } 198 199 /* Make sure that we have an FACS */ 200 201 if (!AcpiGbl_FACS) 202 { 203 return_ACPI_STATUS (AE_NO_ACPI_TABLES); 204 } 205 206 /* Get the vector */ 207 208 if (AcpiGbl_FACS->VectorWidth == 32) 209 { 210 *PhysicalAddress = * (UINT32 *) AcpiGbl_FACS->FirmwareWakingVector; 211 } 212 else 213 { 214 *PhysicalAddress = *AcpiGbl_FACS->FirmwareWakingVector; 215 } 216 217 return_ACPI_STATUS (AE_OK); 218} 219 220 221/****************************************************************************** 222 * 223 * FUNCTION: AcpiEnterSleepStatePrep 224 * 225 * PARAMETERS: SleepState - Which sleep state to enter 226 * 227 * RETURN: Status 228 * 229 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231) 230 * This function must execute with interrupts enabled. 231 * We break sleeping into 2 stages so that OSPM can handle 232 * various OS-specific tasks between the two steps. 233 * 234 ******************************************************************************/ 235 236ACPI_STATUS 237AcpiEnterSleepStatePrep ( 238 UINT8 SleepState) 239{ 240 ACPI_STATUS Status; 241 ACPI_OBJECT_LIST ArgList; 242 ACPI_OBJECT Arg; 243 244 FUNCTION_TRACE ("AcpiEnterSleepStatePrep"); 245 246 /* 247 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc. 248 */ 249 Status = AcpiHwObtainSleepTypeRegisterData (SleepState, &SleepTypeA, &SleepTypeB); 250 if (!ACPI_SUCCESS (Status)) 251 { 252 return_ACPI_STATUS (Status); 253 } 254 255 /* run the _PTS and _GTS methods */ 256 257 MEMSET(&ArgList, 0, sizeof(ArgList)); 258 ArgList.Count = 1; 259 ArgList.Pointer = &Arg; 260 261 MEMSET(&Arg, 0, sizeof(Arg)); 262 Arg.Type = ACPI_TYPE_INTEGER; 263 Arg.Integer.Value = SleepState; 264 265 AcpiEvaluateObject (NULL, "\\_PTS", &ArgList, NULL); 266 AcpiEvaluateObject (NULL, "\\_GTS", &ArgList, NULL); 267 268 return_ACPI_STATUS (AE_OK); 269} 270 271 272 273/****************************************************************************** 274 * 275 * FUNCTION: AcpiEnterSleepState 276 * 277 * PARAMETERS: SleepState - Which sleep state to enter 278 * 279 * RETURN: Status 280 * 281 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231) 282 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 283 * 284 ******************************************************************************/ 285 286ACPI_STATUS 287AcpiEnterSleepState ( 288 UINT8 SleepState) 289{ 290 UINT16 PM1AControl; 291 UINT16 PM1BControl; 292 293 294 FUNCTION_TRACE ("AcpiEnterSleepState"); 295 296 if ((SleepTypeA > ACPI_SLEEP_TYPE_MAX) || 297 (SleepTypeB > ACPI_SLEEP_TYPE_MAX)) 298 { 299 REPORT_ERROR (("Sleep values out of range: A=%x B=%x\n", 300 SleepTypeA, SleepTypeB)); 301 return_ACPI_STATUS (AE_ERROR); 302 } 303 304 /* clear wake status */ 305 306 AcpiHwRegisterBitAccess (ACPI_WRITE, ACPI_MTX_LOCK, WAK_STS, 1); 307 308 AcpiHwClearAcpiStatus(); 309 310 /* disable arbitration here? */ 311 312 AcpiHwDisableNonWakeupGpes(); 313 314 PM1AControl = (UINT16) AcpiHwRegisterRead (ACPI_MTX_LOCK, PM1_CONTROL); 315 316 ACPI_DEBUG_PRINT ((ACPI_DB_OK, "Entering S%d\n", SleepState)); 317 318 /* mask off SLP_EN and SLP_TYP fields */ 319 320 PM1AControl &= ~(SLP_TYPE_X_MASK | SLP_EN_MASK); 321 PM1BControl = PM1AControl; 322 323 /* mask in SLP_TYP */ 324 325 PM1AControl |= (SleepTypeA << AcpiHwGetBitShift (SLP_TYPE_X_MASK)); 326 PM1BControl |= (SleepTypeB << AcpiHwGetBitShift (SLP_TYPE_X_MASK)); 327 328 /* write #1: fill in SLP_TYP data */ 329 330 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1A_CONTROL, PM1AControl); 331 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1B_CONTROL, PM1BControl); 332 333 /* mask in SLP_EN */ 334 335 PM1AControl |= (1 << AcpiHwGetBitShift (SLP_EN_MASK)); 336 PM1BControl |= (1 << AcpiHwGetBitShift (SLP_EN_MASK)); 337 338 /* write #2: SLP_TYP + SLP_EN */ 339 340 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1A_CONTROL, PM1AControl); 341 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1B_CONTROL, PM1BControl); 342 343 /* 344 * Wait a second, then try again. This is to get S4/5 to work on all machines. 345 */ 346 if (SleepState > ACPI_STATE_S3) 347 { 348 AcpiOsStall(1000000); 349 350 AcpiHwRegisterWrite (ACPI_MTX_LOCK, PM1_CONTROL, 351 (1 << AcpiHwGetBitShift (SLP_EN_MASK))); 352 } 353 354 /* wait until we enter sleep state */ 355 356 while (!AcpiHwRegisterBitAccess (ACPI_READ, ACPI_MTX_LOCK, WAK_STS)) 357 { 358 /* spin until we wake */ 359 } 360 361 return_ACPI_STATUS (AE_OK); 362} 363 364/****************************************************************************** 365 * 366 * FUNCTION: AcpiLeaveSleepState 367 * 368 * PARAMETERS: SleepState - Which sleep state we just exited 369 * 370 * RETURN: Status 371 * 372 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 373 * 374 ******************************************************************************/ 375 376ACPI_STATUS 377AcpiLeaveSleepState ( 378 UINT8 SleepState) 379{ 380 ACPI_OBJECT_LIST ArgList; 381 ACPI_OBJECT Arg; 382 383 384 FUNCTION_TRACE ("AcpiLeaveSleepState"); 385 386 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */ 387 SleepTypeA = ACPI_SLEEP_TYPE_INVALID; 388 389 MEMSET (&ArgList, 0, sizeof(ArgList)); 390 ArgList.Count = 1; 391 ArgList.Pointer = &Arg; 392 393 MEMSET (&Arg, 0, sizeof(Arg)); 394 Arg.Type = ACPI_TYPE_INTEGER; 395 Arg.Integer.Value = SleepState; 396 397 AcpiEvaluateObject (NULL, "\\_BFS", &ArgList, NULL); 398 AcpiEvaluateObject (NULL, "\\_WAK", &ArgList, NULL); 399 400 /* _WAK returns stuff - do we want to look at it? */ 401 402 AcpiHwEnableNonWakeupGpes(); 403 404 return_ACPI_STATUS (AE_OK); 405} 406