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