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 - 2012, 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
120ACPI_STATUS
121AcpiAllocateRootTable (
122    UINT32                  InitialTableCount);
123
124/*
125 * tbfadt - FADT parse/convert/validate
126 */
127void
128AcpiTbParseFadt (
129    UINT32                  TableIndex);
130
131void
132AcpiTbCreateLocalFadt (
133    ACPI_TABLE_HEADER       *Table,
134    UINT32                  Length);
135
136
137/*
138 * tbfind - find ACPI table
139 */
140ACPI_STATUS
141AcpiTbFindTable (
142    char                    *Signature,
143    char                    *OemId,
144    char                    *OemTableId,
145    UINT32                  *TableIndex);
146
147
148/*
149 * tbinstal - Table removal and deletion
150 */
151ACPI_STATUS
152AcpiTbResizeRootTableList (
153    void);
154
155ACPI_STATUS
156AcpiTbVerifyTable (
157    ACPI_TABLE_DESC         *TableDesc);
158
159ACPI_TABLE_HEADER *
160AcpiTbTableOverride (
161    ACPI_TABLE_HEADER       *TableHeader,
162    ACPI_TABLE_DESC         *TableDesc);
163
164ACPI_STATUS
165AcpiTbAddTable (
166    ACPI_TABLE_DESC         *TableDesc,
167    UINT32                  *TableIndex);
168
169ACPI_STATUS
170AcpiTbStoreTable (
171    ACPI_PHYSICAL_ADDRESS   Address,
172    ACPI_TABLE_HEADER       *Table,
173    UINT32                  Length,
174    UINT8                   Flags,
175    UINT32                  *TableIndex);
176
177void
178AcpiTbDeleteTable (
179    ACPI_TABLE_DESC        *TableDesc);
180
181void
182AcpiTbTerminate (
183    void);
184
185ACPI_STATUS
186AcpiTbDeleteNamespaceByOwner (
187    UINT32                  TableIndex);
188
189ACPI_STATUS
190AcpiTbAllocateOwnerId (
191    UINT32                  TableIndex);
192
193ACPI_STATUS
194AcpiTbReleaseOwnerId (
195    UINT32                  TableIndex);
196
197ACPI_STATUS
198AcpiTbGetOwnerId (
199    UINT32                  TableIndex,
200    ACPI_OWNER_ID           *OwnerId);
201
202BOOLEAN
203AcpiTbIsTableLoaded (
204    UINT32                  TableIndex);
205
206void
207AcpiTbSetTableLoadedFlag (
208    UINT32                  TableIndex,
209    BOOLEAN                 IsLoaded);
210
211
212/*
213 * tbutils - table manager utilities
214 */
215ACPI_STATUS
216AcpiTbInitializeFacs (
217    void);
218
219BOOLEAN
220AcpiTbTablesLoaded (
221    void);
222
223void
224AcpiTbPrintTableHeader(
225    ACPI_PHYSICAL_ADDRESS   Address,
226    ACPI_TABLE_HEADER       *Header);
227
228UINT8
229AcpiTbChecksum (
230    UINT8                   *Buffer,
231    UINT32                  Length);
232
233ACPI_STATUS
234AcpiTbVerifyChecksum (
235    ACPI_TABLE_HEADER       *Table,
236    UINT32                  Length);
237
238void
239AcpiTbCheckDsdtHeader (
240    void);
241
242ACPI_TABLE_HEADER *
243AcpiTbCopyDsdt (
244    UINT32                  TableIndex);
245
246void
247AcpiTbInstallTable (
248    ACPI_PHYSICAL_ADDRESS   Address,
249    char                    *Signature,
250    UINT32                  TableIndex);
251
252ACPI_STATUS
253AcpiTbParseRootTable (
254    ACPI_PHYSICAL_ADDRESS   RsdpAddress);
255
256#endif /* __ACTABLES_H__ */
257