drivers/acpi/acpica/evrgnini.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evrgnini- ACPI address_space (op_region) init
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2017, Intel Corp.
   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 "accommon.h"
  46 #include "acevents.h"
  47 #include "acnamesp.h"
  48 #include "acinterp.h"
  49
  50 #define _COMPONENT          ACPI_EVENTS
  51 ACPI_MODULE_NAME("evrgnini")
  52
  53 /*******************************************************************************
  54  *
  55  * FUNCTION:    acpi_ev_system_memory_region_setup
  56  *
  57  * PARAMETERS:  handle              - Region we are interested in
  58  *              function            - Start or stop
  59  *              handler_context     - Address space handler context
  60  *              region_context      - Region specific context
  61  *
  62  * RETURN:      Status
  63  *
  64  * DESCRIPTION: Setup a system_memory operation region
  65  *
  66  ******************************************************************************/
  67 acpi_status
  68 acpi_ev_system_memory_region_setup(acpi_handle handle,
  69                                    u32 function,
  70                                    void *handler_context, void **region_context)
  71 {
  72         union acpi_operand_object *region_desc =
  73             (union acpi_operand_object *)handle;
  74         struct acpi_mem_space_context *local_region_context;
  75
  76         ACPI_FUNCTION_TRACE(ev_system_memory_region_setup);
  77
  78         if (function == ACPI_REGION_DEACTIVATE) {
  79                 if (*region_context) {
  80                         local_region_context =
  81                             (struct acpi_mem_space_context *)*region_context;
  82
  83                         /* Delete a cached mapping if present */
  84
  85                         if (local_region_context->mapped_length) {
  86                                 acpi_os_unmap_memory(local_region_context->
  87                                                      mapped_logical_address,
  88                                                      local_region_context->
  89                                                      mapped_length);
  90                         }
  91                         ACPI_FREE(local_region_context);
  92                         *region_context = NULL;
  93                 }
  94                 return_ACPI_STATUS(AE_OK);
  95         }
  96
  97         /* Create a new context */
  98
  99         local_region_context =
 100             ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_mem_space_context));
 101         if (!(local_region_context)) {
 102                 return_ACPI_STATUS(AE_NO_MEMORY);
 103         }
 104
 105         /* Save the region length and address for use in the handler */
 106
 107         local_region_context->length = region_desc->region.length;
 108         local_region_context->address = region_desc->region.address;
 109
 110         *region_context = local_region_context;
 111         return_ACPI_STATUS(AE_OK);
 112 }
 113
 114 /*******************************************************************************
 115  *
 116  * FUNCTION:    acpi_ev_io_space_region_setup
 117  *
 118  * PARAMETERS:  handle              - Region we are interested in
 119  *              function            - Start or stop
 120  *              handler_context     - Address space handler context
 121  *              region_context      - Region specific context
 122  *
 123  * RETURN:      Status
 124  *
 125  * DESCRIPTION: Setup a IO operation region
 126  *
 127  ******************************************************************************/
 128
 129 acpi_status
 130 acpi_ev_io_space_region_setup(acpi_handle handle,
 131                               u32 function,
 132                               void *handler_context, void **region_context)
 133 {
 134         ACPI_FUNCTION_TRACE(ev_io_space_region_setup);
 135
 136         if (function == ACPI_REGION_DEACTIVATE) {
 137                 *region_context = NULL;
 138         } else {
 139                 *region_context = handler_context;
 140         }
 141
 142         return_ACPI_STATUS(AE_OK);
 143 }
 144
 145 /*******************************************************************************
 146  *
 147  * FUNCTION:    acpi_ev_pci_config_region_setup
 148  *
 149  * PARAMETERS:  handle              - Region we are interested in
 150  *              function            - Start or stop
 151  *              handler_context     - Address space handler context
 152  *              region_context      - Region specific context
 153  *
 154  * RETURN:      Status
 155  *
 156  * DESCRIPTION: Setup a PCI_Config operation region
 157  *
 158  * MUTEX:       Assumes namespace is not locked
 159  *
 160  ******************************************************************************/
 161
 162 acpi_status
 163 acpi_ev_pci_config_region_setup(acpi_handle handle,
 164                                 u32 function,
 165                                 void *handler_context, void **region_context)
 166 {
 167         acpi_status status = AE_OK;
 168         u64 pci_value;
 169         struct acpi_pci_id *pci_id = *region_context;
 170         union acpi_operand_object *handler_obj;
 171         struct acpi_namespace_node *parent_node;
 172         struct acpi_namespace_node *pci_root_node;
 173         struct acpi_namespace_node *pci_device_node;
 174         union acpi_operand_object *region_obj =
 175             (union acpi_operand_object *)handle;
 176
 177         ACPI_FUNCTION_TRACE(ev_pci_config_region_setup);
 178
 179         handler_obj = region_obj->region.handler;
 180         if (!handler_obj) {
 181                 /*
 182                  * No installed handler. This shouldn't happen because the dispatch
 183                  * routine checks before we get here, but we check again just in case.
 184                  */
 185                 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 186                                   "Attempting to init a region %p, with no handler\n",
 187                                   region_obj));
 188                 return_ACPI_STATUS(AE_NOT_EXIST);
 189         }
 190
 191         *region_context = NULL;
 192         if (function == ACPI_REGION_DEACTIVATE) {
 193                 if (pci_id) {
 194                         ACPI_FREE(pci_id);
 195                 }
 196                 return_ACPI_STATUS(status);
 197         }
 198
 199         parent_node = region_obj->region.node->parent;
 200
 201         /*
 202          * Get the _SEG and _BBN values from the device upon which the handler
 203          * is installed.
 204          *
 205          * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
 206          * This is the device the handler has been registered to handle.
 207          */
 208
 209         /*
 210          * If the address_space.Node is still pointing to the root, we need
 211          * to scan upward for a PCI Root bridge and re-associate the op_region
 212          * handlers with that device.
 213          */
 214         if (handler_obj->address_space.node == acpi_gbl_root_node) {
 215
 216                 /* Start search from the parent object */
 217
 218                 pci_root_node = parent_node;
 219                 while (pci_root_node != acpi_gbl_root_node) {
 220
 221                         /* Get the _HID/_CID in order to detect a root_bridge */
 222
 223                         if (acpi_ev_is_pci_root_bridge(pci_root_node)) {
 224
 225                                 /* Install a handler for this PCI root bridge */
 226
 227                                 status = acpi_install_address_space_handler((acpi_handle)pci_root_node, ACPI_ADR_SPACE_PCI_CONFIG, ACPI_DEFAULT_HANDLER, NULL, NULL);
 228                                 if (ACPI_FAILURE(status)) {
 229                                         if (status == AE_SAME_HANDLER) {
 230                                                 /*
 231                                                  * It is OK if the handler is already installed on the
 232                                                  * root bridge. Still need to return a context object
 233                                                  * for the new PCI_Config operation region, however.
 234                                                  */
 235                                                 status = AE_OK;
 236                                         } else {
 237                                                 ACPI_EXCEPTION((AE_INFO, status,
 238                                                                 "Could not install PciConfig handler "
 239                                                                 "for Root Bridge %4.4s",
 240                                                                 acpi_ut_get_node_name
 241                                                                 (pci_root_node)));
 242                                         }
 243                                 }
 244                                 break;
 245                         }
 246
 247                         pci_root_node = pci_root_node->parent;
 248                 }
 249
 250                 /* PCI root bridge not found, use namespace root node */
 251         } else {
 252                 pci_root_node = handler_obj->address_space.node;
 253         }
 254
 255         /*
 256          * If this region is now initialized, we are done.
 257          * (install_address_space_handler could have initialized it)
 258          */
 259         if (region_obj->region.flags & AOPOBJ_SETUP_COMPLETE) {
 260                 return_ACPI_STATUS(AE_OK);
 261         }
 262
 263         /* Region is still not initialized. Create a new context */
 264
 265         pci_id = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pci_id));
 266         if (!pci_id) {
 267                 return_ACPI_STATUS(AE_NO_MEMORY);
 268         }
 269
 270         /*
 271          * For PCI_Config space access, we need the segment, bus, device and
 272          * function numbers. Acquire them here.
 273          *
 274          * Find the parent device object. (This allows the operation region to be
 275          * within a subscope under the device, such as a control method.)
 276          */
 277         pci_device_node = region_obj->region.node;
 278         while (pci_device_node && (pci_device_node->type != ACPI_TYPE_DEVICE)) {
 279                 pci_device_node = pci_device_node->parent;
 280         }
 281
 282         if (!pci_device_node) {
 283                 ACPI_FREE(pci_id);
 284                 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 285         }
 286
 287         /*
 288          * Get the PCI device and function numbers from the _ADR object
 289          * contained in the parent's scope.
 290          */
 291         status = acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR,
 292                                                  pci_device_node, &pci_value);
 293
 294         /*
 295          * The default is zero, and since the allocation above zeroed the data,
 296          * just do nothing on failure.
 297          */
 298         if (ACPI_SUCCESS(status)) {
 299                 pci_id->device = ACPI_HIWORD(ACPI_LODWORD(pci_value));
 300                 pci_id->function = ACPI_LOWORD(ACPI_LODWORD(pci_value));
 301         }
 302
 303         /* The PCI segment number comes from the _SEG method */
 304
 305         status = acpi_ut_evaluate_numeric_object(METHOD_NAME__SEG,
 306                                                  pci_root_node, &pci_value);
 307         if (ACPI_SUCCESS(status)) {
 308                 pci_id->segment = ACPI_LOWORD(pci_value);
 309         }
 310
 311         /* The PCI bus number comes from the _BBN method */
 312
 313         status = acpi_ut_evaluate_numeric_object(METHOD_NAME__BBN,
 314                                                  pci_root_node, &pci_value);
 315         if (ACPI_SUCCESS(status)) {
 316                 pci_id->bus = ACPI_LOWORD(pci_value);
 317         }
 318
 319         /* Complete/update the PCI ID for this device */
 320
 321         status =
 322             acpi_hw_derive_pci_id(pci_id, pci_root_node,
 323                                   region_obj->region.node);
 324         if (ACPI_FAILURE(status)) {
 325                 ACPI_FREE(pci_id);
 326                 return_ACPI_STATUS(status);
 327         }
 328
 329         *region_context = pci_id;
 330         return_ACPI_STATUS(AE_OK);
 331 }
 332
 333 /*******************************************************************************
 334  *
 335  * FUNCTION:    acpi_ev_is_pci_root_bridge
 336  *
 337  * PARAMETERS:  node            - Device node being examined
 338  *
 339  * RETURN:      TRUE if device is a PCI/PCI-Express Root Bridge
 340  *
 341  * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
 342  *              examining the _HID and _CID for the device.
 343  *
 344  ******************************************************************************/
 345
 346 u8 acpi_ev_is_pci_root_bridge(struct acpi_namespace_node *node)
 347 {
 348         acpi_status status;
 349         struct acpi_pnp_device_id *hid;
 350         struct acpi_pnp_device_id_list *cid;
 351         u32 i;
 352         u8 match;
 353
 354         /* Get the _HID and check for a PCI Root Bridge */
 355
 356         status = acpi_ut_execute_HID(node, &hid);
 357         if (ACPI_FAILURE(status)) {
 358                 return (FALSE);
 359         }
 360
 361         match = acpi_ut_is_pci_root_bridge(hid->string);
 362         ACPI_FREE(hid);
 363
 364         if (match) {
 365                 return (TRUE);
 366         }
 367
 368         /* The _HID did not match. Get the _CID and check for a PCI Root Bridge */
 369
 370         status = acpi_ut_execute_CID(node, &cid);
 371         if (ACPI_FAILURE(status)) {
 372                 return (FALSE);
 373         }
 374
 375         /* Check all _CIDs in the returned list */
 376
 377         for (i = 0; i < cid->count; i++) {
 378                 if (acpi_ut_is_pci_root_bridge(cid->ids[i].string)) {
 379                         ACPI_FREE(cid);
 380                         return (TRUE);
 381                 }
 382         }
 383
 384         ACPI_FREE(cid);
 385         return (FALSE);
 386 }
 387
 388 /*******************************************************************************
 389  *
 390  * FUNCTION:    acpi_ev_pci_bar_region_setup
 391  *
 392  * PARAMETERS:  handle              - Region we are interested in
 393  *              function            - Start or stop
 394  *              handler_context     - Address space handler context
 395  *              region_context      - Region specific context
 396  *
 397  * RETURN:      Status
 398  *
 399  * DESCRIPTION: Setup a pci_BAR operation region
 400  *
 401  * MUTEX:       Assumes namespace is not locked
 402  *
 403  ******************************************************************************/
 404
 405 acpi_status
 406 acpi_ev_pci_bar_region_setup(acpi_handle handle,
 407                              u32 function,
 408                              void *handler_context, void **region_context)
 409 {
 410         ACPI_FUNCTION_TRACE(ev_pci_bar_region_setup);
 411
 412         return_ACPI_STATUS(AE_OK);
 413 }
 414
 415 /*******************************************************************************
 416  *
 417  * FUNCTION:    acpi_ev_cmos_region_setup
 418  *
 419  * PARAMETERS:  handle              - Region we are interested in
 420  *              function            - Start or stop
 421  *              handler_context     - Address space handler context
 422  *              region_context      - Region specific context
 423  *
 424  * RETURN:      Status
 425  *
 426  * DESCRIPTION: Setup a CMOS operation region
 427  *
 428  * MUTEX:       Assumes namespace is not locked
 429  *
 430  ******************************************************************************/
 431
 432 acpi_status
 433 acpi_ev_cmos_region_setup(acpi_handle handle,
 434                           u32 function,
 435                           void *handler_context, void **region_context)
 436 {
 437         ACPI_FUNCTION_TRACE(ev_cmos_region_setup);
 438
 439         return_ACPI_STATUS(AE_OK);
 440 }
 441
 442 /*******************************************************************************
 443  *
 444  * FUNCTION:    acpi_ev_default_region_setup
 445  *
 446  * PARAMETERS:  handle              - Region we are interested in
 447  *              function            - Start or stop
 448  *              handler_context     - Address space handler context
 449  *              region_context      - Region specific context
 450  *
 451  * RETURN:      Status
 452  *
 453  * DESCRIPTION: Default region initialization
 454  *
 455  ******************************************************************************/
 456
 457 acpi_status
 458 acpi_ev_default_region_setup(acpi_handle handle,
 459                              u32 function,
 460                              void *handler_context, void **region_context)
 461 {
 462         ACPI_FUNCTION_TRACE(ev_default_region_setup);
 463
 464         if (function == ACPI_REGION_DEACTIVATE) {
 465                 *region_context = NULL;
 466         } else {
 467                 *region_context = handler_context;
 468         }
 469
 470         return_ACPI_STATUS(AE_OK);
 471 }
 472
 473 /*******************************************************************************
 474  *
 475  * FUNCTION:    acpi_ev_initialize_region
 476  *
 477  * PARAMETERS:  region_obj      - Region we are initializing
 478  *
 479  * RETURN:      Status
 480  *
 481  * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
 482  *              for execution at a later time
 483  *
 484  *              Get the appropriate address space handler for a newly
 485  *              created region.
 486  *
 487  *              This also performs address space specific initialization. For
 488  *              example, PCI regions must have an _ADR object that contains
 489  *              a PCI address in the scope of the definition. This address is
 490  *              required to perform an access to PCI config space.
 491  *
 492  * MUTEX:       Interpreter should be unlocked, because we may run the _REG
 493  *              method for this region.
 494  *
 495  * NOTE:        Possible incompliance:
 496  *              There is a behavior conflict in automatic _REG execution:
 497  *              1. When the interpreter is evaluating a method, we can only
 498  *                 automatically run _REG for the following case:
 499  *                   operation_region (OPR1, 0x80, 0x1000010, 0x4)
 500  *              2. When the interpreter is loading a table, we can also
 501  *                 automatically run _REG for the following case:
 502  *                   operation_region (OPR1, 0x80, 0x1000010, 0x4)
 503  *              Though this may not be compliant to the de-facto standard, the
 504  *              logic is kept in order not to trigger regressions. And keeping
 505  *              this logic should be taken care by the caller of this function.
 506  *
 507  ******************************************************************************/
 508
 509 acpi_status acpi_ev_initialize_region(union acpi_operand_object *region_obj)
 510 {
 511         union acpi_operand_object *handler_obj;
 512         union acpi_operand_object *obj_desc;
 513         acpi_adr_space_type space_id;
 514         struct acpi_namespace_node *node;
 515
 516         ACPI_FUNCTION_TRACE(ev_initialize_region);
 517
 518         if (!region_obj) {
 519                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 520         }
 521
 522         if (region_obj->common.flags & AOPOBJ_OBJECT_INITIALIZED) {
 523                 return_ACPI_STATUS(AE_OK);
 524         }
 525
 526         region_obj->common.flags |= AOPOBJ_OBJECT_INITIALIZED;
 527
 528         node = region_obj->region.node->parent;
 529         space_id = region_obj->region.space_id;
 530
 531         /*
 532          * The following loop depends upon the root Node having no parent
 533          * ie: acpi_gbl_root_node->Parent being set to NULL
 534          */
 535         while (node) {
 536
 537                 /* Check to see if a handler exists */
 538
 539                 handler_obj = NULL;
 540                 obj_desc = acpi_ns_get_attached_object(node);
 541                 if (obj_desc) {
 542
 543                         /* Can only be a handler if the object exists */
 544
 545                         switch (node->type) {
 546                         case ACPI_TYPE_DEVICE:
 547                         case ACPI_TYPE_PROCESSOR:
 548                         case ACPI_TYPE_THERMAL:
 549
 550                                 handler_obj = obj_desc->common_notify.handler;
 551                                 break;
 552
 553                         case ACPI_TYPE_METHOD:
 554                                 /*
 555                                  * If we are executing module level code, the original
 556                                  * Node's object was replaced by this Method object and we
 557                                  * saved the handler in the method object.
 558                                  *
 559                                  * See acpi_ns_exec_module_code
 560                                  */
 561                                 if (!acpi_gbl_parse_table_as_term_list &&
 562                                     obj_desc->method.
 563                                     info_flags & ACPI_METHOD_MODULE_LEVEL) {
 564                                         handler_obj =
 565                                             obj_desc->method.dispatch.handler;
 566                                 }
 567                                 break;
 568
 569                         default:
 570
 571                                 /* Ignore other objects */
 572
 573                                 break;
 574                         }
 575
 576                         handler_obj =
 577                             acpi_ev_find_region_handler(space_id, handler_obj);
 578                         if (handler_obj) {
 579
 580                                 /* Found correct handler */
 581
 582                                 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 583                                                   "Found handler %p for region %p in obj %p\n",
 584                                                   handler_obj, region_obj,
 585                                                   obj_desc));
 586
 587                                 (void)acpi_ev_attach_region(handler_obj,
 588                                                             region_obj, FALSE);
 589
 590                                 /*
 591                                  * Tell all users that this region is usable by
 592                                  * running the _REG method
 593                                  */
 594                                 acpi_ex_exit_interpreter();
 595                                 (void)acpi_ev_execute_reg_method(region_obj,
 596                                                                  ACPI_REG_CONNECT);
 597                                 acpi_ex_enter_interpreter();
 598                                 return_ACPI_STATUS(AE_OK);
 599                         }
 600                 }
 601
 602                 /* This node does not have the handler we need; Pop up one level */
 603
 604                 node = node->parent;
 605         }
 606
 607         /*
 608          * If we get here, there is no handler for this region. This is not
 609          * fatal because many regions get created before a handler is installed
 610          * for said region.
 611          */
 612         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
 613                           "No handler for RegionType %s(%X) (RegionObj %p)\n",
 614                           acpi_ut_get_region_name(space_id), space_id,
 615                           region_obj));
 616
 617         return_ACPI_STATUS(AE_OK);
 618 }