Raise WARNS to 6:
[dragonfly.git] / sys / contrib / dev / acpica-unix-20040527 / TABLES / tbrsdt.c
1 /******************************************************************************
2  *
3  * Module Name: tbrsdt - ACPI RSDT table utilities
4  *              $Revision: 12 $
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 __TBRSDT_C__
118
119 #include "acpi.h"
120 #include "actables.h"
121
122
123 #define _COMPONENT          ACPI_TABLES
124         ACPI_MODULE_NAME    ("tbrsdt")
125
126
127 /*******************************************************************************
128  *
129  * FUNCTION:    AcpiTbVerifyRsdp
130  *
131  * PARAMETERS:  Address         - RSDP (Pointer to RSDT)
132  *
133  * RETURN:      Status
134  *
135  * DESCRIPTION: Load and validate the RSDP (ptr) and RSDT (table)
136  *
137  ******************************************************************************/
138
139 ACPI_STATUS
140 AcpiTbVerifyRsdp (
141     ACPI_POINTER            *Address)
142 {
143     ACPI_TABLE_DESC         TableInfo;
144     ACPI_STATUS             Status;
145     RSDP_DESCRIPTOR         *Rsdp;
146
147
148     ACPI_FUNCTION_TRACE ("TbVerifyRsdp");
149
150
151     switch (Address->PointerType)
152     {
153     case ACPI_LOGICAL_POINTER:
154
155         Rsdp = Address->Pointer.Logical;
156         break;
157
158     case ACPI_PHYSICAL_POINTER:
159         /*
160          * Obtain access to the RSDP structure
161          */
162         Status = AcpiOsMapMemory (Address->Pointer.Physical, sizeof (RSDP_DESCRIPTOR),
163                                     (void *) &Rsdp);
164         if (ACPI_FAILURE (Status))
165         {
166             return_ACPI_STATUS (Status);
167         }
168         break;
169
170     default:
171         return_ACPI_STATUS (AE_BAD_PARAMETER);
172     }
173
174     /*
175      *  The signature and checksum must both be correct
176      */
177     if (ACPI_STRNCMP ((char *) Rsdp, RSDP_SIG, sizeof (RSDP_SIG)-1) != 0)
178     {
179         /* Nope, BAD Signature */
180
181         Status = AE_BAD_SIGNATURE;
182         goto Cleanup;
183     }
184
185     /* Check the standard checksum */
186
187     if (AcpiTbChecksum (Rsdp, ACPI_RSDP_CHECKSUM_LENGTH) != 0)
188     {
189         Status = AE_BAD_CHECKSUM;
190         goto Cleanup;
191     }
192
193     /* Check extended checksum if table version >= 2 */
194
195     if (Rsdp->Revision >= 2)
196     {
197         if (AcpiTbChecksum (Rsdp, ACPI_RSDP_XCHECKSUM_LENGTH) != 0)
198         {
199             Status = AE_BAD_CHECKSUM;
200             goto Cleanup;
201         }
202     }
203
204     /* The RSDP supplied is OK */
205
206     TableInfo.Pointer      = ACPI_CAST_PTR (ACPI_TABLE_HEADER, Rsdp);
207     TableInfo.Length       = sizeof (RSDP_DESCRIPTOR);
208     TableInfo.Allocation   = ACPI_MEM_MAPPED;
209
210     /* Save the table pointers and allocation info */
211
212     Status = AcpiTbInitTableDescriptor (ACPI_TABLE_RSDP, &TableInfo);
213     if (ACPI_FAILURE (Status))
214     {
215         goto Cleanup;
216     }
217
218     /* Save the RSDP in a global for easy access */
219
220     AcpiGbl_RSDP = ACPI_CAST_PTR (RSDP_DESCRIPTOR, TableInfo.Pointer);
221     return_ACPI_STATUS (Status);
222
223
224     /* Error exit */
225 Cleanup:
226
227     if (AcpiGbl_TableFlags & ACPI_PHYSICAL_POINTER)
228     {
229         AcpiOsUnmapMemory (Rsdp, sizeof (RSDP_DESCRIPTOR));
230     }
231     return_ACPI_STATUS (Status);
232 }
233
234
235 /*******************************************************************************
236  *
237  * FUNCTION:    AcpiTbGetRsdtAddress
238  *
239  * PARAMETERS:  None
240  *
241  * RETURN:      RSDT physical address
242  *
243  * DESCRIPTION: Extract the address of the RSDT or XSDT, depending on the
244  *              version of the RSDP
245  *
246  ******************************************************************************/
247
248 void
249 AcpiTbGetRsdtAddress (
250     ACPI_POINTER            *OutAddress)
251 {
252
253     ACPI_FUNCTION_ENTRY ();
254
255
256     OutAddress->PointerType = AcpiGbl_TableFlags | ACPI_LOGICAL_ADDRESSING;
257
258     /*
259      * For RSDP revision 0 or 1, we use the RSDT.
260      * For RSDP revision 2 (and above), we use the XSDT
261      */
262     if (AcpiGbl_RSDP->Revision < 2)
263     {
264         OutAddress->Pointer.Value = AcpiGbl_RSDP->RsdtPhysicalAddress;
265     }
266     else
267     {
268         OutAddress->Pointer.Value = ACPI_GET_ADDRESS (AcpiGbl_RSDP->XsdtPhysicalAddress);
269     }
270 }
271
272
273 /*******************************************************************************
274  *
275  * FUNCTION:    AcpiTbValidateRsdt
276  *
277  * PARAMETERS:  TablePtr        - Addressable pointer to the RSDT.
278  *
279  * RETURN:      Status
280  *
281  * DESCRIPTION: Validate signature for the RSDT or XSDT
282  *
283  ******************************************************************************/
284
285 ACPI_STATUS
286 AcpiTbValidateRsdt (
287     ACPI_TABLE_HEADER       *TablePtr)
288 {
289     int                     NoMatch;
290
291
292     ACPI_FUNCTION_NAME ("TbValidateRsdt");
293
294
295     /*
296      * For RSDP revision 0 or 1, we use the RSDT.
297      * For RSDP revision 2 and above, we use the XSDT
298      */
299     if (AcpiGbl_RSDP->Revision < 2)
300     {
301         NoMatch = ACPI_STRNCMP ((char *) TablePtr, RSDT_SIG,
302                         sizeof (RSDT_SIG) -1);
303     }
304     else
305     {
306         NoMatch = ACPI_STRNCMP ((char *) TablePtr, XSDT_SIG,
307                         sizeof (XSDT_SIG) -1);
308     }
309
310     if (NoMatch)
311     {
312         /* Invalid RSDT or XSDT signature */
313
314         ACPI_REPORT_ERROR (("Invalid signature where RSDP indicates RSDT/XSDT should be located\n"));
315
316         ACPI_DUMP_BUFFER (AcpiGbl_RSDP, 20);
317
318         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_ERROR,
319             "RSDT/XSDT signature at %X (%p) is invalid\n",
320             AcpiGbl_RSDP->RsdtPhysicalAddress,
321             (void *) (ACPI_NATIVE_UINT) AcpiGbl_RSDP->RsdtPhysicalAddress));
322
323         if (AcpiGbl_RSDP->Revision < 2)
324         {
325             ACPI_REPORT_ERROR (("Looking for RSDT (RSDP->Rev < 2)\n"))
326         }
327         else
328         {
329             ACPI_REPORT_ERROR (("Looking for XSDT (RSDP->Rev >= 2)\n"))
330         }
331
332         ACPI_DUMP_BUFFER ((char *) TablePtr, 48);
333
334         return (AE_BAD_SIGNATURE);
335     }
336
337     return (AE_OK);
338 }
339
340
341 /*******************************************************************************
342  *
343  * FUNCTION:    AcpiTbGetTableRsdt
344  *
345  * PARAMETERS:  None
346  *
347  * RETURN:      Status
348  *
349  * DESCRIPTION: Load and validate the RSDP (ptr) and RSDT (table)
350  *
351  ******************************************************************************/
352
353 ACPI_STATUS
354 AcpiTbGetTableRsdt (
355     void)
356 {
357     ACPI_TABLE_DESC         TableInfo;
358     ACPI_STATUS             Status;
359     ACPI_POINTER            Address;
360
361
362     ACPI_FUNCTION_TRACE ("TbGetTableRsdt");
363
364
365     /* Get the RSDT/XSDT via the RSDP */
366
367     AcpiTbGetRsdtAddress (&Address);
368
369     Status = AcpiTbGetTable (&Address, &TableInfo);
370     if (ACPI_FAILURE (Status))
371     {
372         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not get the RSDT/XSDT, %s\n",
373             AcpiFormatException (Status)));
374         return_ACPI_STATUS (Status);
375     }
376
377     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
378         "RSDP located at %p, points to RSDT physical=%8.8X%8.8X \n",
379         AcpiGbl_RSDP,
380         ACPI_FORMAT_UINT64 (Address.Pointer.Value)));
381
382     /* Check the RSDT or XSDT signature */
383
384     Status = AcpiTbValidateRsdt (TableInfo.Pointer);
385     if (ACPI_FAILURE (Status))
386     {
387         return_ACPI_STATUS (Status);
388     }
389
390     /* Get the number of tables defined in the RSDT or XSDT */
391
392     AcpiGbl_RsdtTableCount = AcpiTbGetTableCount (AcpiGbl_RSDP, TableInfo.Pointer);
393
394     /* Convert and/or copy to an XSDT structure */
395
396     Status = AcpiTbConvertToXsdt (&TableInfo);
397     if (ACPI_FAILURE (Status))
398     {
399         return_ACPI_STATUS (Status);
400     }
401
402     /* Save the table pointers and allocation info */
403
404     Status = AcpiTbInitTableDescriptor (ACPI_TABLE_XSDT, &TableInfo);
405     if (ACPI_FAILURE (Status))
406     {
407         return_ACPI_STATUS (Status);
408     }
409
410     AcpiGbl_XSDT = ACPI_CAST_PTR (XSDT_DESCRIPTOR, TableInfo.Pointer);
411
412     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "XSDT located at %p\n", AcpiGbl_XSDT));
413     return_ACPI_STATUS (Status);
414 }
415
416