hwgpe.c revision 117521
10SN/A 22362SN/A/****************************************************************************** 30SN/A * 40SN/A * Module Name: hwgpe - Low level GPE enable/disable/clear functions 50SN/A * $Revision: 53 $ 60SN/A * 72362SN/A *****************************************************************************/ 80SN/A 92362SN/A/****************************************************************************** 100SN/A * 110SN/A * 1. Copyright Notice 120SN/A * 130SN/A * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp. 140SN/A * All rights reserved. 150SN/A * 160SN/A * 2. License 170SN/A * 180SN/A * 2.1. This is your license from Intel Corp. under its intellectual property 190SN/A * rights. You may have additional license terms from the party that provided 200SN/A * you this software, covering your right to use that party's intellectual 212362SN/A * property rights. 222362SN/A * 232362SN/A * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 240SN/A * copy of the source code appearing in this file ("Covered Code") an 250SN/A * irrevocable, perpetual, worldwide license under Intel's copyrights in the 260SN/A * base code distributed originally by Intel ("Original Intel Code") to copy, 270SN/A * make derivatives, distribute, use and display any portion of the Covered 280SN/A * Code in any form, with the right to sublicense such rights; and 290SN/A * 300SN/A * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 310SN/A * license (with the right to sublicense), under only those claims of Intel 320SN/A * patents that are infringed by the Original Intel Code, to make, use, sell, 330SN/A * offer to sell, and import the Covered Code and derivative works thereof 340SN/A * solely to the minimum extent necessary to exercise the above copyright 350SN/A * license, and in no event shall the patent license extend to any additions 360SN/A * to or modifications of the Original Intel Code. No other license or right 370SN/A * is granted directly or by implication, estoppel or otherwise; 380SN/A * 390SN/A * The above copyright and patent license is granted only if the following 400SN/A * conditions are met: 410SN/A * 420SN/A * 3. Conditions 430SN/A * 440SN/A * 3.1. Redistribution of Source with Rights to Further Distribute Source. 450SN/A * Redistribution of source code of any substantial portion of the Covered 460SN/A * Code or modification with rights to further distribute source must include 470SN/A * the above Copyright Notice, the above License, this list of Conditions, 480SN/A * and the following Disclaimer and Export Compliance provision. In addition, 490SN/A * Licensee must cause all Covered Code to which Licensee contributes to 500SN/A * contain a file documenting the changes Licensee made to create that Covered 510SN/A * Code and the date of any change. Licensee must include in that file the 520SN/A * documentation of any changes made by any predecessor Licensee. Licensee 530SN/A * must include a prominent statement that the modification is derived, 540SN/A * directly or indirectly, from Original Intel Code. 550SN/A * 560SN/A * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 570SN/A * Redistribution of source code of any substantial portion of the Covered 580SN/A * Code or modification without rights to further distribute source must 590SN/A * include the following Disclaimer and Export Compliance provision in the 600SN/A * documentation and/or other materials provided with distribution. In 610SN/A * addition, Licensee may not authorize further sublicense of source of any 620SN/A * portion of the Covered Code, and must include terms to the effect that the 630SN/A * license from Licensee to its licensee is limited to the intellectual 640SN/A * property embodied in the software Licensee provides to its licensee, and 650SN/A * not to intellectual property embodied in modifications its licensee may 660SN/A * make. 670SN/A * 680SN/A * 3.3. Redistribution of Executable. Redistribution in executable form of any 690SN/A * substantial portion of the Covered Code or modification must reproduce the 700SN/A * above Copyright Notice, and the following Disclaimer and Export Compliance 710SN/A * provision in the documentation and/or other materials provided with the 720SN/A * distribution. 730SN/A * 740SN/A * 3.4. Intel retains all right, title, and interest in and to the Original 750SN/A * Intel Code. 760SN/A * 770SN/A * 3.5. Neither the name Intel nor any other trademark owned or controlled by 780SN/A * Intel shall be used in advertising or otherwise to promote the sale, use or 790SN/A * other dealings in products derived from or relating to the Covered Code 800SN/A * without prior written authorization from Intel. 810SN/A * 820SN/A * 4. Disclaimer and Export Compliance 830SN/A * 840SN/A * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 850SN/A * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 860SN/A * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 870SN/A * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 880SN/A * 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); 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); 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); 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); 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); 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 ACPI_GPE_EVENT_INFO *GpeEventInfo, 349 ACPI_EVENT_STATUS *EventStatus) 350{ 351 UINT32 InByte; 352 UINT8 BitMask; 353 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 354 ACPI_STATUS Status; 355 ACPI_EVENT_STATUS LocalEventStatus = 0; 356 357 358 ACPI_FUNCTION_ENTRY (); 359 360 361 if (!EventStatus) 362 { 363 return (AE_BAD_PARAMETER); 364 } 365 366 /* Get the info block for the entire GPE register */ 367 368 GpeRegisterInfo = GpeEventInfo->RegisterInfo; 369 370 /* Get the register bitmask for this GPE */ 371 372 BitMask = GpeEventInfo->BitMask; 373 374 /* GPE Enabled? */ 375 376 Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->EnableAddress); 377 if (ACPI_FAILURE (Status)) 378 { 379 goto UnlockAndExit; 380 } 381 382 if (BitMask & InByte) 383 { 384 LocalEventStatus |= ACPI_EVENT_FLAG_ENABLED; 385 } 386 387 /* GPE Enabled for wake? */ 388 389 if (BitMask & GpeRegisterInfo->WakeEnable) 390 { 391 LocalEventStatus |= ACPI_EVENT_FLAG_WAKE_ENABLED; 392 } 393 394 /* GPE active (set)? */ 395 396 Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->StatusAddress); 397 if (ACPI_FAILURE (Status)) 398 { 399 goto UnlockAndExit; 400 } 401 402 if (BitMask & InByte) 403 { 404 LocalEventStatus |= ACPI_EVENT_FLAG_SET; 405 } 406 407 /* Set return value */ 408 409 (*EventStatus) = LocalEventStatus; 410 411 412UnlockAndExit: 413 return (Status); 414} 415 416 417/****************************************************************************** 418 * 419 * FUNCTION: AcpiHwDisableGpeBlock 420 * 421 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 422 * GpeBlock - Gpe Block info 423 * 424 * RETURN: Status 425 * 426 * DESCRIPTION: Disable all GPEs within a GPE block 427 * 428 ******************************************************************************/ 429 430ACPI_STATUS 431AcpiHwDisableGpeBlock ( 432 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 433 ACPI_GPE_BLOCK_INFO *GpeBlock) 434{ 435 UINT32 i; 436 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 437 ACPI_STATUS Status; 438 439 440 /* Get the register info for the entire GPE block */ 441 442 GpeRegisterInfo = GpeBlock->RegisterInfo; 443 444 /* Examine each GPE Register within the block */ 445 446 for (i = 0; i < GpeBlock->RegisterCount; i++) 447 { 448 Status = AcpiHwLowLevelWrite (8, 0x00, 449 &GpeBlock->RegisterInfo[i].EnableAddress); 450 if (ACPI_FAILURE (Status)) 451 { 452 return (Status); 453 } 454 } 455 456 return (AE_OK); 457} 458 459 460/****************************************************************************** 461 * 462 * FUNCTION: AcpiHwClearGpeBlock 463 * 464 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 465 * GpeBlock - Gpe Block info 466 * 467 * RETURN: Status 468 * 469 * DESCRIPTION: Clear all GPEs within a GPE block 470 * 471 ******************************************************************************/ 472 473ACPI_STATUS 474AcpiHwClearGpeBlock ( 475 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 476 ACPI_GPE_BLOCK_INFO *GpeBlock) 477{ 478 UINT32 i; 479 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 480 ACPI_STATUS Status; 481 482 483 /* Get the register info for the entire GPE block */ 484 485 GpeRegisterInfo = GpeBlock->RegisterInfo; 486 487 /* Examine each GPE Register within the block */ 488 489 for (i = 0; i < GpeBlock->RegisterCount; i++) 490 { 491 Status = AcpiHwLowLevelWrite (8, 0xFF, 492 &GpeBlock->RegisterInfo[i].StatusAddress); 493 if (ACPI_FAILURE (Status)) 494 { 495 return (Status); 496 } 497 } 498 499 return (AE_OK); 500} 501 502 503/****************************************************************************** 504 * 505 * FUNCTION: AcpiHwDisableNonWakeupGpeBlock 506 * 507 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 508 * GpeBlock - Gpe Block info 509 * 510 * RETURN: Status 511 * 512 * DESCRIPTION: Disable all GPEs except wakeup GPEs in a GPE block 513 * 514 ******************************************************************************/ 515 516static ACPI_STATUS 517AcpiHwDisableNonWakeupGpeBlock ( 518 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 519 ACPI_GPE_BLOCK_INFO *GpeBlock) 520{ 521 UINT32 i; 522 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 523 UINT32 InValue; 524 ACPI_STATUS Status; 525 526 527 /* Get the register info for the entire GPE block */ 528 529 GpeRegisterInfo = GpeBlock->RegisterInfo; 530 531 /* Examine each GPE Register within the block */ 532 533 for (i = 0; i < GpeBlock->RegisterCount; i++) 534 { 535 /* 536 * Read the enabled status of all GPEs. We 537 * will be using it to restore all the GPEs later. 538 */ 539 Status = AcpiHwLowLevelRead (8, &InValue, 540 &GpeRegisterInfo->EnableAddress); 541 if (ACPI_FAILURE (Status)) 542 { 543 return (Status); 544 } 545 546 GpeRegisterInfo->Enable = (UINT8) InValue; 547 548 /* 549 * Disable all GPEs except wakeup GPEs. 550 */ 551 Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->WakeEnable, 552 &GpeRegisterInfo->EnableAddress); 553 if (ACPI_FAILURE (Status)) 554 { 555 return (Status); 556 } 557 558 GpeRegisterInfo++; 559 } 560 561 return (AE_OK); 562} 563 564 565/****************************************************************************** 566 * 567 * FUNCTION: AcpiHwDisableNonWakeupGpes 568 * 569 * PARAMETERS: None 570 * 571 * RETURN: None 572 * 573 * DESCRIPTION: Disable all non-wakeup GPEs 574 * Called with interrupts disabled. The interrupt handler also 575 * modifies GpeRegisterInfo->Enable, so it should not be 576 * given the chance to run until after non-wake GPEs are 577 * re-enabled. 578 * 579 ******************************************************************************/ 580 581ACPI_STATUS 582AcpiHwDisableNonWakeupGpes ( 583 void) 584{ 585 ACPI_STATUS Status; 586 587 588 ACPI_FUNCTION_ENTRY (); 589 590 591 Status = AcpiEvWalkGpeList (AcpiHwDisableNonWakeupGpeBlock); 592 593 return (Status); 594} 595 596 597/****************************************************************************** 598 * 599 * FUNCTION: AcpiHwEnableNonWakeupGpeBlock 600 * 601 * PARAMETERS: GpeXruptInfo - GPE Interrupt info 602 * GpeBlock - Gpe Block info 603 * 604 * RETURN: Status 605 * 606 * DESCRIPTION: Enable a single GPE. 607 * 608 ******************************************************************************/ 609 610static ACPI_STATUS 611AcpiHwEnableNonWakeupGpeBlock ( 612 ACPI_GPE_XRUPT_INFO *GpeXruptInfo, 613 ACPI_GPE_BLOCK_INFO *GpeBlock) 614{ 615 UINT32 i; 616 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo; 617 ACPI_STATUS Status; 618 619 620 /* This callback processes one entire GPE block */ 621 622 /* Get the register info for the entire GPE block */ 623 624 GpeRegisterInfo = GpeBlock->RegisterInfo; 625 626 /* Examine each GPE register within the block */ 627 628 for (i = 0; i < GpeBlock->RegisterCount; i++) 629 { 630 /* 631 * We previously stored the enabled status of all GPEs. 632 * Blast them back in. 633 */ 634 Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->Enable, 635 &GpeRegisterInfo->EnableAddress); 636 if (ACPI_FAILURE (Status)) 637 { 638 return (Status); 639 } 640 641 GpeRegisterInfo++; 642 } 643 644 645 return (AE_OK); 646} 647 648 649/****************************************************************************** 650 * 651 * FUNCTION: AcpiHwEnableNonWakeupGpes 652 * 653 * PARAMETERS: None 654 * 655 * RETURN: None 656 * 657 * DESCRIPTION: Enable all non-wakeup GPEs we previously enabled. 658 * 659 ******************************************************************************/ 660 661ACPI_STATUS 662AcpiHwEnableNonWakeupGpes ( 663 void) 664{ 665 ACPI_STATUS Status; 666 667 668 ACPI_FUNCTION_ENTRY (); 669 670 671 Status = AcpiEvWalkGpeList (AcpiHwEnableNonWakeupGpeBlock); 672 673 return (Status); 674} 675