acpica/tables/tbinstal.c

0001 /******************************************************************************
0002  *
0003  * Module Name: tbinstal - ACPI table installation and removal
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "actables.h"
0155
0156 #define _COMPONENT          ACPI_TABLES
0157         ACPI_MODULE_NAME    ("tbinstal")
0158
0159
0160 /*******************************************************************************
0161  *
0162  * FUNCTION:    AcpiTbInstallTableWithOverride
0163  *
0164  * PARAMETERS:  NewTableDesc            - New table descriptor to install
0165  *              Override                - Whether override should be performed
0166  *              TableIndex              - Where the table index is returned
0167  *
0168  * RETURN:      None
0169  *
0170  * DESCRIPTION: Install an ACPI table into the global data structure. The
0171  *              table override mechanism is called to allow the host
0172  *              OS to replace any table before it is installed in the root
0173  *              table array.
0174  *
0175  ******************************************************************************/
0176
0177 void
0178 AcpiTbInstallTableWithOverride (
0179     ACPI_TABLE_DESC         *NewTableDesc,
0180     BOOLEAN                 Override,
0181     UINT32                  *TableIndex)
0182 {
0183     UINT32                  i;
0184     ACPI_STATUS             Status;
0185
0186
0187     Status = AcpiTbGetNextTableDescriptor (&i, NULL);
0188     if (ACPI_FAILURE (Status))
0189     {
0190         return;
0191     }
0192
0193     /*
0194      * ACPI Table Override:
0195      *
0196      * Before we install the table, let the host OS override it with a new
0197      * one if desired. Any table within the RSDT/XSDT can be replaced,
0198      * including the DSDT which is pointed to by the FADT.
0199      */
0200     if (Override)
0201     {
0202         AcpiTbOverrideTable (NewTableDesc);
0203     }
0204
0205     AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList.Tables[i],
0206         NewTableDesc->Address, NewTableDesc->Flags, NewTableDesc->Pointer);
0207
0208     AcpiTbPrintTableHeader (NewTableDesc->Address, NewTableDesc->Pointer);
0209
0210     /* This synchronizes AcpiGbl_DsdtIndex */
0211
0212     *TableIndex = i;
0213
0214     /* Set the global integer width (based upon revision of the DSDT) */
0215
0216     if (i == AcpiGbl_DsdtIndex)
0217     {
0218         AcpiUtSetIntegerWidth (NewTableDesc->Pointer->Revision);
0219     }
0220 }
0221
0222
0223 /*******************************************************************************
0224  *
0225  * FUNCTION:    AcpiTbInstallStandardTable
0226  *
0227  * PARAMETERS:  Address             - Address of the table (might be a virtual
0228  *                                    address depending on the TableFlags)
0229  *              Flags               - Flags for the table
0230  *              Table               - Pointer to the table (required for virtual
0231  *                                    origins, optional for physical)
0232  *              Reload              - Whether reload should be performed
0233  *              Override            - Whether override should be performed
0234  *              TableIndex          - Where the table index is returned
0235  *
0236  * RETURN:      Status
0237  *
0238  * DESCRIPTION: This function is called to verify and install an ACPI table.
0239  *              When this function is called by "Load" or "LoadTable" opcodes,
0240  *              or by AcpiLoadTable() API, the "Reload" parameter is set.
0241  *              After successfully returning from this function, table is
0242  *              "INSTALLED" but not "VALIDATED".
0243  *
0244  ******************************************************************************/
0245
0246 ACPI_STATUS
0247 AcpiTbInstallStandardTable (
0248     ACPI_PHYSICAL_ADDRESS   Address,
0249     UINT8                   Flags,
0250     ACPI_TABLE_HEADER       *Table,
0251     BOOLEAN                 Reload,
0252     BOOLEAN                 Override,
0253     UINT32                  *TableIndex)
0254 {
0255     UINT32                  i;
0256     ACPI_STATUS             Status = AE_OK;
0257     ACPI_TABLE_DESC         NewTableDesc;
0258
0259
0260     ACPI_FUNCTION_TRACE (TbInstallStandardTable);
0261
0262
0263     /* Acquire a temporary table descriptor for validation */
0264
0265     Status = AcpiTbAcquireTempTable (&NewTableDesc, Address, Flags, Table);
0266     if (ACPI_FAILURE (Status))
0267     {
0268         ACPI_ERROR ((AE_INFO,
0269             "Could not acquire table length at %8.8X%8.8X",
0270             ACPI_FORMAT_UINT64 (Address)));
0271         return_ACPI_STATUS (Status);
0272     }
0273
0274     /*
0275      * Optionally do not load any SSDTs from the RSDT/XSDT. This can
0276      * be useful for debugging ACPI problems on some machines.
0277      */
0278     if (!Reload &&
0279         AcpiGbl_DisableSsdtTableInstall &&
0280         ACPI_COMPARE_NAMESEG (&NewTableDesc.Signature, ACPI_SIG_SSDT))
0281     {
0282         ACPI_INFO ((
0283             "Ignoring installation of %4.4s at %8.8X%8.8X",
0284             NewTableDesc.Signature.Ascii, ACPI_FORMAT_UINT64 (Address)));
0285         goto ReleaseAndExit;
0286     }
0287
0288     /* Acquire the table lock */
0289
0290     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
0291
0292     /* Validate and verify a table before installation */
0293
0294     Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL, &i);
0295     if (ACPI_FAILURE (Status))
0296     {
0297         if (Status == AE_CTRL_TERMINATE)
0298         {
0299             /*
0300              * Table was unloaded, allow it to be reloaded.
0301              * As we are going to return AE_OK to the caller, we should
0302              * take the responsibility of freeing the input descriptor.
0303              * Refill the input descriptor to ensure
0304              * AcpiTbInstallTableWithOverride() can be called again to
0305              * indicate the re-installation.
0306              */
0307             AcpiTbUninstallTable (&NewTableDesc);
0308             (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
0309             *TableIndex = i;
0310             return_ACPI_STATUS (AE_OK);
0311         }
0312         goto UnlockAndExit;
0313     }
0314
0315     /* Add the table to the global root table list */
0316
0317     AcpiTbInstallTableWithOverride (&NewTableDesc, Override, TableIndex);
0318
0319     /* Invoke table handler */
0320
0321     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
0322     AcpiTbNotifyTable (ACPI_TABLE_EVENT_INSTALL, NewTableDesc.Pointer);
0323     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
0324
0325 UnlockAndExit:
0326
0327     /* Release the table lock */
0328
0329     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
0330
0331 ReleaseAndExit:
0332
0333     /* Release the temporary table descriptor */
0334
0335     AcpiTbReleaseTempTable (&NewTableDesc);
0336     return_ACPI_STATUS (Status);
0337 }
0338
0339
0340 /*******************************************************************************
0341  *
0342  * FUNCTION:    AcpiTbOverrideTable
0343  *
0344  * PARAMETERS:  OldTableDesc        - Validated table descriptor to be
0345  *                                    overridden
0346  *
0347  * RETURN:      None
0348  *
0349  * DESCRIPTION: Attempt table override by calling the OSL override functions.
0350  *              Note: If the table is overridden, then the entire new table
0351  *              is acquired and returned by this function.
0352  *              Before/after invocation, the table descriptor is in a state
0353  *              that is "VALIDATED".
0354  *
0355  ******************************************************************************/
0356
0357 void
0358 AcpiTbOverrideTable (
0359     ACPI_TABLE_DESC         *OldTableDesc)
0360 {
0361     ACPI_STATUS             Status;
0362     ACPI_TABLE_DESC         NewTableDesc;
0363     ACPI_TABLE_HEADER       *Table;
0364     ACPI_PHYSICAL_ADDRESS   Address;
0365     UINT32                  Length;
0366     ACPI_ERROR_ONLY (char   *OverrideType);
0367
0368
0369     /* (1) Attempt logical override (returns a logical address) */
0370
0371     Status = AcpiOsTableOverride (OldTableDesc->Pointer, &Table);
0372     if (ACPI_SUCCESS (Status) && Table)
0373     {
0374         AcpiTbAcquireTempTable (&NewTableDesc, ACPI_PTR_TO_PHYSADDR (Table),
0375             ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL, Table);
0376         ACPI_ERROR_ONLY (OverrideType = "Logical");
0377         goto FinishOverride;
0378     }
0379
0380     /* (2) Attempt physical override (returns a physical address) */
0381
0382     Status = AcpiOsPhysicalTableOverride (OldTableDesc->Pointer,
0383         &Address, &Length);
0384     if (ACPI_SUCCESS (Status) && Address && Length)
0385     {
0386         AcpiTbAcquireTempTable (&NewTableDesc, Address,
0387             ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL);
0388         ACPI_ERROR_ONLY (OverrideType = "Physical");
0389         goto FinishOverride;
0390     }
0391
0392     return; /* There was no override */
0393
0394
0395 FinishOverride:
0396
0397     /*
0398      * Validate and verify a table before overriding, no nested table
0399      * duplication check as it's too complicated and unnecessary.
0400      */
0401     Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL, NULL);
0402     if (ACPI_FAILURE (Status))
0403     {
0404         return;
0405     }
0406
0407     ACPI_INFO (("%4.4s 0x%8.8X%8.8X"
0408         " %s table override, new table: 0x%8.8X%8.8X",
0409         OldTableDesc->Signature.Ascii,
0410         ACPI_FORMAT_UINT64 (OldTableDesc->Address),
0411         OverrideType, ACPI_FORMAT_UINT64 (NewTableDesc.Address)));
0412
0413     /* We can now uninstall the original table */
0414
0415     AcpiTbUninstallTable (OldTableDesc);
0416
0417     /*
0418      * Replace the original table descriptor and keep its state as
0419      * "VALIDATED".
0420      */
0421     AcpiTbInitTableDescriptor (OldTableDesc, NewTableDesc.Address,
0422         NewTableDesc.Flags, NewTableDesc.Pointer);
0423     AcpiTbValidateTempTable (OldTableDesc);
0424
0425     /* Release the temporary table descriptor */
0426
0427     AcpiTbReleaseTempTable (&NewTableDesc);
0428 }
0429
0430
0431 /*******************************************************************************
0432  *
0433  * FUNCTION:    AcpiTbUninstallTable
0434  *
0435  * PARAMETERS:  TableDesc           - Table descriptor
0436  *
0437  * RETURN:      None
0438  *
0439  * DESCRIPTION: Delete one internal ACPI table
0440  *
0441  ******************************************************************************/
0442
0443 void
0444 AcpiTbUninstallTable (
0445     ACPI_TABLE_DESC         *TableDesc)
0446 {
0447
0448     ACPI_FUNCTION_TRACE (TbUninstallTable);
0449
0450
0451     /* Table must be installed */
0452
0453     if (!TableDesc->Address)
0454     {
0455         return_VOID;
0456     }
0457
0458     AcpiTbInvalidateTable (TableDesc);
0459
0460     if ((TableDesc->Flags & ACPI_TABLE_ORIGIN_MASK) ==
0461         ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL)
0462     {
0463         ACPI_FREE (TableDesc->Pointer);
0464         TableDesc->Pointer = NULL;
0465     }
0466
0467     TableDesc->Address = ACPI_PTR_TO_PHYSADDR (NULL);
0468     return_VOID;
0469 }