drivers/acpi/acpica/exconfig.c

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