Home | History | Annotate | Line # | Download | only in include
      1 /******************************************************************************
      2  *
      3  * Name: actables.h - ACPI table management
      4  *
      5  *****************************************************************************/
      6 
      7 /******************************************************************************
      8  *
      9  * 1. Copyright Notice
     10  *
     11  * Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
     12  * All rights reserved.
     13  *
     14  * 2. License
     15  *
     16  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  * rights. You may have additional license terms from the party that provided
     18  * you this software, covering your right to use that party's intellectual
     19  * property rights.
     20  *
     21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  * copy of the source code appearing in this file ("Covered Code") an
     23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  * make derivatives, distribute, use and display any portion of the Covered
     26  * Code in any form, with the right to sublicense such rights; and
     27  *
     28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  * license (with the right to sublicense), under only those claims of Intel
     30  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  * offer to sell, and import the Covered Code and derivative works thereof
     32  * solely to the minimum extent necessary to exercise the above copyright
     33  * license, and in no event shall the patent license extend to any additions
     34  * to or modifications of the Original Intel Code. No other license or right
     35  * is granted directly or by implication, estoppel or otherwise;
     36  *
     37  * The above copyright and patent license is granted only if the following
     38  * conditions are met:
     39  *
     40  * 3. Conditions
     41  *
     42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  * Redistribution of source code of any substantial portion of the Covered
     44  * Code or modification with rights to further distribute source must include
     45  * the above Copyright Notice, the above License, this list of Conditions,
     46  * and the following Disclaimer and Export Compliance provision. In addition,
     47  * Licensee must cause all Covered Code to which Licensee contributes to
     48  * contain a file documenting the changes Licensee made to create that Covered
     49  * Code and the date of any change. Licensee must include in that file the
     50  * documentation of any changes made by any predecessor Licensee. Licensee
     51  * must include a prominent statement that the modification is derived,
     52  * directly or indirectly, from Original Intel Code.
     53  *
     54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  * Redistribution of source code of any substantial portion of the Covered
     56  * Code or modification without rights to further distribute source must
     57  * include the following Disclaimer and Export Compliance provision in the
     58  * documentation and/or other materials provided with distribution. In
     59  * addition, Licensee may not authorize further sublicense of source of any
     60  * portion of the Covered Code, and must include terms to the effect that the
     61  * license from Licensee to its licensee is limited to the intellectual
     62  * property embodied in the software Licensee provides to its licensee, and
     63  * not to intellectual property embodied in modifications its licensee may
     64  * make.
     65  *
     66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  * substantial portion of the Covered Code or modification must reproduce the
     68  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  * provision in the documentation and/or other materials provided with the
     70  * distribution.
     71  *
     72  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  * Intel Code.
     74  *
     75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  * other dealings in products derived from or relating to the Covered Code
     78  * without prior written authorization from Intel.
     79  *
     80  * 4. Disclaimer and Export Compliance
     81  *
     82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  * PARTICULAR PURPOSE.
     89  *
     90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  * LIMITED REMEDY.
     98  *
     99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  * software or system incorporating such software without first obtaining any
    101  * required license or other approval from the U. S. Department of Commerce or
    102  * any other agency or department of the United States Government. In the
    103  * event Licensee exports any such software from the United States or
    104  * re-exports any such software from a foreign destination, Licensee shall
    105  * ensure that the distribution and export/re-export of the software is in
    106  * compliance with all laws, regulations, orders, or other restrictions of the
    107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  * any of its subsidiaries will export/re-export any technical data, process,
    109  * software, or service, directly or indirectly, to any country for which the
    110  * United States government or any agency thereof requires an export license,
    111  * other governmental approval, or letter of assurance, without first obtaining
    112  * such license, approval or letter.
    113  *
    114  *****************************************************************************
    115  *
    116  * Alternatively, you may choose to be licensed under the terms of the
    117  * following license:
    118  *
    119  * Redistribution and use in source and binary forms, with or without
    120  * modification, are permitted provided that the following conditions
    121  * are met:
    122  * 1. Redistributions of source code must retain the above copyright
    123  *    notice, this list of conditions, and the following disclaimer,
    124  *    without modification.
    125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    126  *    substantially similar to the "NO WARRANTY" disclaimer below
    127  *    ("Disclaimer") and any redistribution must be conditioned upon
    128  *    including a substantially similar Disclaimer requirement for further
    129  *    binary redistribution.
    130  * 3. Neither the names of the above-listed copyright holders nor the names
    131  *    of any contributors may be used to endorse or promote products derived
    132  *    from this software without specific prior written permission.
    133  *
    134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    145  *
    146  * Alternatively, you may choose to be licensed under the terms of the
    147  * GNU General Public License ("GPL") version 2 as published by the Free
    148  * Software Foundation.
    149  *
    150  *****************************************************************************/
    151 
    152 #ifndef __ACTABLES_H__
    153 #define __ACTABLES_H__
    154 
    155 
    156 ACPI_STATUS
    157 AcpiAllocateRootTable (
    158     UINT32                  InitialTableCount);
    159 
    160 /*
    161  * tbxfroot - Root pointer utilities
    162  */
    163 UINT32
    164 AcpiTbGetRsdpLength (
    165     ACPI_TABLE_RSDP         *Rsdp);
    166 
    167 ACPI_STATUS
    168 AcpiTbValidateRsdp (
    169     ACPI_TABLE_RSDP         *Rsdp);
    170 
    171 UINT8 *
    172 AcpiTbScanMemoryForRsdp (
    173     UINT8                   *StartAddress,
    174     UINT32                  Length);
    175 
    176 
    177 /*
    178  * tbdata - table data structure management
    179  */
    180 ACPI_STATUS
    181 AcpiTbGetNextTableDescriptor (
    182     UINT32                  *TableIndex,
    183     ACPI_TABLE_DESC         **TableDesc);
    184 
    185 void
    186 AcpiTbInitTableDescriptor (
    187     ACPI_TABLE_DESC         *TableDesc,
    188     ACPI_PHYSICAL_ADDRESS   Address,
    189     UINT8                   Flags,
    190     ACPI_TABLE_HEADER       *Table);
    191 
    192 ACPI_STATUS
    193 AcpiTbAcquireTempTable (
    194     ACPI_TABLE_DESC         *TableDesc,
    195     ACPI_PHYSICAL_ADDRESS   Address,
    196     UINT8                   Flags,
    197     ACPI_TABLE_HEADER       *Table);
    198 
    199 void
    200 AcpiTbReleaseTempTable (
    201     ACPI_TABLE_DESC         *TableDesc);
    202 
    203 ACPI_STATUS
    204 AcpiTbValidateTempTable (
    205     ACPI_TABLE_DESC         *TableDesc);
    206 
    207 ACPI_STATUS
    208 AcpiTbVerifyTempTable (
    209     ACPI_TABLE_DESC         *TableDesc,
    210     const char              *Signature,
    211     UINT32                  *TableIndex);
    212 
    213 BOOLEAN
    214 AcpiTbIsTableLoaded (
    215     UINT32                  TableIndex);
    216 
    217 void
    218 AcpiTbSetTableLoadedFlag (
    219     UINT32                  TableIndex,
    220     BOOLEAN                 IsLoaded);
    221 
    222 
    223 /*
    224  * tbfadt - FADT parse/convert/validate
    225  */
    226 void
    227 AcpiTbParseFadt (
    228     void);
    229 
    230 void
    231 AcpiTbCreateLocalFadt (
    232     ACPI_TABLE_HEADER       *Table,
    233     UINT32                  Length);
    234 
    235 
    236 /*
    237  * tbfind - find ACPI table
    238  */
    239 ACPI_STATUS
    240 AcpiTbFindTable (
    241     char                    *Signature,
    242     char                    *OemId,
    243     char                    *OemTableId,
    244     UINT32                  *TableIndex);
    245 
    246 
    247 /*
    248  * tbinstal - Table removal and deletion
    249  */
    250 ACPI_STATUS
    251 AcpiTbResizeRootTableList (
    252     void);
    253 
    254 ACPI_STATUS
    255 AcpiTbValidateTable (
    256     ACPI_TABLE_DESC         *TableDesc);
    257 
    258 void
    259 AcpiTbInvalidateTable (
    260     ACPI_TABLE_DESC         *TableDesc);
    261 
    262 void
    263 AcpiTbOverrideTable (
    264     ACPI_TABLE_DESC         *OldTableDesc);
    265 
    266 ACPI_STATUS
    267 AcpiTbAcquireTable (
    268     ACPI_TABLE_DESC         *TableDesc,
    269     ACPI_TABLE_HEADER       **TablePtr,
    270     UINT32                  *TableLength,
    271     UINT8                   *TableFlags);
    272 
    273 void
    274 AcpiTbReleaseTable (
    275     ACPI_TABLE_HEADER       *Table,
    276     UINT32                  TableLength,
    277     UINT8                   TableFlags);
    278 
    279 ACPI_STATUS
    280 AcpiTbInstallStandardTable (
    281     ACPI_PHYSICAL_ADDRESS   Address,
    282     UINT8                   Flags,
    283     ACPI_TABLE_HEADER       *Table,
    284     BOOLEAN                 Reload,
    285     BOOLEAN                 Override,
    286     UINT32                  *TableIndex);
    287 
    288 void
    289 AcpiTbUninstallTable (
    290     ACPI_TABLE_DESC        *TableDesc);
    291 
    292 ACPI_STATUS
    293 AcpiTbLoadTable (
    294     UINT32                  TableIndex,
    295     ACPI_NAMESPACE_NODE     *ParentNode);
    296 
    297 ACPI_STATUS
    298 AcpiTbInstallAndLoadTable (
    299     ACPI_PHYSICAL_ADDRESS   Address,
    300     UINT8                   Flags,
    301     ACPI_TABLE_HEADER       *Table,
    302     BOOLEAN                 Override,
    303     UINT32                  *TableIndex);
    304 
    305 ACPI_STATUS
    306 AcpiTbUnloadTable (
    307     UINT32                  TableIndex);
    308 
    309 void
    310 AcpiTbNotifyTable (
    311     UINT32                          Event,
    312     void                            *Table);
    313 
    314 void
    315 AcpiTbTerminate (
    316     void);
    317 
    318 ACPI_STATUS
    319 AcpiTbDeleteNamespaceByOwner (
    320     UINT32                  TableIndex);
    321 
    322 ACPI_STATUS
    323 AcpiTbAllocateOwnerId (
    324     UINT32                  TableIndex);
    325 
    326 ACPI_STATUS
    327 AcpiTbReleaseOwnerId (
    328     UINT32                  TableIndex);
    329 
    330 ACPI_STATUS
    331 AcpiTbGetOwnerId (
    332     UINT32                  TableIndex,
    333     ACPI_OWNER_ID           *OwnerId);
    334 
    335 
    336 /*
    337  * tbutils - table manager utilities
    338  */
    339 ACPI_STATUS
    340 AcpiTbInitializeFacs (
    341     void);
    342 
    343 void
    344 AcpiTbPrintTableHeader(
    345     ACPI_PHYSICAL_ADDRESS   Address,
    346     ACPI_TABLE_HEADER       *Header);
    347 
    348 void
    349 AcpiTbCheckDsdtHeader (
    350     void);
    351 
    352 ACPI_TABLE_HEADER *
    353 AcpiTbCopyDsdt (
    354     UINT32                  TableIndex);
    355 
    356 void
    357 AcpiTbInstallTableWithOverride (
    358     ACPI_TABLE_DESC         *NewTableDesc,
    359     BOOLEAN                 Override,
    360     UINT32                  *TableIndex);
    361 
    362 ACPI_STATUS
    363 AcpiTbParseRootTable (
    364     ACPI_PHYSICAL_ADDRESS   RsdpAddress);
    365 
    366 ACPI_STATUS
    367 AcpiTbGetTable (
    368     ACPI_TABLE_DESC        *TableDesc,
    369     ACPI_TABLE_HEADER      **OutTable);
    370 
    371 void
    372 AcpiTbPutTable (
    373     ACPI_TABLE_DESC        *TableDesc);
    374 
    375 
    376 /*
    377  * tbxfload
    378  */
    379 ACPI_STATUS
    380 AcpiTbLoadNamespace (
    381     void);
    382 
    383 #endif /* __ACTABLES_H__ */
    384