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