drivers/acpi/acpica/exconfig.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2016, 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 "acinterp.h"
  47 #include "acnamesp.h"
  48 #include "actables.h"
  49 #include "acdispat.h"
  50 #include "acevents.h"
  51 #include "amlcode.h"
  52
  53 #define _COMPONENT          ACPI_EXECUTER
  54 ACPI_MODULE_NAME("exconfig")
  55
  56 /* Local prototypes */
  57 static acpi_status
  58 acpi_ex_add_table(u32 table_index,
  59                   struct acpi_namespace_node *parent_node,
  60                   union acpi_operand_object **ddb_handle);
  61
  62 static acpi_status
  63 acpi_ex_region_read(union acpi_operand_object *obj_desc,
  64                     u32 length, u8 *buffer);
  65
  66 /*******************************************************************************
  67  *
  68  * FUNCTION:    acpi_ex_add_table
  69  *
  70  * PARAMETERS:  table               - Pointer to raw table
  71  *              parent_node         - Where to load the table (scope)
  72  *              ddb_handle          - Where to return the table handle.
  73  *
  74  * RETURN:      Status
  75  *
  76  * DESCRIPTION: Common function to Install and Load an ACPI table with a
  77  *              returned table handle.
  78  *
  79  ******************************************************************************/
  80
  81 static acpi_status
  82 acpi_ex_add_table(u32 table_index,
  83                   struct acpi_namespace_node *parent_node,
  84                   union acpi_operand_object **ddb_handle)
  85 {
  86         union acpi_operand_object *obj_desc;
  87         acpi_status status;
  88         acpi_owner_id owner_id;
  89
  90         ACPI_FUNCTION_TRACE(ex_add_table);
  91
  92         /* Create an object to be the table handle */
  93
  94         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE);
  95         if (!obj_desc) {
  96                 return_ACPI_STATUS(AE_NO_MEMORY);
  97         }
  98
  99         /* Init the table handle */
 100
 101         obj_desc->common.flags |= AOPOBJ_DATA_VALID;
 102         obj_desc->reference.class = ACPI_REFCLASS_TABLE;
 103         *ddb_handle = obj_desc;
 104
 105         /* Install the new table into the local data structures */
 106
 107         obj_desc->reference.value = table_index;
 108
 109         /* Add the table to the namespace */
 110
 111         status = acpi_ns_load_table(table_index, parent_node);
 112         if (ACPI_FAILURE(status)) {
 113                 acpi_ut_remove_reference(obj_desc);
 114                 *ddb_handle = NULL;
 115                 return_ACPI_STATUS(status);
 116         }
 117
 118         /* Execute any module-level code that was found in the table */
 119
 120         acpi_ex_exit_interpreter();
 121         if (acpi_gbl_group_module_level_code) {
 122                 acpi_ns_exec_module_code_list();
 123         }
 124         acpi_ex_enter_interpreter();
 125
 126         /*
 127          * Update GPEs for any new _Lxx/_Exx methods. Ignore errors. The host is
 128          * responsible for discovering any new wake GPEs by running _PRW methods
 129          * that may have been loaded by this table.
 130          */
 131         status = acpi_tb_get_owner_id(table_index, &owner_id);
 132         if (ACPI_SUCCESS(status)) {
 133                 acpi_ev_update_gpes(owner_id);
 134         }
 135
 136         return_ACPI_STATUS(AE_OK);
 137 }
 138
 139 /*******************************************************************************
 140  *
 141  * FUNCTION:    acpi_ex_load_table_op
 142  *
 143  * PARAMETERS:  walk_state          - Current state with operands
 144  *              return_desc         - Where to store the return object
 145  *
 146  * RETURN:      Status
 147  *
 148  * DESCRIPTION: Load an ACPI table from the RSDT/XSDT
 149  *
 150  ******************************************************************************/
 151
 152 acpi_status
 153 acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
 154                       union acpi_operand_object **return_desc)
 155 {
 156         acpi_status status;
 157         union acpi_operand_object **operand = &walk_state->operands[0];
 158         struct acpi_namespace_node *parent_node;
 159         struct acpi_namespace_node *start_node;
 160         struct acpi_namespace_node *parameter_node = NULL;
 161         union acpi_operand_object *ddb_handle;
 162         struct acpi_table_header *table;
 163         u32 table_index;
 164
 165         ACPI_FUNCTION_TRACE(ex_load_table_op);
 166
 167         /* Find the ACPI table in the RSDT/XSDT */
 168
 169         status = acpi_tb_find_table(operand[0]->string.pointer,
 170                                     operand[1]->string.pointer,
 171                                     operand[2]->string.pointer, &table_index);
 172         if (ACPI_FAILURE(status)) {
 173                 if (status != AE_NOT_FOUND) {
 174                         return_ACPI_STATUS(status);
 175                 }
 176
 177                 /* Table not found, return an Integer=0 and AE_OK */
 178
 179                 ddb_handle = acpi_ut_create_integer_object((u64) 0);
 180                 if (!ddb_handle) {
 181                         return_ACPI_STATUS(AE_NO_MEMORY);
 182                 }
 183
 184                 *return_desc = ddb_handle;
 185                 return_ACPI_STATUS(AE_OK);
 186         }
 187
 188         /* Default nodes */
 189
 190         start_node = walk_state->scope_info->scope.node;
 191         parent_node = acpi_gbl_root_node;
 192
 193         /* root_path (optional parameter) */
 194
 195         if (operand[3]->string.length > 0) {
 196                 /*
 197                  * Find the node referenced by the root_path_string. This is the
 198                  * location within the namespace where the table will be loaded.
 199                  */
 200                 status =
 201                     acpi_ns_get_node(start_node, operand[3]->string.pointer,
 202                                      ACPI_NS_SEARCH_PARENT, &parent_node);
 203                 if (ACPI_FAILURE(status)) {
 204                         return_ACPI_STATUS(status);
 205                 }
 206         }
 207
 208         /* parameter_path (optional parameter) */
 209
 210         if (operand[4]->string.length > 0) {
 211                 if ((operand[4]->string.pointer[0] != AML_ROOT_PREFIX) &&
 212                     (operand[4]->string.pointer[0] != AML_PARENT_PREFIX)) {
 213                         /*
 214                          * Path is not absolute, so it will be relative to the node
 215                          * referenced by the root_path_string (or the NS root if omitted)
 216                          */
 217                         start_node = parent_node;
 218                 }
 219
 220                 /* Find the node referenced by the parameter_path_string */
 221
 222                 status =
 223                     acpi_ns_get_node(start_node, operand[4]->string.pointer,
 224                                      ACPI_NS_SEARCH_PARENT, &parameter_node);
 225                 if (ACPI_FAILURE(status)) {
 226                         return_ACPI_STATUS(status);
 227                 }
 228         }
 229
 230         /* Load the table into the namespace */
 231
 232         status = acpi_ex_add_table(table_index, parent_node, &ddb_handle);
 233         if (ACPI_FAILURE(status)) {
 234                 return_ACPI_STATUS(status);
 235         }
 236
 237         /* Parameter Data (optional) */
 238
 239         if (parameter_node) {
 240
 241                 /* Store the parameter data into the optional parameter object */
 242
 243                 status = acpi_ex_store(operand[5],
 244                                        ACPI_CAST_PTR(union acpi_operand_object,
 245                                                      parameter_node),
 246                                        walk_state);
 247                 if (ACPI_FAILURE(status)) {
 248                         (void)acpi_ex_unload_table(ddb_handle);
 249
 250                         acpi_ut_remove_reference(ddb_handle);
 251                         return_ACPI_STATUS(status);
 252                 }
 253         }
 254
 255         status = acpi_get_table_by_index(table_index, &table);
 256         if (ACPI_SUCCESS(status)) {
 257                 ACPI_INFO(("Dynamic OEM Table Load:"));
 258                 acpi_tb_print_table_header(0, table);
 259         }
 260
 261         /* Invoke table handler if present */
 262
 263         if (acpi_gbl_table_handler) {
 264                 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD, table,
 265                                              acpi_gbl_table_handler_context);
 266         }
 267
 268         *return_desc = ddb_handle;
 269         return_ACPI_STATUS(status);
 270 }
 271
 272 /*******************************************************************************
 273  *
 274  * FUNCTION:    acpi_ex_region_read
 275  *
 276  * PARAMETERS:  obj_desc        - Region descriptor
 277  *              length          - Number of bytes to read
 278  *              buffer          - Pointer to where to put the data
 279  *
 280  * RETURN:      Status
 281  *
 282  * DESCRIPTION: Read data from an operation region. The read starts from the
 283  *              beginning of the region.
 284  *
 285  ******************************************************************************/
 286
 287 static acpi_status
 288 acpi_ex_region_read(union acpi_operand_object *obj_desc, u32 length, u8 *buffer)
 289 {
 290         acpi_status status;
 291         u64 value;
 292         u32 region_offset = 0;
 293         u32 i;
 294
 295         /* Bytewise reads */
 296
 297         for (i = 0; i < length; i++) {
 298                 status =
 299                     acpi_ev_address_space_dispatch(obj_desc, NULL, ACPI_READ,
 300                                                    region_offset, 8, &value);
 301                 if (ACPI_FAILURE(status)) {
 302                         return (status);
 303                 }
 304
 305                 *buffer = (u8)value;
 306                 buffer++;
 307                 region_offset++;
 308         }
 309
 310         return (AE_OK);
 311 }
 312
 313 /*******************************************************************************
 314  *
 315  * FUNCTION:    acpi_ex_load_op
 316  *
 317  * PARAMETERS:  obj_desc        - Region or Buffer/Field where the table will be
 318  *                                obtained
 319  *              target          - Where a handle to the table will be stored
 320  *              walk_state      - Current state
 321  *
 322  * RETURN:      Status
 323  *
 324  * DESCRIPTION: Load an ACPI table from a field or operation region
 325  *
 326  * NOTE: Region Fields (Field, bank_field, index_fields) are resolved to buffer
 327  *       objects before this code is reached.
 328  *
 329  *       If source is an operation region, it must refer to system_memory, as
 330  *       per the ACPI specification.
 331  *
 332  ******************************************************************************/
 333
 334 acpi_status
 335 acpi_ex_load_op(union acpi_operand_object *obj_desc,
 336                 union acpi_operand_object *target,
 337                 struct acpi_walk_state *walk_state)
 338 {
 339         union acpi_operand_object *ddb_handle;
 340         struct acpi_table_header *table_header;
 341         struct acpi_table_header *table;
 342         u32 table_index;
 343         acpi_status status;
 344         u32 length;
 345
 346         ACPI_FUNCTION_TRACE(ex_load_op);
 347
 348         /* Source Object can be either an op_region or a Buffer/Field */
 349
 350         switch (obj_desc->common.type) {
 351         case ACPI_TYPE_REGION:
 352
 353                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 354                                   "Load table from Region %p\n", obj_desc));
 355
 356                 /* Region must be system_memory (from ACPI spec) */
 357
 358                 if (obj_desc->region.space_id != ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 359                         return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 360                 }
 361
 362                 /*
 363                  * If the Region Address and Length have not been previously
 364                  * evaluated, evaluate them now and save the results.
 365                  */
 366                 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
 367                         status = acpi_ds_get_region_arguments(obj_desc);
 368                         if (ACPI_FAILURE(status)) {
 369                                 return_ACPI_STATUS(status);
 370                         }
 371                 }
 372
 373                 /* Get the table header first so we can get the table length */
 374
 375                 table_header = ACPI_ALLOCATE(sizeof(struct acpi_table_header));
 376                 if (!table_header) {
 377                         return_ACPI_STATUS(AE_NO_MEMORY);
 378                 }
 379
 380                 status =
 381                     acpi_ex_region_read(obj_desc,
 382                                         sizeof(struct acpi_table_header),
 383                                         ACPI_CAST_PTR(u8, table_header));
 384                 length = table_header->length;
 385                 ACPI_FREE(table_header);
 386
 387                 if (ACPI_FAILURE(status)) {
 388                         return_ACPI_STATUS(status);
 389                 }
 390
 391                 /* Must have at least an ACPI table header */
 392
 393                 if (length < sizeof(struct acpi_table_header)) {
 394                         return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
 395                 }
 396
 397                 /*
 398                  * The original implementation simply mapped the table, with no copy.
 399                  * However, the memory region is not guaranteed to remain stable and
 400                  * we must copy the table to a local buffer. For example, the memory
 401                  * region is corrupted after suspend on some machines. Dynamically
 402                  * loaded tables are usually small, so this overhead is minimal.
 403                  *
 404                  * The latest implementation (5/2009) does not use a mapping at all.
 405                  * We use the low-level operation region interface to read the table
 406                  * instead of the obvious optimization of using a direct mapping.
 407                  * This maintains a consistent use of operation regions across the
 408                  * entire subsystem. This is important if additional processing must
 409                  * be performed in the (possibly user-installed) operation region
 410                  * handler. For example, acpi_exec and ASLTS depend on this.
 411                  */
 412
 413                 /* Allocate a buffer for the table */
 414
 415                 table = ACPI_ALLOCATE(length);
 416                 if (!table) {
 417                         return_ACPI_STATUS(AE_NO_MEMORY);
 418                 }
 419
 420                 /* Read the entire table */
 421
 422                 status = acpi_ex_region_read(obj_desc, length,
 423                                              ACPI_CAST_PTR(u8, table));
 424                 if (ACPI_FAILURE(status)) {
 425                         ACPI_FREE(table);
 426                         return_ACPI_STATUS(status);
 427                 }
 428                 break;
 429
 430         case ACPI_TYPE_BUFFER:  /* Buffer or resolved region_field */
 431
 432                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 433                                   "Load table from Buffer or Field %p\n",
 434                                   obj_desc));
 435
 436                 /* Must have at least an ACPI table header */
 437
 438                 if (obj_desc->buffer.length < sizeof(struct acpi_table_header)) {
 439                         return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
 440                 }
 441
 442                 /* Get the actual table length from the table header */
 443
 444                 table_header =
 445                     ACPI_CAST_PTR(struct acpi_table_header,
 446                                   obj_desc->buffer.pointer);
 447                 length = table_header->length;
 448
 449                 /* Table cannot extend beyond the buffer */
 450
 451                 if (length > obj_desc->buffer.length) {
 452                         return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
 453                 }
 454                 if (length < sizeof(struct acpi_table_header)) {
 455                         return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH);
 456                 }
 457
 458                 /*
 459                  * Copy the table from the buffer because the buffer could be
 460                  * modified or even deleted in the future
 461                  */
 462                 table = ACPI_ALLOCATE(length);
 463                 if (!table) {
 464                         return_ACPI_STATUS(AE_NO_MEMORY);
 465                 }
 466
 467                 memcpy(table, table_header, length);
 468                 break;
 469
 470         default:
 471
 472                 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 473         }
 474
 475         /* Install the new table into the local data structures */
 476
 477         ACPI_INFO(("Dynamic OEM Table Load:"));
 478         (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 479
 480         status = acpi_tb_install_standard_table(ACPI_PTR_TO_PHYSADDR(table),
 481                                                 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL,
 482                                                 TRUE, TRUE, &table_index);
 483
 484         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 485         if (ACPI_FAILURE(status)) {
 486
 487                 /* Delete allocated table buffer */
 488
 489                 ACPI_FREE(table);
 490                 return_ACPI_STATUS(status);
 491         }
 492
 493         /*
 494          * Note: Now table is "INSTALLED", it must be validated before
 495          * loading.
 496          */
 497         status =
 498             acpi_tb_validate_table(&acpi_gbl_root_table_list.
 499                                    tables[table_index]);
 500         if (ACPI_FAILURE(status)) {
 501                 return_ACPI_STATUS(status);
 502         }
 503
 504         /*
 505          * Add the table to the namespace.
 506          *
 507          * Note: Load the table objects relative to the root of the namespace.
 508          * This appears to go against the ACPI specification, but we do it for
 509          * compatibility with other ACPI implementations.
 510          */
 511         status =
 512             acpi_ex_add_table(table_index, acpi_gbl_root_node, &ddb_handle);
 513         if (ACPI_FAILURE(status)) {
 514
 515                 /* On error, table_ptr was deallocated above */
 516
 517                 return_ACPI_STATUS(status);
 518         }
 519
 520         /* Store the ddb_handle into the Target operand */
 521
 522         status = acpi_ex_store(ddb_handle, target, walk_state);
 523         if (ACPI_FAILURE(status)) {
 524                 (void)acpi_ex_unload_table(ddb_handle);
 525
 526                 /* table_ptr was deallocated above */
 527
 528                 acpi_ut_remove_reference(ddb_handle);
 529                 return_ACPI_STATUS(status);
 530         }
 531
 532         /* Remove the reference by added by acpi_ex_store above */
 533
 534         acpi_ut_remove_reference(ddb_handle);
 535
 536         /* Invoke table handler if present */
 537
 538         if (acpi_gbl_table_handler) {
 539                 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD, table,
 540                                              acpi_gbl_table_handler_context);
 541         }
 542
 543         return_ACPI_STATUS(status);
 544 }
 545
 546 /*******************************************************************************
 547  *
 548  * FUNCTION:    acpi_ex_unload_table
 549  *
 550  * PARAMETERS:  ddb_handle          - Handle to a previously loaded table
 551  *
 552  * RETURN:      Status
 553  *
 554  * DESCRIPTION: Unload an ACPI table
 555  *
 556  ******************************************************************************/
 557
 558 acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle)
 559 {
 560         acpi_status status = AE_OK;
 561         union acpi_operand_object *table_desc = ddb_handle;
 562         u32 table_index;
 563         struct acpi_table_header *table;
 564
 565         ACPI_FUNCTION_TRACE(ex_unload_table);
 566
 567         /*
 568          * Temporarily emit a warning so that the ASL for the machine can be
 569          * hopefully obtained. This is to say that the Unload() operator is
 570          * extremely rare if not completely unused.
 571          */
 572         ACPI_WARNING((AE_INFO, "Received request to unload an ACPI table"));
 573
 574         /*
 575          * Validate the handle
 576          * Although the handle is partially validated in acpi_ex_reconfiguration()
 577          * when it calls acpi_ex_resolve_operands(), the handle is more completely
 578          * validated here.
 579          *
 580          * Handle must be a valid operand object of type reference. Also, the
 581          * ddb_handle must still be marked valid (table has not been previously
 582          * unloaded)
 583          */
 584         if ((!ddb_handle) ||
 585             (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle) != ACPI_DESC_TYPE_OPERAND) ||
 586             (ddb_handle->common.type != ACPI_TYPE_LOCAL_REFERENCE) ||
 587             (!(ddb_handle->common.flags & AOPOBJ_DATA_VALID))) {
 588                 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 589         }
 590
 591         /* Get the table index from the ddb_handle */
 592
 593         table_index = table_desc->reference.value;
 594
 595         /* Ensure the table is still loaded */
 596
 597         if (!acpi_tb_is_table_loaded(table_index)) {
 598                 return_ACPI_STATUS(AE_NOT_EXIST);
 599         }
 600
 601         /* Invoke table handler if present */
 602
 603         if (acpi_gbl_table_handler) {
 604                 status = acpi_get_table_by_index(table_index, &table);
 605                 if (ACPI_SUCCESS(status)) {
 606                         (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_UNLOAD,
 607                                                      table,
 608                                                      acpi_gbl_table_handler_context);
 609                 }
 610         }
 611
 612         /* Delete the portion of the namespace owned by this table */
 613
 614         status = acpi_tb_delete_namespace_by_owner(table_index);
 615         if (ACPI_FAILURE(status)) {
 616                 return_ACPI_STATUS(status);
 617         }
 618
 619         (void)acpi_tb_release_owner_id(table_index);
 620         acpi_tb_set_table_loaded_flag(table_index, FALSE);
 621
 622         /*
 623          * Invalidate the handle. We do this because the handle may be stored
 624          * in a named object and may not be actually deleted until much later.
 625          */
 626         ddb_handle->common.flags &= ~AOPOBJ_DATA_VALID;
 627         return_ACPI_STATUS(AE_OK);
 628 }