sys/contrib/dev/acpica-unix/events/evgpeinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evgpeinit - System GPE initialization and update
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, 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 #include "acpi.h"
 118 #include "accommon.h"
 119 #include "acevents.h"
 120 #include "acnamesp.h"
 121
 122 #define _COMPONENT          ACPI_EVENTS
 123         ACPI_MODULE_NAME    ("evgpeinit")
 124
 125
 126 /*
 127  * Note: History of _PRW support in ACPICA
 128  *
 129  * Originally (2000 - 2010), the GPE initialization code performed a walk of
 130  * the entire namespace to execute the _PRW methods and detect all GPEs
 131  * capable of waking the system.
 132  *
 133  * As of 10/2010, the _PRW method execution has been removed since it is
 134  * actually unnecessary. The host OS must in fact execute all _PRW methods
 135  * in order to identify the device/power-resource dependencies. We now put
 136  * the onus on the host OS to identify the wake GPEs as part of this process
 137  * and to inform ACPICA of these GPEs via the AcpiSetupGpeForWake interface. This
 138  * not only reduces the complexity of the ACPICA initialization code, but in
 139  * some cases (on systems with very large namespaces) it should reduce the
 140  * kernel boot time as well.
 141  */
 142
 143 /*******************************************************************************
 144  *
 145  * FUNCTION:    AcpiEvGpeInitialize
 146  *
 147  * PARAMETERS:  None
 148  *
 149  * RETURN:      Status
 150  *
 151  * DESCRIPTION: Initialize the GPE data structures and the FADT GPE 0/1 blocks
 152  *
 153  ******************************************************************************/
 154
 155 ACPI_STATUS
 156 AcpiEvGpeInitialize (
 157     void)
 158 {
 159     UINT32                  RegisterCount0 = 0;
 160     UINT32                  RegisterCount1 = 0;
 161     UINT32                  GpeNumberMax = 0;
 162     ACPI_STATUS             Status;
 163
 164
 165     ACPI_FUNCTION_TRACE (EvGpeInitialize);
 166
 167
 168     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 169     if (ACPI_FAILURE (Status))
 170     {
 171         return_ACPI_STATUS (Status);
 172     }
 173
 174     /*
 175      * Initialize the GPE Block(s) defined in the FADT
 176      *
 177      * Why the GPE register block lengths are divided by 2:  From the ACPI
 178      * Spec, section "General-Purpose Event Registers", we have:
 179      *
 180      * "Each register block contains two registers of equal length
 181      *  GPEx_STS and GPEx_EN (where x is 0 or 1). The length of the
 182      *  GPE0_STS and GPE0_EN registers is equal to half the GPE0_LEN
 183      *  The length of the GPE1_STS and GPE1_EN registers is equal to
 184      *  half the GPE1_LEN. If a generic register block is not supported
 185      *  then its respective block pointer and block length values in the
 186      *  FADT table contain zeros. The GPE0_LEN and GPE1_LEN do not need
 187      *  to be the same size."
 188      */
 189
 190     /*
 191      * Determine the maximum GPE number for this machine.
 192      *
 193      * Note: both GPE0 and GPE1 are optional, and either can exist without
 194      * the other.
 195      *
 196      * If EITHER the register length OR the block address are zero, then that
 197      * particular block is not supported.
 198      */
 199     if (AcpiGbl_FADT.Gpe0BlockLength &&
 200         AcpiGbl_FADT.XGpe0Block.Address)
 201     {
 202         /* GPE block 0 exists (has both length and address > 0) */
 203
 204         RegisterCount0 = (UINT16) (AcpiGbl_FADT.Gpe0BlockLength / 2);
 205
 206         GpeNumberMax = (RegisterCount0 * ACPI_GPE_REGISTER_WIDTH) - 1;
 207
 208         /* Install GPE Block 0 */
 209
 210         Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
 211                     &AcpiGbl_FADT.XGpe0Block, RegisterCount0, 0,
 212                     AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[0]);
 213
 214         if (ACPI_FAILURE (Status))
 215         {
 216             ACPI_EXCEPTION ((AE_INFO, Status,
 217                 "Could not create GPE Block 0"));
 218         }
 219     }
 220
 221     if (AcpiGbl_FADT.Gpe1BlockLength &&
 222         AcpiGbl_FADT.XGpe1Block.Address)
 223     {
 224         /* GPE block 1 exists (has both length and address > 0) */
 225
 226         RegisterCount1 = (UINT16) (AcpiGbl_FADT.Gpe1BlockLength / 2);
 227
 228         /* Check for GPE0/GPE1 overlap (if both banks exist) */
 229
 230         if ((RegisterCount0) &&
 231             (GpeNumberMax >= AcpiGbl_FADT.Gpe1Base))
 232         {
 233             ACPI_ERROR ((AE_INFO,
 234                 "GPE0 block (GPE 0 to %u) overlaps the GPE1 block "
 235                 "(GPE %u to %u) - Ignoring GPE1",
 236                 GpeNumberMax, AcpiGbl_FADT.Gpe1Base,
 237                 AcpiGbl_FADT.Gpe1Base +
 238                 ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1)));
 239
 240             /* Ignore GPE1 block by setting the register count to zero */
 241
 242             RegisterCount1 = 0;
 243         }
 244         else
 245         {
 246             /* Install GPE Block 1 */
 247
 248             Status = AcpiEvCreateGpeBlock (AcpiGbl_FadtGpeDevice,
 249                         &AcpiGbl_FADT.XGpe1Block, RegisterCount1,
 250                         AcpiGbl_FADT.Gpe1Base,
 251                         AcpiGbl_FADT.SciInterrupt, &AcpiGbl_GpeFadtBlocks[1]);
 252
 253             if (ACPI_FAILURE (Status))
 254             {
 255                 ACPI_EXCEPTION ((AE_INFO, Status,
 256                     "Could not create GPE Block 1"));
 257             }
 258
 259             /*
 260              * GPE0 and GPE1 do not have to be contiguous in the GPE number
 261              * space. However, GPE0 always starts at GPE number zero.
 262              */
 263             GpeNumberMax = AcpiGbl_FADT.Gpe1Base +
 264                             ((RegisterCount1 * ACPI_GPE_REGISTER_WIDTH) - 1);
 265         }
 266     }
 267
 268     /* Exit if there are no GPE registers */
 269
 270     if ((RegisterCount0 + RegisterCount1) == 0)
 271     {
 272         /* GPEs are not required by ACPI, this is OK */
 273
 274         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
 275             "There are no GPE blocks defined in the FADT\n"));
 276         Status = AE_OK;
 277         goto Cleanup;
 278     }
 279
 280     /* Check for Max GPE number out-of-range */
 281
 282     if (GpeNumberMax > ACPI_GPE_MAX)
 283     {
 284         ACPI_ERROR ((AE_INFO,
 285             "Maximum GPE number from FADT is too large: 0x%X",
 286             GpeNumberMax));
 287         Status = AE_BAD_VALUE;
 288         goto Cleanup;
 289     }
 290
 291 Cleanup:
 292     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 293     return_ACPI_STATUS (AE_OK);
 294 }
 295
 296
 297 /*******************************************************************************
 298  *
 299  * FUNCTION:    AcpiEvUpdateGpes
 300  *
 301  * PARAMETERS:  TableOwnerId        - ID of the newly-loaded ACPI table
 302  *
 303  * RETURN:      None
 304  *
 305  * DESCRIPTION: Check for new GPE methods (_Lxx/_Exx) made available as a
 306  *              result of a Load() or LoadTable() operation. If new GPE
 307  *              methods have been installed, register the new methods.
 308  *
 309  ******************************************************************************/
 310
 311 void
 312 AcpiEvUpdateGpes (
 313     ACPI_OWNER_ID           TableOwnerId)
 314 {
 315     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
 316     ACPI_GPE_BLOCK_INFO     *GpeBlock;
 317     ACPI_GPE_WALK_INFO      WalkInfo;
 318     ACPI_STATUS             Status = AE_OK;
 319
 320
 321     /*
 322      * Find any _Lxx/_Exx GPE methods that have just been loaded.
 323      *
 324      * Any GPEs that correspond to new _Lxx/_Exx methods are immediately
 325      * enabled.
 326      *
 327      * Examine the namespace underneath each GpeDevice within the
 328      * GpeBlock lists.
 329      */
 330     Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
 331     if (ACPI_FAILURE (Status))
 332     {
 333         return;
 334     }
 335
 336     WalkInfo.Count = 0;
 337     WalkInfo.OwnerId = TableOwnerId;
 338     WalkInfo.ExecuteByOwnerId = TRUE;
 339
 340     /* Walk the interrupt level descriptor list */
 341
 342     GpeXruptInfo = AcpiGbl_GpeXruptListHead;
 343     while (GpeXruptInfo)
 344     {
 345         /* Walk all Gpe Blocks attached to this interrupt level */
 346
 347         GpeBlock = GpeXruptInfo->GpeBlockListHead;
 348         while (GpeBlock)
 349         {
 350             WalkInfo.GpeBlock = GpeBlock;
 351             WalkInfo.GpeDevice = GpeBlock->Node;
 352
 353             Status = AcpiNsWalkNamespace (ACPI_TYPE_METHOD,
 354                         WalkInfo.GpeDevice, ACPI_UINT32_MAX,
 355                         ACPI_NS_WALK_NO_UNLOCK, AcpiEvMatchGpeMethod,
 356                         NULL, &WalkInfo, NULL);
 357             if (ACPI_FAILURE (Status))
 358             {
 359                 ACPI_EXCEPTION ((AE_INFO, Status,
 360                     "While decoding _Lxx/_Exx methods"));
 361             }
 362
 363             GpeBlock = GpeBlock->Next;
 364         }
 365
 366         GpeXruptInfo = GpeXruptInfo->Next;
 367     }
 368
 369     if (WalkInfo.Count)
 370     {
 371         ACPI_INFO ((AE_INFO, "Enabled %u new GPEs", WalkInfo.Count));
 372     }
 373
 374     (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
 375     return;
 376 }
 377
 378
 379 /*******************************************************************************
 380  *
 381  * FUNCTION:    AcpiEvMatchGpeMethod
 382  *
 383  * PARAMETERS:  Callback from WalkNamespace
 384  *
 385  * RETURN:      Status
 386  *
 387  * DESCRIPTION: Called from AcpiWalkNamespace. Expects each object to be a
 388  *              control method under the _GPE portion of the namespace.
 389  *              Extract the name and GPE type from the object, saving this
 390  *              information for quick lookup during GPE dispatch. Allows a
 391  *              per-OwnerId evaluation if ExecuteByOwnerId is TRUE in the
 392  *              WalkInfo parameter block.
 393  *
 394  *              The name of each GPE control method is of the form:
 395  *              "_Lxx" or "_Exx", where:
 396  *                  L      - means that the GPE is level triggered
 397  *                  E      - means that the GPE is edge triggered
 398  *                  xx     - is the GPE number [in HEX]
 399  *
 400  * If WalkInfo->ExecuteByOwnerId is TRUE, we only execute examine GPE methods
 401  * with that owner.
 402  *
 403  ******************************************************************************/
 404
 405 ACPI_STATUS
 406 AcpiEvMatchGpeMethod (
 407     ACPI_HANDLE             ObjHandle,
 408     UINT32                  Level,
 409     void                    *Context,
 410     void                    **ReturnValue)
 411 {
 412     ACPI_NAMESPACE_NODE     *MethodNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, ObjHandle);
 413     ACPI_GPE_WALK_INFO      *WalkInfo = ACPI_CAST_PTR (ACPI_GPE_WALK_INFO, Context);
 414     ACPI_GPE_EVENT_INFO     *GpeEventInfo;
 415     UINT32                  GpeNumber;
 416     char                    Name[ACPI_NAME_SIZE + 1];
 417     UINT8                   Type;
 418
 419
 420     ACPI_FUNCTION_TRACE (EvMatchGpeMethod);
 421
 422
 423     /* Check if requested OwnerId matches this OwnerId */
 424
 425     if ((WalkInfo->ExecuteByOwnerId) &&
 426         (MethodNode->OwnerId != WalkInfo->OwnerId))
 427     {
 428         return_ACPI_STATUS (AE_OK);
 429     }
 430
 431     /*
 432      * Match and decode the _Lxx and _Exx GPE method names
 433      *
 434      * 1) Extract the method name and null terminate it
 435      */
 436     ACPI_MOVE_32_TO_32 (Name, &MethodNode->Name.Integer);
 437     Name[ACPI_NAME_SIZE] = 0;
 438
 439     /* 2) Name must begin with an underscore */
 440
 441     if (Name[0] != '_')
 442     {
 443         return_ACPI_STATUS (AE_OK); /* Ignore this method */
 444     }
 445
 446     /*
 447      * 3) Edge/Level determination is based on the 2nd character
 448      *    of the method name
 449      */
 450     switch (Name[1])
 451     {
 452     case 'L':
 453         Type = ACPI_GPE_LEVEL_TRIGGERED;
 454         break;
 455
 456     case 'E':
 457         Type = ACPI_GPE_EDGE_TRIGGERED;
 458         break;
 459
 460     default:
 461         /* Unknown method type, just ignore it */
 462
 463         ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
 464             "Ignoring unknown GPE method type: %s "
 465             "(name not of form _Lxx or _Exx)", Name));
 466         return_ACPI_STATUS (AE_OK);
 467     }
 468
 469     /* 4) The last two characters of the name are the hex GPE Number */
 470
 471     GpeNumber = ACPI_STRTOUL (&Name[2], NULL, 16);
 472     if (GpeNumber == ACPI_UINT32_MAX)
 473     {
 474         /* Conversion failed; invalid method, just ignore it */
 475
 476         ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
 477             "Could not extract GPE number from name: %s "
 478             "(name is not of form _Lxx or _Exx)", Name));
 479         return_ACPI_STATUS (AE_OK);
 480     }
 481
 482     /* Ensure that we have a valid GPE number for this GPE block */
 483
 484     GpeEventInfo = AcpiEvLowGetGpeInfo (GpeNumber, WalkInfo->GpeBlock);
 485     if (!GpeEventInfo)
 486     {
 487         /*
 488          * This GpeNumber is not valid for this GPE block, just ignore it.
 489          * However, it may be valid for a different GPE block, since GPE0
 490          * and GPE1 methods both appear under \_GPE.
 491          */
 492         return_ACPI_STATUS (AE_OK);
 493     }
 494
 495     if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
 496             ACPI_GPE_DISPATCH_HANDLER)
 497     {
 498         /* If there is already a handler, ignore this GPE method */
 499
 500         return_ACPI_STATUS (AE_OK);
 501     }
 502
 503     if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
 504             ACPI_GPE_DISPATCH_METHOD)
 505     {
 506         /*
 507          * If there is already a method, ignore this method. But check
 508          * for a type mismatch (if both the _Lxx AND _Exx exist)
 509          */
 510         if (Type != (GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK))
 511         {
 512             ACPI_ERROR ((AE_INFO,
 513                 "For GPE 0x%.2X, found both _L%2.2X and _E%2.2X methods",
 514                 GpeNumber, GpeNumber, GpeNumber));
 515         }
 516         return_ACPI_STATUS (AE_OK);
 517     }
 518
 519     /*
 520      * Add the GPE information from above to the GpeEventInfo block for
 521      * use during dispatch of this GPE.
 522      */
 523     GpeEventInfo->Flags &= ~(ACPI_GPE_DISPATCH_MASK);
 524     GpeEventInfo->Flags |= (UINT8) (Type | ACPI_GPE_DISPATCH_METHOD);
 525     GpeEventInfo->Dispatch.MethodNode = MethodNode;
 526
 527     ACPI_DEBUG_PRINT ((ACPI_DB_LOAD,
 528         "Registered GPE method %s as GPE number 0x%.2X\n",
 529         Name, GpeNumber));
 530     return_ACPI_STATUS (AE_OK);
 531 }