drivers/acpi/events/evgpeblk.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evgpeblk - GPE block creation and initialization.
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/acevents.h>
  46 #include <acpi/acnamesp.h>
  47
  48 #define _COMPONENT          ACPI_EVENTS
  49 ACPI_MODULE_NAME("evgpeblk")
  50
  51 /* Local prototypes */
  52 static acpi_status
  53 acpi_ev_save_method_info(acpi_handle obj_handle,
  54                          u32 level, void *obj_desc, void **return_value);
  55
  56 static acpi_status
  57 acpi_ev_match_prw_and_gpe(acpi_handle obj_handle,
  58                           u32 level, void *info, void **return_value);
  59
  60 static struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32
  61                                                                interrupt_number);
  62
  63 static acpi_status
  64 acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt);
  65
  66 static acpi_status
  67 acpi_ev_install_gpe_block(struct acpi_gpe_block_info *gpe_block,
  68                           u32 interrupt_number);
  69
  70 static acpi_status
  71 acpi_ev_create_gpe_info_blocks(struct acpi_gpe_block_info *gpe_block);
  72
  73 /*******************************************************************************
  74  *
  75  * FUNCTION:    acpi_ev_valid_gpe_event
  76  *
  77  * PARAMETERS:  gpe_event_info              - Info for this GPE
  78  *
  79  * RETURN:      TRUE if the gpe_event is valid
  80  *
  81  * DESCRIPTION: Validate a GPE event. DO NOT CALL FROM INTERRUPT LEVEL.
  82  *              Should be called only when the GPE lists are semaphore locked
  83  *              and not subject to change.
  84  *
  85  ******************************************************************************/
  86
  87 u8 acpi_ev_valid_gpe_event(struct acpi_gpe_event_info *gpe_event_info)
  88 {
  89         struct acpi_gpe_xrupt_info *gpe_xrupt_block;
  90         struct acpi_gpe_block_info *gpe_block;
  91
  92         ACPI_FUNCTION_ENTRY();
  93
  94         /* No need for spin lock since we are not changing any list elements */
  95
  96         /* Walk the GPE interrupt levels */
  97
  98         gpe_xrupt_block = acpi_gbl_gpe_xrupt_list_head;
  99         while (gpe_xrupt_block) {
 100                 gpe_block = gpe_xrupt_block->gpe_block_list_head;
 101
 102                 /* Walk the GPE blocks on this interrupt level */
 103
 104                 while (gpe_block) {
 105                         if ((&gpe_block->event_info[0] <= gpe_event_info) &&
 106                             (&gpe_block->
 107                              event_info[((acpi_size) gpe_block->
 108                                          register_count) * 8] >
 109                              gpe_event_info)) {
 110                                 return (TRUE);
 111                         }
 112
 113                         gpe_block = gpe_block->next;
 114                 }
 115
 116                 gpe_xrupt_block = gpe_xrupt_block->next;
 117         }
 118
 119         return (FALSE);
 120 }
 121
 122 /*******************************************************************************
 123  *
 124  * FUNCTION:    acpi_ev_walk_gpe_list
 125  *
 126  * PARAMETERS:  gpe_walk_callback   - Routine called for each GPE block
 127  *
 128  * RETURN:      Status
 129  *
 130  * DESCRIPTION: Walk the GPE lists.
 131  *
 132  ******************************************************************************/
 133
 134 acpi_status acpi_ev_walk_gpe_list(ACPI_GPE_CALLBACK gpe_walk_callback)
 135 {
 136         struct acpi_gpe_block_info *gpe_block;
 137         struct acpi_gpe_xrupt_info *gpe_xrupt_info;
 138         acpi_status status = AE_OK;
 139         acpi_cpu_flags flags;
 140
 141         ACPI_FUNCTION_TRACE("ev_walk_gpe_list");
 142
 143         flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
 144
 145         /* Walk the interrupt level descriptor list */
 146
 147         gpe_xrupt_info = acpi_gbl_gpe_xrupt_list_head;
 148         while (gpe_xrupt_info) {
 149                 /* Walk all Gpe Blocks attached to this interrupt level */
 150
 151                 gpe_block = gpe_xrupt_info->gpe_block_list_head;
 152                 while (gpe_block) {
 153                         /* One callback per GPE block */
 154
 155                         status = gpe_walk_callback(gpe_xrupt_info, gpe_block);
 156                         if (ACPI_FAILURE(status)) {
 157                                 goto unlock_and_exit;
 158                         }
 159
 160                         gpe_block = gpe_block->next;
 161                 }
 162
 163                 gpe_xrupt_info = gpe_xrupt_info->next;
 164         }
 165
 166       unlock_and_exit:
 167         acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
 168         return_ACPI_STATUS(status);
 169 }
 170
 171 /*******************************************************************************
 172  *
 173  * FUNCTION:    acpi_ev_delete_gpe_handlers
 174  *
 175  * PARAMETERS:  gpe_xrupt_info      - GPE Interrupt info
 176  *              gpe_block           - Gpe Block info
 177  *
 178  * RETURN:      Status
 179  *
 180  * DESCRIPTION: Delete all Handler objects found in the GPE data structs.
 181  *              Used only prior to termination.
 182  *
 183  ******************************************************************************/
 184
 185 acpi_status
 186 acpi_ev_delete_gpe_handlers(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 187                             struct acpi_gpe_block_info *gpe_block)
 188 {
 189         struct acpi_gpe_event_info *gpe_event_info;
 190         acpi_native_uint i;
 191         acpi_native_uint j;
 192
 193         ACPI_FUNCTION_TRACE("ev_delete_gpe_handlers");
 194
 195         /* Examine each GPE Register within the block */
 196
 197         for (i = 0; i < gpe_block->register_count; i++) {
 198                 /* Now look at the individual GPEs in this byte register */
 199
 200                 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
 201                         gpe_event_info =
 202                             &gpe_block->
 203                             event_info[(i * ACPI_GPE_REGISTER_WIDTH) + j];
 204
 205                         if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
 206                             ACPI_GPE_DISPATCH_HANDLER) {
 207                                 ACPI_MEM_FREE(gpe_event_info->dispatch.handler);
 208                                 gpe_event_info->dispatch.handler = NULL;
 209                                 gpe_event_info->flags &=
 210                                     ~ACPI_GPE_DISPATCH_MASK;
 211                         }
 212                 }
 213         }
 214
 215         return_ACPI_STATUS(AE_OK);
 216 }
 217
 218 /*******************************************************************************
 219  *
 220  * FUNCTION:    acpi_ev_save_method_info
 221  *
 222  * PARAMETERS:  Callback from walk_namespace
 223  *
 224  * RETURN:      Status
 225  *
 226  * DESCRIPTION: Called from acpi_walk_namespace. Expects each object to be a
 227  *              control method under the _GPE portion of the namespace.
 228  *              Extract the name and GPE type from the object, saving this
 229  *              information for quick lookup during GPE dispatch
 230  *
 231  *              The name of each GPE control method is of the form:
 232  *              "_Lxx" or "_Exx"
 233  *              Where:
 234  *                  L      - means that the GPE is level triggered
 235  *                  E      - means that the GPE is edge triggered
 236  *                  xx     - is the GPE number [in HEX]
 237  *
 238  ******************************************************************************/
 239
 240 static acpi_status
 241 acpi_ev_save_method_info(acpi_handle obj_handle,
 242                          u32 level, void *obj_desc, void **return_value)
 243 {
 244         struct acpi_gpe_block_info *gpe_block = (void *)obj_desc;
 245         struct acpi_gpe_event_info *gpe_event_info;
 246         u32 gpe_number;
 247         char name[ACPI_NAME_SIZE + 1];
 248         u8 type;
 249         acpi_status status;
 250
 251         ACPI_FUNCTION_TRACE("ev_save_method_info");
 252
 253         /*
 254          * _Lxx and _Exx GPE method support
 255          *
 256          * 1) Extract the name from the object and convert to a string
 257          */
 258         ACPI_MOVE_32_TO_32(name,
 259                            &((struct acpi_namespace_node *)obj_handle)->name.
 260                            integer);
 261         name[ACPI_NAME_SIZE] = 0;
 262
 263         /*
 264          * 2) Edge/Level determination is based on the 2nd character
 265          *    of the method name
 266          *
 267          * NOTE: Default GPE type is RUNTIME. May be changed later to WAKE
 268          * if a _PRW object is found that points to this GPE.
 269          */
 270         switch (name[1]) {
 271         case 'L':
 272                 type = ACPI_GPE_LEVEL_TRIGGERED;
 273                 break;
 274
 275         case 'E':
 276                 type = ACPI_GPE_EDGE_TRIGGERED;
 277                 break;
 278
 279         default:
 280                 /* Unknown method type, just ignore it! */
 281
 282                 ACPI_ERROR((AE_INFO,
 283                             "Unknown GPE method type: %s (name not of form _Lxx or _Exx)",
 284                             name));
 285                 return_ACPI_STATUS(AE_OK);
 286         }
 287
 288         /* Convert the last two characters of the name to the GPE Number */
 289
 290         gpe_number = ACPI_STRTOUL(&name[2], NULL, 16);
 291         if (gpe_number == ACPI_UINT32_MAX) {
 292                 /* Conversion failed; invalid method, just ignore it */
 293
 294                 ACPI_ERROR((AE_INFO,
 295                             "Could not extract GPE number from name: %s (name is not of form _Lxx or _Exx)",
 296                             name));
 297                 return_ACPI_STATUS(AE_OK);
 298         }
 299
 300         /* Ensure that we have a valid GPE number for this GPE block */
 301
 302         if ((gpe_number < gpe_block->block_base_number) ||
 303             (gpe_number >=
 304              (gpe_block->block_base_number +
 305               (gpe_block->register_count * 8)))) {
 306                 /*
 307                  * Not valid for this GPE block, just ignore it
 308                  * However, it may be valid for a different GPE block, since GPE0 and GPE1
 309                  * methods both appear under \_GPE.
 310                  */
 311                 return_ACPI_STATUS(AE_OK);
 312         }
 313
 314         /*
 315          * Now we can add this information to the gpe_event_info block
 316          * for use during dispatch of this GPE. Default type is RUNTIME, although
 317          * this may change when the _PRW methods are executed later.
 318          */
 319         gpe_event_info =
 320             &gpe_block->event_info[gpe_number - gpe_block->block_base_number];
 321
 322         gpe_event_info->flags = (u8)
 323             (type | ACPI_GPE_DISPATCH_METHOD | ACPI_GPE_TYPE_RUNTIME);
 324
 325         gpe_event_info->dispatch.method_node =
 326             (struct acpi_namespace_node *)obj_handle;
 327
 328         /* Update enable mask, but don't enable the HW GPE as of yet */
 329
 330         status = acpi_ev_enable_gpe(gpe_event_info, FALSE);
 331
 332         ACPI_DEBUG_PRINT((ACPI_DB_LOAD,
 333                           "Registered GPE method %s as GPE number 0x%.2X\n",
 334                           name, gpe_number));
 335         return_ACPI_STATUS(status);
 336 }
 337
 338 /*******************************************************************************
 339  *
 340  * FUNCTION:    acpi_ev_match_prw_and_gpe
 341  *
 342  * PARAMETERS:  Callback from walk_namespace
 343  *
 344  * RETURN:      Status. NOTE: We ignore errors so that the _PRW walk is
 345  *              not aborted on a single _PRW failure.
 346  *
 347  * DESCRIPTION: Called from acpi_walk_namespace. Expects each object to be a
 348  *              Device. Run the _PRW method. If present, extract the GPE
 349  *              number and mark the GPE as a WAKE GPE.
 350  *
 351  ******************************************************************************/
 352
 353 static acpi_status
 354 acpi_ev_match_prw_and_gpe(acpi_handle obj_handle,
 355                           u32 level, void *info, void **return_value)
 356 {
 357         struct acpi_gpe_walk_info *gpe_info = (void *)info;
 358         struct acpi_namespace_node *gpe_device;
 359         struct acpi_gpe_block_info *gpe_block;
 360         struct acpi_namespace_node *target_gpe_device;
 361         struct acpi_gpe_event_info *gpe_event_info;
 362         union acpi_operand_object *pkg_desc;
 363         union acpi_operand_object *obj_desc;
 364         u32 gpe_number;
 365         acpi_status status;
 366
 367         ACPI_FUNCTION_TRACE("ev_match_prw_and_gpe");
 368
 369         /* Check for a _PRW method under this device */
 370
 371         status = acpi_ut_evaluate_object(obj_handle, METHOD_NAME__PRW,
 372                                          ACPI_BTYPE_PACKAGE, &pkg_desc);
 373         if (ACPI_FAILURE(status)) {
 374                 /* Ignore all errors from _PRW, we don't want to abort the subsystem */
 375
 376                 return_ACPI_STATUS(AE_OK);
 377         }
 378
 379         /* The returned _PRW package must have at least two elements */
 380
 381         if (pkg_desc->package.count < 2) {
 382                 goto cleanup;
 383         }
 384
 385         /* Extract pointers from the input context */
 386
 387         gpe_device = gpe_info->gpe_device;
 388         gpe_block = gpe_info->gpe_block;
 389
 390         /*
 391          * The _PRW object must return a package, we are only interested
 392          * in the first element
 393          */
 394         obj_desc = pkg_desc->package.elements[0];
 395
 396         if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_INTEGER) {
 397                 /* Use FADT-defined GPE device (from definition of _PRW) */
 398
 399                 target_gpe_device = acpi_gbl_fadt_gpe_device;
 400
 401                 /* Integer is the GPE number in the FADT described GPE blocks */
 402
 403                 gpe_number = (u32) obj_desc->integer.value;
 404         } else if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_PACKAGE) {
 405                 /* Package contains a GPE reference and GPE number within a GPE block */
 406
 407                 if ((obj_desc->package.count < 2) ||
 408                     (ACPI_GET_OBJECT_TYPE(obj_desc->package.elements[0]) !=
 409                      ACPI_TYPE_LOCAL_REFERENCE)
 410                     || (ACPI_GET_OBJECT_TYPE(obj_desc->package.elements[1]) !=
 411                         ACPI_TYPE_INTEGER)) {
 412                         goto cleanup;
 413                 }
 414
 415                 /* Get GPE block reference and decode */
 416
 417                 target_gpe_device =
 418                     obj_desc->package.elements[0]->reference.node;
 419                 gpe_number = (u32) obj_desc->package.elements[1]->integer.value;
 420         } else {
 421                 /* Unknown type, just ignore it */
 422
 423                 goto cleanup;
 424         }
 425
 426         /*
 427          * Is this GPE within this block?
 428          *
 429          * TRUE iff these conditions are true:
 430          *     1) The GPE devices match.
 431          *     2) The GPE index(number) is within the range of the Gpe Block
 432          *          associated with the GPE device.
 433          */
 434         if ((gpe_device == target_gpe_device) &&
 435             (gpe_number >= gpe_block->block_base_number) &&
 436             (gpe_number <
 437              gpe_block->block_base_number + (gpe_block->register_count * 8))) {
 438                 gpe_event_info =
 439                     &gpe_block->event_info[gpe_number -
 440                                            gpe_block->block_base_number];
 441
 442                 /* Mark GPE for WAKE-ONLY but WAKE_DISABLED */
 443
 444                 gpe_event_info->flags &=
 445                     ~(ACPI_GPE_WAKE_ENABLED | ACPI_GPE_RUN_ENABLED);
 446
 447                 status =
 448                     acpi_ev_set_gpe_type(gpe_event_info, ACPI_GPE_TYPE_WAKE);
 449                 if (ACPI_FAILURE(status)) {
 450                         goto cleanup;
 451                 }
 452                 status =
 453                     acpi_ev_update_gpe_enable_masks(gpe_event_info,
 454                                                     ACPI_GPE_DISABLE);
 455         }
 456
 457       cleanup:
 458         acpi_ut_remove_reference(pkg_desc);
 459         return_ACPI_STATUS(AE_OK);
 460 }
 461
 462 /*******************************************************************************
 463  *
 464  * FUNCTION:    acpi_ev_get_gpe_xrupt_block
 465  *
 466  * PARAMETERS:  interrupt_number     - Interrupt for a GPE block
 467  *
 468  * RETURN:      A GPE interrupt block
 469  *
 470  * DESCRIPTION: Get or Create a GPE interrupt block. There is one interrupt
 471  *              block per unique interrupt level used for GPEs.
 472  *              Should be called only when the GPE lists are semaphore locked
 473  *              and not subject to change.
 474  *
 475  ******************************************************************************/
 476
 477 static struct acpi_gpe_xrupt_info *acpi_ev_get_gpe_xrupt_block(u32
 478                                                                interrupt_number)
 479 {
 480         struct acpi_gpe_xrupt_info *next_gpe_xrupt;
 481         struct acpi_gpe_xrupt_info *gpe_xrupt;
 482         acpi_status status;
 483         acpi_cpu_flags flags;
 484
 485         ACPI_FUNCTION_TRACE("ev_get_gpe_xrupt_block");
 486
 487         /* No need for lock since we are not changing any list elements here */
 488
 489         next_gpe_xrupt = acpi_gbl_gpe_xrupt_list_head;
 490         while (next_gpe_xrupt) {
 491                 if (next_gpe_xrupt->interrupt_number == interrupt_number) {
 492                         return_PTR(next_gpe_xrupt);
 493                 }
 494
 495                 next_gpe_xrupt = next_gpe_xrupt->next;
 496         }
 497
 498         /* Not found, must allocate a new xrupt descriptor */
 499
 500         gpe_xrupt = ACPI_MEM_CALLOCATE(sizeof(struct acpi_gpe_xrupt_info));
 501         if (!gpe_xrupt) {
 502                 return_PTR(NULL);
 503         }
 504
 505         gpe_xrupt->interrupt_number = interrupt_number;
 506
 507         /* Install new interrupt descriptor with spin lock */
 508
 509         flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
 510         if (acpi_gbl_gpe_xrupt_list_head) {
 511                 next_gpe_xrupt = acpi_gbl_gpe_xrupt_list_head;
 512                 while (next_gpe_xrupt->next) {
 513                         next_gpe_xrupt = next_gpe_xrupt->next;
 514                 }
 515
 516                 next_gpe_xrupt->next = gpe_xrupt;
 517                 gpe_xrupt->previous = next_gpe_xrupt;
 518         } else {
 519                 acpi_gbl_gpe_xrupt_list_head = gpe_xrupt;
 520         }
 521         acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
 522
 523         /* Install new interrupt handler if not SCI_INT */
 524
 525         if (interrupt_number != acpi_gbl_FADT->sci_int) {
 526                 status = acpi_os_install_interrupt_handler(interrupt_number,
 527                                                            acpi_ev_gpe_xrupt_handler,
 528                                                            gpe_xrupt);
 529                 if (ACPI_FAILURE(status)) {
 530                         ACPI_ERROR((AE_INFO,
 531                                     "Could not install GPE interrupt handler at level 0x%X",
 532                                     interrupt_number));
 533                         return_PTR(NULL);
 534                 }
 535         }
 536
 537         return_PTR(gpe_xrupt);
 538 }
 539
 540 /*******************************************************************************
 541  *
 542  * FUNCTION:    acpi_ev_delete_gpe_xrupt
 543  *
 544  * PARAMETERS:  gpe_xrupt       - A GPE interrupt info block
 545  *
 546  * RETURN:      Status
 547  *
 548  * DESCRIPTION: Remove and free a gpe_xrupt block. Remove an associated
 549  *              interrupt handler if not the SCI interrupt.
 550  *
 551  ******************************************************************************/
 552
 553 static acpi_status
 554 acpi_ev_delete_gpe_xrupt(struct acpi_gpe_xrupt_info *gpe_xrupt)
 555 {
 556         acpi_status status;
 557         acpi_cpu_flags flags;
 558
 559         ACPI_FUNCTION_TRACE("ev_delete_gpe_xrupt");
 560
 561         /* We never want to remove the SCI interrupt handler */
 562
 563         if (gpe_xrupt->interrupt_number == acpi_gbl_FADT->sci_int) {
 564                 gpe_xrupt->gpe_block_list_head = NULL;
 565                 return_ACPI_STATUS(AE_OK);
 566         }
 567
 568         /* Disable this interrupt */
 569
 570         status =
 571             acpi_os_remove_interrupt_handler(gpe_xrupt->interrupt_number,
 572                                              acpi_ev_gpe_xrupt_handler);
 573         if (ACPI_FAILURE(status)) {
 574                 return_ACPI_STATUS(status);
 575         }
 576
 577         /* Unlink the interrupt block with lock */
 578
 579         flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
 580         if (gpe_xrupt->previous) {
 581                 gpe_xrupt->previous->next = gpe_xrupt->next;
 582         }
 583
 584         if (gpe_xrupt->next) {
 585                 gpe_xrupt->next->previous = gpe_xrupt->previous;
 586         }
 587         acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
 588
 589         /* Free the block */
 590
 591         ACPI_MEM_FREE(gpe_xrupt);
 592         return_ACPI_STATUS(AE_OK);
 593 }
 594
 595 /*******************************************************************************
 596  *
 597  * FUNCTION:    acpi_ev_install_gpe_block
 598  *
 599  * PARAMETERS:  gpe_block       - New GPE block
 600  *              interrupt_number - Xrupt to be associated with this GPE block
 601  *
 602  * RETURN:      Status
 603  *
 604  * DESCRIPTION: Install new GPE block with mutex support
 605  *
 606  ******************************************************************************/
 607
 608 static acpi_status
 609 acpi_ev_install_gpe_block(struct acpi_gpe_block_info *gpe_block,
 610                           u32 interrupt_number)
 611 {
 612         struct acpi_gpe_block_info *next_gpe_block;
 613         struct acpi_gpe_xrupt_info *gpe_xrupt_block;
 614         acpi_status status;
 615         acpi_cpu_flags flags;
 616
 617         ACPI_FUNCTION_TRACE("ev_install_gpe_block");
 618
 619         status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
 620         if (ACPI_FAILURE(status)) {
 621                 return_ACPI_STATUS(status);
 622         }
 623
 624         gpe_xrupt_block = acpi_ev_get_gpe_xrupt_block(interrupt_number);
 625         if (!gpe_xrupt_block) {
 626                 status = AE_NO_MEMORY;
 627                 goto unlock_and_exit;
 628         }
 629
 630         /* Install the new block at the end of the list with lock */
 631
 632         flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
 633         if (gpe_xrupt_block->gpe_block_list_head) {
 634                 next_gpe_block = gpe_xrupt_block->gpe_block_list_head;
 635                 while (next_gpe_block->next) {
 636                         next_gpe_block = next_gpe_block->next;
 637                 }
 638
 639                 next_gpe_block->next = gpe_block;
 640                 gpe_block->previous = next_gpe_block;
 641         } else {
 642                 gpe_xrupt_block->gpe_block_list_head = gpe_block;
 643         }
 644
 645         gpe_block->xrupt_block = gpe_xrupt_block;
 646         acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
 647
 648       unlock_and_exit:
 649         status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
 650         return_ACPI_STATUS(status);
 651 }
 652
 653 /*******************************************************************************
 654  *
 655  * FUNCTION:    acpi_ev_delete_gpe_block
 656  *
 657  * PARAMETERS:  gpe_block       - Existing GPE block
 658  *
 659  * RETURN:      Status
 660  *
 661  * DESCRIPTION: Remove a GPE block
 662  *
 663  ******************************************************************************/
 664
 665 acpi_status acpi_ev_delete_gpe_block(struct acpi_gpe_block_info *gpe_block)
 666 {
 667         acpi_status status;
 668         acpi_cpu_flags flags;
 669
 670         ACPI_FUNCTION_TRACE("ev_install_gpe_block");
 671
 672         status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
 673         if (ACPI_FAILURE(status)) {
 674                 return_ACPI_STATUS(status);
 675         }
 676
 677         /* Disable all GPEs in this block */
 678
 679         status = acpi_hw_disable_gpe_block(gpe_block->xrupt_block, gpe_block);
 680
 681         if (!gpe_block->previous && !gpe_block->next) {
 682                 /* This is the last gpe_block on this interrupt */
 683
 684                 status = acpi_ev_delete_gpe_xrupt(gpe_block->xrupt_block);
 685                 if (ACPI_FAILURE(status)) {
 686                         goto unlock_and_exit;
 687                 }
 688         } else {
 689                 /* Remove the block on this interrupt with lock */
 690
 691                 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
 692                 if (gpe_block->previous) {
 693                         gpe_block->previous->next = gpe_block->next;
 694                 } else {
 695                         gpe_block->xrupt_block->gpe_block_list_head =
 696                             gpe_block->next;
 697                 }
 698
 699                 if (gpe_block->next) {
 700                         gpe_block->next->previous = gpe_block->previous;
 701                 }
 702                 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
 703         }
 704
 705         /* Free the gpe_block */
 706
 707         ACPI_MEM_FREE(gpe_block->register_info);
 708         ACPI_MEM_FREE(gpe_block->event_info);
 709         ACPI_MEM_FREE(gpe_block);
 710
 711       unlock_and_exit:
 712         status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
 713         return_ACPI_STATUS(status);
 714 }
 715
 716 /*******************************************************************************
 717  *
 718  * FUNCTION:    acpi_ev_create_gpe_info_blocks
 719  *
 720  * PARAMETERS:  gpe_block   - New GPE block
 721  *
 722  * RETURN:      Status
 723  *
 724  * DESCRIPTION: Create the register_info and event_info blocks for this GPE block
 725  *
 726  ******************************************************************************/
 727
 728 static acpi_status
 729 acpi_ev_create_gpe_info_blocks(struct acpi_gpe_block_info *gpe_block)
 730 {
 731         struct acpi_gpe_register_info *gpe_register_info = NULL;
 732         struct acpi_gpe_event_info *gpe_event_info = NULL;
 733         struct acpi_gpe_event_info *this_event;
 734         struct acpi_gpe_register_info *this_register;
 735         acpi_native_uint i;
 736         acpi_native_uint j;
 737         acpi_status status;
 738
 739         ACPI_FUNCTION_TRACE("ev_create_gpe_info_blocks");
 740
 741         /* Allocate the GPE register information block */
 742
 743         gpe_register_info = ACPI_MEM_CALLOCATE((acpi_size) gpe_block->
 744                                                register_count *
 745                                                sizeof(struct
 746                                                       acpi_gpe_register_info));
 747         if (!gpe_register_info) {
 748                 ACPI_ERROR((AE_INFO,
 749                             "Could not allocate the gpe_register_info table"));
 750                 return_ACPI_STATUS(AE_NO_MEMORY);
 751         }
 752
 753         /*
 754          * Allocate the GPE event_info block. There are eight distinct GPEs
 755          * per register. Initialization to zeros is sufficient.
 756          */
 757         gpe_event_info = ACPI_MEM_CALLOCATE(((acpi_size) gpe_block->
 758                                              register_count *
 759                                              ACPI_GPE_REGISTER_WIDTH) *
 760                                             sizeof(struct acpi_gpe_event_info));
 761         if (!gpe_event_info) {
 762                 ACPI_ERROR((AE_INFO,
 763                             "Could not allocate the gpe_event_info table"));
 764                 status = AE_NO_MEMORY;
 765                 goto error_exit;
 766         }
 767
 768         /* Save the new Info arrays in the GPE block */
 769
 770         gpe_block->register_info = gpe_register_info;
 771         gpe_block->event_info = gpe_event_info;
 772
 773         /*
 774          * Initialize the GPE Register and Event structures. A goal of these
 775          * tables is to hide the fact that there are two separate GPE register sets
 776          * in a given GPE hardware block, the status registers occupy the first half,
 777          * and the enable registers occupy the second half.
 778          */
 779         this_register = gpe_register_info;
 780         this_event = gpe_event_info;
 781
 782         for (i = 0; i < gpe_block->register_count; i++) {
 783                 /* Init the register_info for this GPE register (8 GPEs) */
 784
 785                 this_register->base_gpe_number =
 786                     (u8) (gpe_block->block_base_number +
 787                           (i * ACPI_GPE_REGISTER_WIDTH));
 788
 789                 ACPI_STORE_ADDRESS(this_register->status_address.address,
 790                                    (gpe_block->block_address.address + i));
 791
 792                 ACPI_STORE_ADDRESS(this_register->enable_address.address,
 793                                    (gpe_block->block_address.address
 794                                     + i + gpe_block->register_count));
 795
 796                 this_register->status_address.address_space_id =
 797                     gpe_block->block_address.address_space_id;
 798                 this_register->enable_address.address_space_id =
 799                     gpe_block->block_address.address_space_id;
 800                 this_register->status_address.register_bit_width =
 801                     ACPI_GPE_REGISTER_WIDTH;
 802                 this_register->enable_address.register_bit_width =
 803                     ACPI_GPE_REGISTER_WIDTH;
 804                 this_register->status_address.register_bit_offset =
 805                     ACPI_GPE_REGISTER_WIDTH;
 806                 this_register->enable_address.register_bit_offset =
 807                     ACPI_GPE_REGISTER_WIDTH;
 808
 809                 /* Init the event_info for each GPE within this register */
 810
 811                 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
 812                         this_event->register_bit = acpi_gbl_decode_to8bit[j];
 813                         this_event->register_info = this_register;
 814                         this_event++;
 815                 }
 816
 817                 /* Disable all GPEs within this register */
 818
 819                 status = acpi_hw_low_level_write(ACPI_GPE_REGISTER_WIDTH, 0x00,
 820                                                  &this_register->
 821                                                  enable_address);
 822                 if (ACPI_FAILURE(status)) {
 823                         goto error_exit;
 824                 }
 825
 826                 /* Clear any pending GPE events within this register */
 827
 828                 status = acpi_hw_low_level_write(ACPI_GPE_REGISTER_WIDTH, 0xFF,
 829                                                  &this_register->
 830                                                  status_address);
 831                 if (ACPI_FAILURE(status)) {
 832                         goto error_exit;
 833                 }
 834
 835                 this_register++;
 836         }
 837
 838         return_ACPI_STATUS(AE_OK);
 839
 840       error_exit:
 841         if (gpe_register_info) {
 842                 ACPI_MEM_FREE(gpe_register_info);
 843         }
 844         if (gpe_event_info) {
 845                 ACPI_MEM_FREE(gpe_event_info);
 846         }
 847
 848         return_ACPI_STATUS(status);
 849 }
 850
 851 /*******************************************************************************
 852  *
 853  * FUNCTION:    acpi_ev_create_gpe_block
 854  *
 855  * PARAMETERS:  gpe_device          - Handle to the parent GPE block
 856  *              gpe_block_address   - Address and space_iD
 857  *              register_count      - Number of GPE register pairs in the block
 858  *              gpe_block_base_number - Starting GPE number for the block
 859  *              interrupt_number    - H/W interrupt for the block
 860  *              return_gpe_block    - Where the new block descriptor is returned
 861  *
 862  * RETURN:      Status
 863  *
 864  * DESCRIPTION: Create and Install a block of GPE registers. All GPEs within
 865  *              the block are disabled at exit.
 866  *              Note: Assumes namespace is locked.
 867  *
 868  ******************************************************************************/
 869
 870 acpi_status
 871 acpi_ev_create_gpe_block(struct acpi_namespace_node *gpe_device,
 872                          struct acpi_generic_address *gpe_block_address,
 873                          u32 register_count,
 874                          u8 gpe_block_base_number,
 875                          u32 interrupt_number,
 876                          struct acpi_gpe_block_info **return_gpe_block)
 877 {
 878         acpi_status status;
 879         struct acpi_gpe_block_info *gpe_block;
 880
 881         ACPI_FUNCTION_TRACE("ev_create_gpe_block");
 882
 883         if (!register_count) {
 884                 return_ACPI_STATUS(AE_OK);
 885         }
 886
 887         /* Allocate a new GPE block */
 888
 889         gpe_block = ACPI_MEM_CALLOCATE(sizeof(struct acpi_gpe_block_info));
 890         if (!gpe_block) {
 891                 return_ACPI_STATUS(AE_NO_MEMORY);
 892         }
 893
 894         /* Initialize the new GPE block */
 895
 896         gpe_block->node = gpe_device;
 897         gpe_block->register_count = register_count;
 898         gpe_block->block_base_number = gpe_block_base_number;
 899
 900         ACPI_MEMCPY(&gpe_block->block_address, gpe_block_address,
 901                     sizeof(struct acpi_generic_address));
 902
 903         /*
 904          * Create the register_info and event_info sub-structures
 905          * Note: disables and clears all GPEs in the block
 906          */
 907         status = acpi_ev_create_gpe_info_blocks(gpe_block);
 908         if (ACPI_FAILURE(status)) {
 909                 ACPI_MEM_FREE(gpe_block);
 910                 return_ACPI_STATUS(status);
 911         }
 912
 913         /* Install the new block in the global lists */
 914
 915         status = acpi_ev_install_gpe_block(gpe_block, interrupt_number);
 916         if (ACPI_FAILURE(status)) {
 917                 ACPI_MEM_FREE(gpe_block);
 918                 return_ACPI_STATUS(status);
 919         }
 920
 921         /* Find all GPE methods (_Lxx, _Exx) for this block */
 922
 923         status = acpi_ns_walk_namespace(ACPI_TYPE_METHOD, gpe_device,
 924                                         ACPI_UINT32_MAX, ACPI_NS_WALK_NO_UNLOCK,
 925                                         acpi_ev_save_method_info, gpe_block,
 926                                         NULL);
 927
 928         /* Return the new block */
 929
 930         if (return_gpe_block) {
 931                 (*return_gpe_block) = gpe_block;
 932         }
 933
 934         ACPI_DEBUG_PRINT((ACPI_DB_INIT,
 935                           "GPE %02X to %02X [%4.4s] %u regs on int 0x%X\n",
 936                           (u32) gpe_block->block_base_number,
 937                           (u32) (gpe_block->block_base_number +
 938                                  ((gpe_block->register_count *
 939                                    ACPI_GPE_REGISTER_WIDTH) - 1)),
 940                           gpe_device->name.ascii, gpe_block->register_count,
 941                           interrupt_number));
 942
 943         return_ACPI_STATUS(AE_OK);
 944 }
 945
 946 /*******************************************************************************
 947  *
 948  * FUNCTION:    acpi_ev_initialize_gpe_block
 949  *
 950  * PARAMETERS:  gpe_device          - Handle to the parent GPE block
 951  *              gpe_block           - Gpe Block info
 952  *
 953  * RETURN:      Status
 954  *
 955  * DESCRIPTION: Initialize and enable a GPE block. First find and run any
 956  *              _PRT methods associated with the block, then enable the
 957  *              appropriate GPEs.
 958  *              Note: Assumes namespace is locked.
 959  *
 960  ******************************************************************************/
 961
 962 acpi_status
 963 acpi_ev_initialize_gpe_block(struct acpi_namespace_node *gpe_device,
 964                              struct acpi_gpe_block_info *gpe_block)
 965 {
 966         acpi_status status;
 967         struct acpi_gpe_event_info *gpe_event_info;
 968         struct acpi_gpe_walk_info gpe_info;
 969         u32 wake_gpe_count;
 970         u32 gpe_enabled_count;
 971         acpi_native_uint i;
 972         acpi_native_uint j;
 973
 974         ACPI_FUNCTION_TRACE("ev_initialize_gpe_block");
 975
 976         /* Ignore a null GPE block (e.g., if no GPE block 1 exists) */
 977
 978         if (!gpe_block) {
 979                 return_ACPI_STATUS(AE_OK);
 980         }
 981
 982         /*
 983          * Runtime option: Should wake GPEs be enabled at runtime?  The default
 984          * is no, they should only be enabled just as the machine goes to sleep.
 985          */
 986         if (acpi_gbl_leave_wake_gpes_disabled) {
 987                 /*
 988                  * Differentiate runtime vs wake GPEs, via the _PRW control methods.
 989                  * Each GPE that has one or more _PRWs that reference it is by
 990                  * definition a wake GPE and will not be enabled while the machine
 991                  * is running.
 992                  */
 993                 gpe_info.gpe_block = gpe_block;
 994                 gpe_info.gpe_device = gpe_device;
 995
 996                 status =
 997                     acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 998                                            ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
 999                                            acpi_ev_match_prw_and_gpe, &gpe_info,
1000                                            NULL);
1001         }
1002
1003         /*
1004          * Enable all GPEs in this block that have these attributes:
1005          * 1) are "runtime" or "run/wake" GPEs, and
1006          * 2) have a corresponding _Lxx or _Exx method
1007          *
1008          * Any other GPEs within this block must be enabled via the acpi_enable_gpe()
1009          * external interface.
1010          */
1011         wake_gpe_count = 0;
1012         gpe_enabled_count = 0;
1013
1014         for (i = 0; i < gpe_block->register_count; i++) {
1015                 for (j = 0; j < 8; j++) {
1016                         /* Get the info block for this particular GPE */
1017
1018                         gpe_event_info =
1019                             &gpe_block->
1020                             event_info[(i * ACPI_GPE_REGISTER_WIDTH) + j];
1021
1022                         if (((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
1023                              ACPI_GPE_DISPATCH_METHOD)
1024                             && (gpe_event_info->
1025                                 flags & ACPI_GPE_TYPE_RUNTIME)) {
1026                                 gpe_enabled_count++;
1027                         }
1028
1029                         if (gpe_event_info->flags & ACPI_GPE_TYPE_WAKE) {
1030                                 wake_gpe_count++;
1031                         }
1032                 }
1033         }
1034
1035         ACPI_DEBUG_PRINT((ACPI_DB_INIT,
1036                           "Found %u Wake, Enabled %u Runtime GPEs in this block\n",
1037                           wake_gpe_count, gpe_enabled_count));
1038
1039         /* Enable all valid runtime GPEs found above */
1040
1041         status = acpi_hw_enable_runtime_gpe_block(NULL, gpe_block);
1042         if (ACPI_FAILURE(status)) {
1043                 ACPI_ERROR((AE_INFO, "Could not enable GPEs in gpe_block %p",
1044                             gpe_block));
1045         }
1046
1047         return_ACPI_STATUS(status);
1048 }
1049
1050 /*******************************************************************************
1051  *
1052  * FUNCTION:    acpi_ev_gpe_initialize
1053  *
1054  * PARAMETERS:  None
1055  *
1056  * RETURN:      Status
1057  *
1058  * DESCRIPTION: Initialize the GPE data structures
1059  *
1060  ******************************************************************************/
1061
1062 acpi_status acpi_ev_gpe_initialize(void)
1063 {
1064         u32 register_count0 = 0;
1065         u32 register_count1 = 0;
1066         u32 gpe_number_max = 0;
1067         acpi_status status;
1068
1069         ACPI_FUNCTION_TRACE("ev_gpe_initialize");
1070
1071         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
1072         if (ACPI_FAILURE(status)) {
1073                 return_ACPI_STATUS(status);
1074         }
1075
1076         /*
1077          * Initialize the GPE Block(s) defined in the FADT
1078          *
1079          * Why the GPE register block lengths are divided by 2:  From the ACPI Spec,
1080          * section "General-Purpose Event Registers", we have:
1081          *
1082          * "Each register block contains two registers of equal length
1083          *  GPEx_STS and GPEx_EN (where x is 0 or 1). The length of the
1084          *  GPE0_STS and GPE0_EN registers is equal to half the GPE0_LEN
1085          *  The length of the GPE1_STS and GPE1_EN registers is equal to
1086          *  half the GPE1_LEN. If a generic register block is not supported
1087          *  then its respective block pointer and block length values in the
1088          *  FADT table contain zeros. The GPE0_LEN and GPE1_LEN do not need
1089          *  to be the same size."
1090          */
1091
1092         /*
1093          * Determine the maximum GPE number for this machine.
1094          *
1095          * Note: both GPE0 and GPE1 are optional, and either can exist without
1096          * the other.
1097          *
1098          * If EITHER the register length OR the block address are zero, then that
1099          * particular block is not supported.
1100          */
1101         if (acpi_gbl_FADT->gpe0_blk_len && acpi_gbl_FADT->xgpe0_blk.address) {
1102                 /* GPE block 0 exists (has both length and address > 0) */
1103
1104                 register_count0 = (u16) (acpi_gbl_FADT->gpe0_blk_len / 2);
1105
1106                 gpe_number_max =
1107                     (register_count0 * ACPI_GPE_REGISTER_WIDTH) - 1;
1108
1109                 /* Install GPE Block 0 */
1110
1111                 status = acpi_ev_create_gpe_block(acpi_gbl_fadt_gpe_device,
1112                                                   &acpi_gbl_FADT->xgpe0_blk,
1113                                                   register_count0, 0,
1114                                                   acpi_gbl_FADT->sci_int,
1115                                                   &acpi_gbl_gpe_fadt_blocks[0]);
1116
1117                 if (ACPI_FAILURE(status)) {
1118                         ACPI_EXCEPTION((AE_INFO, status,
1119                                         "Could not create GPE Block 0"));
1120                 }
1121         }
1122
1123         if (acpi_gbl_FADT->gpe1_blk_len && acpi_gbl_FADT->xgpe1_blk.address) {
1124                 /* GPE block 1 exists (has both length and address > 0) */
1125
1126                 register_count1 = (u16) (acpi_gbl_FADT->gpe1_blk_len / 2);
1127
1128                 /* Check for GPE0/GPE1 overlap (if both banks exist) */
1129
1130                 if ((register_count0) &&
1131                     (gpe_number_max >= acpi_gbl_FADT->gpe1_base)) {
1132                         ACPI_ERROR((AE_INFO,
1133                                     "GPE0 block (GPE 0 to %d) overlaps the GPE1 block (GPE %d to %d) - Ignoring GPE1",
1134                                     gpe_number_max, acpi_gbl_FADT->gpe1_base,
1135                                     acpi_gbl_FADT->gpe1_base +
1136                                     ((register_count1 *
1137                                       ACPI_GPE_REGISTER_WIDTH) - 1)));
1138
1139                         /* Ignore GPE1 block by setting the register count to zero */
1140
1141                         register_count1 = 0;
1142                 } else {
1143                         /* Install GPE Block 1 */
1144
1145                         status =
1146                             acpi_ev_create_gpe_block(acpi_gbl_fadt_gpe_device,
1147                                                      &acpi_gbl_FADT->xgpe1_blk,
1148                                                      register_count1,
1149                                                      acpi_gbl_FADT->gpe1_base,
1150                                                      acpi_gbl_FADT->sci_int,
1151                                                      &acpi_gbl_gpe_fadt_blocks
1152                                                      [1]);
1153
1154                         if (ACPI_FAILURE(status)) {
1155                                 ACPI_EXCEPTION((AE_INFO, status,
1156                                                 "Could not create GPE Block 1"));
1157                         }
1158
1159                         /*
1160                          * GPE0 and GPE1 do not have to be contiguous in the GPE number
1161                          * space. However, GPE0 always starts at GPE number zero.
1162                          */
1163                         gpe_number_max = acpi_gbl_FADT->gpe1_base +
1164                             ((register_count1 * ACPI_GPE_REGISTER_WIDTH) - 1);
1165                 }
1166         }
1167
1168         /* Exit if there are no GPE registers */
1169
1170         if ((register_count0 + register_count1) == 0) {
1171                 /* GPEs are not required by ACPI, this is OK */
1172
1173                 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
1174                                   "There are no GPE blocks defined in the FADT\n"));
1175                 status = AE_OK;
1176                 goto cleanup;
1177         }
1178
1179         /* Check for Max GPE number out-of-range */
1180
1181         if (gpe_number_max > ACPI_GPE_MAX) {
1182                 ACPI_ERROR((AE_INFO,
1183                             "Maximum GPE number from FADT is too large: 0x%X",
1184                             gpe_number_max));
1185                 status = AE_BAD_VALUE;
1186                 goto cleanup;
1187         }
1188
1189       cleanup:
1190         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
1191         return_ACPI_STATUS(AE_OK);
1192 }