FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/tables/tbinstal.c

     /******************************************************************************
      *
      * Module Name: tbinstal - ACPI table installation and removal
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 1. Copyright Notice
     *
     * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
     * All rights reserved.
     *
     * 2. License
     *
     * 2.1. This is your license from Intel Corp. under its intellectual property
     * rights. You may have additional license terms from the party that provided
     * you this software, covering your right to use that party's intellectual
     * property rights.
     *
     * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     * copy of the source code appearing in this file ("Covered Code") an
     * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     * base code distributed originally by Intel ("Original Intel Code") to copy,
     * make derivatives, distribute, use and display any portion of the Covered
     * Code in any form, with the right to sublicense such rights; and
     *
     * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     * license (with the right to sublicense), under only those claims of Intel
     * patents that are infringed by the Original Intel Code, to make, use, sell,
     * offer to sell, and import the Covered Code and derivative works thereof
     * solely to the minimum extent necessary to exercise the above copyright
     * license, and in no event shall the patent license extend to any additions
     * to or modifications of the Original Intel Code. No other license or right
     * is granted directly or by implication, estoppel or otherwise;
     *
     * The above copyright and patent license is granted only if the following
     * conditions are met:
     *
     * 3. Conditions
     *
     * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification with rights to further distribute source must include
     * the above Copyright Notice, the above License, this list of Conditions,
     * and the following Disclaimer and Export Compliance provision. In addition,
     * Licensee must cause all Covered Code to which Licensee contributes to
     * contain a file documenting the changes Licensee made to create that Covered
     * Code and the date of any change. Licensee must include in that file the
     * documentation of any changes made by any predecessor Licensee. Licensee
     * must include a prominent statement that the modification is derived,
     * directly or indirectly, from Original Intel Code.
     *
     * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification without rights to further distribute source must
     * include the following Disclaimer and Export Compliance provision in the
     * documentation and/or other materials provided with distribution. In
     * addition, Licensee may not authorize further sublicense of source of any
     * portion of the Covered Code, and must include terms to the effect that the
     * license from Licensee to its licensee is limited to the intellectual
     * property embodied in the software Licensee provides to its licensee, and
     * not to intellectual property embodied in modifications its licensee may
     * make.
     *
     * 3.3. Redistribution of Executable. Redistribution in executable form of any
     * substantial portion of the Covered Code or modification must reproduce the
     * above Copyright Notice, and the following Disclaimer and Export Compliance
     * provision in the documentation and/or other materials provided with the
     * distribution.
     *
     * 3.4. Intel retains all right, title, and interest in and to the Original
     * Intel Code.
     *
     * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     * Intel shall be used in advertising or otherwise to promote the sale, use or
     * other dealings in products derived from or relating to the Covered Code
     * without prior written authorization from Intel.
     *
     * 4. Disclaimer and Export Compliance
     *
     * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     * PARTICULAR PURPOSE.
     *
     * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     * LIMITED REMEDY.
     *
     * 4.3. Licensee shall not export, either directly or indirectly, any of this
    * software or system incorporating such software without first obtaining any
    * required license or other approval from the U. S. Department of Commerce or
    * any other agency or department of the United States Government. In the
    * event Licensee exports any such software from the United States or
    * re-exports any such software from a foreign destination, Licensee shall
    * ensure that the distribution and export/re-export of the software is in
    * compliance with all laws, regulations, orders, or other restrictions of the
    * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    * any of its subsidiaries will export/re-export any technical data, process,
    * software, or service, directly or indirectly, to any country for which the
    * United States government or any agency thereof requires an export license,
    * other governmental approval, or letter of assurance, without first obtaining
    * such license, approval or letter.
    *
    *****************************************************************************
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * following license:
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions, and the following disclaimer,
    *    without modification.
    * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    *    substantially similar to the "NO WARRANTY" disclaimer below
    *    ("Disclaimer") and any redistribution must be conditioned upon
    *    including a substantially similar Disclaimer requirement for further
    *    binary redistribution.
    * 3. Neither the names of the above-listed copyright holders nor the names
    *    of any contributors may be used to endorse or promote products derived
    *    from this software without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * GNU General Public License ("GPL") version 2 as published by the Free
    * Software Foundation.
    *
    *****************************************************************************/
   
   #include <contrib/dev/acpica/include/acpi.h>
   #include <contrib/dev/acpica/include/accommon.h>
   #include <contrib/dev/acpica/include/actables.h>
   
   #define _COMPONENT          ACPI_TABLES
           ACPI_MODULE_NAME    ("tbinstal")
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiTbInstallTableWithOverride
    *
    * PARAMETERS:  NewTableDesc            - New table descriptor to install
    *              Override                - Whether override should be performed
    *              TableIndex              - Where the table index is returned
    *
    * RETURN:      None
    *
    * DESCRIPTION: Install an ACPI table into the global data structure. The
    *              table override mechanism is called to allow the host
    *              OS to replace any table before it is installed in the root
    *              table array.
    *
    ******************************************************************************/
   
   void
   AcpiTbInstallTableWithOverride (
       ACPI_TABLE_DESC         *NewTableDesc,
       BOOLEAN                 Override,
       UINT32                  *TableIndex)
   {
       UINT32                  i;
       ACPI_STATUS             Status;
   
   
       Status = AcpiTbGetNextTableDescriptor (&i, NULL);
       if (ACPI_FAILURE (Status))
       {
           return;
       }
   
       /*
        * ACPI Table Override:
        *
        * Before we install the table, let the host OS override it with a new
        * one if desired. Any table within the RSDT/XSDT can be replaced,
        * including the DSDT which is pointed to by the FADT.
        */
       if (Override)
       {
           AcpiTbOverrideTable (NewTableDesc);
       }
   
       AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList.Tables[i],
           NewTableDesc->Address, NewTableDesc->Flags, NewTableDesc->Pointer);
   
       AcpiTbPrintTableHeader (NewTableDesc->Address, NewTableDesc->Pointer);
   
       /* This synchronizes AcpiGbl_DsdtIndex */
   
       *TableIndex = i;
   
       /* Set the global integer width (based upon revision of the DSDT) */
   
       if (i == AcpiGbl_DsdtIndex)
       {
           AcpiUtSetIntegerWidth (NewTableDesc->Pointer->Revision);
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiTbInstallStandardTable
    *
    * PARAMETERS:  Address             - Address of the table (might be a virtual
    *                                    address depending on the TableFlags)
    *              Flags               - Flags for the table
    *              Table               - Pointer to the table (required for virtual
    *                                    origins, optional for physical)
    *              Reload              - Whether reload should be performed
    *              Override            - Whether override should be performed
    *              TableIndex          - Where the table index is returned
    *
    * RETURN:      Status
    *
    * DESCRIPTION: This function is called to verify and install an ACPI table.
    *              When this function is called by "Load" or "LoadTable" opcodes,
    *              or by AcpiLoadTable() API, the "Reload" parameter is set.
    *              After successfully returning from this function, table is
    *              "INSTALLED" but not "VALIDATED".
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiTbInstallStandardTable (
       ACPI_PHYSICAL_ADDRESS   Address,
       UINT8                   Flags,
       ACPI_TABLE_HEADER       *Table,
       BOOLEAN                 Reload,
       BOOLEAN                 Override,
       UINT32                  *TableIndex)
   {
       UINT32                  i;
       ACPI_STATUS             Status = AE_OK;
       ACPI_TABLE_DESC         NewTableDesc;
   
   
       ACPI_FUNCTION_TRACE (TbInstallStandardTable);
   
   
       /* Acquire a temporary table descriptor for validation */
   
       Status = AcpiTbAcquireTempTable (&NewTableDesc, Address, Flags, Table);
       if (ACPI_FAILURE (Status))
       {
           ACPI_ERROR ((AE_INFO,
               "Could not acquire table length at %8.8X%8.8X",
               ACPI_FORMAT_UINT64 (Address)));
           return_ACPI_STATUS (Status);
       }
   
       /*
        * Optionally do not load any SSDTs from the RSDT/XSDT. This can
        * be useful for debugging ACPI problems on some machines.
        */
       if (!Reload &&
           AcpiGbl_DisableSsdtTableInstall &&
           ACPI_COMPARE_NAMESEG (&NewTableDesc.Signature, ACPI_SIG_SSDT))
       {
           ACPI_INFO ((
               "Ignoring installation of %4.4s at %8.8X%8.8X",
               NewTableDesc.Signature.Ascii, ACPI_FORMAT_UINT64 (Address)));
           goto ReleaseAndExit;
       }
   
       /* Acquire the table lock */
   
       (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
   
       /* Validate and verify a table before installation */
   
       Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL, &i);
       if (ACPI_FAILURE (Status))
       {
           if (Status == AE_CTRL_TERMINATE)
           {
               /*
                * Table was unloaded, allow it to be reloaded.
                * As we are going to return AE_OK to the caller, we should
                * take the responsibility of freeing the input descriptor.
                * Refill the input descriptor to ensure
                * AcpiTbInstallTableWithOverride() can be called again to
                * indicate the re-installation.
                */
               AcpiTbUninstallTable (&NewTableDesc);
               (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
               *TableIndex = i;
               return_ACPI_STATUS (AE_OK);
           }
           goto UnlockAndExit;
       }
   
       /* Add the table to the global root table list */
   
       AcpiTbInstallTableWithOverride (&NewTableDesc, Override, TableIndex);
   
       /* Invoke table handler */
   
       (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
       AcpiTbNotifyTable (ACPI_TABLE_EVENT_INSTALL, NewTableDesc.Pointer);
       (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
   
   UnlockAndExit:
   
       /* Release the table lock */
   
       (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
   
   ReleaseAndExit:
   
       /* Release the temporary table descriptor */
   
       AcpiTbReleaseTempTable (&NewTableDesc);
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiTbOverrideTable
    *
    * PARAMETERS:  OldTableDesc        - Validated table descriptor to be
    *                                    overridden
    *
    * RETURN:      None
    *
    * DESCRIPTION: Attempt table override by calling the OSL override functions.
    *              Note: If the table is overridden, then the entire new table
    *              is acquired and returned by this function.
    *              Before/after invocation, the table descriptor is in a state
    *              that is "VALIDATED".
    *
    ******************************************************************************/
   
   void
   AcpiTbOverrideTable (
       ACPI_TABLE_DESC         *OldTableDesc)
   {
       ACPI_STATUS             Status;
       ACPI_TABLE_DESC         NewTableDesc;
       ACPI_TABLE_HEADER       *Table;
       ACPI_PHYSICAL_ADDRESS   Address;
       UINT32                  Length;
       ACPI_ERROR_ONLY (char   *OverrideType);
   
   
       /* (1) Attempt logical override (returns a logical address) */
   
       Status = AcpiOsTableOverride (OldTableDesc->Pointer, &Table);
       if (ACPI_SUCCESS (Status) && Table)
       {
           AcpiTbAcquireTempTable (&NewTableDesc, ACPI_PTR_TO_PHYSADDR (Table),
               ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL, Table);
           ACPI_ERROR_ONLY (OverrideType = "Logical");
           goto FinishOverride;
       }
   
       /* (2) Attempt physical override (returns a physical address) */
   
       Status = AcpiOsPhysicalTableOverride (OldTableDesc->Pointer,
           &Address, &Length);
       if (ACPI_SUCCESS (Status) && Address && Length)
       {
           AcpiTbAcquireTempTable (&NewTableDesc, Address,
               ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL, NULL);
           ACPI_ERROR_ONLY (OverrideType = "Physical");
           goto FinishOverride;
       }
   
       return; /* There was no override */
   
   
   FinishOverride:
   
       /*
        * Validate and verify a table before overriding, no nested table
        * duplication check as it's too complicated and unnecessary.
        */
       Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL, NULL);
       if (ACPI_FAILURE (Status))
       {
           return;
       }
   
       ACPI_INFO (("%4.4s 0x%8.8X%8.8X"
           " %s table override, new table: 0x%8.8X%8.8X",
           OldTableDesc->Signature.Ascii,
           ACPI_FORMAT_UINT64 (OldTableDesc->Address),
           OverrideType, ACPI_FORMAT_UINT64 (NewTableDesc.Address)));
   
       /* We can now uninstall the original table */
   
       AcpiTbUninstallTable (OldTableDesc);
   
       /*
        * Replace the original table descriptor and keep its state as
        * "VALIDATED".
        */
       AcpiTbInitTableDescriptor (OldTableDesc, NewTableDesc.Address,
           NewTableDesc.Flags, NewTableDesc.Pointer);
       AcpiTbValidateTempTable (OldTableDesc);
   
       /* Release the temporary table descriptor */
   
       AcpiTbReleaseTempTable (&NewTableDesc);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiTbUninstallTable
    *
    * PARAMETERS:  TableDesc           - Table descriptor
    *
    * RETURN:      None
    *
    * DESCRIPTION: Delete one internal ACPI table
    *
    ******************************************************************************/
   
   void
   AcpiTbUninstallTable (
       ACPI_TABLE_DESC         *TableDesc)
   {
   
       ACPI_FUNCTION_TRACE (TbUninstallTable);
   
   
       /* Table must be installed */
   
       if (!TableDesc->Address)
       {
           return_VOID;
       }
   
       AcpiTbInvalidateTable (TableDesc);
   
       if ((TableDesc->Flags & ACPI_TABLE_ORIGIN_MASK) ==
           ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL)
       {
           ACPI_FREE (TableDesc->Pointer);
           TableDesc->Pointer = NULL;
       }
   
       TableDesc->Address = ACPI_PTR_TO_PHYSADDR (NULL);
       return_VOID;
   }

Cache object: e4f018be54739087d10cc59e6d1194c2