sys/contrib/dev/acpica/hwgpe.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: hwgpe - Low level GPE enable/disable/clear functions
   5  *              $Revision: 1.71 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2005, 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 <contrib/dev/acpica/acpi.h>
 119 #include <contrib/dev/acpica/acevents.h>
 120
 121 #define _COMPONENT          ACPI_HARDWARE
 122         ACPI_MODULE_NAME    ("hwgpe")
 123
 124 /* Local prototypes */
 125
 126 static ACPI_STATUS
 127 AcpiHwEnableWakeupGpeBlock (
 128     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 129     ACPI_GPE_BLOCK_INFO     *GpeBlock);
 130
 131
 132 /******************************************************************************
 133  *
 134  * FUNCTION:    AcpiHwWriteGpeEnableReg
 135  *
 136  * PARAMETERS:  GpeEventInfo        - Info block for the GPE to be enabled
 137  *
 138  * RETURN:      Status
 139  *
 140  * DESCRIPTION: Write a GPE enable register.  Note: The bit for this GPE must
 141  *              already be cleared or set in the parent register
 142  *              EnableForRun mask.
 143  *
 144  ******************************************************************************/
 145
 146 ACPI_STATUS
 147 AcpiHwWriteGpeEnableReg (
 148     ACPI_GPE_EVENT_INFO     *GpeEventInfo)
 149 {
 150     ACPI_GPE_REGISTER_INFO  *GpeRegisterInfo;
 151     ACPI_STATUS             Status;
 152
 153
 154     ACPI_FUNCTION_ENTRY ();
 155
 156
 157     /* Get the info block for the entire GPE register */
 158
 159     GpeRegisterInfo = GpeEventInfo->RegisterInfo;
 160     if (!GpeRegisterInfo)
 161     {
 162         return (AE_NOT_EXIST);
 163     }
 164
 165     /* Write the entire GPE (runtime) enable register */
 166
 167     Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->EnableForRun,
 168                     &GpeRegisterInfo->EnableAddress);
 169
 170     return (Status);
 171 }
 172
 173
 174 /******************************************************************************
 175  *
 176  * FUNCTION:    AcpiHwClearGpe
 177  *
 178  * PARAMETERS:  GpeEventInfo        - Info block for the GPE to be cleared
 179  *
 180  * RETURN:      Status
 181  *
 182  * DESCRIPTION: Clear the status bit for a single GPE.
 183  *
 184  ******************************************************************************/
 185
 186 ACPI_STATUS
 187 AcpiHwClearGpe (
 188     ACPI_GPE_EVENT_INFO     *GpeEventInfo)
 189 {
 190     ACPI_STATUS             Status;
 191
 192
 193     ACPI_FUNCTION_ENTRY ();
 194
 195
 196     /*
 197      * Write a one to the appropriate bit in the status register to
 198      * clear this GPE.
 199      */
 200     Status = AcpiHwLowLevelWrite (8, GpeEventInfo->RegisterBit,
 201                     &GpeEventInfo->RegisterInfo->StatusAddress);
 202
 203     return (Status);
 204 }
 205
 206
 207 /******************************************************************************
 208  *
 209  * FUNCTION:    AcpiHwGetGpeStatus
 210  *
 211  * PARAMETERS:  GpeEventInfo        - Info block for the GPE to queried
 212  *              EventStatus         - Where the GPE status is returned
 213  *
 214  * RETURN:      Status
 215  *
 216  * DESCRIPTION: Return the status of a single GPE.
 217  *
 218  ******************************************************************************/
 219
 220 ACPI_STATUS
 221 AcpiHwGetGpeStatus (
 222     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
 223     ACPI_EVENT_STATUS       *EventStatus)
 224 {
 225     UINT32                  InByte;
 226     UINT8                   RegisterBit;
 227     ACPI_GPE_REGISTER_INFO  *GpeRegisterInfo;
 228     ACPI_STATUS             Status;
 229     ACPI_EVENT_STATUS       LocalEventStatus = 0;
 230
 231
 232     ACPI_FUNCTION_ENTRY ();
 233
 234
 235     if (!EventStatus)
 236     {
 237         return (AE_BAD_PARAMETER);
 238     }
 239
 240     /* Get the info block for the entire GPE register */
 241
 242     GpeRegisterInfo = GpeEventInfo->RegisterInfo;
 243
 244     /* Get the register bitmask for this GPE */
 245
 246     RegisterBit = GpeEventInfo->RegisterBit;
 247
 248     /* GPE currently enabled? (enabled for runtime?) */
 249
 250     if (RegisterBit & GpeRegisterInfo->EnableForRun)
 251     {
 252         LocalEventStatus |= ACPI_EVENT_FLAG_ENABLED;
 253     }
 254
 255     /* GPE enabled for wake? */
 256
 257     if (RegisterBit & GpeRegisterInfo->EnableForWake)
 258     {
 259         LocalEventStatus |= ACPI_EVENT_FLAG_WAKE_ENABLED;
 260     }
 261
 262     /* GPE currently active (status bit == 1)? */
 263
 264     Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->StatusAddress);
 265     if (ACPI_FAILURE (Status))
 266     {
 267         goto UnlockAndExit;
 268     }
 269
 270     if (RegisterBit & InByte)
 271     {
 272         LocalEventStatus |= ACPI_EVENT_FLAG_SET;
 273     }
 274
 275     /* Set return value */
 276
 277     (*EventStatus) = LocalEventStatus;
 278
 279
 280 UnlockAndExit:
 281     return (Status);
 282 }
 283
 284
 285 /******************************************************************************
 286  *
 287  * FUNCTION:    AcpiHwDisableGpeBlock
 288  *
 289  * PARAMETERS:  GpeXruptInfo        - GPE Interrupt info
 290  *              GpeBlock            - Gpe Block info
 291  *
 292  * RETURN:      Status
 293  *
 294  * DESCRIPTION: Disable all GPEs within a single GPE block
 295  *
 296  ******************************************************************************/
 297
 298 ACPI_STATUS
 299 AcpiHwDisableGpeBlock (
 300     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 301     ACPI_GPE_BLOCK_INFO     *GpeBlock)
 302 {
 303     UINT32                  i;
 304     ACPI_STATUS             Status;
 305
 306
 307     /* Examine each GPE Register within the block */
 308
 309     for (i = 0; i < GpeBlock->RegisterCount; i++)
 310     {
 311         /* Disable all GPEs in this register */
 312
 313         Status = AcpiHwLowLevelWrite (8, 0x00,
 314                     &GpeBlock->RegisterInfo[i].EnableAddress);
 315         if (ACPI_FAILURE (Status))
 316         {
 317             return (Status);
 318         }
 319     }
 320
 321     return (AE_OK);
 322 }
 323
 324
 325 /******************************************************************************
 326  *
 327  * FUNCTION:    AcpiHwClearGpeBlock
 328  *
 329  * PARAMETERS:  GpeXruptInfo        - GPE Interrupt info
 330  *              GpeBlock            - Gpe Block info
 331  *
 332  * RETURN:      Status
 333  *
 334  * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
 335  *
 336  ******************************************************************************/
 337
 338 ACPI_STATUS
 339 AcpiHwClearGpeBlock (
 340     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 341     ACPI_GPE_BLOCK_INFO     *GpeBlock)
 342 {
 343     UINT32                  i;
 344     ACPI_STATUS             Status;
 345
 346
 347     /* Examine each GPE Register within the block */
 348
 349     for (i = 0; i < GpeBlock->RegisterCount; i++)
 350     {
 351         /* Clear status on all GPEs in this register */
 352
 353         Status = AcpiHwLowLevelWrite (8, 0xFF,
 354                     &GpeBlock->RegisterInfo[i].StatusAddress);
 355         if (ACPI_FAILURE (Status))
 356         {
 357             return (Status);
 358         }
 359     }
 360
 361     return (AE_OK);
 362 }
 363
 364
 365 /******************************************************************************
 366  *
 367  * FUNCTION:    AcpiHwEnableRuntimeGpeBlock
 368  *
 369  * PARAMETERS:  GpeXruptInfo        - GPE Interrupt info
 370  *              GpeBlock            - Gpe Block info
 371  *
 372  * RETURN:      Status
 373  *
 374  * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
 375  *              combination wake/run GPEs.
 376  *
 377  ******************************************************************************/
 378
 379 ACPI_STATUS
 380 AcpiHwEnableRuntimeGpeBlock (
 381     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 382     ACPI_GPE_BLOCK_INFO     *GpeBlock)
 383 {
 384     UINT32                  i;
 385     ACPI_STATUS             Status;
 386
 387
 388     /* NOTE: assumes that all GPEs are currently disabled */
 389
 390     /* Examine each GPE Register within the block */
 391
 392     for (i = 0; i < GpeBlock->RegisterCount; i++)
 393     {
 394         if (!GpeBlock->RegisterInfo[i].EnableForRun)
 395         {
 396             continue;
 397         }
 398
 399         /* Enable all "runtime" GPEs in this register */
 400
 401         Status = AcpiHwLowLevelWrite (8, GpeBlock->RegisterInfo[i].EnableForRun,
 402                     &GpeBlock->RegisterInfo[i].EnableAddress);
 403         if (ACPI_FAILURE (Status))
 404         {
 405             return (Status);
 406         }
 407     }
 408
 409     return (AE_OK);
 410 }
 411
 412
 413 /******************************************************************************
 414  *
 415  * FUNCTION:    AcpiHwEnableWakeupGpeBlock
 416  *
 417  * PARAMETERS:  GpeXruptInfo        - GPE Interrupt info
 418  *              GpeBlock            - Gpe Block info
 419  *
 420  * RETURN:      Status
 421  *
 422  * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
 423  *              combination wake/run GPEs.
 424  *
 425  ******************************************************************************/
 426
 427 static ACPI_STATUS
 428 AcpiHwEnableWakeupGpeBlock (
 429     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 430     ACPI_GPE_BLOCK_INFO     *GpeBlock)
 431 {
 432     UINT32                  i;
 433     ACPI_STATUS             Status;
 434
 435
 436     /* Examine each GPE Register within the block */
 437
 438     for (i = 0; i < GpeBlock->RegisterCount; i++)
 439     {
 440         if (!GpeBlock->RegisterInfo[i].EnableForWake)
 441         {
 442             continue;
 443         }
 444
 445         /* Enable all "wake" GPEs in this register */
 446
 447         Status = AcpiHwLowLevelWrite (8,
 448                     GpeBlock->RegisterInfo[i].EnableForWake,
 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:    AcpiHwDisableAllGpes
 463  *
 464  * PARAMETERS:  None
 465  *
 466  * RETURN:      Status
 467  *
 468  * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
 469  *
 470  ******************************************************************************/
 471
 472 ACPI_STATUS
 473 AcpiHwDisableAllGpes (
 474     void)
 475 {
 476     ACPI_STATUS             Status;
 477
 478
 479     ACPI_FUNCTION_TRACE ("HwDisableAllGpes");
 480
 481
 482     Status = AcpiEvWalkGpeList (AcpiHwDisableGpeBlock);
 483     Status = AcpiEvWalkGpeList (AcpiHwClearGpeBlock);
 484     return_ACPI_STATUS (Status);
 485 }
 486
 487
 488 /******************************************************************************
 489  *
 490  * FUNCTION:    AcpiHwEnableAllRuntimeGpes
 491  *
 492  * PARAMETERS:  None
 493  *
 494  * RETURN:      Status
 495  *
 496  * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
 497  *
 498  ******************************************************************************/
 499
 500 ACPI_STATUS
 501 AcpiHwEnableAllRuntimeGpes (
 502     void)
 503 {
 504     ACPI_STATUS             Status;
 505
 506
 507     ACPI_FUNCTION_TRACE ("HwEnableAllRuntimeGpes");
 508
 509
 510     Status = AcpiEvWalkGpeList (AcpiHwEnableRuntimeGpeBlock);
 511     return_ACPI_STATUS (Status);
 512 }
 513
 514
 515 /******************************************************************************
 516  *
 517  * FUNCTION:    AcpiHwEnableAllWakeupGpes
 518  *
 519  * PARAMETERS:  None
 520  *
 521  * RETURN:      Status
 522  *
 523  * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
 524  *
 525  ******************************************************************************/
 526
 527 ACPI_STATUS
 528 AcpiHwEnableAllWakeupGpes (
 529     void)
 530 {
 531     ACPI_STATUS             Status;
 532
 533
 534     ACPI_FUNCTION_TRACE ("HwEnableAllWakeupGpes");
 535
 536
 537     Status = AcpiEvWalkGpeList (AcpiHwEnableWakeupGpeBlock);
 538     return_ACPI_STATUS (Status);
 539 }
 540