reactos/drivers/bus/acpi/acpica/include/actables.h

   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 - 2015, 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 #ifndef __ACTABLES_H__
 117 #define __ACTABLES_H__
 118
 119
 120 ACPI_STATUS
 121 AcpiAllocateRootTable (
 122     UINT32                  InitialTableCount);
 123
 124 /*
 125  * tbxfroot - Root pointer utilities
 126  */
 127 UINT32
 128 AcpiTbGetRsdpLength (
 129     ACPI_TABLE_RSDP         *Rsdp);
 130
 131 ACPI_STATUS
 132 AcpiTbValidateRsdp (
 133     ACPI_TABLE_RSDP         *Rsdp);
 134
 135 UINT8 *
 136 AcpiTbScanMemoryForRsdp (
 137     UINT8                   *StartAddress,
 138     UINT32                  Length);
 139
 140
 141 /*
 142  * tbdata - table data structure management
 143  */
 144 ACPI_STATUS
 145 AcpiTbGetNextTableDescriptor (
 146     UINT32                  *TableIndex,
 147     ACPI_TABLE_DESC         **TableDesc);
 148
 149 void
 150 AcpiTbInitTableDescriptor (
 151     ACPI_TABLE_DESC         *TableDesc,
 152     ACPI_PHYSICAL_ADDRESS   Address,
 153     UINT8                   Flags,
 154     ACPI_TABLE_HEADER       *Table);
 155
 156 ACPI_STATUS
 157 AcpiTbAcquireTempTable (
 158     ACPI_TABLE_DESC         *TableDesc,
 159     ACPI_PHYSICAL_ADDRESS   Address,
 160     UINT8                   Flags);
 161
 162 void
 163 AcpiTbReleaseTempTable (
 164     ACPI_TABLE_DESC         *TableDesc);
 165
 166 ACPI_STATUS
 167 AcpiTbValidateTempTable (
 168     ACPI_TABLE_DESC         *TableDesc);
 169
 170 ACPI_STATUS
 171 AcpiTbVerifyTempTable (
 172     ACPI_TABLE_DESC         *TableDesc,
 173     char                    *Signature);
 174
 175 BOOLEAN
 176 AcpiTbIsTableLoaded (
 177     UINT32                  TableIndex);
 178
 179 void
 180 AcpiTbSetTableLoadedFlag (
 181     UINT32                  TableIndex,
 182     BOOLEAN                 IsLoaded);
 183
 184
 185 /*
 186  * tbfadt - FADT parse/convert/validate
 187  */
 188 void
 189 AcpiTbParseFadt (
 190     UINT32                  TableIndex);
 191
 192 void
 193 AcpiTbCreateLocalFadt (
 194     ACPI_TABLE_HEADER       *Table,
 195     UINT32                  Length);
 196
 197
 198 /*
 199  * tbfind - find ACPI table
 200  */
 201 ACPI_STATUS
 202 AcpiTbFindTable (
 203     char                    *Signature,
 204     char                    *OemId,
 205     char                    *OemTableId,
 206     UINT32                  *TableIndex);
 207
 208
 209 /*
 210  * tbinstal - Table removal and deletion
 211  */
 212 ACPI_STATUS
 213 AcpiTbResizeRootTableList (
 214     void);
 215
 216 ACPI_STATUS
 217 AcpiTbValidateTable (
 218     ACPI_TABLE_DESC         *TableDesc);
 219
 220 void
 221 AcpiTbInvalidateTable (
 222     ACPI_TABLE_DESC         *TableDesc);
 223
 224 void
 225 AcpiTbOverrideTable (
 226     ACPI_TABLE_DESC         *OldTableDesc);
 227
 228 ACPI_STATUS
 229 AcpiTbAcquireTable (
 230     ACPI_TABLE_DESC         *TableDesc,
 231     ACPI_TABLE_HEADER       **TablePtr,
 232     UINT32                  *TableLength,
 233     UINT8                   *TableFlags);
 234
 235 void
 236 AcpiTbReleaseTable (
 237     ACPI_TABLE_HEADER       *Table,
 238     UINT32                  TableLength,
 239     UINT8                   TableFlags);
 240
 241 ACPI_STATUS
 242 AcpiTbInstallStandardTable (
 243     ACPI_PHYSICAL_ADDRESS   Address,
 244     UINT8                   Flags,
 245     BOOLEAN                 Reload,
 246     BOOLEAN                 Override,
 247     UINT32                  *TableIndex);
 248
 249 void
 250 AcpiTbUninstallTable (
 251     ACPI_TABLE_DESC        *TableDesc);
 252
 253 void
 254 AcpiTbTerminate (
 255     void);
 256
 257 ACPI_STATUS
 258 AcpiTbDeleteNamespaceByOwner (
 259     UINT32                  TableIndex);
 260
 261 ACPI_STATUS
 262 AcpiTbAllocateOwnerId (
 263     UINT32                  TableIndex);
 264
 265 ACPI_STATUS
 266 AcpiTbReleaseOwnerId (
 267     UINT32                  TableIndex);
 268
 269 ACPI_STATUS
 270 AcpiTbGetOwnerId (
 271     UINT32                  TableIndex,
 272     ACPI_OWNER_ID           *OwnerId);
 273
 274
 275 /*
 276  * tbutils - table manager utilities
 277  */
 278 ACPI_STATUS
 279 AcpiTbInitializeFacs (
 280     void);
 281
 282 BOOLEAN
 283 AcpiTbTablesLoaded (
 284     void);
 285
 286 void
 287 AcpiTbPrintTableHeader(
 288     ACPI_PHYSICAL_ADDRESS   Address,
 289     ACPI_TABLE_HEADER       *Header);
 290
 291 UINT8
 292 AcpiTbChecksum (
 293     UINT8                   *Buffer,
 294     UINT32                  Length);
 295
 296 ACPI_STATUS
 297 AcpiTbVerifyChecksum (
 298     ACPI_TABLE_HEADER       *Table,
 299     UINT32                  Length);
 300
 301 void
 302 AcpiTbCheckDsdtHeader (
 303     void);
 304
 305 ACPI_TABLE_HEADER *
 306 AcpiTbCopyDsdt (
 307     UINT32                  TableIndex);
 308
 309 void
 310 AcpiTbInstallTableWithOverride (
 311     ACPI_TABLE_DESC         *NewTableDesc,
 312     BOOLEAN                 Override,
 313     UINT32                  *TableIndex);
 314
 315 ACPI_STATUS
 316 AcpiTbInstallFixedTable (
 317     ACPI_PHYSICAL_ADDRESS   Address,
 318     char                    *Signature,
 319     UINT32                  *TableIndex);
 320
 321 ACPI_STATUS
 322 AcpiTbParseRootTable (
 323     ACPI_PHYSICAL_ADDRESS   RsdpAddress);
 324
 325 BOOLEAN
 326 AcpiIsValidSignature (
 327     char                    *Signature);
 328
 329
 330 /*
 331  * tbxfload
 332  */
 333 ACPI_STATUS
 334 AcpiTbLoadNamespace (
 335     void);
 336
 337 #endif /* __ACTABLES_H__ */