acpi/acpica/actables.h

0001 /******************************************************************************
0002  *
0003  * Name: actables.h - ACPI table management
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 #ifndef __ACTABLES_H__
0153 #define __ACTABLES_H__
0154
0155
0156 ACPI_STATUS
0157 AcpiAllocateRootTable (
0158     UINT32                  InitialTableCount);
0159
0160 /*
0161  * tbxfroot - Root pointer utilities
0162  */
0163 UINT32
0164 AcpiTbGetRsdpLength (
0165     ACPI_TABLE_RSDP         *Rsdp);
0166
0167 ACPI_STATUS
0168 AcpiTbValidateRsdp (
0169     ACPI_TABLE_RSDP         *Rsdp);
0170
0171 UINT8 *
0172 AcpiTbScanMemoryForRsdp (
0173     UINT8                   *StartAddress,
0174     UINT32                  Length);
0175
0176
0177 /*
0178  * tbdata - table data structure management
0179  */
0180 ACPI_STATUS
0181 AcpiTbGetNextTableDescriptor (
0182     UINT32                  *TableIndex,
0183     ACPI_TABLE_DESC         **TableDesc);
0184
0185 void
0186 AcpiTbInitTableDescriptor (
0187     ACPI_TABLE_DESC         *TableDesc,
0188     ACPI_PHYSICAL_ADDRESS   Address,
0189     UINT8                   Flags,
0190     ACPI_TABLE_HEADER       *Table);
0191
0192 ACPI_STATUS
0193 AcpiTbAcquireTempTable (
0194     ACPI_TABLE_DESC         *TableDesc,
0195     ACPI_PHYSICAL_ADDRESS   Address,
0196     UINT8                   Flags,
0197     ACPI_TABLE_HEADER       *Table);
0198
0199 void
0200 AcpiTbReleaseTempTable (
0201     ACPI_TABLE_DESC         *TableDesc);
0202
0203 ACPI_STATUS
0204 AcpiTbValidateTempTable (
0205     ACPI_TABLE_DESC         *TableDesc);
0206
0207 ACPI_STATUS
0208 AcpiTbVerifyTempTable (
0209     ACPI_TABLE_DESC         *TableDesc,
0210     char                    *Signature,
0211     UINT32                  *TableIndex);
0212
0213 BOOLEAN
0214 AcpiTbIsTableLoaded (
0215     UINT32                  TableIndex);
0216
0217 void
0218 AcpiTbSetTableLoadedFlag (
0219     UINT32                  TableIndex,
0220     BOOLEAN                 IsLoaded);
0221
0222
0223 /*
0224  * tbfadt - FADT parse/convert/validate
0225  */
0226 void
0227 AcpiTbParseFadt (
0228     void);
0229
0230 void
0231 AcpiTbCreateLocalFadt (
0232     ACPI_TABLE_HEADER       *Table,
0233     UINT32                  Length);
0234
0235
0236 /*
0237  * tbfind - find ACPI table
0238  */
0239 ACPI_STATUS
0240 AcpiTbFindTable (
0241     char                    *Signature,
0242     char                    *OemId,
0243     char                    *OemTableId,
0244     UINT32                  *TableIndex);
0245
0246
0247 /*
0248  * tbinstal - Table removal and deletion
0249  */
0250 ACPI_STATUS
0251 AcpiTbResizeRootTableList (
0252     void);
0253
0254 ACPI_STATUS
0255 AcpiTbValidateTable (
0256     ACPI_TABLE_DESC         *TableDesc);
0257
0258 void
0259 AcpiTbInvalidateTable (
0260     ACPI_TABLE_DESC         *TableDesc);
0261
0262 void
0263 AcpiTbOverrideTable (
0264     ACPI_TABLE_DESC         *OldTableDesc);
0265
0266 ACPI_STATUS
0267 AcpiTbAcquireTable (
0268     ACPI_TABLE_DESC         *TableDesc,
0269     ACPI_TABLE_HEADER       **TablePtr,
0270     UINT32                  *TableLength,
0271     UINT8                   *TableFlags);
0272
0273 void
0274 AcpiTbReleaseTable (
0275     ACPI_TABLE_HEADER       *Table,
0276     UINT32                  TableLength,
0277     UINT8                   TableFlags);
0278
0279 ACPI_STATUS
0280 AcpiTbInstallStandardTable (
0281     ACPI_PHYSICAL_ADDRESS   Address,
0282     UINT8                   Flags,
0283     ACPI_TABLE_HEADER       *Table,
0284     BOOLEAN                 Reload,
0285     BOOLEAN                 Override,
0286     UINT32                  *TableIndex);
0287
0288 void
0289 AcpiTbUninstallTable (
0290     ACPI_TABLE_DESC        *TableDesc);
0291
0292 ACPI_STATUS
0293 AcpiTbLoadTable (
0294     UINT32                  TableIndex,
0295     ACPI_NAMESPACE_NODE     *ParentNode);
0296
0297 ACPI_STATUS
0298 AcpiTbInstallAndLoadTable (
0299     ACPI_PHYSICAL_ADDRESS   Address,
0300     UINT8                   Flags,
0301     ACPI_TABLE_HEADER       *Table,
0302     BOOLEAN                 Override,
0303     UINT32                  *TableIndex);
0304
0305 ACPI_STATUS
0306 AcpiTbUnloadTable (
0307     UINT32                  TableIndex);
0308
0309 void
0310 AcpiTbNotifyTable (
0311     UINT32                          Event,
0312     void                            *Table);
0313
0314 void
0315 AcpiTbTerminate (
0316     void);
0317
0318 ACPI_STATUS
0319 AcpiTbDeleteNamespaceByOwner (
0320     UINT32                  TableIndex);
0321
0322 ACPI_STATUS
0323 AcpiTbAllocateOwnerId (
0324     UINT32                  TableIndex);
0325
0326 ACPI_STATUS
0327 AcpiTbReleaseOwnerId (
0328     UINT32                  TableIndex);
0329
0330 ACPI_STATUS
0331 AcpiTbGetOwnerId (
0332     UINT32                  TableIndex,
0333     ACPI_OWNER_ID           *OwnerId);
0334
0335
0336 /*
0337  * tbutils - table manager utilities
0338  */
0339 ACPI_STATUS
0340 AcpiTbInitializeFacs (
0341     void);
0342
0343 void
0344 AcpiTbPrintTableHeader(
0345     ACPI_PHYSICAL_ADDRESS   Address,
0346     ACPI_TABLE_HEADER       *Header);
0347
0348 void
0349 AcpiTbCheckDsdtHeader (
0350     void);
0351
0352 ACPI_TABLE_HEADER *
0353 AcpiTbCopyDsdt (
0354     UINT32                  TableIndex);
0355
0356 void
0357 AcpiTbInstallTableWithOverride (
0358     ACPI_TABLE_DESC         *NewTableDesc,
0359     BOOLEAN                 Override,
0360     UINT32                  *TableIndex);
0361
0362 ACPI_STATUS
0363 AcpiTbParseRootTable (
0364     ACPI_PHYSICAL_ADDRESS   RsdpAddress);
0365
0366 ACPI_STATUS
0367 AcpiTbGetTable (
0368     ACPI_TABLE_DESC        *TableDesc,
0369     ACPI_TABLE_HEADER      **OutTable);
0370
0371 void
0372 AcpiTbPutTable (
0373     ACPI_TABLE_DESC        *TableDesc);
0374
0375
0376 /*
0377  * tbxfload
0378  */
0379 ACPI_STATUS
0380 AcpiTbLoadNamespace (
0381     void);
0382
0383 #endif /* __ACTABLES_H__ */