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