drivers/acpi/acpica/tbxfload.c

   1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
   2 /******************************************************************************
   3  *
   4  * Module Name: tbxfload - Table load/unload external interfaces
   5  *
   6  * Copyright (C) 2000 - 2018, Intel Corp.
   7  *
   8  *****************************************************************************/
   9
  10 #define EXPORT_ACPI_INTERFACES
  11
  12 #include <acpi/acpi.h>
  13 #include "accommon.h"
  14 #include "acnamesp.h"
  15 #include "actables.h"
  16 #include "acevents.h"
  17
  18 #define _COMPONENT          ACPI_TABLES
  19 ACPI_MODULE_NAME("tbxfload")
  20
  21 /*******************************************************************************
  22  *
  23  * FUNCTION:    acpi_load_tables
  24  *
  25  * PARAMETERS:  None
  26  *
  27  * RETURN:      Status
  28  *
  29  * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
  30  *
  31  ******************************************************************************/
  32 acpi_status ACPI_INIT_FUNCTION acpi_load_tables(void)
  33 {
  34         acpi_status status;
  35
  36         ACPI_FUNCTION_TRACE(acpi_load_tables);
  37
  38         /*
  39          * Install the default operation region handlers. These are the
  40          * handlers that are defined by the ACPI specification to be
  41          * "always accessible" -- namely, system_memory, system_IO, and
  42          * PCI_Config. This also means that no _REG methods need to be
  43          * run for these address spaces. We need to have these handlers
  44          * installed before any AML code can be executed, especially any
  45          * module-level code (11/2015).
  46          * Note that we allow OSPMs to install their own region handlers
  47          * between acpi_initialize_subsystem() and acpi_load_tables() to use
  48          * their customized default region handlers.
  49          */
  50         status = acpi_ev_install_region_handlers();
  51         if (ACPI_FAILURE(status)) {
  52                 ACPI_EXCEPTION((AE_INFO, status,
  53                                 "During Region initialization"));
  54                 return_ACPI_STATUS(status);
  55         }
  56
  57         /* Load the namespace from the tables */
  58
  59         status = acpi_tb_load_namespace();
  60
  61         /* Don't let single failures abort the load */
  62
  63         if (status == AE_CTRL_TERMINATE) {
  64                 status = AE_OK;
  65         }
  66
  67         if (ACPI_FAILURE(status)) {
  68                 ACPI_EXCEPTION((AE_INFO, status,
  69                                 "While loading namespace from ACPI tables"));
  70         }
  71
  72         if (acpi_gbl_execute_tables_as_methods
  73             || !acpi_gbl_group_module_level_code) {
  74                 /*
  75                  * Initialize the objects that remain uninitialized. This
  76                  * runs the executable AML that may be part of the
  77                  * declaration of these objects:
  78                  * operation_regions, buffer_fields, Buffers, and Packages.
  79                  */
  80                 status = acpi_ns_initialize_objects();
  81                 if (ACPI_FAILURE(status)) {
  82                         return_ACPI_STATUS(status);
  83                 }
  84         }
  85
  86         acpi_gbl_namespace_initialized = TRUE;
  87         return_ACPI_STATUS(status);
  88 }
  89
  90 ACPI_EXPORT_SYMBOL_INIT(acpi_load_tables)
  91
  92 /*******************************************************************************
  93  *
  94  * FUNCTION:    acpi_tb_load_namespace
  95  *
  96  * PARAMETERS:  None
  97  *
  98  * RETURN:      Status
  99  *
 100  * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
 101  *              the RSDT/XSDT.
 102  *
 103  ******************************************************************************/
 104 acpi_status acpi_tb_load_namespace(void)
 105 {
 106         acpi_status status;
 107         u32 i;
 108         struct acpi_table_header *new_dsdt;
 109         struct acpi_table_desc *table;
 110         u32 tables_loaded = 0;
 111         u32 tables_failed = 0;
 112
 113         ACPI_FUNCTION_TRACE(tb_load_namespace);
 114
 115         (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 116
 117         /*
 118          * Load the namespace. The DSDT is required, but any SSDT and
 119          * PSDT tables are optional. Verify the DSDT.
 120          */
 121         table = &acpi_gbl_root_table_list.tables[acpi_gbl_dsdt_index];
 122
 123         if (!acpi_gbl_root_table_list.current_table_count ||
 124             !ACPI_COMPARE_NAME(table->signature.ascii, ACPI_SIG_DSDT) ||
 125             ACPI_FAILURE(acpi_tb_validate_table(table))) {
 126                 status = AE_NO_ACPI_TABLES;
 127                 goto unlock_and_exit;
 128         }
 129
 130         /*
 131          * Save the DSDT pointer for simple access. This is the mapped memory
 132          * address. We must take care here because the address of the .Tables
 133          * array can change dynamically as tables are loaded at run-time. Note:
 134          * .Pointer field is not validated until after call to acpi_tb_validate_table.
 135          */
 136         acpi_gbl_DSDT = table->pointer;
 137
 138         /*
 139          * Optionally copy the entire DSDT to local memory (instead of simply
 140          * mapping it.) There are some BIOSs that corrupt or replace the original
 141          * DSDT, creating the need for this option. Default is FALSE, do not copy
 142          * the DSDT.
 143          */
 144         if (acpi_gbl_copy_dsdt_locally) {
 145                 new_dsdt = acpi_tb_copy_dsdt(acpi_gbl_dsdt_index);
 146                 if (new_dsdt) {
 147                         acpi_gbl_DSDT = new_dsdt;
 148                 }
 149         }
 150
 151         /*
 152          * Save the original DSDT header for detection of table corruption
 153          * and/or replacement of the DSDT from outside the OS.
 154          */
 155         memcpy(&acpi_gbl_original_dsdt_header, acpi_gbl_DSDT,
 156                sizeof(struct acpi_table_header));
 157
 158         /* Load and parse tables */
 159
 160         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 161         status = acpi_ns_load_table(acpi_gbl_dsdt_index, acpi_gbl_root_node);
 162         (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 163         if (ACPI_FAILURE(status)) {
 164                 ACPI_EXCEPTION((AE_INFO, status, "[DSDT] table load failed"));
 165                 tables_failed++;
 166         } else {
 167                 tables_loaded++;
 168         }
 169
 170         /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
 171
 172         for (i = 0; i < acpi_gbl_root_table_list.current_table_count; ++i) {
 173                 table = &acpi_gbl_root_table_list.tables[i];
 174
 175                 if (!table->address ||
 176                     (!ACPI_COMPARE_NAME(table->signature.ascii, ACPI_SIG_SSDT)
 177                      && !ACPI_COMPARE_NAME(table->signature.ascii,
 178                                            ACPI_SIG_PSDT)
 179                      && !ACPI_COMPARE_NAME(table->signature.ascii,
 180                                            ACPI_SIG_OSDT))
 181                     || ACPI_FAILURE(acpi_tb_validate_table(table))) {
 182                         continue;
 183                 }
 184
 185                 /* Ignore errors while loading tables, get as many as possible */
 186
 187                 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 188                 status = acpi_ns_load_table(i, acpi_gbl_root_node);
 189                 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 190                 if (ACPI_FAILURE(status)) {
 191                         ACPI_EXCEPTION((AE_INFO, status,
 192                                         "(%4.4s:%8.8s) while loading table",
 193                                         table->signature.ascii,
 194                                         table->pointer->oem_table_id));
 195
 196                         tables_failed++;
 197
 198                         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
 199                                               "Table [%4.4s:%8.8s] (id FF) - Table namespace load failed\n\n",
 200                                               table->signature.ascii,
 201                                               table->pointer->oem_table_id));
 202                 } else {
 203                         tables_loaded++;
 204                 }
 205         }
 206
 207         if (!tables_failed) {
 208                 ACPI_INFO(("%u ACPI AML tables successfully acquired and loaded", tables_loaded));
 209         } else {
 210                 ACPI_ERROR((AE_INFO,
 211                             "%u table load failures, %u successful",
 212                             tables_failed, tables_loaded));
 213
 214                 /* Indicate at least one failure */
 215
 216                 status = AE_CTRL_TERMINATE;
 217         }
 218
 219 #ifdef ACPI_APPLICATION
 220         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, "\n"));
 221 #endif
 222
 223 unlock_and_exit:
 224         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 225         return_ACPI_STATUS(status);
 226 }
 227
 228 /*******************************************************************************
 229  *
 230  * FUNCTION:    acpi_install_table
 231  *
 232  * PARAMETERS:  address             - Address of the ACPI table to be installed.
 233  *              physical            - Whether the address is a physical table
 234  *                                    address or not
 235  *
 236  * RETURN:      Status
 237  *
 238  * DESCRIPTION: Dynamically install an ACPI table.
 239  *              Note: This function should only be invoked after
 240  *                    acpi_initialize_tables() and before acpi_load_tables().
 241  *
 242  ******************************************************************************/
 243
 244 acpi_status ACPI_INIT_FUNCTION
 245 acpi_install_table(acpi_physical_address address, u8 physical)
 246 {
 247         acpi_status status;
 248         u8 flags;
 249         u32 table_index;
 250
 251         ACPI_FUNCTION_TRACE(acpi_install_table);
 252
 253         if (physical) {
 254                 flags = ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL;
 255         } else {
 256                 flags = ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL;
 257         }
 258
 259         status = acpi_tb_install_standard_table(address, flags,
 260                                                 FALSE, FALSE, &table_index);
 261
 262         return_ACPI_STATUS(status);
 263 }
 264
 265 ACPI_EXPORT_SYMBOL_INIT(acpi_install_table)
 266
 267 /*******************************************************************************
 268  *
 269  * FUNCTION:    acpi_load_table
 270  *
 271  * PARAMETERS:  table               - Pointer to a buffer containing the ACPI
 272  *                                    table to be loaded.
 273  *
 274  * RETURN:      Status
 275  *
 276  * DESCRIPTION: Dynamically load an ACPI table from the caller's buffer. Must
 277  *              be a valid ACPI table with a valid ACPI table header.
 278  *              Note1: Mainly intended to support hotplug addition of SSDTs.
 279  *              Note2: Does not copy the incoming table. User is responsible
 280  *              to ensure that the table is not deleted or unmapped.
 281  *
 282  ******************************************************************************/
 283 acpi_status acpi_load_table(struct acpi_table_header *table)
 284 {
 285         acpi_status status;
 286         u32 table_index;
 287
 288         ACPI_FUNCTION_TRACE(acpi_load_table);
 289
 290         /* Parameter validation */
 291
 292         if (!table) {
 293                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 294         }
 295
 296         /* Install the table and load it into the namespace */
 297
 298         ACPI_INFO(("Host-directed Dynamic ACPI Table Load:"));
 299         status = acpi_tb_install_and_load_table(ACPI_PTR_TO_PHYSADDR(table),
 300                                                 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL,
 301                                                 FALSE, &table_index);
 302         return_ACPI_STATUS(status);
 303 }
 304
 305 ACPI_EXPORT_SYMBOL(acpi_load_table)
 306
 307 /*******************************************************************************
 308  *
 309  * FUNCTION:    acpi_unload_parent_table
 310  *
 311  * PARAMETERS:  object              - Handle to any namespace object owned by
 312  *                                    the table to be unloaded
 313  *
 314  * RETURN:      Status
 315  *
 316  * DESCRIPTION: Via any namespace object within an SSDT or OEMx table, unloads
 317  *              the table and deletes all namespace objects associated with
 318  *              that table. Unloading of the DSDT is not allowed.
 319  *              Note: Mainly intended to support hotplug removal of SSDTs.
 320  *
 321  ******************************************************************************/
 322 acpi_status acpi_unload_parent_table(acpi_handle object)
 323 {
 324         struct acpi_namespace_node *node =
 325             ACPI_CAST_PTR(struct acpi_namespace_node, object);
 326         acpi_status status = AE_NOT_EXIST;
 327         acpi_owner_id owner_id;
 328         u32 i;
 329
 330         ACPI_FUNCTION_TRACE(acpi_unload_parent_table);
 331
 332         /* Parameter validation */
 333
 334         if (!object) {
 335                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 336         }
 337
 338         /*
 339          * The node owner_id is currently the same as the parent table ID.
 340          * However, this could change in the future.
 341          */
 342         owner_id = node->owner_id;
 343         if (!owner_id) {
 344
 345                 /* owner_id==0 means DSDT is the owner. DSDT cannot be unloaded */
 346
 347                 return_ACPI_STATUS(AE_TYPE);
 348         }
 349
 350         /* Must acquire the table lock during this operation */
 351
 352         status = acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 353         if (ACPI_FAILURE(status)) {
 354                 return_ACPI_STATUS(status);
 355         }
 356
 357         /* Find the table in the global table list */
 358
 359         for (i = 0; i < acpi_gbl_root_table_list.current_table_count; i++) {
 360                 if (owner_id != acpi_gbl_root_table_list.tables[i].owner_id) {
 361                         continue;
 362                 }
 363
 364                 /*
 365                  * Allow unload of SSDT and OEMx tables only. Do not allow unload
 366                  * of the DSDT. No other types of tables should get here, since
 367                  * only these types can contain AML and thus are the only types
 368                  * that can create namespace objects.
 369                  */
 370                 if (ACPI_COMPARE_NAME
 371                     (acpi_gbl_root_table_list.tables[i].signature.ascii,
 372                      ACPI_SIG_DSDT)) {
 373                         status = AE_TYPE;
 374                         break;
 375                 }
 376
 377                 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 378                 status = acpi_tb_unload_table(i);
 379                 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
 380                 break;
 381         }
 382
 383         (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
 384         return_ACPI_STATUS(status);
 385 }
 386
 387 ACPI_EXPORT_SYMBOL(acpi_unload_parent_table)