sys/contrib/dev/acpica-unix-20031203/hardware/hwgpe.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: hwgpe - Low level GPE enable/disable/clear functions
   5  *              $Revision: 53 $
   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
 137 ACPI_STATUS
 138 AcpiHwEnableGpe (
 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
 181 void
 182 AcpiHwEnableGpeForWakeup (
 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
 218 ACPI_STATUS
 219 AcpiHwDisableGpe (
 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
 276 void
 277 AcpiHwDisableGpeForWakeup (
 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
 313 ACPI_STATUS
 314 AcpiHwClearGpe (
 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
 346 ACPI_STATUS
 347 AcpiHwGetGpeStatus (
 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
 412 UnlockAndExit:
 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
 430 ACPI_STATUS
 431 AcpiHwDisableGpeBlock (
 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
 473 ACPI_STATUS
 474 AcpiHwClearGpeBlock (
 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
 516 static ACPI_STATUS
 517 AcpiHwDisableNonWakeupGpeBlock (
 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
 581 ACPI_STATUS
 582 AcpiHwDisableNonWakeupGpes (
 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
 610 static ACPI_STATUS
 611 AcpiHwEnableNonWakeupGpeBlock (
 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
 661 ACPI_STATUS
 662 AcpiHwEnableNonWakeupGpes (
 663     void)
 664 {
 665     ACPI_STATUS             Status;
 666
 667
 668     ACPI_FUNCTION_ENTRY ();
 669
 670
 671     Status = AcpiEvWalkGpeList (AcpiHwEnableNonWakeupGpeBlock);
 672
 673     return (Status);
 674 }