7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Module Name: tbxfload - Table load/unload external interfaces
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *****************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * All rights reserved.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Redistribution and use in source and binary forms, with or without
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * modification, are permitted provided that the following conditions
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 1. Redistributions of source code must retain the above copyright
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * notice, this list of conditions, and the following disclaimer,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * without modification.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * substantially similar to the "NO WARRANTY" disclaimer below
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * ("Disclaimer") and any redistribution must be conditioned upon
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * including a substantially similar Disclaimer requirement for further
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * binary redistribution.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 3. Neither the names of the above-listed copyright holders nor the names
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * of any contributors may be used to endorse or promote products derived
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * from this software without specific prior written permission.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Alternatively, this software may be distributed under the terms of the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * GNU General Public License ("GPL") version 2 as published by the Free
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Software Foundation.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * NO WARRANTY
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * POSSIBILITY OF SUCH DAMAGES.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiLoadTables
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: None
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Status
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Install the default operation region handlers. These are the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * handlers that are defined by the ACPI specification to be
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * "always accessible" -- namely, SystemMemory, SystemIO, and
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PCI_Config. This also means that no _REG methods need to be
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * run for these address spaces. We need to have these handlers
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * installed before any AML code can be executed, especially any
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * module-level code (11/2015).
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note that we allow OSPMs to install their own region handlers
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * between AcpiInitializeSubsystem() and AcpiLoadTables() to use
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * their customized default region handlers.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_EXCEPTION ((AE_INFO, Status, "During Region initialization"));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Load the namespace from the tables */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Don't let single failures abort the load */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "While loading namespace from ACPI tables"));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Initialize the objects that remain uninitialized. This
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * runs the executable AML that may be part of the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * declaration of these objects:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * OperationRegions, BufferFields, Buffers, and Packages.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiTbLoadNamespace
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: None
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Status
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Load the namespace. The DSDT is required, but any SSDT and
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PSDT tables are optional. Verify the DSDT.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Table = &AcpiGbl_RootTableList.Tables[AcpiGbl_DsdtIndex];
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (!AcpiGbl_RootTableList.CurrentTableCount ||
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_DSDT) ||
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Save the DSDT pointer for simple access. This is the mapped memory
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * address. We must take care here because the address of the .Tables
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * array can change dynamically as tables are loaded at run-time. Note:
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * .Pointer field is not validated until after call to AcpiTbValidateTable.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Optionally copy the entire DSDT to local memory (instead of simply
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * mapping it.) There are some BIOSs that corrupt or replace the original
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DSDT, creating the need for this option. Default is FALSE, do not copy
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Save the original DSDT header for detection of table corruption
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * and/or replacement of the DSDT from outside the OS.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek memcpy (&AcpiGbl_OriginalDsdtHeader, AcpiGbl_DSDT,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Load and parse tables */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Status = AcpiNsLoadTable (AcpiGbl_DsdtIndex, AcpiGbl_RootNode);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_EXCEPTION ((AE_INFO, Status, "[DSDT] table load failed"));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (!AcpiGbl_RootTableList.Tables[i].Address ||
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek (!ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_SSDT) &&
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_PSDT) &&
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek !ACPI_COMPARE_NAME (Table->Signature.Ascii, ACPI_SIG_OSDT)) ||
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Ignore errors while loading tables, get as many as possible */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Status = AcpiNsLoadTable (i, AcpiGbl_RootNode);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_EXCEPTION ((AE_INFO, Status, "(%4.4s:%8.8s) while loading table",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Table->Signature.Ascii, Table->Pointer->OemTableId));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Table [%4.4s:%8.8s] (id FF) - Table namespace load failed\n\n",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Table->Signature.Ascii, Table->Pointer->OemTableId));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "%u ACPI AML tables successfully acquired and loaded\n",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "%u table load failures, %u successful",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Indicate at least one failure */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiInstallTable
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Address - Address of the ACPI table to be installed.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Physical - Whether the address is a physical table
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * address or not
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Status
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Dynamically install an ACPI table.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: This function should only be invoked after
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * AcpiInitializeTables() and before AcpiLoadTables().
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Status = AcpiTbInstallStandardTable (Address, Flags,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiLoadTable
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Table - Pointer to a buffer containing the ACPI
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * table to be loaded.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Status
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Dynamically load an ACPI table from the caller's buffer. Must
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * be a valid ACPI table with a valid ACPI table header.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note1: Mainly intended to support hotplug addition of SSDTs.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note2: Does not copy the incoming table. User is responsible
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * to ensure that the table is not deleted or unmapped.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Parameter validation */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Must acquire the interpreter lock during this operation */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Install the table and load it into the namespace */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_INFO (("Host-directed Dynamic ACPI Table Load:"));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Status = AcpiTbInstallStandardTable (ACPI_PTR_TO_PHYSADDR (Table),
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL, TRUE, FALSE,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: Now table is "INSTALLED", it must be validated before
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Status = AcpiNsLoadTable (TableIndex, AcpiGbl_RootNode);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Invoke table handler if present */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_LOAD, Table,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek (void) AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiUnloadParentTable
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Object - Handle to any namespace object owned by
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the table to be unloaded
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: Status
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Via any namespace object within an SSDT or OEMx table, unloads
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the table and deletes all namespace objects associated with
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * that table. Unloading of the DSDT is not allowed.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: Mainly intended to support hotplug removal of SSDTs.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_NAMESPACE_NODE *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Object);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Parameter validation */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * The node OwnerId is currently the same as the parent table ID.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * However, this could change in the future.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* OwnerId==0 means DSDT is the owner. DSDT cannot be unloaded */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Must acquire the interpreter lock during this operation */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Find the table in the global table list */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek if (OwnerId != AcpiGbl_RootTableList.Tables[i].OwnerId)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Allow unload of SSDT and OEMx tables only. Do not allow unload
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * of the DSDT. No other types of tables should get here, since
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * only these types can contain AML and thus are the only types
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * that can create namespace objects.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiGbl_RootTableList.Tables[i].Signature.Ascii,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Ensure the table is actually loaded */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Invoke table handler if present */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_UNLOAD,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Delete all namespace objects owned by this table. Note that
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * these objects can appear anywhere in the namespace by virtue
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * of the AML "Scope" operator. Thus, we need to track ownership
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * by an ID, not simply a position within the hierarchy.