Raise WARNS to 6:
[dragonfly.git] / sys / contrib / dev / acpica-unix-20040527 / TABLES / tbgetall.c
1 /******************************************************************************
2  *
3  * Module Name: tbgetall - Get all required ACPI tables
4  *              $Revision: 9 $
5  *
6  *****************************************************************************/
7
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2004, 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 #define __TBGETALL_C__
118
119 #include "acpi.h"
120 #include "actables.h"
121
122
123 #define _COMPONENT          ACPI_TABLES
124         ACPI_MODULE_NAME    ("tbgetall")
125
126
127 /*******************************************************************************
128  *
129  * FUNCTION:    AcpiTbGetPrimaryTable
130  *
131  * PARAMETERS:  Address             - Physical address of table to retrieve
132  *              *TableInfo          - Where the table info is returned
133  *
134  * RETURN:      Status
135  *
136  * DESCRIPTION: Maps the physical address of table into a logical address
137  *
138  ******************************************************************************/
139
140 ACPI_STATUS
141 AcpiTbGetPrimaryTable (
142     ACPI_POINTER            *Address,
143     ACPI_TABLE_DESC         *TableInfo)
144 {
145     ACPI_STATUS             Status;
146     ACPI_TABLE_HEADER       Header;
147
148
149     ACPI_FUNCTION_TRACE ("TbGetPrimaryTable");
150
151
152     /* Ignore a NULL address in the RSDT */
153
154     if (!Address->Pointer.Value)
155     {
156         return_ACPI_STATUS (AE_OK);
157     }
158
159     /*
160      * Get the header in order to get signature and table size
161      */
162     Status = AcpiTbGetTableHeader (Address, &Header);
163     if (ACPI_FAILURE (Status))
164     {
165         return_ACPI_STATUS (Status);
166     }
167
168     /* Clear the TableInfo */
169
170     ACPI_MEMSET (TableInfo, 0, sizeof (ACPI_TABLE_DESC));
171
172     /*
173      * Check the table signature and make sure it is recognized.
174      * Also checks the header checksum
175      */
176     TableInfo->Pointer = &Header;
177     Status = AcpiTbRecognizeTable (TableInfo, ACPI_TABLE_PRIMARY);
178     if (ACPI_FAILURE (Status))
179     {
180         return_ACPI_STATUS (Status);
181     }
182
183     /* Get the entire table */
184
185     Status = AcpiTbGetTableBody (Address, &Header, TableInfo);
186     if (ACPI_FAILURE (Status))
187     {
188         return_ACPI_STATUS (Status);
189     }
190
191     /* Install the table */
192
193     Status = AcpiTbInstallTable (TableInfo);
194     return_ACPI_STATUS (Status);
195 }
196
197
198 /*******************************************************************************
199  *
200  * FUNCTION:    AcpiTbGetSecondaryTable
201  *
202  * PARAMETERS:  Address             - Physical address of table to retrieve
203  *              *TableInfo          - Where the table info is returned
204  *
205  * RETURN:      Status
206  *
207  * DESCRIPTION: Maps the physical address of table into a logical address
208  *
209  ******************************************************************************/
210
211 ACPI_STATUS
212 AcpiTbGetSecondaryTable (
213     ACPI_POINTER            *Address,
214     ACPI_STRING             Signature,
215     ACPI_TABLE_DESC         *TableInfo)
216 {
217     ACPI_STATUS             Status;
218     ACPI_TABLE_HEADER       Header;
219
220
221     ACPI_FUNCTION_TRACE_STR ("TbGetSecondaryTable", Signature);
222
223
224     /* Get the header in order to match the signature */
225
226     Status = AcpiTbGetTableHeader (Address, &Header);
227     if (ACPI_FAILURE (Status))
228     {
229         return_ACPI_STATUS (Status);
230     }
231
232     /* Signature must match request */
233
234     if (ACPI_STRNCMP (Header.Signature, Signature, ACPI_NAME_SIZE))
235     {
236         ACPI_REPORT_ERROR (("Incorrect table signature - wanted [%s] found [%4.4s]\n",
237             Signature, Header.Signature));
238         return_ACPI_STATUS (AE_BAD_SIGNATURE);
239     }
240
241     /*
242      * Check the table signature and make sure it is recognized.
243      * Also checks the header checksum
244      */
245     TableInfo->Pointer = &Header;
246     Status = AcpiTbRecognizeTable (TableInfo, ACPI_TABLE_SECONDARY);
247     if (ACPI_FAILURE (Status))
248     {
249         return_ACPI_STATUS (Status);
250     }
251
252     /* Get the entire table */
253
254     Status = AcpiTbGetTableBody (Address, &Header, TableInfo);
255     if (ACPI_FAILURE (Status))
256     {
257         return_ACPI_STATUS (Status);
258     }
259
260     /* Install the table */
261
262     Status = AcpiTbInstallTable (TableInfo);
263     return_ACPI_STATUS (Status);
264 }
265
266
267 /*******************************************************************************
268  *
269  * FUNCTION:    AcpiTbGetRequiredTables
270  *
271  * PARAMETERS:  None
272  *
273  * RETURN:      Status
274  *
275  * DESCRIPTION: Load and validate tables other than the RSDT.  The RSDT must
276  *              already be loaded and validated.
277  *
278  *              Get the minimum set of ACPI tables, namely:
279  *
280  *              1) FADT (via RSDT in loop below)
281  *              2) FACS (via FADT)
282  *              3) DSDT (via FADT)
283  *
284  ******************************************************************************/
285
286 ACPI_STATUS
287 AcpiTbGetRequiredTables (
288     void)
289 {
290     ACPI_STATUS             Status = AE_OK;
291     UINT32                  i;
292     ACPI_TABLE_DESC         TableInfo;
293     ACPI_POINTER            Address;
294
295
296     ACPI_FUNCTION_TRACE ("TbGetRequiredTables");
297
298     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "%d ACPI tables in RSDT\n",
299         AcpiGbl_RsdtTableCount));
300
301
302     Address.PointerType   = AcpiGbl_TableFlags | ACPI_LOGICAL_ADDRESSING;
303
304     /*
305      * Loop through all table pointers found in RSDT.
306      * This will NOT include the FACS and DSDT - we must get
307      * them after the loop.
308      *
309      * The only tables we are interested in getting here is the FADT and
310      * any SSDTs.
311      */
312     for (i = 0; i < AcpiGbl_RsdtTableCount; i++)
313     {
314         /* Get the table address from the common internal XSDT */
315
316         Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_XSDT->TableOffsetEntry[i]);
317
318         /*
319          * Get the tables needed by this subsystem (FADT and any SSDTs).
320          * NOTE: All other tables are completely ignored at this time.
321          */
322         Status = AcpiTbGetPrimaryTable (&Address, &TableInfo);
323         if ((Status != AE_OK) && (Status != AE_TABLE_NOT_SUPPORTED))
324         {
325             ACPI_REPORT_WARNING (("%s, while getting table at %8.8X%8.8X\n",
326                 AcpiFormatException (Status),
327                 ACPI_FORMAT_UINT64 (Address.Pointer.Value)));
328         }
329     }
330
331     /* We must have a FADT to continue */
332
333     if (!AcpiGbl_FADT)
334     {
335         ACPI_REPORT_ERROR (("No FADT present in RSDT/XSDT\n"));
336         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
337     }
338
339     /*
340      * Convert the FADT to a common format.  This allows earlier revisions of the
341      * table to coexist with newer versions, using common access code.
342      */
343     Status = AcpiTbConvertTableFadt ();
344     if (ACPI_FAILURE (Status))
345     {
346         ACPI_REPORT_ERROR (("Could not convert FADT to internal common format\n"));
347         return_ACPI_STATUS (Status);
348     }
349
350     /*
351      * Get the FACS (Pointed to by the FADT)
352      */
353     Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_FADT->XFirmwareCtrl);
354
355     Status = AcpiTbGetSecondaryTable (&Address, FACS_SIG, &TableInfo);
356     if (ACPI_FAILURE (Status))
357     {
358         ACPI_REPORT_ERROR (("Could not get/install the FACS, %s\n",
359             AcpiFormatException (Status)));
360         return_ACPI_STATUS (Status);
361     }
362
363     /*
364      * Create the common FACS pointer table
365      * (Contains pointers to the original table)
366      */
367     Status = AcpiTbBuildCommonFacs (&TableInfo);
368     if (ACPI_FAILURE (Status))
369     {
370         return_ACPI_STATUS (Status);
371     }
372
373     /*
374      * Get/install the DSDT (Pointed to by the FADT)
375      */
376     Address.Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_FADT->XDsdt);
377
378     Status = AcpiTbGetSecondaryTable (&Address, DSDT_SIG, &TableInfo);
379     if (ACPI_FAILURE (Status))
380     {
381         ACPI_REPORT_ERROR (("Could not get/install the DSDT\n"));
382         return_ACPI_STATUS (Status);
383     }
384
385     /* Set Integer Width (32/64) based upon DSDT revision */
386
387     AcpiUtSetIntegerWidth (AcpiGbl_DSDT->Revision);
388
389     /* Dump the entire DSDT */
390
391     ACPI_DEBUG_PRINT ((ACPI_DB_TABLES,
392         "Hex dump of entire DSDT, size %d (0x%X), Integer width = %d\n",
393         AcpiGbl_DSDT->Length, AcpiGbl_DSDT->Length, AcpiGbl_IntegerBitWidth));
394     ACPI_DUMP_BUFFER ((UINT8 *) AcpiGbl_DSDT, AcpiGbl_DSDT->Length);
395
396     /* Always delete the RSDP mapping, we are done with it */
397
398     AcpiTbDeleteTablesByType (ACPI_TABLE_RSDP);
399     return_ACPI_STATUS (Status);
400 }
401
402