xref: /freebsd/sys/contrib/dev/acpica/include/actables.h (revision f6a3b357e9be4c6423c85eff9a847163a0d307c8)
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 - 2019, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef __ACTABLES_H__
153 #define __ACTABLES_H__
154 
155 
156 ACPI_STATUS
157 AcpiAllocateRootTable (
158     UINT32                  InitialTableCount);
159 
160 /*
161  * tbxfroot - Root pointer utilities
162  */
163 UINT32
164 AcpiTbGetRsdpLength (
165     ACPI_TABLE_RSDP         *Rsdp);
166 
167 ACPI_STATUS
168 AcpiTbValidateRsdp (
169     ACPI_TABLE_RSDP         *Rsdp);
170 
171 UINT8 *
172 AcpiTbScanMemoryForRsdp (
173     UINT8                   *StartAddress,
174     UINT32                  Length);
175 
176 
177 /*
178  * tbdata - table data structure management
179  */
180 ACPI_STATUS
181 AcpiTbGetNextTableDescriptor (
182     UINT32                  *TableIndex,
183     ACPI_TABLE_DESC         **TableDesc);
184 
185 void
186 AcpiTbInitTableDescriptor (
187     ACPI_TABLE_DESC         *TableDesc,
188     ACPI_PHYSICAL_ADDRESS   Address,
189     UINT8                   Flags,
190     ACPI_TABLE_HEADER       *Table);
191 
192 ACPI_STATUS
193 AcpiTbAcquireTempTable (
194     ACPI_TABLE_DESC         *TableDesc,
195     ACPI_PHYSICAL_ADDRESS   Address,
196     UINT8                   Flags);
197 
198 void
199 AcpiTbReleaseTempTable (
200     ACPI_TABLE_DESC         *TableDesc);
201 
202 ACPI_STATUS
203 AcpiTbValidateTempTable (
204     ACPI_TABLE_DESC         *TableDesc);
205 
206 ACPI_STATUS
207 AcpiTbVerifyTempTable (
208     ACPI_TABLE_DESC         *TableDesc,
209     char                    *Signature,
210     UINT32                  *TableIndex);
211 
212 BOOLEAN
213 AcpiTbIsTableLoaded (
214     UINT32                  TableIndex);
215 
216 void
217 AcpiTbSetTableLoadedFlag (
218     UINT32                  TableIndex,
219     BOOLEAN                 IsLoaded);
220 
221 
222 /*
223  * tbfadt - FADT parse/convert/validate
224  */
225 void
226 AcpiTbParseFadt (
227     void);
228 
229 void
230 AcpiTbCreateLocalFadt (
231     ACPI_TABLE_HEADER       *Table,
232     UINT32                  Length);
233 
234 
235 /*
236  * tbfind - find ACPI table
237  */
238 ACPI_STATUS
239 AcpiTbFindTable (
240     char                    *Signature,
241     char                    *OemId,
242     char                    *OemTableId,
243     UINT32                  *TableIndex);
244 
245 
246 /*
247  * tbinstal - Table removal and deletion
248  */
249 ACPI_STATUS
250 AcpiTbResizeRootTableList (
251     void);
252 
253 ACPI_STATUS
254 AcpiTbValidateTable (
255     ACPI_TABLE_DESC         *TableDesc);
256 
257 void
258 AcpiTbInvalidateTable (
259     ACPI_TABLE_DESC         *TableDesc);
260 
261 void
262 AcpiTbOverrideTable (
263     ACPI_TABLE_DESC         *OldTableDesc);
264 
265 ACPI_STATUS
266 AcpiTbAcquireTable (
267     ACPI_TABLE_DESC         *TableDesc,
268     ACPI_TABLE_HEADER       **TablePtr,
269     UINT32                  *TableLength,
270     UINT8                   *TableFlags);
271 
272 void
273 AcpiTbReleaseTable (
274     ACPI_TABLE_HEADER       *Table,
275     UINT32                  TableLength,
276     UINT8                   TableFlags);
277 
278 ACPI_STATUS
279 AcpiTbInstallStandardTable (
280     ACPI_PHYSICAL_ADDRESS   Address,
281     UINT8                   Flags,
282     BOOLEAN                 Reload,
283     BOOLEAN                 Override,
284     UINT32                  *TableIndex);
285 
286 void
287 AcpiTbUninstallTable (
288     ACPI_TABLE_DESC        *TableDesc);
289 
290 ACPI_STATUS
291 AcpiTbLoadTable (
292     UINT32                  TableIndex,
293     ACPI_NAMESPACE_NODE     *ParentNode);
294 
295 ACPI_STATUS
296 AcpiTbInstallAndLoadTable (
297     ACPI_PHYSICAL_ADDRESS   Address,
298     UINT8                   Flags,
299     BOOLEAN                 Override,
300     UINT32                  *TableIndex);
301 
302 ACPI_STATUS
303 AcpiTbUnloadTable (
304     UINT32                  TableIndex);
305 
306 void
307 AcpiTbNotifyTable (
308     UINT32                          Event,
309     void                            *Table);
310 
311 void
312 AcpiTbTerminate (
313     void);
314 
315 ACPI_STATUS
316 AcpiTbDeleteNamespaceByOwner (
317     UINT32                  TableIndex);
318 
319 ACPI_STATUS
320 AcpiTbAllocateOwnerId (
321     UINT32                  TableIndex);
322 
323 ACPI_STATUS
324 AcpiTbReleaseOwnerId (
325     UINT32                  TableIndex);
326 
327 ACPI_STATUS
328 AcpiTbGetOwnerId (
329     UINT32                  TableIndex,
330     ACPI_OWNER_ID           *OwnerId);
331 
332 
333 /*
334  * tbutils - table manager utilities
335  */
336 ACPI_STATUS
337 AcpiTbInitializeFacs (
338     void);
339 
340 void
341 AcpiTbPrintTableHeader(
342     ACPI_PHYSICAL_ADDRESS   Address,
343     ACPI_TABLE_HEADER       *Header);
344 
345 UINT8
346 AcpiTbChecksum (
347     UINT8                   *Buffer,
348     UINT32                  Length);
349 
350 ACPI_STATUS
351 AcpiTbVerifyChecksum (
352     ACPI_TABLE_HEADER       *Table,
353     UINT32                  Length);
354 
355 void
356 AcpiTbCheckDsdtHeader (
357     void);
358 
359 ACPI_TABLE_HEADER *
360 AcpiTbCopyDsdt (
361     UINT32                  TableIndex);
362 
363 void
364 AcpiTbInstallTableWithOverride (
365     ACPI_TABLE_DESC         *NewTableDesc,
366     BOOLEAN                 Override,
367     UINT32                  *TableIndex);
368 
369 ACPI_STATUS
370 AcpiTbParseRootTable (
371     ACPI_PHYSICAL_ADDRESS   RsdpAddress);
372 
373 ACPI_STATUS
374 AcpiTbGetTable (
375     ACPI_TABLE_DESC        *TableDesc,
376     ACPI_TABLE_HEADER      **OutTable);
377 
378 void
379 AcpiTbPutTable (
380     ACPI_TABLE_DESC        *TableDesc);
381 
382 
383 /*
384  * tbxfload
385  */
386 ACPI_STATUS
387 AcpiTbLoadNamespace (
388     void);
389 
390 #endif /* __ACTABLES_H__ */
391