sys/contrib/dev/acpica-unix-20050309/include/actables.h

   1 /******************************************************************************
   2  *
   3  * Name: actables.h - ACPI table management
   4  *       $Revision: 47 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #ifndef __ACTABLES_H__
 118 #define __ACTABLES_H__
 119
 120
 121 /* Used in AcpiTbMapAcpiTable for size parameter if table header is to be used */
 122
 123 #define SIZE_IN_HEADER          0
 124
 125
 126 ACPI_STATUS
 127 AcpiTbHandleToObject (
 128     UINT16                  TableId,
 129     ACPI_TABLE_DESC         **TableDesc);
 130
 131 /*
 132  * tbconvrt - Table conversion routines
 133  */
 134
 135 ACPI_STATUS
 136 AcpiTbConvertToXsdt (
 137     ACPI_TABLE_DESC         *TableInfo);
 138
 139 ACPI_STATUS
 140 AcpiTbConvertTableFadt (
 141     void);
 142
 143 ACPI_STATUS
 144 AcpiTbBuildCommonFacs (
 145     ACPI_TABLE_DESC         *TableInfo);
 146
 147 UINT32
 148 AcpiTbGetTableCount (
 149     RSDP_DESCRIPTOR         *RSDP,
 150     ACPI_TABLE_HEADER       *RSDT);
 151
 152 /*
 153  * tbget - Table "get" routines
 154  */
 155
 156 ACPI_STATUS
 157 AcpiTbGetTable (
 158     ACPI_POINTER            *Address,
 159     ACPI_TABLE_DESC         *TableInfo);
 160
 161 ACPI_STATUS
 162 AcpiTbGetTableHeader (
 163     ACPI_POINTER            *Address,
 164     ACPI_TABLE_HEADER       *ReturnHeader);
 165
 166 ACPI_STATUS
 167 AcpiTbGetTableBody (
 168     ACPI_POINTER            *Address,
 169     ACPI_TABLE_HEADER       *Header,
 170     ACPI_TABLE_DESC         *TableInfo);
 171
 172 ACPI_STATUS
 173 AcpiTbGetThisTable (
 174     ACPI_POINTER            *Address,
 175     ACPI_TABLE_HEADER       *Header,
 176     ACPI_TABLE_DESC         *TableInfo);
 177
 178 ACPI_STATUS
 179 AcpiTbTableOverride (
 180     ACPI_TABLE_HEADER       *Header,
 181     ACPI_TABLE_DESC         *TableInfo);
 182
 183 ACPI_STATUS
 184 AcpiTbGetTablePtr (
 185     ACPI_TABLE_TYPE         TableType,
 186     UINT32                  Instance,
 187     ACPI_TABLE_HEADER       **TablePtrLoc);
 188
 189 ACPI_STATUS
 190 AcpiTbVerifyRsdp (
 191     ACPI_POINTER            *Address);
 192
 193 void
 194 AcpiTbGetRsdtAddress (
 195     ACPI_POINTER            *OutAddress);
 196
 197 ACPI_STATUS
 198 AcpiTbValidateRsdt (
 199     ACPI_TABLE_HEADER       *TablePtr);
 200
 201 ACPI_STATUS
 202 AcpiTbGetRequiredTables (
 203     void);
 204
 205 ACPI_STATUS
 206 AcpiTbGetPrimaryTable (
 207     ACPI_POINTER            *Address,
 208     ACPI_TABLE_DESC         *TableInfo);
 209
 210 ACPI_STATUS
 211 AcpiTbGetSecondaryTable (
 212     ACPI_POINTER            *Address,
 213     ACPI_STRING             Signature,
 214     ACPI_TABLE_DESC         *TableInfo);
 215
 216 /*
 217  * tbinstall - Table installation
 218  */
 219
 220 ACPI_STATUS
 221 AcpiTbInstallTable (
 222     ACPI_TABLE_DESC         *TableInfo);
 223
 224 ACPI_STATUS
 225 AcpiTbMatchSignature (
 226     char                    *Signature,
 227     ACPI_TABLE_DESC         *TableInfo,
 228     UINT8                   SearchType);
 229
 230 ACPI_STATUS
 231 AcpiTbRecognizeTable (
 232     ACPI_TABLE_DESC         *TableInfo,
 233     UINT8                   SearchType);
 234
 235 ACPI_STATUS
 236 AcpiTbInitTableDescriptor (
 237     ACPI_TABLE_TYPE         TableType,
 238     ACPI_TABLE_DESC         *TableInfo);
 239
 240
 241 /*
 242  * tbremove - Table removal and deletion
 243  */
 244
 245 void
 246 AcpiTbDeleteAllTables (
 247     void);
 248
 249 void
 250 AcpiTbDeleteTablesByType (
 251     ACPI_TABLE_TYPE         Type);
 252
 253 void
 254 AcpiTbDeleteSingleTable (
 255     ACPI_TABLE_DESC         *TableDesc);
 256
 257 ACPI_TABLE_DESC *
 258 AcpiTbUninstallTable (
 259     ACPI_TABLE_DESC         *TableDesc);
 260
 261
 262 /*
 263  * tbrsd - RSDP, RSDT utilities
 264  */
 265
 266 ACPI_STATUS
 267 AcpiTbGetTableRsdt (
 268     void);
 269
 270 UINT8 *
 271 AcpiTbScanMemoryForRsdp (
 272     UINT8                   *StartAddress,
 273     UINT32                  Length);
 274
 275 ACPI_STATUS
 276 AcpiTbFindRsdp (
 277     ACPI_TABLE_DESC         *TableInfo,
 278     UINT32                  Flags);
 279
 280
 281 /*
 282  * tbutils - common table utilities
 283  */
 284
 285 ACPI_STATUS
 286 AcpiTbFindTable (
 287     char                    *Signature,
 288     char                    *OemId,
 289     char                    *OemTableId,
 290     ACPI_TABLE_HEADER       **TablePtr);
 291
 292 ACPI_STATUS
 293 AcpiTbVerifyTableChecksum (
 294     ACPI_TABLE_HEADER       *TableHeader);
 295
 296 UINT8
 297 AcpiTbChecksum (
 298     void                    *Buffer,
 299     UINT32                  Length);
 300
 301 ACPI_STATUS
 302 AcpiTbValidateTableHeader (
 303     ACPI_TABLE_HEADER       *TableHeader);
 304
 305
 306 #endif /* __ACTABLES_H__ */