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