xref: /titanic_52/usr/src/uts/intel/sys/acpi/actables.h (revision b6c3f7863936abeae522e48a13887dddeb691a45)
1 /******************************************************************************
2  *
3  * Name: actables.h - ACPI table management
4  *       $Revision: 1.55 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2006, 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 /*
127  * tbconvrt - Table conversion routines
128  */
129 ACPI_STATUS
130 AcpiTbConvertToXsdt (
131     ACPI_TABLE_DESC         *TableInfo);
132 
133 ACPI_STATUS
134 AcpiTbConvertTableFadt (
135     void);
136 
137 ACPI_STATUS
138 AcpiTbBuildCommonFacs (
139     ACPI_TABLE_DESC         *TableInfo);
140 
141 UINT32
142 AcpiTbGetTableCount (
143     RSDP_DESCRIPTOR         *RSDP,
144     ACPI_TABLE_HEADER       *RSDT);
145 
146 
147 /*
148  * tbget - Table "get" routines
149  */
150 ACPI_STATUS
151 AcpiTbGetTable (
152     ACPI_POINTER            *Address,
153     ACPI_TABLE_DESC         *TableInfo);
154 
155 ACPI_STATUS
156 AcpiTbGetTableHeader (
157     ACPI_POINTER            *Address,
158     ACPI_TABLE_HEADER       *ReturnHeader);
159 
160 ACPI_STATUS
161 AcpiTbGetTableBody (
162     ACPI_POINTER            *Address,
163     ACPI_TABLE_HEADER       *Header,
164     ACPI_TABLE_DESC         *TableInfo);
165 
166 ACPI_STATUS
167 AcpiTbGetTablePtr (
168     ACPI_TABLE_TYPE         TableType,
169     UINT32                  Instance,
170     ACPI_TABLE_HEADER       **TablePtrLoc);
171 
172 ACPI_STATUS
173 AcpiTbVerifyRsdp (
174     ACPI_POINTER            *Address);
175 
176 void
177 AcpiTbGetRsdtAddress (
178     ACPI_POINTER            *OutAddress);
179 
180 ACPI_STATUS
181 AcpiTbValidateRsdt (
182     ACPI_TABLE_HEADER       *TablePtr);
183 
184 
185 /*
186  * tbgetall - get multiple required tables
187  */
188 ACPI_STATUS
189 AcpiTbGetRequiredTables (
190     void);
191 
192 
193 /*
194  * tbinstall - Table installation
195  */
196 ACPI_STATUS
197 AcpiTbInstallTable (
198     ACPI_TABLE_DESC         *TableInfo);
199 
200 ACPI_STATUS
201 AcpiTbRecognizeTable (
202     ACPI_TABLE_DESC         *TableInfo,
203     UINT8                   SearchType);
204 
205 ACPI_STATUS
206 AcpiTbInitTableDescriptor (
207     ACPI_TABLE_TYPE         TableType,
208     ACPI_TABLE_DESC         *TableInfo);
209 
210 
211 /*
212  * tbremove - Table removal and deletion
213  */
214 void
215 AcpiTbDeleteAllTables (
216     void);
217 
218 void
219 AcpiTbDeleteTablesByType (
220     ACPI_TABLE_TYPE         Type);
221 
222 void
223 AcpiTbDeleteSingleTable (
224     ACPI_TABLE_DESC         *TableDesc);
225 
226 ACPI_TABLE_DESC *
227 AcpiTbUninstallTable (
228     ACPI_TABLE_DESC         *TableDesc);
229 
230 
231 /*
232  * tbxfroot - RSDP, RSDT utilities
233  */
234 ACPI_STATUS
235 AcpiTbFindTable (
236     char                    *Signature,
237     char                    *OemId,
238     char                    *OemTableId,
239     ACPI_TABLE_HEADER       **TablePtr);
240 
241 ACPI_STATUS
242 AcpiTbGetTableRsdt (
243     void);
244 
245 ACPI_STATUS
246 AcpiTbValidateRsdp (
247     RSDP_DESCRIPTOR         *Rsdp);
248 
249 
250 /*
251  * tbutils - common table utilities
252  */
253 ACPI_STATUS
254 AcpiTbIsTableInstalled (
255     ACPI_TABLE_DESC         *NewTableDesc);
256 
257 ACPI_STATUS
258 AcpiTbVerifyTableChecksum (
259     ACPI_TABLE_HEADER       *TableHeader);
260 
261 UINT8
262 AcpiTbSumTable (
263     void                    *Buffer,
264     UINT32                  Length);
265 
266 UINT8
267 AcpiTbGenerateChecksum (
268     ACPI_TABLE_HEADER       *Table);
269 
270 void
271 AcpiTbSetChecksum (
272     ACPI_TABLE_HEADER       *Table);
273 
274 ACPI_STATUS
275 AcpiTbValidateTableHeader (
276     ACPI_TABLE_HEADER       *TableHeader);
277 
278 #endif /* __ACTABLES_H__ */
279