sys/contrib/dev/acpica/evgpe.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evgpe - General Purpose Event handling and dispatch
   4  *              $Revision: 12 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/evgpe.c,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 117
 118 #include "acpi.h"
 119 #include "acevents.h"
 120 #include "acnamesp.h"
 121
 122 #define _COMPONENT          ACPI_EVENTS
 123         ACPI_MODULE_NAME    ("evgpe")
 124
 125
 126 /*******************************************************************************
 127  *
 128  * FUNCTION:    AcpiEvGetGpeEventInfo
 129  *
 130  * PARAMETERS:  GpeNumber       - Raw GPE number
 131  *
 132  * RETURN:      None.
 133  *
 134  * DESCRIPTION: Returns the EventInfo struct
 135  *              associated with this GPE.
 136  *
 137  * TBD: this function will go away when full support of GPE block devices
 138  *      is implemented!
 139  *
 140  ******************************************************************************/
 141
 142 ACPI_GPE_EVENT_INFO *
 143 AcpiEvGetGpeEventInfo (
 144     UINT32                  GpeNumber)
 145 {
 146     ACPI_GPE_BLOCK_INFO     *GpeBlock;
 147
 148
 149     /* Examine GPE Block 0 */
 150
 151     GpeBlock = AcpiGbl_GpeBlockListHead;
 152     if (!GpeBlock)
 153     {
 154         return (NULL);
 155     }
 156
 157     if ((GpeNumber >= GpeBlock->BlockBaseNumber) &&
 158         (GpeNumber < GpeBlock->BlockBaseNumber + (GpeBlock->RegisterCount * 8)))
 159     {
 160         return (&GpeBlock->EventInfo[GpeNumber - GpeBlock->BlockBaseNumber]);
 161     }
 162
 163     /* Examine GPE Block 1 */
 164
 165     GpeBlock = GpeBlock->Next;
 166     if (!GpeBlock)
 167     {
 168         return (NULL);
 169     }
 170
 171     if ((GpeNumber >= GpeBlock->BlockBaseNumber) &&
 172         (GpeNumber < GpeBlock->BlockBaseNumber + (GpeBlock->RegisterCount * 8)))
 173     {
 174         return (&GpeBlock->EventInfo[GpeNumber - GpeBlock->BlockBaseNumber]);
 175     }
 176
 177     return (NULL);
 178 }
 179
 180 /*******************************************************************************
 181  *
 182  * FUNCTION:    AcpiEvGpeDetect
 183  *
 184  * PARAMETERS:  None
 185  *
 186  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 187  *
 188  * DESCRIPTION: Detect if any GP events have occurred.  This function is
 189  *              executed at interrupt level.
 190  *
 191  ******************************************************************************/
 192
 193 UINT32
 194 AcpiEvGpeDetect (void)
 195 {
 196     UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
 197     UINT32                  i;
 198     UINT32                  j;
 199     UINT8                   EnabledStatusByte;
 200     UINT8                   BitMask;
 201     ACPI_GPE_REGISTER_INFO  *GpeRegisterInfo;
 202     UINT32                  InValue;
 203     ACPI_STATUS             Status;
 204     ACPI_GPE_BLOCK_INFO     *GpeBlock;
 205
 206
 207     ACPI_FUNCTION_NAME ("EvGpeDetect");
 208
 209
 210     /* Examine all GPE blocks attached to this interrupt level */
 211
 212     GpeBlock = AcpiGbl_GpeBlockListHead;
 213     while (GpeBlock)
 214     {
 215         /*
 216          * Read all of the 8-bit GPE status and enable registers
 217          * in this GPE block, saving all of them.
 218          * Find all currently active GP events.
 219          */
 220         for (i = 0; i < GpeBlock->RegisterCount; i++)
 221         {
 222             /* Get the next status/enable pair */
 223
 224             GpeRegisterInfo = &GpeBlock->RegisterInfo[i];
 225
 226             Status = AcpiHwLowLevelRead (ACPI_GPE_REGISTER_WIDTH, &InValue,
 227                         &GpeRegisterInfo->StatusAddress, 0);
 228             GpeRegisterInfo->Status = (UINT8) InValue;
 229             if (ACPI_FAILURE (Status))
 230             {
 231                 return (ACPI_INTERRUPT_NOT_HANDLED);
 232             }
 233
 234             Status = AcpiHwLowLevelRead (ACPI_GPE_REGISTER_WIDTH, &InValue,
 235                         &GpeRegisterInfo->EnableAddress, 0);
 236             GpeRegisterInfo->Enable = (UINT8) InValue;
 237             if (ACPI_FAILURE (Status))
 238             {
 239                 return (ACPI_INTERRUPT_NOT_HANDLED);
 240             }
 241
 242             ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
 243                 "GPE block at %8.8X%8.8X - Values: Enable %02X Status %02X\n",
 244                 ACPI_HIDWORD (ACPI_GET_ADDRESS (GpeRegisterInfo->EnableAddress.Address)),
 245                 ACPI_LODWORD (ACPI_GET_ADDRESS (GpeRegisterInfo->EnableAddress.Address)),
 246                 GpeRegisterInfo->Enable,
 247                 GpeRegisterInfo->Status));
 248
 249             /* First check if there is anything active at all in this register */
 250
 251             EnabledStatusByte = (UINT8) (GpeRegisterInfo->Status &
 252                                          GpeRegisterInfo->Enable);
 253             if (!EnabledStatusByte)
 254             {
 255                 /* No active GPEs in this register, move on */
 256
 257                 continue;
 258             }
 259
 260             /* Now look at the individual GPEs in this byte register */
 261
 262             for (j = 0, BitMask = 1; j < ACPI_GPE_REGISTER_WIDTH; j++, BitMask <<= 1)
 263             {
 264                 /* Examine one GPE bit */
 265
 266                 if (EnabledStatusByte & BitMask)
 267                 {
 268                     /*
 269                      * Found an active GPE. Dispatch the event to a handler
 270                      * or method.
 271                      */
 272                     IntStatus |= AcpiEvGpeDispatch (
 273                                     &GpeBlock->EventInfo[(i * ACPI_GPE_REGISTER_WIDTH) +j]);
 274                 }
 275             }
 276         }
 277
 278         GpeBlock = GpeBlock->Next;
 279     }
 280
 281     return (IntStatus);
 282 }
 283
 284
 285 /*******************************************************************************
 286  *
 287  * FUNCTION:    AcpiEvAsynchExecuteGpeMethod
 288  *
 289  * PARAMETERS:  GpeEventInfo - Info for this GPE
 290  *
 291  * RETURN:      None
 292  *
 293  * DESCRIPTION: Perform the actual execution of a GPE control method.  This
 294  *              function is called from an invocation of AcpiOsQueueForExecution
 295  *              (and therefore does NOT execute at interrupt level) so that
 296  *              the control method itself is not executed in the context of
 297  *              the SCI interrupt handler.
 298  *
 299  ******************************************************************************/
 300
 301 static void ACPI_SYSTEM_XFACE
 302 AcpiEvAsynchExecuteGpeMethod (
 303     void                    *Context)
 304 {
 305     ACPI_GPE_EVENT_INFO     *GpeEventInfo = (void *) Context;
 306     UINT32                  GpeNumber = 0;
 307     ACPI_STATUS             Status;
 308
 309
 310     ACPI_FUNCTION_TRACE ("EvAsynchExecuteGpeMethod");
 311
 312
 313     /*
 314      * Take a snapshot of the GPE info for this level - we copy the
 315      * info to prevent a race condition with RemoveHandler.
 316      */
 317     Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
 318     if (ACPI_FAILURE (Status))
 319     {
 320         return_VOID;
 321     }
 322
 323     Status = AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
 324     if (ACPI_FAILURE (Status))
 325     {
 326         return_VOID;
 327     }
 328
 329     if (GpeEventInfo->MethodNode)
 330     {
 331         /*
 332          * Invoke the GPE Method (_Lxx, _Exx):
 333          * (Evaluate the _Lxx/_Exx control method that corresponds to this GPE.)
 334          */
 335         Status = AcpiNsEvaluateByHandle (GpeEventInfo->MethodNode, NULL, NULL);
 336         if (ACPI_FAILURE (Status))
 337         {
 338             ACPI_REPORT_ERROR (("%s while evaluating method [%4.4s] for GPE[%2.2X]\n",
 339                 AcpiFormatException (Status),
 340                 GpeEventInfo->MethodNode->Name.Ascii, GpeNumber));
 341         }
 342     }
 343
 344     if (GpeEventInfo->Type & ACPI_EVENT_LEVEL_TRIGGERED)
 345     {
 346         /*
 347          * GPE is level-triggered, we clear the GPE status bit after handling
 348          * the event.
 349          */
 350         Status = AcpiHwClearGpe (GpeEventInfo);
 351         if (ACPI_FAILURE (Status))
 352         {
 353             return_VOID;
 354         }
 355     }
 356
 357     /* Enable this GPE */
 358
 359     (void) AcpiHwEnableGpe (GpeEventInfo);
 360     return_VOID;
 361 }
 362
 363
 364 /*******************************************************************************
 365  *
 366  * FUNCTION:    AcpiEvGpeDispatch
 367  *
 368  * PARAMETERS:  GpeEventInfo   - info for this GPE
 369  *
 370  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 371  *
 372  * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
 373  *              or method (e.g. _Lxx/_Exx) handler.  This function executes
 374  *              at interrupt level.
 375  *
 376  ******************************************************************************/
 377
 378 UINT32
 379 AcpiEvGpeDispatch (
 380     ACPI_GPE_EVENT_INFO     *GpeEventInfo)
 381 {
 382     UINT32                  GpeNumber = 0; /* TBD: remove */
 383     ACPI_STATUS             Status;
 384
 385
 386     ACPI_FUNCTION_TRACE ("EvGpeDispatch");
 387
 388
 389     /*
 390      * If edge-triggered, clear the GPE status bit now.  Note that
 391      * level-triggered events are cleared after the GPE is serviced.
 392      */
 393     if (GpeEventInfo->Type & ACPI_EVENT_EDGE_TRIGGERED)
 394     {
 395         Status = AcpiHwClearGpe (GpeEventInfo);
 396         if (ACPI_FAILURE (Status))
 397         {
 398             ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to clear GPE[%2.2X]\n",
 399                 GpeNumber));
 400             return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
 401         }
 402     }
 403
 404     /*
 405      * Dispatch the GPE to either an installed handler, or the control
 406      * method associated with this GPE (_Lxx or _Exx).
 407      * If a handler exists, we invoke it and do not attempt to run the method.
 408      * If there is neither a handler nor a method, we disable the level to
 409      * prevent further events from coming in here.
 410      */
 411     if (GpeEventInfo->Handler)
 412     {
 413         /* Invoke the installed handler (at interrupt level) */
 414
 415         GpeEventInfo->Handler (GpeEventInfo->Context);
 416     }
 417     else if (GpeEventInfo->MethodNode)
 418     {
 419         /*
 420          * Disable GPE, so it doesn't keep firing before the method has a
 421          * chance to run.
 422          */
 423         Status = AcpiHwDisableGpe (GpeEventInfo);
 424         if (ACPI_FAILURE (Status))
 425         {
 426             ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to disable GPE[%2.2X]\n",
 427                 GpeNumber));
 428             return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
 429         }
 430
 431         /*
 432          * Execute the method associated with the GPE.
 433          */
 434         if (ACPI_FAILURE (AcpiOsQueueForExecution (OSD_PRIORITY_GPE,
 435                                 AcpiEvAsynchExecuteGpeMethod,
 436                                 GpeEventInfo)))
 437         {
 438             ACPI_REPORT_ERROR ((
 439                 "AcpiEvGpeDispatch: Unable to queue handler for GPE[%2.2X], event is disabled\n",
 440                 GpeNumber));
 441         }
 442     }
 443     else
 444     {
 445         /* No handler or method to run! */
 446
 447         ACPI_REPORT_ERROR ((
 448             "AcpiEvGpeDispatch: No handler or method for GPE[%2.2X], disabling event\n",
 449             GpeNumber));
 450
 451         /*
 452          * Disable the GPE.  The GPE will remain disabled until the ACPI
 453          * Core Subsystem is restarted, or the handler is reinstalled.
 454          */
 455         Status = AcpiHwDisableGpe (GpeEventInfo);
 456         if (ACPI_FAILURE (Status))
 457         {
 458             ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to disable GPE[%2.2X]\n",
 459                 GpeNumber));
 460             return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
 461         }
 462     }
 463
 464     /*
 465      * It is now safe to clear level-triggered evnets.
 466      */
 467     if (GpeEventInfo->Type & ACPI_EVENT_LEVEL_TRIGGERED)
 468     {
 469         Status = AcpiHwClearGpe (GpeEventInfo);
 470         if (ACPI_FAILURE (Status))
 471         {
 472             ACPI_REPORT_ERROR (("AcpiEvGpeDispatch: Unable to clear GPE[%2.2X]\n",
 473                 GpeNumber));
 474             return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
 475         }
 476     }
 477
 478     return_VALUE (ACPI_INTERRUPT_HANDLED);
 479 }
 480