hwgpe.c revision 114237
1 2/****************************************************************************** 3 * 4 * Module Name: hwgpe - Low level GPE enable/disable/clear functions 5 * $Revision: 47 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2003, 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 "acevents.h" 120 121#define _COMPONENT ACPI_HARDWARE 122 ACPI_MODULE_NAME ("hwgpe") 123 124 125/****************************************************************************** 126 * 127 * FUNCTION: AcpiHwEnableGpe 128 * 129 * PARAMETERS: GpeNumber - The GPE 130 * 131 * RETURN: None 132 * 133 * DESCRIPTION: Enable a single GPE. 134 * 135 ******************************************************************************/ 136 137ACPI_STATUS 138AcpiHwEnableGpe ( 139 ACPI_GPE_EVENT_INFO *GpeEventInfo) 140{ 141 UINT32 InByte; 142 ACPI_STATUS Status; 143 144 145 ACPI_FUNCTION_ENTRY (); 146 147 148 /* 149 * Read the current value of the register, set the appropriate bit 150 * to enable the GPE, and write out the new register. 151 */ 152 Status = AcpiHwLowLevelRead (8, &InByte, 153 &GpeEventInfo->RegisterInfo->EnableAddress, 0); 154 if (ACPI_FAILURE (Status)) 155 { 156 return (Status); 157 } 158 159 /* Write with the new GPE bit enabled */ 160 161 Status = AcpiHwLowLevelWrite (8, (InByte | GpeEventInfo->BitMask), 162 &GpeEventInfo->RegisterInfo->EnableAddress, 0); 163 164 return (Status); 165} 166 167 168/****************************************************************************** 169 * 170 * FUNCTION: AcpiHwEnableGpeForWakeup 171 * 172 * PARAMETERS: GpeNumber - The GPE 173 * 174 * RETURN: None 175 * 176 * DESCRIPTION: Keep track of which GPEs the OS has requested not be 177 * disabled when going to sleep. 178 * 179 ******************************************************************************/ 180 181void 182AcpiHwEnableGpeForWakeup ( 183 ACPI_GPE_EVENT_INFO *GpeEventInfo) 184{ 185 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 186 187 188 ACPI_FUNCTION_ENTRY (); 189 190 191 /* Get the info block for the entire GPE register */ 192 193 GpeRegisterInfo = GpeEventInfo->RegisterInfo; 194 if (!GpeRegisterInfo) 195 { 196 return; 197 } 198 199 /* 200 * Set the bit so we will not disable this when sleeping 201 */ 202 GpeRegisterInfo->WakeEnable |= GpeEventInfo->BitMask; 203} 204 205 206/****************************************************************************** 207 * 208 * FUNCTION: AcpiHwDisableGpe 209 * 210 * PARAMETERS: GpeNumber - The GPE 211 * 212 * RETURN: None 213 * 214 * DESCRIPTION: Disable a single GPE. 215 * 216 ******************************************************************************/ 217 218ACPI_STATUS 219AcpiHwDisableGpe ( 220 ACPI_GPE_EVENT_INFO *GpeEventInfo) 221{ 222 UINT32 InByte; 223 ACPI_STATUS Status; 224 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 225 226 227 ACPI_FUNCTION_ENTRY (); 228 229 230 /* Get the info block for the entire GPE register */ 231 232 GpeRegisterInfo = GpeEventInfo->RegisterInfo; 233 if (!GpeRegisterInfo) 234 { 235 return (AE_BAD_PARAMETER); 236 } 237 238 /* 239 * Read the current value of the register, clear the appropriate bit, 240 * and write out the new register value to disable the GPE. 241 */ 242 Status = AcpiHwLowLevelRead (8, &InByte, 243 &GpeRegisterInfo->EnableAddress, 0); 244 if (ACPI_FAILURE (Status)) 245 { 246 return (Status); 247 } 248 249 /* Write the byte with this GPE bit cleared */ 250 251 Status = AcpiHwLowLevelWrite (8, (InByte & ~(GpeEventInfo->BitMask)), 252 &GpeRegisterInfo->EnableAddress, 0); 253 if (ACPI_FAILURE (Status)) 254 { 255 return (Status); 256 } 257 258 AcpiHwDisableGpeForWakeup (GpeEventInfo); 259 return (AE_OK); 260} 261 262 263/****************************************************************************** 264 * 265 * FUNCTION: AcpiHwDisableGpeForWakeup 266 * 267 * PARAMETERS: GpeNumber - The GPE 268 * 269 * RETURN: None 270 * 271 * DESCRIPTION: Keep track of which GPEs the OS has requested not be 272 * disabled when going to sleep. 273 * 274 ******************************************************************************/ 275 276void 277AcpiHwDisableGpeForWakeup ( 278 ACPI_GPE_EVENT_INFO *GpeEventInfo) 279{ 280 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 281 282 283 ACPI_FUNCTION_ENTRY (); 284 285 286 /* Get the info block for the entire GPE register */ 287 288 GpeRegisterInfo = GpeEventInfo->RegisterInfo; 289 if (!GpeRegisterInfo) 290 { 291 return; 292 } 293 294 /* 295 * Clear the bit so we will disable this when sleeping 296 */ 297 GpeRegisterInfo->WakeEnable &= ~(GpeEventInfo->BitMask); 298} 299 300 301/****************************************************************************** 302 * 303 * FUNCTION: AcpiHwClearGpe 304 * 305 * PARAMETERS: GpeNumber - The GPE 306 * 307 * RETURN: None 308 * 309 * DESCRIPTION: Clear a single GPE. 310 * 311 ******************************************************************************/ 312 313ACPI_STATUS 314AcpiHwClearGpe ( 315 ACPI_GPE_EVENT_INFO *GpeEventInfo) 316{ 317 ACPI_STATUS Status; 318 319 320 ACPI_FUNCTION_ENTRY (); 321 322 323 /* 324 * Write a one to the appropriate bit in the status register to 325 * clear this GPE. 326 */ 327 Status = AcpiHwLowLevelWrite (8, GpeEventInfo->BitMask, 328 &GpeEventInfo->RegisterInfo->StatusAddress, 0); 329 330 return (Status); 331} 332 333 334/****************************************************************************** 335 * 336 * FUNCTION: AcpiHwGetGpeStatus 337 * 338 * PARAMETERS: GpeNumber - The GPE 339 * 340 * RETURN: None 341 * 342 * DESCRIPTION: Return the status of a single GPE. 343 * 344 ******************************************************************************/ 345 346ACPI_STATUS 347AcpiHwGetGpeStatus ( 348 UINT32 GpeNumber, 349 ACPI_EVENT_STATUS *EventStatus) 350{ 351 UINT32 InByte; 352 UINT8 BitMask; 353 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 354 ACPI_GPE_EVENT_INFO *GpeEventInfo; 355 ACPI_STATUS Status; 356 ACPI_EVENT_STATUS LocalEventStatus = 0; 357 358 359 ACPI_FUNCTION_ENTRY (); 360 361 362 if (!EventStatus) 363 { 364 return (AE_BAD_PARAMETER); 365 } 366 367 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeNumber); 368 if (!GpeEventInfo) 369 { 370 return (AE_BAD_PARAMETER); 371 } 372 373 /* Get the info block for the entire GPE register */ 374 375 GpeRegisterInfo = GpeEventInfo->RegisterInfo; 376 377 /* Get the register bitmask for this GPE */ 378 379 BitMask = GpeEventInfo->BitMask; 380 381 /* GPE Enabled? */ 382 383 Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->EnableAddress, 0); 384 if (ACPI_FAILURE (Status)) 385 { 386 return (Status); 387 } 388 389 if (BitMask & InByte) 390 { 391 LocalEventStatus |= ACPI_EVENT_FLAG_ENABLED; 392 } 393 394 /* GPE Enabled for wake? */ 395 396 if (BitMask & GpeRegisterInfo->WakeEnable) 397 { 398 LocalEventStatus |= ACPI_EVENT_FLAG_WAKE_ENABLED; 399 } 400 401 /* GPE active (set)? */ 402 403 Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->StatusAddress, 0); 404 if (ACPI_FAILURE (Status)) 405 { 406 return (Status); 407 } 408 409 if (BitMask & InByte) 410 { 411 LocalEventStatus |= ACPI_EVENT_FLAG_SET; 412 } 413 414 /* Set return value */ 415 416 (*EventStatus) = LocalEventStatus; 417 return (AE_OK); 418} 419 420 421/****************************************************************************** 422 * 423 * FUNCTION: AcpiHwDisableNonWakeupGpes 424 * 425 * PARAMETERS: None 426 * 427 * RETURN: None 428 * 429 * DESCRIPTION: Disable all non-wakeup GPEs 430 * Call with interrupts disabled. The interrupt handler also 431 * modifies GpeRegisterInfo->Enable, so it should not be 432 * given the chance to run until after non-wake GPEs are 433 * re-enabled. 434 * 435 ******************************************************************************/ 436 437ACPI_STATUS 438AcpiHwDisableNonWakeupGpes ( 439 void) 440{ 441 UINT32 i; 442 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 443 UINT32 InValue; 444 ACPI_STATUS Status; 445 ACPI_GPE_BLOCK_INFO *GpeBlock; 446 447 448 ACPI_FUNCTION_ENTRY (); 449 450 451 GpeBlock = AcpiGbl_GpeBlockListHead; 452 while (GpeBlock) 453 { 454 /* Get the register info for the entire GPE block */ 455 456 GpeRegisterInfo = GpeBlock->RegisterInfo; 457 if (!GpeRegisterInfo) 458 { 459 return (AE_BAD_PARAMETER); 460 } 461 462 for (i = 0; i < GpeBlock->RegisterCount; i++) 463 { 464 /* 465 * Read the enabled status of all GPEs. We 466 * will be using it to restore all the GPEs later. 467 */ 468 Status = AcpiHwLowLevelRead (8, &InValue, 469 &GpeRegisterInfo->EnableAddress, 0); 470 if (ACPI_FAILURE (Status)) 471 { 472 return (Status); 473 } 474 475 GpeRegisterInfo->Enable = (UINT8) InValue; 476 477 /* 478 * Disable all GPEs except wakeup GPEs. 479 */ 480 Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->WakeEnable, 481 &GpeRegisterInfo->EnableAddress, 0); 482 if (ACPI_FAILURE (Status)) 483 { 484 return (Status); 485 } 486 487 GpeRegisterInfo++; 488 } 489 490 GpeBlock = GpeBlock->Next; 491 } 492 493 return (AE_OK); 494} 495 496 497/****************************************************************************** 498 * 499 * FUNCTION: AcpiHwEnableNonWakeupGpes 500 * 501 * PARAMETERS: None 502 * 503 * RETURN: None 504 * 505 * DESCRIPTION: Enable all non-wakeup GPEs we previously enabled. 506 * 507 ******************************************************************************/ 508 509ACPI_STATUS 510AcpiHwEnableNonWakeupGpes ( 511 void) 512{ 513 UINT32 i; 514 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 515 ACPI_STATUS Status; 516 ACPI_GPE_BLOCK_INFO *GpeBlock; 517 518 519 ACPI_FUNCTION_ENTRY (); 520 521 522 GpeBlock = AcpiGbl_GpeBlockListHead; 523 while (GpeBlock) 524 { 525 /* Get the register info for the entire GPE block */ 526 527 GpeRegisterInfo = GpeBlock->RegisterInfo; 528 if (!GpeRegisterInfo) 529 { 530 return (AE_BAD_PARAMETER); 531 } 532 533 for (i = 0; i < GpeBlock->RegisterCount; i++) 534 { 535 /* 536 * We previously stored the enabled status of all GPEs. 537 * Blast them back in. 538 */ 539 Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->Enable, 540 &GpeRegisterInfo->EnableAddress, 0); 541 if (ACPI_FAILURE (Status)) 542 { 543 return (Status); 544 } 545 546 GpeRegisterInfo++; 547 } 548 549 GpeBlock = GpeBlock->Next; 550 } 551 552 return (AE_OK); 553} 554