sys/contrib/dev/acpica/events/evgpeutil.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evgpeutil - GPE utilities
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116
 117
 118 #include <contrib/dev/acpica/include/acpi.h>
 119 #include <contrib/dev/acpica/include/accommon.h>
 120 #include <contrib/dev/acpica/include/acevents.h>
 121
 122 #define _COMPONENT          ACPI_EVENTS
 123         ACPI_MODULE_NAME    ("evgpeutil")
 124
 125
 126 /*******************************************************************************
 127  *
 128  * FUNCTION:    AcpiEvWalkGpeList
 129  *
 130  * PARAMETERS:  GpeWalkCallback     - Routine called for each GPE block
 131  *              Context             - Value passed to callback
 132  *
 133  * RETURN:      Status
 134  *
 135  * DESCRIPTION: Walk the GPE lists.
 136  *
 137  ******************************************************************************/
 138
 139 ACPI_STATUS
 140 AcpiEvWalkGpeList (
 141     ACPI_GPE_CALLBACK       GpeWalkCallback,
 142     void                    *Context)
 143 {
 144     ACPI_GPE_BLOCK_INFO     *GpeBlock;
 145     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
 146     ACPI_STATUS             Status = AE_OK;
 147     ACPI_CPU_FLAGS          Flags;
 148
 149
 150     ACPI_FUNCTION_TRACE (EvWalkGpeList);
 151
 152
 153     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 154
 155     /* Walk the interrupt level descriptor list */
 156
 157     GpeXruptInfo = AcpiGbl_GpeXruptListHead;
 158     while (GpeXruptInfo)
 159     {
 160         /* Walk all Gpe Blocks attached to this interrupt level */
 161
 162         GpeBlock = GpeXruptInfo->GpeBlockListHead;
 163         while (GpeBlock)
 164         {
 165             /* One callback per GPE block */
 166
 167             Status = GpeWalkCallback (GpeXruptInfo, GpeBlock, Context);
 168             if (ACPI_FAILURE (Status))
 169             {
 170                 if (Status == AE_CTRL_END) /* Callback abort */
 171                 {
 172                     Status = AE_OK;
 173                 }
 174                 goto UnlockAndExit;
 175             }
 176
 177             GpeBlock = GpeBlock->Next;
 178         }
 179
 180         GpeXruptInfo = GpeXruptInfo->Next;
 181     }
 182
 183 UnlockAndExit:
 184     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 185     return_ACPI_STATUS (Status);
 186 }
 187
 188
 189 /*******************************************************************************
 190  *
 191  * FUNCTION:    AcpiEvValidGpeEvent
 192  *
 193  * PARAMETERS:  GpeEventInfo                - Info for this GPE
 194  *
 195  * RETURN:      TRUE if the GpeEvent is valid
 196  *
 197  * DESCRIPTION: Validate a GPE event. DO NOT CALL FROM INTERRUPT LEVEL.
 198  *              Should be called only when the GPE lists are semaphore locked
 199  *              and not subject to change.
 200  *
 201  ******************************************************************************/
 202
 203 BOOLEAN
 204 AcpiEvValidGpeEvent (
 205     ACPI_GPE_EVENT_INFO     *GpeEventInfo)
 206 {
 207     ACPI_GPE_XRUPT_INFO     *GpeXruptBlock;
 208     ACPI_GPE_BLOCK_INFO     *GpeBlock;
 209
 210
 211     ACPI_FUNCTION_ENTRY ();
 212
 213
 214     /* No need for spin lock since we are not changing any list elements */
 215
 216     /* Walk the GPE interrupt levels */
 217
 218     GpeXruptBlock = AcpiGbl_GpeXruptListHead;
 219     while (GpeXruptBlock)
 220     {
 221         GpeBlock = GpeXruptBlock->GpeBlockListHead;
 222
 223         /* Walk the GPE blocks on this interrupt level */
 224
 225         while (GpeBlock)
 226         {
 227             if ((&GpeBlock->EventInfo[0] <= GpeEventInfo) &&
 228                 (&GpeBlock->EventInfo[GpeBlock->GpeCount] > GpeEventInfo))
 229             {
 230                 return (TRUE);
 231             }
 232
 233             GpeBlock = GpeBlock->Next;
 234         }
 235
 236         GpeXruptBlock = GpeXruptBlock->Next;
 237     }
 238
 239     return (FALSE);
 240 }
 241
 242
 243 /*******************************************************************************
 244  *
 245  * FUNCTION:    AcpiEvGetGpeXruptBlock
 246  *
 247  * PARAMETERS:  InterruptNumber      - Interrupt for a GPE block
 248  *
 249  * RETURN:      A GPE interrupt block
 250  *
 251  * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt
 252  *              block per unique interrupt level used for GPEs. Should be
 253  *              called only when the GPE lists are semaphore locked and not
 254  *              subject to change.
 255  *
 256  ******************************************************************************/
 257
 258 ACPI_GPE_XRUPT_INFO *
 259 AcpiEvGetGpeXruptBlock (
 260     UINT32                  InterruptNumber)
 261 {
 262     ACPI_GPE_XRUPT_INFO     *NextGpeXrupt;
 263     ACPI_GPE_XRUPT_INFO     *GpeXrupt;
 264     ACPI_STATUS             Status;
 265     ACPI_CPU_FLAGS          Flags;
 266
 267
 268     ACPI_FUNCTION_TRACE (EvGetGpeXruptBlock);
 269
 270
 271     /* No need for lock since we are not changing any list elements here */
 272
 273     NextGpeXrupt = AcpiGbl_GpeXruptListHead;
 274     while (NextGpeXrupt)
 275     {
 276         if (NextGpeXrupt->InterruptNumber == InterruptNumber)
 277         {
 278             return_PTR (NextGpeXrupt);
 279         }
 280
 281         NextGpeXrupt = NextGpeXrupt->Next;
 282     }
 283
 284     /* Not found, must allocate a new xrupt descriptor */
 285
 286     GpeXrupt = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_XRUPT_INFO));
 287     if (!GpeXrupt)
 288     {
 289         return_PTR (NULL);
 290     }
 291
 292     GpeXrupt->InterruptNumber = InterruptNumber;
 293
 294     /* Install new interrupt descriptor with spin lock */
 295
 296     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 297     if (AcpiGbl_GpeXruptListHead)
 298     {
 299         NextGpeXrupt = AcpiGbl_GpeXruptListHead;
 300         while (NextGpeXrupt->Next)
 301         {
 302             NextGpeXrupt = NextGpeXrupt->Next;
 303         }
 304
 305         NextGpeXrupt->Next = GpeXrupt;
 306         GpeXrupt->Previous = NextGpeXrupt;
 307     }
 308     else
 309     {
 310         AcpiGbl_GpeXruptListHead = GpeXrupt;
 311     }
 312     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 313
 314     /* Install new interrupt handler if not SCI_INT */
 315
 316     if (InterruptNumber != AcpiGbl_FADT.SciInterrupt)
 317     {
 318         Status = AcpiOsInstallInterruptHandler (InterruptNumber,
 319                     AcpiEvGpeXruptHandler, GpeXrupt);
 320         if (ACPI_FAILURE (Status))
 321         {
 322             ACPI_ERROR ((AE_INFO,
 323                 "Could not install GPE interrupt handler at level 0x%X",
 324                 InterruptNumber));
 325             return_PTR (NULL);
 326         }
 327     }
 328
 329     return_PTR (GpeXrupt);
 330 }
 331
 332
 333 /*******************************************************************************
 334  *
 335  * FUNCTION:    AcpiEvDeleteGpeXrupt
 336  *
 337  * PARAMETERS:  GpeXrupt        - A GPE interrupt info block
 338  *
 339  * RETURN:      Status
 340  *
 341  * DESCRIPTION: Remove and free a GpeXrupt block. Remove an associated
 342  *              interrupt handler if not the SCI interrupt.
 343  *
 344  ******************************************************************************/
 345
 346 ACPI_STATUS
 347 AcpiEvDeleteGpeXrupt (
 348     ACPI_GPE_XRUPT_INFO     *GpeXrupt)
 349 {
 350     ACPI_STATUS             Status;
 351     ACPI_CPU_FLAGS          Flags;
 352
 353
 354     ACPI_FUNCTION_TRACE (EvDeleteGpeXrupt);
 355
 356
 357     /* We never want to remove the SCI interrupt handler */
 358
 359     if (GpeXrupt->InterruptNumber == AcpiGbl_FADT.SciInterrupt)
 360     {
 361         GpeXrupt->GpeBlockListHead = NULL;
 362         return_ACPI_STATUS (AE_OK);
 363     }
 364
 365     /* Disable this interrupt */
 366
 367     Status = AcpiOsRemoveInterruptHandler (
 368                 GpeXrupt->InterruptNumber, AcpiEvGpeXruptHandler);
 369     if (ACPI_FAILURE (Status))
 370     {
 371         return_ACPI_STATUS (Status);
 372     }
 373
 374     /* Unlink the interrupt block with lock */
 375
 376     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 377     if (GpeXrupt->Previous)
 378     {
 379         GpeXrupt->Previous->Next = GpeXrupt->Next;
 380     }
 381     else
 382     {
 383         /* No previous, update list head */
 384
 385         AcpiGbl_GpeXruptListHead = GpeXrupt->Next;
 386     }
 387
 388     if (GpeXrupt->Next)
 389     {
 390         GpeXrupt->Next->Previous = GpeXrupt->Previous;
 391     }
 392     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 393
 394     /* Free the block */
 395
 396     ACPI_FREE (GpeXrupt);
 397     return_ACPI_STATUS (AE_OK);
 398 }
 399
 400
 401 /*******************************************************************************
 402  *
 403  * FUNCTION:    AcpiEvDeleteGpeHandlers
 404  *
 405  * PARAMETERS:  GpeXruptInfo        - GPE Interrupt info
 406  *              GpeBlock            - Gpe Block info
 407  *
 408  * RETURN:      Status
 409  *
 410  * DESCRIPTION: Delete all Handler objects found in the GPE data structs.
 411  *              Used only prior to termination.
 412  *
 413  ******************************************************************************/
 414
 415 ACPI_STATUS
 416 AcpiEvDeleteGpeHandlers (
 417     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 418     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 419     void                    *Context)
 420 {
 421     ACPI_GPE_EVENT_INFO     *GpeEventInfo;
 422     UINT32                  i;
 423     UINT32                  j;
 424
 425
 426     ACPI_FUNCTION_TRACE (EvDeleteGpeHandlers);
 427
 428
 429     /* Examine each GPE Register within the block */
 430
 431     for (i = 0; i < GpeBlock->RegisterCount; i++)
 432     {
 433         /* Now look at the individual GPEs in this byte register */
 434
 435         for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++)
 436         {
 437             GpeEventInfo = &GpeBlock->EventInfo[((ACPI_SIZE) i *
 438                 ACPI_GPE_REGISTER_WIDTH) + j];
 439
 440             if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
 441                     ACPI_GPE_DISPATCH_HANDLER)
 442             {
 443                 ACPI_FREE (GpeEventInfo->Dispatch.Handler);
 444                 GpeEventInfo->Dispatch.Handler = NULL;
 445                 GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK;
 446             }
 447         }
 448     }
 449
 450     return_ACPI_STATUS (AE_OK);
 451 }
 452