reactos/drivers/bus/acpi/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 - 2015, 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 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acevents.h"
 119
 120 #define _COMPONENT          ACPI_EVENTS
 121         ACPI_MODULE_NAME    ("evgpeutil")
 122
 123
 124 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    AcpiEvWalkGpeList
 128  *
 129  * PARAMETERS:  GpeWalkCallback     - Routine called for each GPE block
 130  *              Context             - Value passed to callback
 131  *
 132  * RETURN:      Status
 133  *
 134  * DESCRIPTION: Walk the GPE lists.
 135  *
 136  ******************************************************************************/
 137
 138 ACPI_STATUS
 139 AcpiEvWalkGpeList (
 140     ACPI_GPE_CALLBACK       GpeWalkCallback,
 141     void                    *Context)
 142 {
 143     ACPI_GPE_BLOCK_INFO     *GpeBlock;
 144     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
 145     ACPI_STATUS             Status = AE_OK;
 146     ACPI_CPU_FLAGS          Flags;
 147
 148
 149     ACPI_FUNCTION_TRACE (EvWalkGpeList);
 150
 151
 152     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 153
 154     /* Walk the interrupt level descriptor list */
 155
 156     GpeXruptInfo = AcpiGbl_GpeXruptListHead;
 157     while (GpeXruptInfo)
 158     {
 159         /* Walk all Gpe Blocks attached to this interrupt level */
 160
 161         GpeBlock = GpeXruptInfo->GpeBlockListHead;
 162         while (GpeBlock)
 163         {
 164             /* One callback per GPE block */
 165
 166             Status = GpeWalkCallback (GpeXruptInfo, GpeBlock, Context);
 167             if (ACPI_FAILURE (Status))
 168             {
 169                 if (Status == AE_CTRL_END) /* Callback abort */
 170                 {
 171                     Status = AE_OK;
 172                 }
 173                 goto UnlockAndExit;
 174             }
 175
 176             GpeBlock = GpeBlock->Next;
 177         }
 178
 179         GpeXruptInfo = GpeXruptInfo->Next;
 180     }
 181
 182 UnlockAndExit:
 183     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 184     return_ACPI_STATUS (Status);
 185 }
 186
 187
 188 /*******************************************************************************
 189  *
 190  * FUNCTION:    AcpiEvGetGpeDevice
 191  *
 192  * PARAMETERS:  GPE_WALK_CALLBACK
 193  *
 194  * RETURN:      Status
 195  *
 196  * DESCRIPTION: Matches the input GPE index (0-CurrentGpeCount) with a GPE
 197  *              block device. NULL if the GPE is one of the FADT-defined GPEs.
 198  *
 199  ******************************************************************************/
 200
 201 ACPI_STATUS
 202 AcpiEvGetGpeDevice (
 203     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 204     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 205     void                    *Context)
 206 {
 207     ACPI_GPE_DEVICE_INFO    *Info = Context;
 208
 209
 210     /* Increment Index by the number of GPEs in this block */
 211
 212     Info->NextBlockBaseIndex += GpeBlock->GpeCount;
 213
 214     if (Info->Index < Info->NextBlockBaseIndex)
 215     {
 216         /*
 217          * The GPE index is within this block, get the node. Leave the node
 218          * NULL for the FADT-defined GPEs
 219          */
 220         if ((GpeBlock->Node)->Type == ACPI_TYPE_DEVICE)
 221         {
 222             Info->GpeDevice = GpeBlock->Node;
 223         }
 224
 225         Info->Status = AE_OK;
 226         return (AE_CTRL_END);
 227     }
 228
 229     return (AE_OK);
 230 }
 231
 232
 233 /*******************************************************************************
 234  *
 235  * FUNCTION:    AcpiEvGetGpeXruptBlock
 236  *
 237  * PARAMETERS:  InterruptNumber             - Interrupt for a GPE block
 238  *              GpeXruptBlock               - Where the block is returned
 239  *
 240  * RETURN:      Status
 241  *
 242  * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt
 243  *              block per unique interrupt level used for GPEs. Should be
 244  *              called only when the GPE lists are semaphore locked and not
 245  *              subject to change.
 246  *
 247  ******************************************************************************/
 248
 249 ACPI_STATUS
 250 AcpiEvGetGpeXruptBlock (
 251     UINT32                  InterruptNumber,
 252     ACPI_GPE_XRUPT_INFO     **GpeXruptBlock)
 253 {
 254     ACPI_GPE_XRUPT_INFO     *NextGpeXrupt;
 255     ACPI_GPE_XRUPT_INFO     *GpeXrupt;
 256     ACPI_STATUS             Status;
 257     ACPI_CPU_FLAGS          Flags;
 258
 259
 260     ACPI_FUNCTION_TRACE (EvGetGpeXruptBlock);
 261
 262
 263     /* No need for lock since we are not changing any list elements here */
 264
 265     NextGpeXrupt = AcpiGbl_GpeXruptListHead;
 266     while (NextGpeXrupt)
 267     {
 268         if (NextGpeXrupt->InterruptNumber == InterruptNumber)
 269         {
 270             *GpeXruptBlock = NextGpeXrupt;
 271             return_ACPI_STATUS (AE_OK);
 272         }
 273
 274         NextGpeXrupt = NextGpeXrupt->Next;
 275     }
 276
 277     /* Not found, must allocate a new xrupt descriptor */
 278
 279     GpeXrupt = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_XRUPT_INFO));
 280     if (!GpeXrupt)
 281     {
 282         return_ACPI_STATUS (AE_NO_MEMORY);
 283     }
 284
 285     GpeXrupt->InterruptNumber = InterruptNumber;
 286
 287     /* Install new interrupt descriptor with spin lock */
 288
 289     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 290     if (AcpiGbl_GpeXruptListHead)
 291     {
 292         NextGpeXrupt = AcpiGbl_GpeXruptListHead;
 293         while (NextGpeXrupt->Next)
 294         {
 295             NextGpeXrupt = NextGpeXrupt->Next;
 296         }
 297
 298         NextGpeXrupt->Next = GpeXrupt;
 299         GpeXrupt->Previous = NextGpeXrupt;
 300     }
 301     else
 302     {
 303         AcpiGbl_GpeXruptListHead = GpeXrupt;
 304     }
 305
 306     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 307
 308     /* Install new interrupt handler if not SCI_INT */
 309
 310     if (InterruptNumber != AcpiGbl_FADT.SciInterrupt)
 311     {
 312         Status = AcpiOsInstallInterruptHandler (InterruptNumber,
 313                     AcpiEvGpeXruptHandler, GpeXrupt);
 314         if (ACPI_FAILURE (Status))
 315         {
 316             ACPI_EXCEPTION ((AE_INFO, Status,
 317                 "Could not install GPE interrupt handler at level 0x%X",
 318                 InterruptNumber));
 319             return_ACPI_STATUS (Status);
 320         }
 321     }
 322
 323     *GpeXruptBlock = GpeXrupt;
 324     return_ACPI_STATUS (AE_OK);
 325 }
 326
 327
 328 /*******************************************************************************
 329  *
 330  * FUNCTION:    AcpiEvDeleteGpeXrupt
 331  *
 332  * PARAMETERS:  GpeXrupt        - A GPE interrupt info block
 333  *
 334  * RETURN:      Status
 335  *
 336  * DESCRIPTION: Remove and free a GpeXrupt block. Remove an associated
 337  *              interrupt handler if not the SCI interrupt.
 338  *
 339  ******************************************************************************/
 340
 341 ACPI_STATUS
 342 AcpiEvDeleteGpeXrupt (
 343     ACPI_GPE_XRUPT_INFO     *GpeXrupt)
 344 {
 345     ACPI_STATUS             Status;
 346     ACPI_CPU_FLAGS          Flags;
 347
 348
 349     ACPI_FUNCTION_TRACE (EvDeleteGpeXrupt);
 350
 351
 352     /* We never want to remove the SCI interrupt handler */
 353
 354     if (GpeXrupt->InterruptNumber == AcpiGbl_FADT.SciInterrupt)
 355     {
 356         GpeXrupt->GpeBlockListHead = NULL;
 357         return_ACPI_STATUS (AE_OK);
 358     }
 359
 360     /* Disable this interrupt */
 361
 362     Status = AcpiOsRemoveInterruptHandler (
 363                 GpeXrupt->InterruptNumber, AcpiEvGpeXruptHandler);
 364     if (ACPI_FAILURE (Status))
 365     {
 366         return_ACPI_STATUS (Status);
 367     }
 368
 369     /* Unlink the interrupt block with lock */
 370
 371     Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
 372     if (GpeXrupt->Previous)
 373     {
 374         GpeXrupt->Previous->Next = GpeXrupt->Next;
 375     }
 376     else
 377     {
 378         /* No previous, update list head */
 379
 380         AcpiGbl_GpeXruptListHead = GpeXrupt->Next;
 381     }
 382
 383     if (GpeXrupt->Next)
 384     {
 385         GpeXrupt->Next->Previous = GpeXrupt->Previous;
 386     }
 387     AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
 388
 389     /* Free the block */
 390
 391     ACPI_FREE (GpeXrupt);
 392     return_ACPI_STATUS (AE_OK);
 393 }
 394
 395
 396 /*******************************************************************************
 397  *
 398  * FUNCTION:    AcpiEvDeleteGpeHandlers
 399  *
 400  * PARAMETERS:  GpeXruptInfo        - GPE Interrupt info
 401  *              GpeBlock            - Gpe Block info
 402  *
 403  * RETURN:      Status
 404  *
 405  * DESCRIPTION: Delete all Handler objects found in the GPE data structs.
 406  *              Used only prior to termination.
 407  *
 408  ******************************************************************************/
 409
 410 ACPI_STATUS
 411 AcpiEvDeleteGpeHandlers (
 412     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
 413     ACPI_GPE_BLOCK_INFO     *GpeBlock,
 414     void                    *Context)
 415 {
 416     ACPI_GPE_EVENT_INFO     *GpeEventInfo;
 417     ACPI_GPE_NOTIFY_INFO    *Notify;
 418     ACPI_GPE_NOTIFY_INFO    *Next;
 419     UINT32                  i;
 420     UINT32                  j;
 421
 422
 423     ACPI_FUNCTION_TRACE (EvDeleteGpeHandlers);
 424
 425
 426     /* Examine each GPE Register within the block */
 427
 428     for (i = 0; i < GpeBlock->RegisterCount; i++)
 429     {
 430         /* Now look at the individual GPEs in this byte register */
 431
 432         for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++)
 433         {
 434             GpeEventInfo = &GpeBlock->EventInfo[((ACPI_SIZE) i *
 435                 ACPI_GPE_REGISTER_WIDTH) + j];
 436
 437             if ((ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
 438                     ACPI_GPE_DISPATCH_HANDLER) ||
 439                 (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
 440                     ACPI_GPE_DISPATCH_RAW_HANDLER))
 441             {
 442                 /* Delete an installed handler block */
 443
 444                 ACPI_FREE (GpeEventInfo->Dispatch.Handler);
 445                 GpeEventInfo->Dispatch.Handler = NULL;
 446                 GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK;
 447             }
 448             else if (ACPI_GPE_DISPATCH_TYPE (GpeEventInfo->Flags) ==
 449                     ACPI_GPE_DISPATCH_NOTIFY)
 450             {
 451                 /* Delete the implicit notification device list */
 452
 453                 Notify = GpeEventInfo->Dispatch.NotifyList;
 454                 while (Notify)
 455                 {
 456                     Next = Notify->Next;
 457                     ACPI_FREE (Notify);
 458                     Notify = Next;
 459                 }
 460                 GpeEventInfo->Dispatch.NotifyList = NULL;
 461                 GpeEventInfo->Flags &= ~ACPI_GPE_DISPATCH_MASK;
 462             }
 463         }
 464     }
 465
 466     return_ACPI_STATUS (AE_OK);
 467 }
 468
 469 #endif /* !ACPI_REDUCED_HARDWARE */