sys/contrib/dev/acpica/source/include/actables.h

   1 /******************************************************************************
   2  *
   3  * Name: actables.h - ACPI table management
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2014, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #ifndef __ACTABLES_H__
  45 #define __ACTABLES_H__
  46
  47
  48 ACPI_STATUS
  49 AcpiAllocateRootTable (
  50     UINT32                  InitialTableCount);
  51
  52 /*
  53  * tbxfroot - Root pointer utilities
  54  */
  55 ACPI_STATUS
  56 AcpiTbValidateRsdp (
  57     ACPI_TABLE_RSDP         *Rsdp);
  58
  59 UINT8 *
  60 AcpiTbScanMemoryForRsdp (
  61     UINT8                   *StartAddress,
  62     UINT32                  Length);
  63
  64
  65 /*
  66  * tbdata - table data structure management
  67  */
  68 ACPI_STATUS
  69 AcpiTbGetNextRootIndex (
  70     UINT32                  *TableIndex);
  71
  72 void
  73 AcpiTbInitTableDescriptor (
  74     ACPI_TABLE_DESC         *TableDesc,
  75     ACPI_PHYSICAL_ADDRESS   Address,
  76     UINT8                   Flags,
  77     ACPI_TABLE_HEADER       *Table);
  78
  79 ACPI_STATUS
  80 AcpiTbAcquireTempTable (
  81     ACPI_TABLE_DESC         *TableDesc,
  82     ACPI_PHYSICAL_ADDRESS   Address,
  83     UINT8                   Flags);
  84
  85 void
  86 AcpiTbReleaseTempTable (
  87     ACPI_TABLE_DESC         *TableDesc);
  88
  89 ACPI_STATUS
  90 AcpiTbValidateTempTable (
  91     ACPI_TABLE_DESC         *TableDesc);
  92
  93 ACPI_STATUS
  94 AcpiTbVerifyTempTable (
  95     ACPI_TABLE_DESC         *TableDesc,
  96     char                    *Signature);
  97
  98 BOOLEAN
  99 AcpiTbIsTableLoaded (
 100     UINT32                  TableIndex);
 101
 102 void
 103 AcpiTbSetTableLoadedFlag (
 104     UINT32                  TableIndex,
 105     BOOLEAN                 IsLoaded);
 106
 107
 108 /*
 109  * tbfadt - FADT parse/convert/validate
 110  */
 111 void
 112 AcpiTbParseFadt (
 113     UINT32                  TableIndex);
 114
 115 void
 116 AcpiTbCreateLocalFadt (
 117     ACPI_TABLE_HEADER       *Table,
 118     UINT32                  Length);
 119
 120
 121 /*
 122  * tbfind - find ACPI table
 123  */
 124 ACPI_STATUS
 125 AcpiTbFindTable (
 126     char                    *Signature,
 127     char                    *OemId,
 128     char                    *OemTableId,
 129     UINT32                  *TableIndex);
 130
 131
 132 /*
 133  * tbinstal - Table removal and deletion
 134  */
 135 ACPI_STATUS
 136 AcpiTbResizeRootTableList (
 137     void);
 138
 139 ACPI_STATUS
 140 AcpiTbValidateTable (
 141     ACPI_TABLE_DESC         *TableDesc);
 142
 143 void
 144 AcpiTbInvalidateTable (
 145     ACPI_TABLE_DESC         *TableDesc);
 146
 147 void
 148 AcpiTbOverrideTable (
 149     ACPI_TABLE_DESC         *OldTableDesc);
 150
 151 ACPI_STATUS
 152 AcpiTbAcquireTable (
 153     ACPI_TABLE_DESC         *TableDesc,
 154     ACPI_TABLE_HEADER       **TablePtr,
 155     UINT32                  *TableLength,
 156     UINT8                   *TableFlags);
 157
 158 void
 159 AcpiTbReleaseTable (
 160     ACPI_TABLE_HEADER       *Table,
 161     UINT32                  TableLength,
 162     UINT8                   TableFlags);
 163
 164 ACPI_STATUS
 165 AcpiTbInstallStandardTable (
 166     ACPI_PHYSICAL_ADDRESS   Address,
 167     UINT8                   Flags,
 168     BOOLEAN                 Reload,
 169     BOOLEAN                 Override,
 170     UINT32                  *TableIndex);
 171
 172 ACPI_STATUS
 173 AcpiTbStoreTable (
 174     ACPI_PHYSICAL_ADDRESS   Address,
 175     ACPI_TABLE_HEADER       *Table,
 176     UINT32                  Length,
 177     UINT8                   Flags,
 178     UINT32                  *TableIndex);
 179
 180 void
 181 AcpiTbUninstallTable (
 182     ACPI_TABLE_DESC        *TableDesc);
 183
 184 void
 185 AcpiTbTerminate (
 186     void);
 187
 188 ACPI_STATUS
 189 AcpiTbDeleteNamespaceByOwner (
 190     UINT32                  TableIndex);
 191
 192 ACPI_STATUS
 193 AcpiTbAllocateOwnerId (
 194     UINT32                  TableIndex);
 195
 196 ACPI_STATUS
 197 AcpiTbReleaseOwnerId (
 198     UINT32                  TableIndex);
 199
 200 ACPI_STATUS
 201 AcpiTbGetOwnerId (
 202     UINT32                  TableIndex,
 203     ACPI_OWNER_ID           *OwnerId);
 204
 205
 206 /*
 207  * tbutils - table manager utilities
 208  */
 209 ACPI_STATUS
 210 AcpiTbInitializeFacs (
 211     void);
 212
 213 BOOLEAN
 214 AcpiTbTablesLoaded (
 215     void);
 216
 217 void
 218 AcpiTbPrintTableHeader(
 219     ACPI_PHYSICAL_ADDRESS   Address,
 220     ACPI_TABLE_HEADER       *Header);
 221
 222 UINT8
 223 AcpiTbChecksum (
 224     UINT8                   *Buffer,
 225     UINT32                  Length);
 226
 227 ACPI_STATUS
 228 AcpiTbVerifyChecksum (
 229     ACPI_TABLE_HEADER       *Table,
 230     UINT32                  Length);
 231
 232 void
 233 AcpiTbCheckDsdtHeader (
 234     void);
 235
 236 ACPI_TABLE_HEADER *
 237 AcpiTbCopyDsdt (
 238     UINT32                  TableIndex);
 239
 240 void
 241 AcpiTbInstallTableWithOverride (
 242     UINT32                  TableIndex,
 243     ACPI_TABLE_DESC         *NewTableDesc,
 244     BOOLEAN                 Override);
 245
 246 ACPI_STATUS
 247 AcpiTbInstallFixedTable (
 248     ACPI_PHYSICAL_ADDRESS   Address,
 249     char                    *Signature,
 250     UINT32                  TableIndex);
 251
 252 ACPI_STATUS
 253 AcpiTbParseRootTable (
 254     ACPI_PHYSICAL_ADDRESS   RsdpAddress);
 255
 256 #endif /* __ACTABLES_H__ */