drivers/acpi/tables/tbinstal.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbinstal - ACPI table installation and removal
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   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 <acpi/actables.h>
  46
  47 #define _COMPONENT          ACPI_TABLES
  48 ACPI_MODULE_NAME("tbinstal")
  49
  50 /* Local prototypes */
  51 static acpi_status
  52 acpi_tb_match_signature(char *signature,
  53                         struct acpi_table_desc *table_info, u8 search_type);
  54
  55 /*******************************************************************************
  56  *
  57  * FUNCTION:    acpi_tb_match_signature
  58  *
  59  * PARAMETERS:  Signature           - Table signature to match
  60  *              table_info          - Return data
  61  *              search_type         - Table type to match (primary/secondary)
  62  *
  63  * RETURN:      Status
  64  *
  65  * DESCRIPTION: Compare signature against the list of "ACPI-subsystem-owned"
  66  *              tables (DSDT/FADT/SSDT, etc.) Returns the table_type_iD on match.
  67  *
  68  ******************************************************************************/
  69
  70 static acpi_status
  71 acpi_tb_match_signature(char *signature,
  72                         struct acpi_table_desc *table_info, u8 search_type)
  73 {
  74         acpi_native_uint i;
  75
  76         ACPI_FUNCTION_TRACE(tb_match_signature);
  77
  78         /* Search for a signature match among the known table types */
  79
  80         for (i = 0; i < (ACPI_TABLE_ID_MAX + 1); i++) {
  81                 if (!(acpi_gbl_table_data[i].flags & search_type)) {
  82                         continue;
  83                 }
  84
  85                 if (!ACPI_STRNCMP(signature, acpi_gbl_table_data[i].signature,
  86                                   acpi_gbl_table_data[i].sig_length)) {
  87
  88                         /* Found a signature match, return index if requested */
  89
  90                         if (table_info) {
  91                                 table_info->type = (u8) i;
  92                         }
  93
  94                         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
  95                                           "Table [%4.4s] is an ACPI table consumed by the core subsystem\n",
  96                                           (char *)acpi_gbl_table_data[i].
  97                                           signature));
  98
  99                         return_ACPI_STATUS(AE_OK);
 100                 }
 101         }
 102
 103         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 104                           "Table [%4.4s] is not an ACPI table consumed by the core subsystem - ignored\n",
 105                           (char *)signature));
 106
 107         return_ACPI_STATUS(AE_TABLE_NOT_SUPPORTED);
 108 }
 109
 110 /*******************************************************************************
 111  *
 112  * FUNCTION:    acpi_tb_install_table
 113  *
 114  * PARAMETERS:  table_info          - Return value from acpi_tb_get_table_body
 115  *
 116  * RETURN:      Status
 117  *
 118  * DESCRIPTION: Install the table into the global data structures.
 119  *
 120  ******************************************************************************/
 121
 122 acpi_status acpi_tb_install_table(struct acpi_table_desc *table_info)
 123 {
 124         acpi_status status;
 125
 126         ACPI_FUNCTION_TRACE(tb_install_table);
 127
 128         /* Lock tables while installing */
 129
 130         status = acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 131         if (ACPI_FAILURE(status)) {
 132                 ACPI_EXCEPTION((AE_INFO, status,
 133                                 "Could not acquire table mutex"));
 134                 return_ACPI_STATUS(status);
 135         }
 136
 137         /*
 138          * Ignore a table that is already installed. For example, some BIOS
 139          * ASL code will repeatedly attempt to load the same SSDT.
 140          */
 141         status = acpi_tb_is_table_installed(table_info);
 142         if (ACPI_FAILURE(status)) {
 143                 goto unlock_and_exit;
 144         }
 145
 146         /* Install the table into the global data structure */
 147
 148         status = acpi_tb_init_table_descriptor(table_info->type, table_info);
 149         if (ACPI_FAILURE(status)) {
 150                 ACPI_EXCEPTION((AE_INFO, status,
 151                                 "Could not install table [%4.4s]",
 152                                 table_info->pointer->signature));
 153         }
 154
 155         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s located at %p\n",
 156                           acpi_gbl_table_data[table_info->type].name,
 157                           table_info->pointer));
 158
 159       unlock_and_exit:
 160         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 161         return_ACPI_STATUS(status);
 162 }
 163
 164 /*******************************************************************************
 165  *
 166  * FUNCTION:    acpi_tb_recognize_table
 167  *
 168  * PARAMETERS:  table_info          - Return value from acpi_tb_get_table_body
 169  *              search_type         - Table type to match (primary/secondary)
 170  *
 171  * RETURN:      Status
 172  *
 173  * DESCRIPTION: Check a table signature for a match against known table types
 174  *
 175  * NOTE:  All table pointers are validated as follows:
 176  *          1) Table pointer must point to valid physical memory
 177  *          2) Signature must be 4 ASCII chars, even if we don't recognize the
 178  *             name
 179  *          3) Table must be readable for length specified in the header
 180  *          4) Table checksum must be valid (with the exception of the FACS
 181  *             which has no checksum for some odd reason)
 182  *
 183  ******************************************************************************/
 184
 185 acpi_status
 186 acpi_tb_recognize_table(struct acpi_table_desc *table_info, u8 search_type)
 187 {
 188         struct acpi_table_header *table_header;
 189         acpi_status status;
 190
 191         ACPI_FUNCTION_TRACE(tb_recognize_table);
 192
 193         /* Ensure that we have a valid table pointer */
 194
 195         table_header = (struct acpi_table_header *)table_info->pointer;
 196         if (!table_header) {
 197                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 198         }
 199
 200         /*
 201          * We only "recognize" a limited number of ACPI tables -- namely, the
 202          * ones that are used by the subsystem (DSDT, FADT, etc.)
 203          *
 204          * An AE_TABLE_NOT_SUPPORTED means that the table was not recognized.
 205          * This can be any one of many valid ACPI tables, it just isn't one of
 206          * the tables that is consumed by the core subsystem
 207          */
 208         status = acpi_tb_match_signature(table_header->signature,
 209                                          table_info, search_type);
 210         if (ACPI_FAILURE(status)) {
 211                 return_ACPI_STATUS(status);
 212         }
 213
 214         status = acpi_tb_validate_table_header(table_header);
 215         if (ACPI_FAILURE(status)) {
 216                 return_ACPI_STATUS(status);
 217         }
 218
 219         /* Return the table type and length via the info struct */
 220
 221         table_info->length = (acpi_size) table_header->length;
 222         return_ACPI_STATUS(status);
 223 }
 224
 225 /*******************************************************************************
 226  *
 227  * FUNCTION:    acpi_tb_init_table_descriptor
 228  *
 229  * PARAMETERS:  table_type          - The type of the table
 230  *              table_info          - A table info struct
 231  *
 232  * RETURN:      None.
 233  *
 234  * DESCRIPTION: Install a table into the global data structs.
 235  *
 236  ******************************************************************************/
 237
 238 acpi_status
 239 acpi_tb_init_table_descriptor(acpi_table_type table_type,
 240                               struct acpi_table_desc *table_info)
 241 {
 242         struct acpi_table_list *list_head;
 243         struct acpi_table_desc *table_desc;
 244         acpi_status status;
 245
 246         ACPI_FUNCTION_TRACE_U32(tb_init_table_descriptor, table_type);
 247
 248         /* Allocate a descriptor for this table */
 249
 250         table_desc = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_table_desc));
 251         if (!table_desc) {
 252                 return_ACPI_STATUS(AE_NO_MEMORY);
 253         }
 254
 255         /* Get a new owner ID for the table */
 256
 257         status = acpi_ut_allocate_owner_id(&table_desc->owner_id);
 258         if (ACPI_FAILURE(status)) {
 259                 goto error_exit1;
 260         }
 261
 262         /* Install the table into the global data structure */
 263
 264         list_head = &acpi_gbl_table_lists[table_type];
 265
 266         /*
 267          * Two major types of tables:  1) Only one instance is allowed.  This
 268          * includes most ACPI tables such as the DSDT.  2) Multiple instances of
 269          * the table are allowed.  This includes SSDT and PSDTs.
 270          */
 271         if (ACPI_IS_SINGLE_TABLE(acpi_gbl_table_data[table_type].flags)) {
 272                 /*
 273                  * Only one table allowed, and a table has alread been installed
 274                  * at this location, so return an error.
 275                  */
 276                 if (list_head->next) {
 277                         status = AE_ALREADY_EXISTS;
 278                         goto error_exit2;
 279                 }
 280
 281                 table_desc->next = list_head->next;
 282                 list_head->next = table_desc;
 283
 284                 if (table_desc->next) {
 285                         table_desc->next->prev = table_desc;
 286                 }
 287
 288                 list_head->count++;
 289         } else {
 290                 /*
 291                  * Link the new table in to the list of tables of this type.
 292                  * Insert at the end of the list, order IS IMPORTANT.
 293                  *
 294                  * table_desc->Prev & Next are already NULL from calloc()
 295                  */
 296                 list_head->count++;
 297
 298                 if (!list_head->next) {
 299                         list_head->next = table_desc;
 300                 } else {
 301                         table_desc->next = list_head->next;
 302
 303                         while (table_desc->next->next) {
 304                                 table_desc->next = table_desc->next->next;
 305                         }
 306
 307                         table_desc->next->next = table_desc;
 308                         table_desc->prev = table_desc->next;
 309                         table_desc->next = NULL;
 310                 }
 311         }
 312
 313         /* Finish initialization of the table descriptor */
 314
 315         table_desc->loaded_into_namespace = FALSE;
 316         table_desc->type = (u8) table_type;
 317         table_desc->pointer = table_info->pointer;
 318         table_desc->length = table_info->length;
 319         table_desc->allocation = table_info->allocation;
 320         table_desc->aml_start = (u8 *) (table_desc->pointer + 1),
 321             table_desc->aml_length = (u32)
 322             (table_desc->length - (u32) sizeof(struct acpi_table_header));
 323
 324         /*
 325          * Set the appropriate global pointer (if there is one) to point to the
 326          * newly installed table
 327          */
 328         if (acpi_gbl_table_data[table_type].global_ptr) {
 329                 *(acpi_gbl_table_data[table_type].global_ptr) =
 330                     table_info->pointer;
 331         }
 332
 333         /* Return Data */
 334
 335         table_info->owner_id = table_desc->owner_id;
 336         table_info->installed_desc = table_desc;
 337         return_ACPI_STATUS(AE_OK);
 338
 339         /* Error exit with cleanup */
 340
 341       error_exit2:
 342
 343         acpi_ut_release_owner_id(&table_desc->owner_id);
 344
 345       error_exit1:
 346
 347         ACPI_FREE(table_desc);
 348         return_ACPI_STATUS(status);
 349 }
 350
 351 /*******************************************************************************
 352  *
 353  * FUNCTION:    acpi_tb_delete_all_tables
 354  *
 355  * PARAMETERS:  None.
 356  *
 357  * RETURN:      None.
 358  *
 359  * DESCRIPTION: Delete all internal ACPI tables
 360  *
 361  ******************************************************************************/
 362
 363 void acpi_tb_delete_all_tables(void)
 364 {
 365         acpi_table_type type;
 366
 367         /*
 368          * Free memory allocated for ACPI tables
 369          * Memory can either be mapped or allocated
 370          */
 371         for (type = 0; type < (ACPI_TABLE_ID_MAX + 1); type++) {
 372                 acpi_tb_delete_tables_by_type(type);
 373         }
 374 }
 375
 376 /*******************************************************************************
 377  *
 378  * FUNCTION:    acpi_tb_delete_tables_by_type
 379  *
 380  * PARAMETERS:  Type                - The table type to be deleted
 381  *
 382  * RETURN:      None.
 383  *
 384  * DESCRIPTION: Delete an internal ACPI table
 385  *              Locks the ACPI table mutex
 386  *
 387  ******************************************************************************/
 388
 389 void acpi_tb_delete_tables_by_type(acpi_table_type type)
 390 {
 391         struct acpi_table_desc *table_desc;
 392         u32 count;
 393         u32 i;
 394
 395         ACPI_FUNCTION_TRACE_U32(tb_delete_tables_by_type, type);
 396
 397         if (type > ACPI_TABLE_ID_MAX) {
 398                 return_VOID;
 399         }
 400
 401         if (ACPI_FAILURE(acpi_ut_acquire_mutex(ACPI_MTX_TABLES))) {
 402                 return;
 403         }
 404
 405         /* Clear the appropriate "typed" global table pointer */
 406
 407         switch (type) {
 408         case ACPI_TABLE_ID_RSDP:
 409                 acpi_gbl_RSDP = NULL;
 410                 break;
 411
 412         case ACPI_TABLE_ID_DSDT:
 413                 acpi_gbl_DSDT = NULL;
 414                 break;
 415
 416         case ACPI_TABLE_ID_FADT:
 417                 acpi_gbl_FADT = NULL;
 418                 break;
 419
 420         case ACPI_TABLE_ID_FACS:
 421                 acpi_gbl_FACS = NULL;
 422                 break;
 423
 424         case ACPI_TABLE_ID_XSDT:
 425                 acpi_gbl_XSDT = NULL;
 426                 break;
 427
 428         case ACPI_TABLE_ID_SSDT:
 429         case ACPI_TABLE_ID_PSDT:
 430         default:
 431                 break;
 432         }
 433
 434         /*
 435          * Free the table
 436          * 1) Get the head of the list
 437          */
 438         table_desc = acpi_gbl_table_lists[type].next;
 439         count = acpi_gbl_table_lists[type].count;
 440
 441         /*
 442          * 2) Walk the entire list, deleting both the allocated tables
 443          *    and the table descriptors
 444          */
 445         for (i = 0; i < count; i++) {
 446                 table_desc = acpi_tb_uninstall_table(table_desc);
 447         }
 448
 449         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 450         return_VOID;
 451 }
 452
 453 /*******************************************************************************
 454  *
 455  * FUNCTION:    acpi_tb_delete_single_table
 456  *
 457  * PARAMETERS:  table_info          - A table info struct
 458  *
 459  * RETURN:      None.
 460  *
 461  * DESCRIPTION: Low-level free for a single ACPI table.  Handles cases where
 462  *              the table was allocated a buffer or was mapped.
 463  *
 464  ******************************************************************************/
 465
 466 void acpi_tb_delete_single_table(struct acpi_table_desc *table_desc)
 467 {
 468
 469         /* Must have a valid table descriptor and pointer */
 470
 471         if ((!table_desc) || (!table_desc->pointer)) {
 472                 return;
 473         }
 474
 475         /* Valid table, determine type of memory allocation */
 476
 477         switch (table_desc->allocation) {
 478         case ACPI_MEM_NOT_ALLOCATED:
 479                 break;
 480
 481         case ACPI_MEM_ALLOCATED:
 482
 483                 ACPI_FREE(table_desc->pointer);
 484                 break;
 485
 486         case ACPI_MEM_MAPPED:
 487
 488                 acpi_os_unmap_memory(table_desc->pointer, table_desc->length);
 489                 break;
 490
 491         default:
 492                 break;
 493         }
 494 }
 495
 496 /*******************************************************************************
 497  *
 498  * FUNCTION:    acpi_tb_uninstall_table
 499  *
 500  * PARAMETERS:  table_info          - A table info struct
 501  *
 502  * RETURN:      Pointer to the next table in the list (of same type)
 503  *
 504  * DESCRIPTION: Free the memory associated with an internal ACPI table that
 505  *              is either installed or has never been installed.
 506  *              Table mutex should be locked.
 507  *
 508  ******************************************************************************/
 509
 510 struct acpi_table_desc *acpi_tb_uninstall_table(struct acpi_table_desc
 511                                                 *table_desc)
 512 {
 513         struct acpi_table_desc *next_desc;
 514
 515         ACPI_FUNCTION_TRACE_PTR(tb_uninstall_table, table_desc);
 516
 517         if (!table_desc) {
 518                 return_PTR(NULL);
 519         }
 520
 521         /* Unlink the descriptor from the doubly linked list */
 522
 523         if (table_desc->prev) {
 524                 table_desc->prev->next = table_desc->next;
 525         } else {
 526                 /* Is first on list, update list head */
 527
 528                 acpi_gbl_table_lists[table_desc->type].next = table_desc->next;
 529         }
 530
 531         if (table_desc->next) {
 532                 table_desc->next->prev = table_desc->prev;
 533         }
 534
 535         /* Free the memory allocated for the table itself */
 536
 537         acpi_tb_delete_single_table(table_desc);
 538
 539         /* Free the owner ID associated with this table */
 540
 541         acpi_ut_release_owner_id(&table_desc->owner_id);
 542
 543         /* Free the table descriptor */
 544
 545         next_desc = table_desc->next;
 546         ACPI_FREE(table_desc);
 547
 548         /* Return pointer to the next descriptor */
 549
 550         return_PTR(next_desc);
 551 }