drivers/acpi/events/evregion.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evregion - ACPI address_space (op_region) handler dispatch
   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 #include <acpi/acinterp.h>
  48
  49 #define _COMPONENT          ACPI_EVENTS
  50 ACPI_MODULE_NAME("evregion")
  51 #define ACPI_NUM_DEFAULT_SPACES     4
  52 static u8 acpi_gbl_default_address_spaces[ACPI_NUM_DEFAULT_SPACES] = {
  53         ACPI_ADR_SPACE_SYSTEM_MEMORY,
  54         ACPI_ADR_SPACE_SYSTEM_IO,
  55         ACPI_ADR_SPACE_PCI_CONFIG,
  56         ACPI_ADR_SPACE_DATA_TABLE
  57 };
  58
  59 /* Local prototypes */
  60
  61 static acpi_status
  62 acpi_ev_reg_run(acpi_handle obj_handle,
  63                 u32 level, void *context, void **return_value);
  64
  65 static acpi_status
  66 acpi_ev_install_handler(acpi_handle obj_handle,
  67                         u32 level, void *context, void **return_value);
  68
  69 /*******************************************************************************
  70  *
  71  * FUNCTION:    acpi_ev_install_region_handlers
  72  *
  73  * PARAMETERS:  None
  74  *
  75  * RETURN:      Status
  76  *
  77  * DESCRIPTION: Installs the core subsystem default address space handlers.
  78  *
  79  ******************************************************************************/
  80
  81 acpi_status acpi_ev_install_region_handlers(void)
  82 {
  83         acpi_status status;
  84         acpi_native_uint i;
  85
  86         ACPI_FUNCTION_TRACE(ev_install_region_handlers);
  87
  88         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  89         if (ACPI_FAILURE(status)) {
  90                 return_ACPI_STATUS(status);
  91         }
  92
  93         /*
  94          * All address spaces (PCI Config, EC, SMBus) are scope dependent
  95          * and registration must occur for a specific device.
  96          *
  97          * In the case of the system memory and IO address spaces there is currently
  98          * no device associated with the address space.  For these we use the root.
  99          *
 100          * We install the default PCI config space handler at the root so
 101          * that this space is immediately available even though the we have
 102          * not enumerated all the PCI Root Buses yet.  This is to conform
 103          * to the ACPI specification which states that the PCI config
 104          * space must be always available -- even though we are nowhere
 105          * near ready to find the PCI root buses at this point.
 106          *
 107          * NOTE: We ignore AE_ALREADY_EXISTS because this means that a handler
 108          * has already been installed (via acpi_install_address_space_handler).
 109          * Similar for AE_SAME_HANDLER.
 110          */
 111         for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++) {
 112                 status = acpi_ev_install_space_handler(acpi_gbl_root_node,
 113                                                        acpi_gbl_default_address_spaces
 114                                                        [i],
 115                                                        ACPI_DEFAULT_HANDLER,
 116                                                        NULL, NULL);
 117                 switch (status) {
 118                 case AE_OK:
 119                 case AE_SAME_HANDLER:
 120                 case AE_ALREADY_EXISTS:
 121
 122                         /* These exceptions are all OK */
 123
 124                         status = AE_OK;
 125                         break;
 126
 127                 default:
 128
 129                         goto unlock_and_exit;
 130                 }
 131         }
 132
 133       unlock_and_exit:
 134         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 135         return_ACPI_STATUS(status);
 136 }
 137
 138 /*******************************************************************************
 139  *
 140  * FUNCTION:    acpi_ev_initialize_op_regions
 141  *
 142  * PARAMETERS:  None
 143  *
 144  * RETURN:      Status
 145  *
 146  * DESCRIPTION: Execute _REG methods for all Operation Regions that have
 147  *              an installed default region handler.
 148  *
 149  ******************************************************************************/
 150
 151 acpi_status acpi_ev_initialize_op_regions(void)
 152 {
 153         acpi_status status;
 154         acpi_native_uint i;
 155
 156         ACPI_FUNCTION_TRACE(ev_initialize_op_regions);
 157
 158         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 159         if (ACPI_FAILURE(status)) {
 160                 return_ACPI_STATUS(status);
 161         }
 162
 163         /*
 164          * Run the _REG methods for op_regions in each default address space
 165          */
 166         for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++) {
 167
 168                 /* TBD: Make sure handler is the DEFAULT handler, otherwise
 169                  * _REG will have already been run.
 170                  */
 171                 status = acpi_ev_execute_reg_methods(acpi_gbl_root_node,
 172                                                      acpi_gbl_default_address_spaces
 173                                                      [i]);
 174         }
 175
 176         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 177         return_ACPI_STATUS(status);
 178 }
 179
 180 /*******************************************************************************
 181  *
 182  * FUNCTION:    acpi_ev_execute_reg_method
 183  *
 184  * PARAMETERS:  region_obj          - Region object
 185  *              Function            - Passed to _REG: On (1) or Off (0)
 186  *
 187  * RETURN:      Status
 188  *
 189  * DESCRIPTION: Execute _REG method for a region
 190  *
 191  ******************************************************************************/
 192
 193 acpi_status
 194 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function)
 195 {
 196         struct acpi_parameter_info info;
 197         union acpi_operand_object *params[3];
 198         union acpi_operand_object *region_obj2;
 199         acpi_status status;
 200
 201         ACPI_FUNCTION_TRACE(ev_execute_reg_method);
 202
 203         region_obj2 = acpi_ns_get_secondary_object(region_obj);
 204         if (!region_obj2) {
 205                 return_ACPI_STATUS(AE_NOT_EXIST);
 206         }
 207
 208         if (region_obj2->extra.method_REG == NULL) {
 209                 return_ACPI_STATUS(AE_OK);
 210         }
 211
 212         /*
 213          * The _REG method has two arguments:
 214          *
 215          * Arg0, Integer: Operation region space ID
 216          *          Same value as region_obj->Region.space_id
 217          * Arg1, Integer: connection status
 218          *          1 for connecting the handler,
 219          *          0 for disconnecting the handler
 220          *          Passed as a parameter
 221          */
 222         params[0] = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 223         if (!params[0]) {
 224                 return_ACPI_STATUS(AE_NO_MEMORY);
 225         }
 226
 227         params[1] = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 228         if (!params[1]) {
 229                 status = AE_NO_MEMORY;
 230                 goto cleanup;
 231         }
 232
 233         /* Setup the parameter objects */
 234
 235         params[0]->integer.value = region_obj->region.space_id;
 236         params[1]->integer.value = function;
 237         params[2] = NULL;
 238
 239         info.node = region_obj2->extra.method_REG;
 240         info.parameters = params;
 241         info.parameter_type = ACPI_PARAM_ARGS;
 242
 243         /* Execute the method, no return value */
 244
 245         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
 246                         (ACPI_TYPE_METHOD, info.node, NULL));
 247         status = acpi_ns_evaluate_by_handle(&info);
 248
 249         acpi_ut_remove_reference(params[1]);
 250
 251       cleanup:
 252         acpi_ut_remove_reference(params[0]);
 253         return_ACPI_STATUS(status);
 254 }
 255
 256 /*******************************************************************************
 257  *
 258  * FUNCTION:    acpi_ev_address_space_dispatch
 259  *
 260  * PARAMETERS:  region_obj          - Internal region object
 261  *              Function            - Read or Write operation
 262  *              Address             - Where in the space to read or write
 263  *              bit_width           - Field width in bits (8, 16, 32, or 64)
 264  *              Value               - Pointer to in or out value, must be
 265  *                                    full 64-bit acpi_integer
 266  *
 267  * RETURN:      Status
 268  *
 269  * DESCRIPTION: Dispatch an address space or operation region access to
 270  *              a previously installed handler.
 271  *
 272  ******************************************************************************/
 273
 274 acpi_status
 275 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
 276                                u32 function,
 277                                acpi_physical_address address,
 278                                u32 bit_width, acpi_integer * value)
 279 {
 280         acpi_status status;
 281         acpi_status status2;
 282         acpi_adr_space_handler handler;
 283         acpi_adr_space_setup region_setup;
 284         union acpi_operand_object *handler_desc;
 285         union acpi_operand_object *region_obj2;
 286         void *region_context = NULL;
 287
 288         ACPI_FUNCTION_TRACE(ev_address_space_dispatch);
 289
 290         region_obj2 = acpi_ns_get_secondary_object(region_obj);
 291         if (!region_obj2) {
 292                 return_ACPI_STATUS(AE_NOT_EXIST);
 293         }
 294
 295         /* Ensure that there is a handler associated with this region */
 296
 297         handler_desc = region_obj->region.handler;
 298         if (!handler_desc) {
 299                 ACPI_ERROR((AE_INFO,
 300                             "No handler for Region [%4.4s] (%p) [%s]",
 301                             acpi_ut_get_node_name(region_obj->region.node),
 302                             region_obj,
 303                             acpi_ut_get_region_name(region_obj->region.
 304                                                     space_id)));
 305
 306                 return_ACPI_STATUS(AE_NOT_EXIST);
 307         }
 308
 309         /*
 310          * It may be the case that the region has never been initialized
 311          * Some types of regions require special init code
 312          */
 313         if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
 314                 /*
 315                  * This region has not been initialized yet, do it
 316                  */
 317                 region_setup = handler_desc->address_space.setup;
 318                 if (!region_setup) {
 319
 320                         /* No initialization routine, exit with error */
 321
 322                         ACPI_ERROR((AE_INFO,
 323                                     "No init routine for region(%p) [%s]",
 324                                     region_obj,
 325                                     acpi_ut_get_region_name(region_obj->region.
 326                                                             space_id)));
 327                         return_ACPI_STATUS(AE_NOT_EXIST);
 328                 }
 329
 330                 /*
 331                  * We must exit the interpreter because the region
 332                  * setup will potentially execute control methods
 333                  * (e.g., _REG method for this region)
 334                  */
 335                 acpi_ex_exit_interpreter();
 336
 337                 status = region_setup(region_obj, ACPI_REGION_ACTIVATE,
 338                                       handler_desc->address_space.context,
 339                                       &region_context);
 340
 341                 /* Re-enter the interpreter */
 342
 343                 status2 = acpi_ex_enter_interpreter();
 344                 if (ACPI_FAILURE(status2)) {
 345                         return_ACPI_STATUS(status2);
 346                 }
 347
 348                 /* Check for failure of the Region Setup */
 349
 350                 if (ACPI_FAILURE(status)) {
 351                         ACPI_EXCEPTION((AE_INFO, status,
 352                                         "During region initialization: [%s]",
 353                                         acpi_ut_get_region_name(region_obj->
 354                                                                 region.
 355                                                                 space_id)));
 356                         return_ACPI_STATUS(status);
 357                 }
 358
 359                 /*
 360                  * Region initialization may have been completed by region_setup
 361                  */
 362                 if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
 363                         region_obj->region.flags |= AOPOBJ_SETUP_COMPLETE;
 364
 365                         if (region_obj2->extra.region_context) {
 366
 367                                 /* The handler for this region was already installed */
 368
 369                                 ACPI_FREE(region_context);
 370                         } else {
 371                                 /*
 372                                  * Save the returned context for use in all accesses to
 373                                  * this particular region
 374                                  */
 375                                 region_obj2->extra.region_context =
 376                                     region_context;
 377                         }
 378                 }
 379         }
 380
 381         /* We have everything we need, we can invoke the address space handler */
 382
 383         handler = handler_desc->address_space.handler;
 384
 385         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 386                           "Handler %p (@%p) Address %8.8X%8.8X [%s]\n",
 387                           &region_obj->region.handler->address_space, handler,
 388                           ACPI_FORMAT_UINT64(address),
 389                           acpi_ut_get_region_name(region_obj->region.
 390                                                   space_id)));
 391
 392         if (!(handler_desc->address_space.handler_flags &
 393               ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
 394                 /*
 395                  * For handlers other than the default (supplied) handlers, we must
 396                  * exit the interpreter because the handler *might* block -- we don't
 397                  * know what it will do, so we can't hold the lock on the intepreter.
 398                  */
 399                 acpi_ex_exit_interpreter();
 400         }
 401
 402         /* Call the handler */
 403
 404         status = handler(function, address, bit_width, value,
 405                          handler_desc->address_space.context,
 406                          region_obj2->extra.region_context);
 407
 408         if (ACPI_FAILURE(status)) {
 409                 ACPI_EXCEPTION((AE_INFO, status, "Returned by Handler for [%s]",
 410                                 acpi_ut_get_region_name(region_obj->region.
 411                                                         space_id)));
 412         }
 413
 414         if (!(handler_desc->address_space.handler_flags &
 415               ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
 416                 /*
 417                  * We just returned from a non-default handler, we must re-enter the
 418                  * interpreter
 419                  */
 420                 status2 = acpi_ex_enter_interpreter();
 421                 if (ACPI_FAILURE(status2)) {
 422                         return_ACPI_STATUS(status2);
 423                 }
 424         }
 425
 426         return_ACPI_STATUS(status);
 427 }
 428
 429 /*******************************************************************************
 430  *
 431  * FUNCTION:    acpi_ev_detach_region
 432  *
 433  * PARAMETERS:  region_obj          - Region Object
 434  *              acpi_ns_is_locked   - Namespace Region Already Locked?
 435  *
 436  * RETURN:      None
 437  *
 438  * DESCRIPTION: Break the association between the handler and the region
 439  *              this is a two way association.
 440  *
 441  ******************************************************************************/
 442
 443 void
 444 acpi_ev_detach_region(union acpi_operand_object *region_obj,
 445                       u8 acpi_ns_is_locked)
 446 {
 447         union acpi_operand_object *handler_obj;
 448         union acpi_operand_object *obj_desc;
 449         union acpi_operand_object **last_obj_ptr;
 450         acpi_adr_space_setup region_setup;
 451         void **region_context;
 452         union acpi_operand_object *region_obj2;
 453         acpi_status status;
 454
 455         ACPI_FUNCTION_TRACE(ev_detach_region);
 456
 457         region_obj2 = acpi_ns_get_secondary_object(region_obj);
 458         if (!region_obj2) {
 459                 return_VOID;
 460         }
 461         region_context = &region_obj2->extra.region_context;
 462
 463         /* Get the address handler from the region object */
 464
 465         handler_obj = region_obj->region.handler;
 466         if (!handler_obj) {
 467
 468                 /* This region has no handler, all done */
 469
 470                 return_VOID;
 471         }
 472
 473         /* Find this region in the handler's list */
 474
 475         obj_desc = handler_obj->address_space.region_list;
 476         last_obj_ptr = &handler_obj->address_space.region_list;
 477
 478         while (obj_desc) {
 479
 480                 /* Is this the correct Region? */
 481
 482                 if (obj_desc == region_obj) {
 483                         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 484                                           "Removing Region %p from address handler %p\n",
 485                                           region_obj, handler_obj));
 486
 487                         /* This is it, remove it from the handler's list */
 488
 489                         *last_obj_ptr = obj_desc->region.next;
 490                         obj_desc->region.next = NULL;   /* Must clear field */
 491
 492                         if (acpi_ns_is_locked) {
 493                                 status =
 494                                     acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 495                                 if (ACPI_FAILURE(status)) {
 496                                         return_VOID;
 497                                 }
 498                         }
 499
 500                         /* Now stop region accesses by executing the _REG method */
 501
 502                         status = acpi_ev_execute_reg_method(region_obj, 0);
 503                         if (ACPI_FAILURE(status)) {
 504                                 ACPI_EXCEPTION((AE_INFO, status,
 505                                                 "from region _REG, [%s]",
 506                                                 acpi_ut_get_region_name
 507                                                 (region_obj->region.space_id)));
 508                         }
 509
 510                         if (acpi_ns_is_locked) {
 511                                 status =
 512                                     acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 513                                 if (ACPI_FAILURE(status)) {
 514                                         return_VOID;
 515                                 }
 516                         }
 517
 518                         /* Call the setup handler with the deactivate notification */
 519
 520                         region_setup = handler_obj->address_space.setup;
 521                         status =
 522                             region_setup(region_obj, ACPI_REGION_DEACTIVATE,
 523                                          handler_obj->address_space.context,
 524                                          region_context);
 525
 526                         /* Init routine may fail, Just ignore errors */
 527
 528                         if (ACPI_FAILURE(status)) {
 529                                 ACPI_EXCEPTION((AE_INFO, status,
 530                                                 "from region init, [%s]",
 531                                                 acpi_ut_get_region_name
 532                                                 (region_obj->region.space_id)));
 533                         }
 534
 535                         region_obj->region.flags &= ~(AOPOBJ_SETUP_COMPLETE);
 536
 537                         /*
 538                          * Remove handler reference in the region
 539                          *
 540                          * NOTE: this doesn't mean that the region goes away
 541                          * The region is just inaccessible as indicated to
 542                          * the _REG method
 543                          *
 544                          * If the region is on the handler's list
 545                          * this better be the region's handler
 546                          */
 547                         region_obj->region.handler = NULL;
 548                         acpi_ut_remove_reference(handler_obj);
 549
 550                         return_VOID;
 551                 }
 552
 553                 /* Walk the linked list of handlers */
 554
 555                 last_obj_ptr = &obj_desc->region.next;
 556                 obj_desc = obj_desc->region.next;
 557         }
 558
 559         /* If we get here, the region was not in the handler's region list */
 560
 561         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 562                           "Cannot remove region %p from address handler %p\n",
 563                           region_obj, handler_obj));
 564
 565         return_VOID;
 566 }
 567
 568 /*******************************************************************************
 569  *
 570  * FUNCTION:    acpi_ev_attach_region
 571  *
 572  * PARAMETERS:  handler_obj         - Handler Object
 573  *              region_obj          - Region Object
 574  *              acpi_ns_is_locked   - Namespace Region Already Locked?
 575  *
 576  * RETURN:      None
 577  *
 578  * DESCRIPTION: Create the association between the handler and the region
 579  *              this is a two way association.
 580  *
 581  ******************************************************************************/
 582
 583 acpi_status
 584 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
 585                       union acpi_operand_object *region_obj,
 586                       u8 acpi_ns_is_locked)
 587 {
 588
 589         ACPI_FUNCTION_TRACE(ev_attach_region);
 590
 591         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 592                           "Adding Region [%4.4s] %p to address handler %p [%s]\n",
 593                           acpi_ut_get_node_name(region_obj->region.node),
 594                           region_obj, handler_obj,
 595                           acpi_ut_get_region_name(region_obj->region.
 596                                                   space_id)));
 597
 598         /* Link this region to the front of the handler's list */
 599
 600         region_obj->region.next = handler_obj->address_space.region_list;
 601         handler_obj->address_space.region_list = region_obj;
 602
 603         /* Install the region's handler */
 604
 605         if (region_obj->region.handler) {
 606                 return_ACPI_STATUS(AE_ALREADY_EXISTS);
 607         }
 608
 609         region_obj->region.handler = handler_obj;
 610         acpi_ut_add_reference(handler_obj);
 611
 612         return_ACPI_STATUS(AE_OK);
 613 }
 614
 615 /*******************************************************************************
 616  *
 617  * FUNCTION:    acpi_ev_install_handler
 618  *
 619  * PARAMETERS:  walk_namespace callback
 620  *
 621  * DESCRIPTION: This routine installs an address handler into objects that are
 622  *              of type Region or Device.
 623  *
 624  *              If the Object is a Device, and the device has a handler of
 625  *              the same type then the search is terminated in that branch.
 626  *
 627  *              This is because the existing handler is closer in proximity
 628  *              to any more regions than the one we are trying to install.
 629  *
 630  ******************************************************************************/
 631
 632 static acpi_status
 633 acpi_ev_install_handler(acpi_handle obj_handle,
 634                         u32 level, void *context, void **return_value)
 635 {
 636         union acpi_operand_object *handler_obj;
 637         union acpi_operand_object *next_handler_obj;
 638         union acpi_operand_object *obj_desc;
 639         struct acpi_namespace_node *node;
 640         acpi_status status;
 641
 642         ACPI_FUNCTION_NAME(ev_install_handler);
 643
 644         handler_obj = (union acpi_operand_object *)context;
 645
 646         /* Parameter validation */
 647
 648         if (!handler_obj) {
 649                 return (AE_OK);
 650         }
 651
 652         /* Convert and validate the device handle */
 653
 654         node = acpi_ns_map_handle_to_node(obj_handle);
 655         if (!node) {
 656                 return (AE_BAD_PARAMETER);
 657         }
 658
 659         /*
 660          * We only care about regions.and objects
 661          * that are allowed to have address space handlers
 662          */
 663         if ((node->type != ACPI_TYPE_DEVICE) &&
 664             (node->type != ACPI_TYPE_REGION) && (node != acpi_gbl_root_node)) {
 665                 return (AE_OK);
 666         }
 667
 668         /* Check for an existing internal object */
 669
 670         obj_desc = acpi_ns_get_attached_object(node);
 671         if (!obj_desc) {
 672
 673                 /* No object, just exit */
 674
 675                 return (AE_OK);
 676         }
 677
 678         /* Devices are handled different than regions */
 679
 680         if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_DEVICE) {
 681
 682                 /* Check if this Device already has a handler for this address space */
 683
 684                 next_handler_obj = obj_desc->device.handler;
 685                 while (next_handler_obj) {
 686
 687                         /* Found a handler, is it for the same address space? */
 688
 689                         if (next_handler_obj->address_space.space_id ==
 690                             handler_obj->address_space.space_id) {
 691                                 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 692                                                   "Found handler for region [%s] in device %p(%p) handler %p\n",
 693                                                   acpi_ut_get_region_name
 694                                                   (handler_obj->address_space.
 695                                                    space_id), obj_desc,
 696                                                   next_handler_obj,
 697                                                   handler_obj));
 698
 699                                 /*
 700                                  * Since the object we found it on was a device, then it
 701                                  * means that someone has already installed a handler for
 702                                  * the branch of the namespace from this device on.  Just
 703                                  * bail out telling the walk routine to not traverse this
 704                                  * branch.  This preserves the scoping rule for handlers.
 705                                  */
 706                                 return (AE_CTRL_DEPTH);
 707                         }
 708
 709                         /* Walk the linked list of handlers attached to this device */
 710
 711                         next_handler_obj = next_handler_obj->address_space.next;
 712                 }
 713
 714                 /*
 715                  * As long as the device didn't have a handler for this
 716                  * space we don't care about it.  We just ignore it and
 717                  * proceed.
 718                  */
 719                 return (AE_OK);
 720         }
 721
 722         /* Object is a Region */
 723
 724         if (obj_desc->region.space_id != handler_obj->address_space.space_id) {
 725                 /*
 726                  * This region is for a different address space
 727                  * -- just ignore it
 728                  */
 729                 return (AE_OK);
 730         }
 731
 732         /*
 733          * Now we have a region and it is for the handler's address
 734          * space type.
 735          *
 736          * First disconnect region for any previous handler (if any)
 737          */
 738         acpi_ev_detach_region(obj_desc, FALSE);
 739
 740         /* Connect the region to the new handler */
 741
 742         status = acpi_ev_attach_region(handler_obj, obj_desc, FALSE);
 743         return (status);
 744 }
 745
 746 /*******************************************************************************
 747  *
 748  * FUNCTION:    acpi_ev_install_space_handler
 749  *
 750  * PARAMETERS:  Node            - Namespace node for the device
 751  *              space_id        - The address space ID
 752  *              Handler         - Address of the handler
 753  *              Setup           - Address of the setup function
 754  *              Context         - Value passed to the handler on each access
 755  *
 756  * RETURN:      Status
 757  *
 758  * DESCRIPTION: Install a handler for all op_regions of a given space_id.
 759  *              Assumes namespace is locked
 760  *
 761  ******************************************************************************/
 762
 763 acpi_status
 764 acpi_ev_install_space_handler(struct acpi_namespace_node * node,
 765                               acpi_adr_space_type space_id,
 766                               acpi_adr_space_handler handler,
 767                               acpi_adr_space_setup setup, void *context)
 768 {
 769         union acpi_operand_object *obj_desc;
 770         union acpi_operand_object *handler_obj;
 771         acpi_status status;
 772         acpi_object_type type;
 773         u8 flags = 0;
 774
 775         ACPI_FUNCTION_TRACE(ev_install_space_handler);
 776
 777         /*
 778          * This registration is valid for only the types below
 779          * and the root.  This is where the default handlers
 780          * get placed.
 781          */
 782         if ((node->type != ACPI_TYPE_DEVICE) &&
 783             (node->type != ACPI_TYPE_PROCESSOR) &&
 784             (node->type != ACPI_TYPE_THERMAL) && (node != acpi_gbl_root_node)) {
 785                 status = AE_BAD_PARAMETER;
 786                 goto unlock_and_exit;
 787         }
 788
 789         if (handler == ACPI_DEFAULT_HANDLER) {
 790                 flags = ACPI_ADDR_HANDLER_DEFAULT_INSTALLED;
 791
 792                 switch (space_id) {
 793                 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
 794                         handler = acpi_ex_system_memory_space_handler;
 795                         setup = acpi_ev_system_memory_region_setup;
 796                         break;
 797
 798                 case ACPI_ADR_SPACE_SYSTEM_IO:
 799                         handler = acpi_ex_system_io_space_handler;
 800                         setup = acpi_ev_io_space_region_setup;
 801                         break;
 802
 803                 case ACPI_ADR_SPACE_PCI_CONFIG:
 804                         handler = acpi_ex_pci_config_space_handler;
 805                         setup = acpi_ev_pci_config_region_setup;
 806                         break;
 807
 808                 case ACPI_ADR_SPACE_CMOS:
 809                         handler = acpi_ex_cmos_space_handler;
 810                         setup = acpi_ev_cmos_region_setup;
 811                         break;
 812
 813                 case ACPI_ADR_SPACE_PCI_BAR_TARGET:
 814                         handler = acpi_ex_pci_bar_space_handler;
 815                         setup = acpi_ev_pci_bar_region_setup;
 816                         break;
 817
 818                 case ACPI_ADR_SPACE_DATA_TABLE:
 819                         handler = acpi_ex_data_table_space_handler;
 820                         setup = NULL;
 821                         break;
 822
 823                 default:
 824                         status = AE_BAD_PARAMETER;
 825                         goto unlock_and_exit;
 826                 }
 827         }
 828
 829         /* If the caller hasn't specified a setup routine, use the default */
 830
 831         if (!setup) {
 832                 setup = acpi_ev_default_region_setup;
 833         }
 834
 835         /* Check for an existing internal object */
 836
 837         obj_desc = acpi_ns_get_attached_object(node);
 838         if (obj_desc) {
 839                 /*
 840                  * The attached device object already exists.
 841                  * Make sure the handler is not already installed.
 842                  */
 843                 handler_obj = obj_desc->device.handler;
 844
 845                 /* Walk the handler list for this device */
 846
 847                 while (handler_obj) {
 848
 849                         /* Same space_id indicates a handler already installed */
 850
 851                         if (handler_obj->address_space.space_id == space_id) {
 852                                 if (handler_obj->address_space.handler ==
 853                                     handler) {
 854                                         /*
 855                                          * It is (relatively) OK to attempt to install the SAME
 856                                          * handler twice. This can easily happen
 857                                          * with PCI_Config space.
 858                                          */
 859                                         status = AE_SAME_HANDLER;
 860                                         goto unlock_and_exit;
 861                                 } else {
 862                                         /* A handler is already installed */
 863
 864                                         status = AE_ALREADY_EXISTS;
 865                                 }
 866                                 goto unlock_and_exit;
 867                         }
 868
 869                         /* Walk the linked list of handlers */
 870
 871                         handler_obj = handler_obj->address_space.next;
 872                 }
 873         } else {
 874                 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 875                                   "Creating object on Device %p while installing handler\n",
 876                                   node));
 877
 878                 /* obj_desc does not exist, create one */
 879
 880                 if (node->type == ACPI_TYPE_ANY) {
 881                         type = ACPI_TYPE_DEVICE;
 882                 } else {
 883                         type = node->type;
 884                 }
 885
 886                 obj_desc = acpi_ut_create_internal_object(type);
 887                 if (!obj_desc) {
 888                         status = AE_NO_MEMORY;
 889                         goto unlock_and_exit;
 890                 }
 891
 892                 /* Init new descriptor */
 893
 894                 obj_desc->common.type = (u8) type;
 895
 896                 /* Attach the new object to the Node */
 897
 898                 status = acpi_ns_attach_object(node, obj_desc, type);
 899
 900                 /* Remove local reference to the object */
 901
 902                 acpi_ut_remove_reference(obj_desc);
 903
 904                 if (ACPI_FAILURE(status)) {
 905                         goto unlock_and_exit;
 906                 }
 907         }
 908
 909         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 910                           "Installing address handler for region %s(%X) on Device %4.4s %p(%p)\n",
 911                           acpi_ut_get_region_name(space_id), space_id,
 912                           acpi_ut_get_node_name(node), node, obj_desc));
 913
 914         /*
 915          * Install the handler
 916          *
 917          * At this point there is no existing handler.
 918          * Just allocate the object for the handler and link it
 919          * into the list.
 920          */
 921         handler_obj =
 922             acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_ADDRESS_HANDLER);
 923         if (!handler_obj) {
 924                 status = AE_NO_MEMORY;
 925                 goto unlock_and_exit;
 926         }
 927
 928         /* Init handler obj */
 929
 930         handler_obj->address_space.space_id = (u8) space_id;
 931         handler_obj->address_space.handler_flags = flags;
 932         handler_obj->address_space.region_list = NULL;
 933         handler_obj->address_space.node = node;
 934         handler_obj->address_space.handler = handler;
 935         handler_obj->address_space.context = context;
 936         handler_obj->address_space.setup = setup;
 937
 938         /* Install at head of Device.address_space list */
 939
 940         handler_obj->address_space.next = obj_desc->device.handler;
 941
 942         /*
 943          * The Device object is the first reference on the handler_obj.
 944          * Each region that uses the handler adds a reference.
 945          */
 946         obj_desc->device.handler = handler_obj;
 947
 948         /*
 949          * Walk the namespace finding all of the regions this
 950          * handler will manage.
 951          *
 952          * Start at the device and search the branch toward
 953          * the leaf nodes until either the leaf is encountered or
 954          * a device is detected that has an address handler of the
 955          * same type.
 956          *
 957          * In either case, back up and search down the remainder
 958          * of the branch
 959          */
 960         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, node, ACPI_UINT32_MAX,
 961                                         ACPI_NS_WALK_UNLOCK,
 962                                         acpi_ev_install_handler, handler_obj,
 963                                         NULL);
 964
 965       unlock_and_exit:
 966         return_ACPI_STATUS(status);
 967 }
 968
 969 /*******************************************************************************
 970  *
 971  * FUNCTION:    acpi_ev_execute_reg_methods
 972  *
 973  * PARAMETERS:  Node            - Namespace node for the device
 974  *              space_id        - The address space ID
 975  *
 976  * RETURN:      Status
 977  *
 978  * DESCRIPTION: Run all _REG methods for the input Space ID;
 979  *              Note: assumes namespace is locked, or system init time.
 980  *
 981  ******************************************************************************/
 982
 983 acpi_status
 984 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
 985                             acpi_adr_space_type space_id)
 986 {
 987         acpi_status status;
 988
 989         ACPI_FUNCTION_TRACE(ev_execute_reg_methods);
 990
 991         /*
 992          * Run all _REG methods for all Operation Regions for this
 993          * space ID.  This is a separate walk in order to handle any
 994          * interdependencies between regions and _REG methods.  (i.e. handlers
 995          * must be installed for all regions of this Space ID before we
 996          * can run any _REG methods)
 997          */
 998         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, node, ACPI_UINT32_MAX,
 999                                         ACPI_NS_WALK_UNLOCK, acpi_ev_reg_run,
1000                                         &space_id, NULL);
1001
1002         return_ACPI_STATUS(status);
1003 }
1004
1005 /*******************************************************************************
1006  *
1007  * FUNCTION:    acpi_ev_reg_run
1008  *
1009  * PARAMETERS:  walk_namespace callback
1010  *
1011  * DESCRIPTION: Run _REG method for region objects of the requested space_iD
1012  *
1013  ******************************************************************************/
1014
1015 static acpi_status
1016 acpi_ev_reg_run(acpi_handle obj_handle,
1017                 u32 level, void *context, void **return_value)
1018 {
1019         union acpi_operand_object *obj_desc;
1020         struct acpi_namespace_node *node;
1021         acpi_adr_space_type space_id;
1022         acpi_status status;
1023
1024         space_id = *ACPI_CAST_PTR(acpi_adr_space_type, context);
1025
1026         /* Convert and validate the device handle */
1027
1028         node = acpi_ns_map_handle_to_node(obj_handle);
1029         if (!node) {
1030                 return (AE_BAD_PARAMETER);
1031         }
1032
1033         /*
1034          * We only care about regions.and objects
1035          * that are allowed to have address space handlers
1036          */
1037         if ((node->type != ACPI_TYPE_REGION) && (node != acpi_gbl_root_node)) {
1038                 return (AE_OK);
1039         }
1040
1041         /* Check for an existing internal object */
1042
1043         obj_desc = acpi_ns_get_attached_object(node);
1044         if (!obj_desc) {
1045
1046                 /* No object, just exit */
1047
1048                 return (AE_OK);
1049         }
1050
1051         /* Object is a Region */
1052
1053         if (obj_desc->region.space_id != space_id) {
1054                 /*
1055                  * This region is for a different address space
1056                  * -- just ignore it
1057                  */
1058                 return (AE_OK);
1059         }
1060
1061         status = acpi_ev_execute_reg_method(obj_desc, 1);
1062         return (status);
1063 }