Home | History | Annotate | Line # | Download | only in tables
      1   1.1    jruoho /******************************************************************************
      2   1.1    jruoho  *
      3   1.5  christos  * Module Name: tbxface - ACPI table-oriented external interfaces
      4   1.1    jruoho  *
      5   1.1    jruoho  *****************************************************************************/
      6   1.1    jruoho 
      7  1.20  christos /******************************************************************************
      8  1.20  christos  *
      9  1.20  christos  * 1. Copyright Notice
     10  1.20  christos  *
     11  1.21  christos  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
     12   1.1    jruoho  * All rights reserved.
     13   1.1    jruoho  *
     14  1.20  christos  * 2. License
     15  1.20  christos  *
     16  1.20  christos  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.20  christos  * rights. You may have additional license terms from the party that provided
     18  1.20  christos  * you this software, covering your right to use that party's intellectual
     19  1.20  christos  * property rights.
     20  1.20  christos  *
     21  1.20  christos  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.20  christos  * copy of the source code appearing in this file ("Covered Code") an
     23  1.20  christos  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.20  christos  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.20  christos  * make derivatives, distribute, use and display any portion of the Covered
     26  1.20  christos  * Code in any form, with the right to sublicense such rights; and
     27  1.20  christos  *
     28  1.20  christos  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.20  christos  * license (with the right to sublicense), under only those claims of Intel
     30  1.20  christos  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.20  christos  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.20  christos  * solely to the minimum extent necessary to exercise the above copyright
     33  1.20  christos  * license, and in no event shall the patent license extend to any additions
     34  1.20  christos  * to or modifications of the Original Intel Code. No other license or right
     35  1.20  christos  * is granted directly or by implication, estoppel or otherwise;
     36  1.20  christos  *
     37  1.20  christos  * The above copyright and patent license is granted only if the following
     38  1.20  christos  * conditions are met:
     39  1.20  christos  *
     40  1.20  christos  * 3. Conditions
     41  1.20  christos  *
     42  1.20  christos  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.20  christos  * Redistribution of source code of any substantial portion of the Covered
     44  1.20  christos  * Code or modification with rights to further distribute source must include
     45  1.20  christos  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.20  christos  * and the following Disclaimer and Export Compliance provision. In addition,
     47  1.20  christos  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.20  christos  * contain a file documenting the changes Licensee made to create that Covered
     49  1.20  christos  * Code and the date of any change. Licensee must include in that file the
     50  1.20  christos  * documentation of any changes made by any predecessor Licensee. Licensee
     51  1.20  christos  * must include a prominent statement that the modification is derived,
     52  1.20  christos  * directly or indirectly, from Original Intel Code.
     53  1.20  christos  *
     54  1.20  christos  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.20  christos  * Redistribution of source code of any substantial portion of the Covered
     56  1.20  christos  * Code or modification without rights to further distribute source must
     57  1.20  christos  * include the following Disclaimer and Export Compliance provision in the
     58  1.20  christos  * documentation and/or other materials provided with distribution. In
     59  1.20  christos  * addition, Licensee may not authorize further sublicense of source of any
     60  1.20  christos  * portion of the Covered Code, and must include terms to the effect that the
     61  1.20  christos  * license from Licensee to its licensee is limited to the intellectual
     62  1.20  christos  * property embodied in the software Licensee provides to its licensee, and
     63  1.20  christos  * not to intellectual property embodied in modifications its licensee may
     64  1.20  christos  * make.
     65  1.20  christos  *
     66  1.20  christos  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.20  christos  * substantial portion of the Covered Code or modification must reproduce the
     68  1.20  christos  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.20  christos  * provision in the documentation and/or other materials provided with the
     70  1.20  christos  * distribution.
     71  1.20  christos  *
     72  1.20  christos  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.20  christos  * Intel Code.
     74  1.20  christos  *
     75  1.20  christos  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.20  christos  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.20  christos  * other dealings in products derived from or relating to the Covered Code
     78  1.20  christos  * without prior written authorization from Intel.
     79  1.20  christos  *
     80  1.20  christos  * 4. Disclaimer and Export Compliance
     81  1.20  christos  *
     82  1.20  christos  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.20  christos  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.20  christos  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  1.20  christos  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  1.20  christos  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.20  christos  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.20  christos  * PARTICULAR PURPOSE.
     89  1.20  christos  *
     90  1.20  christos  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.20  christos  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.20  christos  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.20  christos  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.20  christos  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.20  christos  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  1.20  christos  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.20  christos  * LIMITED REMEDY.
     98  1.20  christos  *
     99  1.20  christos  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.20  christos  * software or system incorporating such software without first obtaining any
    101  1.20  christos  * required license or other approval from the U. S. Department of Commerce or
    102  1.20  christos  * any other agency or department of the United States Government. In the
    103  1.20  christos  * event Licensee exports any such software from the United States or
    104  1.20  christos  * re-exports any such software from a foreign destination, Licensee shall
    105  1.20  christos  * ensure that the distribution and export/re-export of the software is in
    106  1.20  christos  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.20  christos  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.20  christos  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.20  christos  * software, or service, directly or indirectly, to any country for which the
    110  1.20  christos  * United States government or any agency thereof requires an export license,
    111  1.20  christos  * other governmental approval, or letter of assurance, without first obtaining
    112  1.20  christos  * such license, approval or letter.
    113  1.20  christos  *
    114  1.20  christos  *****************************************************************************
    115  1.20  christos  *
    116  1.20  christos  * Alternatively, you may choose to be licensed under the terms of the
    117  1.20  christos  * following license:
    118  1.20  christos  *
    119   1.3    jruoho  * Redistribution and use in source and binary forms, with or without
    120   1.3    jruoho  * modification, are permitted provided that the following conditions
    121   1.3    jruoho  * are met:
    122   1.3    jruoho  * 1. Redistributions of source code must retain the above copyright
    123   1.3    jruoho  *    notice, this list of conditions, and the following disclaimer,
    124   1.3    jruoho  *    without modification.
    125   1.3    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126   1.3    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
    127   1.3    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
    128   1.3    jruoho  *    including a substantially similar Disclaimer requirement for further
    129   1.3    jruoho  *    binary redistribution.
    130   1.3    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
    131   1.3    jruoho  *    of any contributors may be used to endorse or promote products derived
    132   1.3    jruoho  *    from this software without specific prior written permission.
    133   1.3    jruoho  *
    134   1.3    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135   1.3    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  1.17  christos  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137   1.3    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  1.20  christos  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  1.20  christos  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  1.20  christos  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  1.20  christos  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  1.20  christos  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  1.20  christos  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  1.20  christos  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  1.20  christos  *
    146  1.20  christos  * Alternatively, you may choose to be licensed under the terms of the
    147  1.20  christos  * GNU General Public License ("GPL") version 2 as published by the Free
    148  1.20  christos  * Software Foundation.
    149  1.20  christos  *
    150  1.20  christos  *****************************************************************************/
    151   1.1    jruoho 
    152   1.5  christos #define EXPORT_ACPI_INTERFACES
    153   1.1    jruoho 
    154   1.1    jruoho #include "acpi.h"
    155   1.1    jruoho #include "accommon.h"
    156   1.1    jruoho #include "actables.h"
    157   1.1    jruoho 
    158   1.1    jruoho #define _COMPONENT          ACPI_TABLES
    159   1.1    jruoho         ACPI_MODULE_NAME    ("tbxface")
    160   1.1    jruoho 
    161   1.1    jruoho 
    162   1.1    jruoho /*******************************************************************************
    163   1.1    jruoho  *
    164   1.1    jruoho  * FUNCTION:    AcpiAllocateRootTable
    165   1.1    jruoho  *
    166   1.1    jruoho  * PARAMETERS:  InitialTableCount   - Size of InitialTableArray, in number of
    167   1.1    jruoho  *                                    ACPI_TABLE_DESC structures
    168   1.1    jruoho  *
    169   1.1    jruoho  * RETURN:      Status
    170   1.1    jruoho  *
    171   1.1    jruoho  * DESCRIPTION: Allocate a root table array. Used by iASL compiler and
    172   1.1    jruoho  *              AcpiInitializeTables.
    173   1.1    jruoho  *
    174   1.1    jruoho  ******************************************************************************/
    175   1.1    jruoho 
    176   1.1    jruoho ACPI_STATUS
    177   1.1    jruoho AcpiAllocateRootTable (
    178   1.1    jruoho     UINT32                  InitialTableCount)
    179   1.1    jruoho {
    180   1.1    jruoho 
    181   1.1    jruoho     AcpiGbl_RootTableList.MaxTableCount = InitialTableCount;
    182   1.1    jruoho     AcpiGbl_RootTableList.Flags = ACPI_ROOT_ALLOW_RESIZE;
    183   1.1    jruoho 
    184   1.1    jruoho     return (AcpiTbResizeRootTableList ());
    185   1.1    jruoho }
    186   1.1    jruoho 
    187   1.1    jruoho 
    188   1.1    jruoho /*******************************************************************************
    189   1.1    jruoho  *
    190   1.1    jruoho  * FUNCTION:    AcpiInitializeTables
    191   1.1    jruoho  *
    192   1.1    jruoho  * PARAMETERS:  InitialTableArray   - Pointer to an array of pre-allocated
    193   1.1    jruoho  *                                    ACPI_TABLE_DESC structures. If NULL, the
    194   1.1    jruoho  *                                    array is dynamically allocated.
    195   1.1    jruoho  *              InitialTableCount   - Size of InitialTableArray, in number of
    196   1.1    jruoho  *                                    ACPI_TABLE_DESC structures
    197   1.5  christos  *              AllowResize         - Flag to tell Table Manager if resize of
    198   1.1    jruoho  *                                    pre-allocated array is allowed. Ignored
    199   1.1    jruoho  *                                    if InitialTableArray is NULL.
    200   1.1    jruoho  *
    201   1.1    jruoho  * RETURN:      Status
    202   1.1    jruoho  *
    203   1.1    jruoho  * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
    204   1.1    jruoho  *
    205   1.1    jruoho  * NOTE:        Allows static allocation of the initial table array in order
    206   1.1    jruoho  *              to avoid the use of dynamic memory in confined environments
    207   1.1    jruoho  *              such as the kernel boot sequence where it may not be available.
    208   1.1    jruoho  *
    209   1.1    jruoho  *              If the host OS memory managers are initialized, use NULL for
    210   1.1    jruoho  *              InitialTableArray, and the table will be dynamically allocated.
    211   1.1    jruoho  *
    212   1.1    jruoho  ******************************************************************************/
    213   1.1    jruoho 
    214  1.10  christos ACPI_STATUS ACPI_INIT_FUNCTION
    215   1.1    jruoho AcpiInitializeTables (
    216   1.1    jruoho     ACPI_TABLE_DESC         *InitialTableArray,
    217   1.1    jruoho     UINT32                  InitialTableCount,
    218   1.1    jruoho     BOOLEAN                 AllowResize)
    219   1.1    jruoho {
    220   1.1    jruoho     ACPI_PHYSICAL_ADDRESS   RsdpAddress;
    221   1.1    jruoho     ACPI_STATUS             Status;
    222   1.1    jruoho 
    223   1.1    jruoho 
    224   1.1    jruoho     ACPI_FUNCTION_TRACE (AcpiInitializeTables);
    225   1.1    jruoho 
    226   1.1    jruoho 
    227   1.1    jruoho     /*
    228   1.5  christos      * Setup the Root Table Array and allocate the table array
    229   1.5  christos      * if requested
    230   1.1    jruoho      */
    231   1.1    jruoho     if (!InitialTableArray)
    232   1.1    jruoho     {
    233   1.1    jruoho         Status = AcpiAllocateRootTable (InitialTableCount);
    234   1.1    jruoho         if (ACPI_FAILURE (Status))
    235   1.1    jruoho         {
    236   1.1    jruoho             return_ACPI_STATUS (Status);
    237   1.1    jruoho         }
    238   1.1    jruoho     }
    239   1.1    jruoho     else
    240   1.1    jruoho     {
    241   1.1    jruoho         /* Root Table Array has been statically allocated by the host */
    242   1.1    jruoho 
    243   1.8  christos         memset (InitialTableArray, 0,
    244   1.1    jruoho             (ACPI_SIZE) InitialTableCount * sizeof (ACPI_TABLE_DESC));
    245   1.1    jruoho 
    246   1.1    jruoho         AcpiGbl_RootTableList.Tables = InitialTableArray;
    247   1.1    jruoho         AcpiGbl_RootTableList.MaxTableCount = InitialTableCount;
    248   1.1    jruoho         AcpiGbl_RootTableList.Flags = ACPI_ROOT_ORIGIN_UNKNOWN;
    249   1.1    jruoho         if (AllowResize)
    250   1.1    jruoho         {
    251   1.1    jruoho             AcpiGbl_RootTableList.Flags |= ACPI_ROOT_ALLOW_RESIZE;
    252   1.1    jruoho         }
    253   1.1    jruoho     }
    254   1.1    jruoho 
    255   1.1    jruoho     /* Get the address of the RSDP */
    256   1.1    jruoho 
    257   1.1    jruoho     RsdpAddress = AcpiOsGetRootPointer ();
    258   1.1    jruoho     if (!RsdpAddress)
    259   1.1    jruoho     {
    260   1.1    jruoho         return_ACPI_STATUS (AE_NOT_FOUND);
    261   1.1    jruoho     }
    262   1.1    jruoho 
    263   1.1    jruoho     /*
    264   1.1    jruoho      * Get the root table (RSDT or XSDT) and extract all entries to the local
    265   1.1    jruoho      * Root Table Array. This array contains the information of the RSDT/XSDT
    266  1.14  christos      * in a common, more usable format.
    267   1.1    jruoho      */
    268   1.1    jruoho     Status = AcpiTbParseRootTable (RsdpAddress);
    269   1.1    jruoho     return_ACPI_STATUS (Status);
    270   1.1    jruoho }
    271   1.1    jruoho 
    272   1.5  christos ACPI_EXPORT_SYMBOL_INIT (AcpiInitializeTables)
    273   1.1    jruoho 
    274   1.1    jruoho 
    275   1.1    jruoho /*******************************************************************************
    276   1.1    jruoho  *
    277   1.1    jruoho  * FUNCTION:    AcpiReallocateRootTable
    278   1.1    jruoho  *
    279   1.1    jruoho  * PARAMETERS:  None
    280   1.1    jruoho  *
    281   1.1    jruoho  * RETURN:      Status
    282   1.1    jruoho  *
    283   1.1    jruoho  * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
    284   1.1    jruoho  *              root list from the previously provided scratch area. Should
    285   1.1    jruoho  *              be called once dynamic memory allocation is available in the
    286   1.5  christos  *              kernel.
    287   1.1    jruoho  *
    288   1.1    jruoho  ******************************************************************************/
    289   1.1    jruoho 
    290  1.10  christos ACPI_STATUS ACPI_INIT_FUNCTION
    291   1.1    jruoho AcpiReallocateRootTable (
    292   1.1    jruoho     void)
    293   1.1    jruoho {
    294   1.5  christos     ACPI_STATUS             Status;
    295  1.12  christos     ACPI_TABLE_DESC         *TableDesc;
    296  1.12  christos     UINT32                  i, j;
    297   1.1    jruoho 
    298   1.1    jruoho 
    299   1.1    jruoho     ACPI_FUNCTION_TRACE (AcpiReallocateRootTable);
    300   1.1    jruoho 
    301   1.1    jruoho 
    302   1.1    jruoho     /*
    303  1.12  christos      * If there are tables unverified, it is required to reallocate the
    304  1.12  christos      * root table list to clean up invalid table entries. Otherwise only
    305  1.12  christos      * reallocate the root table list if the host provided a static buffer
    306  1.12  christos      * for the table array in the call to AcpiInitializeTables().
    307   1.1    jruoho      */
    308  1.12  christos     if ((AcpiGbl_RootTableList.Flags & ACPI_ROOT_ORIGIN_ALLOCATED) &&
    309  1.12  christos         AcpiGbl_EnableTableValidation)
    310   1.1    jruoho     {
    311   1.1    jruoho         return_ACPI_STATUS (AE_SUPPORT);
    312   1.1    jruoho     }
    313   1.1    jruoho 
    314  1.12  christos     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
    315  1.12  christos 
    316  1.11  christos     /*
    317  1.11  christos      * Ensure OS early boot logic, which is required by some hosts. If the
    318  1.11  christos      * table state is reported to be wrong, developers should fix the
    319  1.11  christos      * issue by invoking AcpiPutTable() for the reported table during the
    320  1.11  christos      * early stage.
    321  1.11  christos      */
    322  1.11  christos     for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
    323  1.11  christos     {
    324  1.12  christos         TableDesc = &AcpiGbl_RootTableList.Tables[i];
    325  1.12  christos         if (TableDesc->Pointer)
    326  1.11  christos         {
    327  1.11  christos             ACPI_ERROR ((AE_INFO,
    328  1.11  christos                 "Table [%4.4s] is not invalidated during early boot stage",
    329  1.12  christos                 TableDesc->Signature.Ascii));
    330  1.12  christos         }
    331  1.12  christos     }
    332  1.12  christos 
    333  1.12  christos     if (!AcpiGbl_EnableTableValidation)
    334  1.12  christos     {
    335  1.12  christos         /*
    336  1.12  christos          * Now it's safe to do full table validation. We can do deferred
    337  1.14  christos          * table initialization here once the flag is set.
    338  1.12  christos          */
    339  1.12  christos         AcpiGbl_EnableTableValidation = TRUE;
    340  1.12  christos         for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
    341  1.12  christos         {
    342  1.12  christos             TableDesc = &AcpiGbl_RootTableList.Tables[i];
    343  1.12  christos             if (!(TableDesc->Flags & ACPI_TABLE_IS_VERIFIED))
    344  1.12  christos             {
    345  1.12  christos                 Status = AcpiTbVerifyTempTable (TableDesc, NULL, &j);
    346  1.12  christos                 if (ACPI_FAILURE (Status))
    347  1.12  christos                 {
    348  1.12  christos                     AcpiTbUninstallTable (TableDesc);
    349  1.12  christos                 }
    350  1.12  christos             }
    351  1.11  christos         }
    352  1.11  christos     }
    353  1.11  christos 
    354   1.5  christos     AcpiGbl_RootTableList.Flags |= ACPI_ROOT_ALLOW_RESIZE;
    355  1.12  christos     Status = AcpiTbResizeRootTableList ();
    356  1.12  christos     AcpiGbl_RootTableList.Flags |= ACPI_ROOT_ORIGIN_ALLOCATED;
    357   1.1    jruoho 
    358  1.12  christos     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
    359   1.5  christos     return_ACPI_STATUS (Status);
    360   1.1    jruoho }
    361   1.1    jruoho 
    362   1.5  christos ACPI_EXPORT_SYMBOL_INIT (AcpiReallocateRootTable)
    363   1.1    jruoho 
    364   1.1    jruoho 
    365   1.1    jruoho /*******************************************************************************
    366   1.1    jruoho  *
    367   1.1    jruoho  * FUNCTION:    AcpiGetTableHeader
    368   1.1    jruoho  *
    369   1.1    jruoho  * PARAMETERS:  Signature           - ACPI signature of needed table
    370   1.1    jruoho  *              Instance            - Which instance (for SSDTs)
    371  1.15  christos  *              OutTableHeader      - The pointer to the where the table header
    372  1.15  christos  *                                    is returned
    373   1.1    jruoho  *
    374  1.15  christos  * RETURN:      Status and a copy of the table header
    375   1.1    jruoho  *
    376  1.15  christos  * DESCRIPTION: Finds and returns an ACPI table header. Caller provides the
    377  1.15  christos  *              memory where a copy of the header is to be returned
    378  1.15  christos  *              (fixed length).
    379   1.1    jruoho  *
    380   1.1    jruoho  ******************************************************************************/
    381   1.1    jruoho 
    382   1.1    jruoho ACPI_STATUS
    383   1.1    jruoho AcpiGetTableHeader (
    384   1.2    jruoho     ACPI_CONST_STRING       Signature,
    385   1.1    jruoho     UINT32                  Instance,
    386   1.1    jruoho     ACPI_TABLE_HEADER       *OutTableHeader)
    387   1.1    jruoho {
    388   1.1    jruoho     UINT32                  i;
    389   1.1    jruoho     UINT32                  j;
    390   1.1    jruoho     ACPI_TABLE_HEADER       *Header;
    391   1.1    jruoho 
    392  1.16       rin 
    393   1.1    jruoho     /* Parameter validation */
    394   1.1    jruoho 
    395   1.1    jruoho     if (!Signature || !OutTableHeader)
    396   1.1    jruoho     {
    397   1.1    jruoho         return (AE_BAD_PARAMETER);
    398   1.1    jruoho     }
    399   1.1    jruoho 
    400   1.1    jruoho     /* Walk the root table list */
    401   1.1    jruoho 
    402   1.1    jruoho     for (i = 0, j = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++)
    403   1.1    jruoho     {
    404  1.14  christos         if (!ACPI_COMPARE_NAMESEG (
    405   1.9  christos                 &(AcpiGbl_RootTableList.Tables[i].Signature), Signature))
    406   1.1    jruoho         {
    407   1.1    jruoho             continue;
    408   1.1    jruoho         }
    409   1.1    jruoho 
    410   1.1    jruoho         if (++j < Instance)
    411   1.1    jruoho         {
    412   1.1    jruoho             continue;
    413   1.1    jruoho         }
    414   1.1    jruoho 
    415   1.1    jruoho         if (!AcpiGbl_RootTableList.Tables[i].Pointer)
    416   1.1    jruoho         {
    417   1.1    jruoho             if ((AcpiGbl_RootTableList.Tables[i].Flags &
    418   1.1    jruoho                     ACPI_TABLE_ORIGIN_MASK) ==
    419   1.6  christos                 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL)
    420   1.1    jruoho             {
    421   1.1    jruoho                 Header = AcpiOsMapMemory (
    422   1.9  christos                     AcpiGbl_RootTableList.Tables[i].Address,
    423   1.9  christos                     sizeof (ACPI_TABLE_HEADER));
    424   1.1    jruoho                 if (!Header)
    425   1.1    jruoho                 {
    426   1.5  christos                     return (AE_NO_MEMORY);
    427   1.1    jruoho                 }
    428   1.1    jruoho 
    429   1.9  christos                 memcpy (OutTableHeader, Header, sizeof (ACPI_TABLE_HEADER));
    430   1.5  christos                 AcpiOsUnmapMemory (Header, sizeof (ACPI_TABLE_HEADER));
    431   1.1    jruoho             }
    432   1.1    jruoho             else
    433   1.1    jruoho             {
    434   1.5  christos                 return (AE_NOT_FOUND);
    435   1.1    jruoho             }
    436   1.1    jruoho         }
    437   1.1    jruoho         else
    438   1.1    jruoho         {
    439   1.8  christos             memcpy (OutTableHeader,
    440   1.1    jruoho                 AcpiGbl_RootTableList.Tables[i].Pointer,
    441   1.5  christos                 sizeof (ACPI_TABLE_HEADER));
    442   1.1    jruoho         }
    443   1.1    jruoho 
    444   1.1    jruoho         return (AE_OK);
    445   1.1    jruoho     }
    446   1.1    jruoho 
    447   1.1    jruoho     return (AE_NOT_FOUND);
    448   1.1    jruoho }
    449   1.1    jruoho 
    450   1.1    jruoho ACPI_EXPORT_SYMBOL (AcpiGetTableHeader)
    451   1.1    jruoho 
    452   1.1    jruoho 
    453   1.1    jruoho /*******************************************************************************
    454   1.1    jruoho  *
    455   1.1    jruoho  * FUNCTION:    AcpiGetTable
    456   1.1    jruoho  *
    457   1.1    jruoho  * PARAMETERS:  Signature           - ACPI signature of needed table
    458   1.1    jruoho  *              Instance            - Which instance (for SSDTs)
    459   1.1    jruoho  *              OutTable            - Where the pointer to the table is returned
    460   1.1    jruoho  *
    461   1.5  christos  * RETURN:      Status and pointer to the requested table
    462   1.1    jruoho  *
    463   1.5  christos  * DESCRIPTION: Finds and verifies an ACPI table. Table must be in the
    464   1.5  christos  *              RSDT/XSDT.
    465  1.11  christos  *              Note that an early stage AcpiGetTable() call must be paired
    466  1.11  christos  *              with an early stage AcpiPutTable() call. otherwise the table
    467  1.11  christos  *              pointer mapped by the early stage mapping implementation may be
    468  1.11  christos  *              erroneously unmapped by the late stage unmapping implementation
    469  1.11  christos  *              in an AcpiPutTable() invoked during the late stage.
    470   1.1    jruoho  *
    471   1.1    jruoho  ******************************************************************************/
    472   1.1    jruoho 
    473   1.1    jruoho ACPI_STATUS
    474   1.1    jruoho AcpiGetTable (
    475   1.2    jruoho     ACPI_CONST_STRING       Signature,
    476   1.1    jruoho     UINT32                  Instance,
    477   1.1    jruoho     ACPI_TABLE_HEADER       **OutTable)
    478   1.1    jruoho {
    479   1.1    jruoho     UINT32                  i;
    480   1.1    jruoho     UINT32                  j;
    481  1.11  christos     ACPI_STATUS             Status = AE_NOT_FOUND;
    482  1.11  christos     ACPI_TABLE_DESC         *TableDesc;
    483   1.1    jruoho 
    484  1.16       rin 
    485   1.1    jruoho     /* Parameter validation */
    486   1.1    jruoho 
    487   1.1    jruoho     if (!Signature || !OutTable)
    488   1.1    jruoho     {
    489   1.1    jruoho         return (AE_BAD_PARAMETER);
    490   1.1    jruoho     }
    491   1.1    jruoho 
    492  1.11  christos     /*
    493  1.11  christos      * Note that the following line is required by some OSPMs, they only
    494  1.11  christos      * check if the returned table is NULL instead of the returned status
    495  1.11  christos      * to determined if this function is succeeded.
    496  1.11  christos      */
    497  1.11  christos     *OutTable = NULL;
    498  1.11  christos 
    499  1.11  christos     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
    500  1.11  christos 
    501   1.1    jruoho     /* Walk the root table list */
    502   1.1    jruoho 
    503   1.1    jruoho     for (i = 0, j = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++)
    504   1.1    jruoho     {
    505  1.11  christos         TableDesc = &AcpiGbl_RootTableList.Tables[i];
    506  1.11  christos 
    507  1.14  christos         if (!ACPI_COMPARE_NAMESEG (&TableDesc->Signature, Signature))
    508   1.1    jruoho         {
    509   1.1    jruoho             continue;
    510   1.1    jruoho         }
    511   1.1    jruoho 
    512   1.1    jruoho         if (++j < Instance)
    513   1.1    jruoho         {
    514   1.1    jruoho             continue;
    515   1.1    jruoho         }
    516   1.1    jruoho 
    517  1.11  christos         Status = AcpiTbGetTable (TableDesc, OutTable);
    518  1.11  christos         break;
    519  1.11  christos     }
    520  1.11  christos 
    521  1.11  christos     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
    522  1.11  christos     return (Status);
    523  1.11  christos }
    524  1.11  christos 
    525  1.11  christos ACPI_EXPORT_SYMBOL (AcpiGetTable)
    526  1.11  christos 
    527  1.11  christos 
    528  1.11  christos /*******************************************************************************
    529  1.11  christos  *
    530  1.11  christos  * FUNCTION:    AcpiPutTable
    531  1.11  christos  *
    532  1.11  christos  * PARAMETERS:  Table               - The pointer to the table
    533  1.11  christos  *
    534  1.11  christos  * RETURN:      None
    535  1.11  christos  *
    536  1.11  christos  * DESCRIPTION: Release a table returned by AcpiGetTable() and its clones.
    537  1.11  christos  *              Note that it is not safe if this function was invoked after an
    538  1.11  christos  *              uninstallation happened to the original table descriptor.
    539  1.11  christos  *              Currently there is no OSPMs' requirement to handle such
    540  1.11  christos  *              situations.
    541  1.11  christos  *
    542  1.11  christos  ******************************************************************************/
    543  1.11  christos 
    544  1.11  christos void
    545  1.11  christos AcpiPutTable (
    546  1.11  christos     ACPI_TABLE_HEADER       *Table)
    547  1.11  christos {
    548  1.11  christos     UINT32                  i;
    549  1.11  christos     ACPI_TABLE_DESC         *TableDesc;
    550  1.11  christos 
    551  1.11  christos 
    552  1.11  christos     ACPI_FUNCTION_TRACE (AcpiPutTable);
    553  1.11  christos 
    554  1.11  christos 
    555  1.12  christos     if (!Table)
    556  1.12  christos     {
    557  1.12  christos         return_VOID;
    558  1.12  christos     }
    559  1.12  christos 
    560  1.11  christos     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
    561  1.11  christos 
    562  1.11  christos     /* Walk the root table list */
    563  1.11  christos 
    564  1.11  christos     for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++)
    565  1.11  christos     {
    566  1.11  christos         TableDesc = &AcpiGbl_RootTableList.Tables[i];
    567  1.11  christos 
    568  1.11  christos         if (TableDesc->Pointer != Table)
    569   1.1    jruoho         {
    570  1.11  christos             continue;
    571   1.1    jruoho         }
    572   1.1    jruoho 
    573  1.11  christos         AcpiTbPutTable (TableDesc);
    574  1.11  christos         break;
    575   1.1    jruoho     }
    576   1.1    jruoho 
    577  1.11  christos     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
    578  1.11  christos     return_VOID;
    579   1.1    jruoho }
    580   1.1    jruoho 
    581  1.11  christos ACPI_EXPORT_SYMBOL (AcpiPutTable)
    582   1.1    jruoho 
    583   1.1    jruoho 
    584   1.1    jruoho /*******************************************************************************
    585   1.1    jruoho  *
    586   1.1    jruoho  * FUNCTION:    AcpiGetTableByIndex
    587   1.1    jruoho  *
    588   1.1    jruoho  * PARAMETERS:  TableIndex          - Table index
    589  1.11  christos  *              OutTable            - Where the pointer to the table is returned
    590   1.1    jruoho  *
    591   1.5  christos  * RETURN:      Status and pointer to the requested table
    592   1.1    jruoho  *
    593   1.5  christos  * DESCRIPTION: Obtain a table by an index into the global table list. Used
    594   1.5  christos  *              internally also.
    595   1.1    jruoho  *
    596   1.1    jruoho  ******************************************************************************/
    597   1.1    jruoho 
    598   1.1    jruoho ACPI_STATUS
    599   1.1    jruoho AcpiGetTableByIndex (
    600   1.1    jruoho     UINT32                  TableIndex,
    601  1.11  christos     ACPI_TABLE_HEADER       **OutTable)
    602   1.1    jruoho {
    603   1.1    jruoho     ACPI_STATUS             Status;
    604   1.1    jruoho 
    605   1.1    jruoho 
    606   1.1    jruoho     ACPI_FUNCTION_TRACE (AcpiGetTableByIndex);
    607   1.1    jruoho 
    608   1.1    jruoho 
    609   1.1    jruoho     /* Parameter validation */
    610   1.1    jruoho 
    611  1.11  christos     if (!OutTable)
    612   1.1    jruoho     {
    613   1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    614   1.1    jruoho     }
    615   1.1    jruoho 
    616  1.11  christos     /*
    617  1.11  christos      * Note that the following line is required by some OSPMs, they only
    618  1.11  christos      * check if the returned table is NULL instead of the returned status
    619  1.11  christos      * to determined if this function is succeeded.
    620  1.11  christos      */
    621  1.11  christos     *OutTable = NULL;
    622  1.11  christos 
    623   1.1    jruoho     (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
    624   1.1    jruoho 
    625   1.1    jruoho     /* Validate index */
    626   1.1    jruoho 
    627   1.1    jruoho     if (TableIndex >= AcpiGbl_RootTableList.CurrentTableCount)
    628   1.1    jruoho     {
    629  1.11  christos         Status = AE_BAD_PARAMETER;
    630  1.11  christos         goto UnlockAndExit;
    631   1.1    jruoho     }
    632   1.1    jruoho 
    633  1.11  christos     Status = AcpiTbGetTable (
    634  1.11  christos         &AcpiGbl_RootTableList.Tables[TableIndex], OutTable);
    635   1.1    jruoho 
    636  1.11  christos UnlockAndExit:
    637   1.1    jruoho     (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
    638  1.11  christos     return_ACPI_STATUS (Status);
    639   1.1    jruoho }
    640   1.1    jruoho 
    641   1.1    jruoho ACPI_EXPORT_SYMBOL (AcpiGetTableByIndex)
    642   1.1    jruoho 
    643   1.1    jruoho 
    644   1.1    jruoho /*******************************************************************************
    645   1.1    jruoho  *
    646   1.1    jruoho  * FUNCTION:    AcpiInstallTableHandler
    647   1.1    jruoho  *
    648   1.1    jruoho  * PARAMETERS:  Handler         - Table event handler
    649   1.1    jruoho  *              Context         - Value passed to the handler on each event
    650   1.1    jruoho  *
    651   1.1    jruoho  * RETURN:      Status
    652   1.1    jruoho  *
    653   1.5  christos  * DESCRIPTION: Install a global table event handler.
    654   1.1    jruoho  *
    655   1.1    jruoho  ******************************************************************************/
    656   1.1    jruoho 
    657   1.1    jruoho ACPI_STATUS
    658   1.1    jruoho AcpiInstallTableHandler (
    659   1.1    jruoho     ACPI_TABLE_HANDLER      Handler,
    660   1.1    jruoho     void                    *Context)
    661   1.1    jruoho {
    662   1.1    jruoho     ACPI_STATUS             Status;
    663   1.1    jruoho 
    664   1.1    jruoho 
    665   1.1    jruoho     ACPI_FUNCTION_TRACE (AcpiInstallTableHandler);
    666   1.1    jruoho 
    667   1.1    jruoho 
    668   1.1    jruoho     if (!Handler)
    669   1.1    jruoho     {
    670   1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    671   1.1    jruoho     }
    672   1.1    jruoho 
    673   1.1    jruoho     Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
    674   1.1    jruoho     if (ACPI_FAILURE (Status))
    675   1.1    jruoho     {
    676   1.1    jruoho         return_ACPI_STATUS (Status);
    677   1.1    jruoho     }
    678   1.1    jruoho 
    679   1.1    jruoho     /* Don't allow more than one handler */
    680   1.1    jruoho 
    681   1.1    jruoho     if (AcpiGbl_TableHandler)
    682   1.1    jruoho     {
    683   1.1    jruoho         Status = AE_ALREADY_EXISTS;
    684   1.1    jruoho         goto Cleanup;
    685   1.1    jruoho     }
    686   1.1    jruoho 
    687   1.1    jruoho     /* Install the handler */
    688   1.1    jruoho 
    689   1.1    jruoho     AcpiGbl_TableHandler = Handler;
    690   1.1    jruoho     AcpiGbl_TableHandlerContext = Context;
    691   1.1    jruoho 
    692   1.1    jruoho Cleanup:
    693   1.1    jruoho     (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
    694   1.1    jruoho     return_ACPI_STATUS (Status);
    695   1.1    jruoho }
    696   1.1    jruoho 
    697   1.1    jruoho ACPI_EXPORT_SYMBOL (AcpiInstallTableHandler)
    698   1.1    jruoho 
    699   1.1    jruoho 
    700   1.1    jruoho /*******************************************************************************
    701   1.1    jruoho  *
    702   1.1    jruoho  * FUNCTION:    AcpiRemoveTableHandler
    703   1.1    jruoho  *
    704   1.1    jruoho  * PARAMETERS:  Handler         - Table event handler that was installed
    705   1.1    jruoho  *                                previously.
    706   1.1    jruoho  *
    707   1.1    jruoho  * RETURN:      Status
    708   1.1    jruoho  *
    709   1.5  christos  * DESCRIPTION: Remove a table event handler
    710   1.1    jruoho  *
    711   1.1    jruoho  ******************************************************************************/
    712   1.1    jruoho 
    713   1.1    jruoho ACPI_STATUS
    714   1.1    jruoho AcpiRemoveTableHandler (
    715   1.1    jruoho     ACPI_TABLE_HANDLER      Handler)
    716   1.1    jruoho {
    717   1.1    jruoho     ACPI_STATUS             Status;
    718   1.1    jruoho 
    719   1.1    jruoho 
    720   1.1    jruoho     ACPI_FUNCTION_TRACE (AcpiRemoveTableHandler);
    721   1.1    jruoho 
    722   1.1    jruoho 
    723   1.1    jruoho     Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
    724   1.1    jruoho     if (ACPI_FAILURE (Status))
    725   1.1    jruoho     {
    726   1.1    jruoho         return_ACPI_STATUS (Status);
    727   1.1    jruoho     }
    728   1.1    jruoho 
    729   1.1    jruoho     /* Make sure that the installed handler is the same */
    730   1.1    jruoho 
    731   1.1    jruoho     if (!Handler ||
    732   1.1    jruoho         Handler != AcpiGbl_TableHandler)
    733   1.1    jruoho     {
    734   1.1    jruoho         Status = AE_BAD_PARAMETER;
    735   1.1    jruoho         goto Cleanup;
    736   1.1    jruoho     }
    737   1.1    jruoho 
    738   1.1    jruoho     /* Remove the handler */
    739   1.1    jruoho 
    740   1.1    jruoho     AcpiGbl_TableHandler = NULL;
    741   1.1    jruoho 
    742   1.1    jruoho Cleanup:
    743   1.1    jruoho     (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
    744   1.1    jruoho     return_ACPI_STATUS (Status);
    745   1.1    jruoho }
    746   1.1    jruoho 
    747   1.1    jruoho ACPI_EXPORT_SYMBOL (AcpiRemoveTableHandler)
    748