drivers/bus/acpi/acpica/tables/tbxfload.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbxfload - Table load/unload external interfaces
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2019, 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 #define EXPORT_ACPI_INTERFACES
  45
  46 #include "acpi.h"
  47 #include "accommon.h"
  48 #include "acnamesp.h"
  49 #include "actables.h"
  50 #include "acevents.h"
  51
  52 #define _COMPONENT          ACPI_TABLES
  53         ACPI_MODULE_NAME    ("tbxfload")
  54
  55
  56 /*******************************************************************************
  57  *
  58  * FUNCTION:    AcpiLoadTables
  59  *
  60  * PARAMETERS:  None
  61  *
  62  * RETURN:      Status
  63  *
  64  * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
  65  *
  66  ******************************************************************************/
  67
  68 ACPI_STATUS ACPI_INIT_FUNCTION
  69 AcpiLoadTables (
  70     void)
  71 {
  72     ACPI_STATUS             Status;
  73
  74
  75     ACPI_FUNCTION_TRACE (AcpiLoadTables);
  76
  77
  78     /*
  79      * Install the default operation region handlers. These are the
  80      * handlers that are defined by the ACPI specification to be
  81      * "always accessible" -- namely, SystemMemory, SystemIO, and
  82      * PCI_Config. This also means that no _REG methods need to be
  83      * run for these address spaces. We need to have these handlers
  84      * installed before any AML code can be executed, especially any
  85      * module-level code (11/2015).
  86      * Note that we allow OSPMs to install their own region handlers
  87      * between AcpiInitializeSubsystem() and AcpiLoadTables() to use
  88      * their customized default region handlers.
  89      */
  90     Status = AcpiEvInstallRegionHandlers ();
  91     if (ACPI_FAILURE (Status))
  92     {
  93         ACPI_EXCEPTION ((AE_INFO, Status, "During Region initialization"));
  94         return_ACPI_STATUS (Status);
  95     }
  96
  97     /* Load the namespace from the tables */
  98
  99     Status = AcpiTbLoadNamespace ();
 100
 101     /* Don't let single failures abort the load */
 102
 103     if (Status == AE_CTRL_TERMINATE)
 104     {
 105         Status = AE_OK;
 106     }
 107
 108     if (ACPI_FAILURE (Status))
 109     {
 110         ACPI_EXCEPTION ((AE_INFO, Status,
 111             "While loading namespace from ACPI tables"));
 112     }
 113
 114     if (AcpiGbl_ExecuteTablesAsMethods)
 115     {
 116         /*
 117          * If the module-level code support is enabled, initialize the objects
 118          * in the namespace that remain uninitialized. This runs the executable
 119          * AML that may be part of the declaration of these name objects:
 120          *     OperationRegions, BufferFields, Buffers, and Packages.
 121          *
 122          * Note: The module-level code is optional at this time, but will
 123          * become the default in the future.
 124          */
 125         Status = AcpiNsInitializeObjects ();
 126         if (ACPI_FAILURE (Status))
 127         {
 128             return_ACPI_STATUS (Status);
 129         }
 130     }
 131
 132     AcpiGbl_NamespaceInitialized = TRUE;
 133     return_ACPI_STATUS (Status);
 134 }
 135
 136 ACPI_EXPORT_SYMBOL_INIT (AcpiLoadTables)
 137
 138
 139 /*******************************************************************************
 140  *
 141  * FUNCTION:    AcpiTbLoadNamespace
 142  *
 143  * PARAMETERS:  None
 144  *
 145  * RETURN:      Status
 146  *
 147  * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
 148  *              the RSDT/XSDT.
 149  *
 150  ******************************************************************************/
 151
 152 ACPI_STATUS
 153 AcpiTbLoadNamespace (
 154     void)
 155 {
 156     ACPI_STATUS             Status;
 157     UINT32                  i;
 158     ACPI_TABLE_HEADER       *NewDsdt;
 159     ACPI_TABLE_DESC         *Table;
 160     UINT32                  TablesLoaded = 0;
 161     UINT32                  TablesFailed = 0;
 162
 163
 164     ACPI_FUNCTION_TRACE (TbLoadNamespace);
 165
 166
 167     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
 168
 169     /*
 170      * Load the namespace. The DSDT is required, but any SSDT and
 171      * PSDT tables are optional. Verify the DSDT.
 172      */
 173     Table = &AcpiGbl_RootTableList.Tables[AcpiGbl_DsdtIndex];
 174
 175     if (!AcpiGbl_RootTableList.CurrentTableCount ||
 176         !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_DSDT) ||
 177          ACPI_FAILURE (AcpiTbValidateTable (Table)))
 178     {
 179         Status = AE_NO_ACPI_TABLES;
 180         goto UnlockAndExit;
 181     }
 182
 183     /*
 184      * Save the DSDT pointer for simple access. This is the mapped memory
 185      * address. We must take care here because the address of the .Tables
 186      * array can change dynamically as tables are loaded at run-time. Note:
 187      * .Pointer field is not validated until after call to AcpiTbValidateTable.
 188      */
 189     AcpiGbl_DSDT = Table->Pointer;
 190
 191     /*
 192      * Optionally copy the entire DSDT to local memory (instead of simply
 193      * mapping it.) There are some BIOSs that corrupt or replace the original
 194      * DSDT, creating the need for this option. Default is FALSE, do not copy
 195      * the DSDT.
 196      */
 197     if (AcpiGbl_CopyDsdtLocally)
 198     {
 199         NewDsdt = AcpiTbCopyDsdt (AcpiGbl_DsdtIndex);
 200         if (NewDsdt)
 201         {
 202             AcpiGbl_DSDT = NewDsdt;
 203         }
 204     }
 205
 206     /*
 207      * Save the original DSDT header for detection of table corruption
 208      * and/or replacement of the DSDT from outside the OS.
 209      */
 210     memcpy (&AcpiGbl_OriginalDsdtHeader, AcpiGbl_DSDT,
 211         sizeof (ACPI_TABLE_HEADER));
 212
 213     /* Load and parse tables */
 214
 215     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
 216     Status = AcpiNsLoadTable (AcpiGbl_DsdtIndex, AcpiGbl_RootNode);
 217     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
 218     if (ACPI_FAILURE (Status))
 219     {
 220         ACPI_EXCEPTION ((AE_INFO, Status, "[DSDT] table load failed"));
 221         TablesFailed++;
 222     }
 223     else
 224     {
 225         TablesLoaded++;
 226     }
 227
 228     /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
 229
 230     for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
 231     {
 232         Table = &AcpiGbl_RootTableList.Tables[i];
 233
 234         if (!Table->Address ||
 235             (!ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_SSDT) &&
 236              !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_PSDT) &&
 237              !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_OSDT)) ||
 238             ACPI_FAILURE (AcpiTbValidateTable (Table)))
 239         {
 240             continue;
 241         }
 242
 243         /* Ignore errors while loading tables, get as many as possible */
 244
 245         (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
 246         Status =  AcpiNsLoadTable (i, AcpiGbl_RootNode);
 247         (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
 248         if (ACPI_FAILURE (Status))
 249         {
 250             ACPI_EXCEPTION ((AE_INFO, Status, "(%4.4s:%8.8s) while loading table",
 251                 Table->Signature.Ascii, Table->Pointer->OemTableId));
 252
 253             TablesFailed++;
 254
 255             ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
 256                 "Table [%4.4s:%8.8s] (id FF) - Table namespace load failed\n\n",
 257                 Table->Signature.Ascii, Table->Pointer->OemTableId));
 258         }
 259         else
 260         {
 261             TablesLoaded++;
 262         }
 263     }
 264
 265     if (!TablesFailed)
 266     {
 267         ACPI_INFO ((
 268             "%u ACPI AML tables successfully acquired and loaded",
 269             TablesLoaded));
 270     }
 271     else
 272     {
 273         ACPI_ERROR ((AE_INFO,
 274             "%u table load failures, %u successful",
 275             TablesFailed, TablesLoaded));
 276
 277         /* Indicate at least one failure */
 278
 279         Status = AE_CTRL_TERMINATE;
 280     }
 281
 282 #ifdef ACPI_APPLICATION
 283     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "\n"));
 284 #endif
 285
 286
 287 UnlockAndExit:
 288     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
 289     return_ACPI_STATUS (Status);
 290 }
 291
 292
 293 /*******************************************************************************
 294  *
 295  * FUNCTION:    AcpiInstallTable
 296  *
 297  * PARAMETERS:  Address             - Address of the ACPI table to be installed.
 298  *              Physical            - Whether the address is a physical table
 299  *                                    address or not
 300  *
 301  * RETURN:      Status
 302  *
 303  * DESCRIPTION: Dynamically install an ACPI table.
 304  *              Note: This function should only be invoked after
 305  *                    AcpiInitializeTables() and before AcpiLoadTables().
 306  *
 307  ******************************************************************************/
 308
 309 ACPI_STATUS ACPI_INIT_FUNCTION
 310 AcpiInstallTable (
 311     ACPI_PHYSICAL_ADDRESS   Address,
 312     BOOLEAN                 Physical)
 313 {
 314     ACPI_STATUS             Status;
 315     UINT8                   Flags;
 316     UINT32                  TableIndex;
 317
 318
 319     ACPI_FUNCTION_TRACE (AcpiInstallTable);
 320
 321
 322     if (Physical)
 323     {
 324         Flags = ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL;
 325     }
 326     else
 327     {
 328         Flags = ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL;
 329     }
 330
 331     Status = AcpiTbInstallStandardTable (Address, Flags,
 332         FALSE, FALSE, &TableIndex);
 333
 334     return_ACPI_STATUS (Status);
 335 }
 336
 337 ACPI_EXPORT_SYMBOL_INIT (AcpiInstallTable)
 338
 339
 340 /*******************************************************************************
 341  *
 342  * FUNCTION:    AcpiLoadTable
 343  *
 344  * PARAMETERS:  Table               - Pointer to a buffer containing the ACPI
 345  *                                    table to be loaded.
 346  *
 347  * RETURN:      Status
 348  *
 349  * DESCRIPTION: Dynamically load an ACPI table from the caller's buffer. Must
 350  *              be a valid ACPI table with a valid ACPI table header.
 351  *              Note1: Mainly intended to support hotplug addition of SSDTs.
 352  *              Note2: Does not copy the incoming table. User is responsible
 353  *              to ensure that the table is not deleted or unmapped.
 354  *
 355  ******************************************************************************/
 356
 357 ACPI_STATUS
 358 AcpiLoadTable (
 359     ACPI_TABLE_HEADER       *Table)
 360 {
 361     ACPI_STATUS             Status;
 362     UINT32                  TableIndex;
 363
 364
 365     ACPI_FUNCTION_TRACE (AcpiLoadTable);
 366
 367
 368     /* Parameter validation */
 369
 370     if (!Table)
 371     {
 372         return_ACPI_STATUS (AE_BAD_PARAMETER);
 373     }
 374
 375     /* Install the table and load it into the namespace */
 376
 377     ACPI_INFO (("Host-directed Dynamic ACPI Table Load:"));
 378     Status = AcpiTbInstallAndLoadTable (ACPI_PTR_TO_PHYSADDR (Table),
 379         ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL, FALSE, &TableIndex);
 380     return_ACPI_STATUS (Status);
 381 }
 382
 383 ACPI_EXPORT_SYMBOL (AcpiLoadTable)
 384
 385
 386 /*******************************************************************************
 387  *
 388  * FUNCTION:    AcpiUnloadParentTable
 389  *
 390  * PARAMETERS:  Object              - Handle to any namespace object owned by
 391  *                                    the table to be unloaded
 392  *
 393  * RETURN:      Status
 394  *
 395  * DESCRIPTION: Via any namespace object within an SSDT or OEMx table, unloads
 396  *              the table and deletes all namespace objects associated with
 397  *              that table. Unloading of the DSDT is not allowed.
 398  *              Note: Mainly intended to support hotplug removal of SSDTs.
 399  *
 400  ******************************************************************************/
 401
 402 ACPI_STATUS
 403 AcpiUnloadParentTable (
 404     ACPI_HANDLE             Object)
 405 {
 406     ACPI_NAMESPACE_NODE     *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Object);
 407     ACPI_STATUS             Status = AE_NOT_EXIST;
 408     ACPI_OWNER_ID           OwnerId;
 409     UINT32                  i;
 410
 411
 412     ACPI_FUNCTION_TRACE (AcpiUnloadParentTable);
 413
 414
 415     /* Parameter validation */
 416
 417     if (!Object)
 418     {
 419         return_ACPI_STATUS (AE_BAD_PARAMETER);
 420     }
 421
 422     /*
 423      * The node OwnerId is currently the same as the parent table ID.
 424      * However, this could change in the future.
 425      */
 426     OwnerId = Node->OwnerId;
 427     if (!OwnerId)
 428     {
 429         /* OwnerId==0 means DSDT is the owner. DSDT cannot be unloaded */
 430
 431         return_ACPI_STATUS (AE_TYPE);
 432     }
 433
 434     /* Must acquire the table lock during this operation */
 435
 436     Status = AcpiUtAcquireMutex (ACPI_MTX_TABLES);
 437     if (ACPI_FAILURE (Status))
 438     {
 439         return_ACPI_STATUS (Status);
 440     }
 441
 442     /* Find the table in the global table list */
 443
 444     for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++)
 445     {
 446         if (OwnerId != AcpiGbl_RootTableList.Tables[i].OwnerId)
 447         {
 448             continue;
 449         }
 450
 451         /*
 452          * Allow unload of SSDT and OEMx tables only. Do not allow unload
 453          * of the DSDT. No other types of tables should get here, since
 454          * only these types can contain AML and thus are the only types
 455          * that can create namespace objects.
 456          */
 457         if (ACPI_COMPARE_NAME (
 458                 AcpiGbl_RootTableList.Tables[i].Signature.Ascii,
 459                 ACPI_SIG_DSDT))
 460         {
 461             Status = AE_TYPE;
 462             break;
 463         }
 464
 465         (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
 466         Status = AcpiTbUnloadTable (i);
 467         (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
 468         break;
 469     }
 470
 471     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
 472     return_ACPI_STATUS (Status);
 473 }
 474
 475 ACPI_EXPORT_SYMBOL (AcpiUnloadParentTable)