1/******************************************************************************
2 *
3 * Name: actables.h - ACPI table management
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2019, 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
48ACPI_STATUS
49AcpiAllocateRootTable (
50 UINT32 InitialTableCount);
51
52/*
53 * tbxfroot - Root pointer utilities
54 */
55UINT32
56AcpiTbGetRsdpLength (
57 ACPI_TABLE_RSDP *Rsdp);
58
59ACPI_STATUS
60AcpiTbValidateRsdp (
61 ACPI_TABLE_RSDP *Rsdp);
62
63UINT8 *
64AcpiTbScanMemoryForRsdp (
65 UINT8 *StartAddress,
66 UINT32 Length);
67
68
69/*
70 * tbdata - table data structure management
71 */
72ACPI_STATUS
73AcpiTbGetNextTableDescriptor (
74 UINT32 *TableIndex,
75 ACPI_TABLE_DESC **TableDesc);
76
77void
78AcpiTbInitTableDescriptor (
79 ACPI_TABLE_DESC *TableDesc,
80 ACPI_PHYSICAL_ADDRESS Address,
81 UINT8 Flags,
82 ACPI_TABLE_HEADER *Table);
83
84ACPI_STATUS
85AcpiTbAcquireTempTable (
86 ACPI_TABLE_DESC *TableDesc,
87 ACPI_PHYSICAL_ADDRESS Address,
88 UINT8 Flags);
89
90void
91AcpiTbReleaseTempTable (
92 ACPI_TABLE_DESC *TableDesc);
93
94ACPI_STATUS
95AcpiTbValidateTempTable (
96 ACPI_TABLE_DESC *TableDesc);
97
98ACPI_STATUS
99AcpiTbVerifyTempTable (
100 ACPI_TABLE_DESC *TableDesc,
101 const char *Signature,
102 UINT32 *TableIndex);
103
104BOOLEAN
105AcpiTbIsTableLoaded (
106 UINT32 TableIndex);
107
108void
109AcpiTbSetTableLoadedFlag (
110 UINT32 TableIndex,
111 BOOLEAN IsLoaded);
112
113
114/*
115 * tbfadt - FADT parse/convert/validate
116 */
117void
118AcpiTbParseFadt (
119 void);
120
121void
122AcpiTbCreateLocalFadt (
123 ACPI_TABLE_HEADER *Table,
124 UINT32 Length);
125
126
127/*
128 * tbfind - find ACPI table
129 */
130ACPI_STATUS
131AcpiTbFindTable (
132 char *Signature,
133 char *OemId,
134 char *OemTableId,
135 UINT32 *TableIndex);
136
137
138/*
139 * tbinstal - Table removal and deletion
140 */
141ACPI_STATUS
142AcpiTbResizeRootTableList (
143 void);
144
145ACPI_STATUS
146AcpiTbValidateTable (
147 ACPI_TABLE_DESC *TableDesc);
148
149void
150AcpiTbInvalidateTable (
151 ACPI_TABLE_DESC *TableDesc);
152
153void
154AcpiTbOverrideTable (
155 ACPI_TABLE_DESC *OldTableDesc);
156
157ACPI_STATUS
158AcpiTbAcquireTable (
159 ACPI_TABLE_DESC *TableDesc,
160 ACPI_TABLE_HEADER **TablePtr,
161 UINT32 *TableLength,
162 UINT8 *TableFlags);
163
164void
165AcpiTbReleaseTable (
166 ACPI_TABLE_HEADER *Table,
167 UINT32 TableLength,
168 UINT8 TableFlags);
169
170ACPI_STATUS
171AcpiTbInstallStandardTable (
172 ACPI_PHYSICAL_ADDRESS Address,
173 UINT8 Flags,
174 BOOLEAN Reload,
175 BOOLEAN Override,
176 UINT32 *TableIndex);
177
178void
179AcpiTbUninstallTable (
180 ACPI_TABLE_DESC *TableDesc);
181
182ACPI_STATUS
183AcpiTbLoadTable (
184 UINT32 TableIndex,
185 ACPI_NAMESPACE_NODE *ParentNode);
186
187ACPI_STATUS
188AcpiTbInstallAndLoadTable (
189 ACPI_PHYSICAL_ADDRESS Address,
190 UINT8 Flags,
191 BOOLEAN Override,
192 UINT32 *TableIndex);
193
194ACPI_STATUS
195AcpiTbUnloadTable (
196 UINT32 TableIndex);
197
198void
199AcpiTbNotifyTable (
200 UINT32 Event,
201 void *Table);
202
203void
204AcpiTbTerminate (
205 void);
206
207ACPI_STATUS
208AcpiTbDeleteNamespaceByOwner (
209 UINT32 TableIndex);
210
211ACPI_STATUS
212AcpiTbAllocateOwnerId (
213 UINT32 TableIndex);
214
215ACPI_STATUS
216AcpiTbReleaseOwnerId (
217 UINT32 TableIndex);
218
219ACPI_STATUS
220AcpiTbGetOwnerId (
221 UINT32 TableIndex,
222 ACPI_OWNER_ID *OwnerId);
223
224
225/*
226 * tbutils - table manager utilities
227 */
228ACPI_STATUS
229AcpiTbInitializeFacs (
230 void);
231
232void
233AcpiTbPrintTableHeader(
234 ACPI_PHYSICAL_ADDRESS Address,
235 ACPI_TABLE_HEADER *Header);
236
237UINT8
238AcpiTbChecksum (
239 UINT8 *Buffer,
240 UINT32 Length);
241
242ACPI_STATUS
243AcpiTbVerifyChecksum (
244 ACPI_TABLE_HEADER *Table,
245 UINT32 Length);
246
247void
248AcpiTbCheckDsdtHeader (
249 void);
250
251ACPI_TABLE_HEADER *
252AcpiTbCopyDsdt (
253 UINT32 TableIndex);
254
255void
256AcpiTbInstallTableWithOverride (
257 ACPI_TABLE_DESC *NewTableDesc,
258 BOOLEAN Override,
259 UINT32 *TableIndex);
260
261ACPI_STATUS
262AcpiTbParseRootTable (
263 ACPI_PHYSICAL_ADDRESS RsdpAddress);
264
265ACPI_STATUS
266AcpiTbGetTable (
267 ACPI_TABLE_DESC *TableDesc,
268 ACPI_TABLE_HEADER **OutTable);
269
270void
271AcpiTbPutTable (
272 ACPI_TABLE_DESC *TableDesc);
273
274
275/*
276 * tbxfload
277 */
278ACPI_STATUS
279AcpiTbLoadNamespace (
280 void);
281
282#endif /* __ACTABLES_H__ */
283