drivers/acpi/acpica/exconfig.c

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