1 /******************************************************************************
3 * Module Name: tbutils - Table manipulation utilities
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/tbutils.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
118 #define __TBUTILS_C__
121 #include "actables.h"
124 #define _COMPONENT ACPI_TABLES
125 ACPI_MODULE_NAME ("tbutils")
128 /*******************************************************************************
130 * FUNCTION: AcpiTbHandleToObject
132 * PARAMETERS: TableId - Id for which the function is searching
133 * TableDesc - Pointer to return the matching table
136 * RETURN: Search the tables to find one with a matching TableId and
137 * return a pointer to that table descriptor.
139 ******************************************************************************/
142 AcpiTbHandleToObject (
144 ACPI_TABLE_DESC **TableDesc)
147 ACPI_TABLE_DESC *ListHead;
150 ACPI_FUNCTION_NAME ("TbHandleToObject");
153 for (i = 0; i < ACPI_TABLE_MAX; i++)
155 ListHead = &AcpiGbl_AcpiTables[i];
158 if (ListHead->TableId == TableId)
160 *TableDesc = ListHead;
164 ListHead = ListHead->Next;
166 } while (ListHead != &AcpiGbl_AcpiTables[i]);
169 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "TableId=%X does not exist\n", TableId));
170 return (AE_BAD_PARAMETER);
174 /*******************************************************************************
176 * FUNCTION: AcpiTbValidateTableHeader
178 * PARAMETERS: TableHeader - Logical pointer to the table
182 * DESCRIPTION: Check an ACPI table header for validity
184 * NOTE: Table pointers are validated as follows:
185 * 1) Table pointer must point to valid physical memory
186 * 2) Signature must be 4 ASCII chars, even if we don't recognize the
188 * 3) Table must be readable for length specified in the header
189 * 4) Table checksum must be valid (with the exception of the FACS
190 * which has no checksum because it contains variable fields)
192 ******************************************************************************/
195 AcpiTbValidateTableHeader (
196 ACPI_TABLE_HEADER *TableHeader)
201 ACPI_FUNCTION_NAME ("TbValidateTableHeader");
204 /* Verify that this is a valid address */
206 if (!AcpiOsReadable (TableHeader, sizeof (ACPI_TABLE_HEADER)))
208 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
209 "Cannot read table header at %p\n", TableHeader));
210 return (AE_BAD_ADDRESS);
213 /* Ensure that the signature is 4 ASCII characters */
215 ACPI_MOVE_UNALIGNED32_TO_32 (&Signature, TableHeader->Signature);
216 if (!AcpiUtValidAcpiName (Signature))
218 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
219 "Table signature at %p [%p] has invalid characters\n",
220 TableHeader, &Signature));
222 ACPI_REPORT_WARNING (("Invalid table signature found: [%4.4s]\n",
223 (char *) &Signature));
224 ACPI_DUMP_BUFFER (TableHeader, sizeof (ACPI_TABLE_HEADER));
225 return (AE_BAD_SIGNATURE);
228 /* Validate the table length */
230 if (TableHeader->Length < sizeof (ACPI_TABLE_HEADER))
232 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
233 "Invalid length in table header %p name %4.4s\n",
234 TableHeader, (char *) &Signature));
236 ACPI_REPORT_WARNING (("Invalid table header length (0x%X) found\n",
237 (UINT32) TableHeader->Length));
238 ACPI_DUMP_BUFFER (TableHeader, sizeof (ACPI_TABLE_HEADER));
239 return (AE_BAD_HEADER);
246 /*******************************************************************************
248 * FUNCTION: AcpiTbVerifyTableChecksum
250 * PARAMETERS: *TableHeader - ACPI table to verify
252 * RETURN: 8 bit checksum of table
254 * DESCRIPTION: Does an 8 bit checksum of table and returns status. A correct
255 * table should have a checksum of 0.
257 ******************************************************************************/
260 AcpiTbVerifyTableChecksum (
261 ACPI_TABLE_HEADER *TableHeader)
264 ACPI_STATUS Status = AE_OK;
267 ACPI_FUNCTION_TRACE ("TbVerifyTableChecksum");
270 /* Compute the checksum on the table */
272 Checksum = AcpiTbChecksum (TableHeader, TableHeader->Length);
274 /* Return the appropriate exception */
278 ACPI_REPORT_WARNING (("Invalid checksum in table [%4.4s] (%02X, sum %02X is not zero)\n",
279 TableHeader->Signature, (UINT32) TableHeader->Checksum, (UINT32) Checksum));
281 Status = AE_BAD_CHECKSUM;
283 return_ACPI_STATUS (Status);
287 /*******************************************************************************
289 * FUNCTION: AcpiTbChecksum
291 * PARAMETERS: Buffer - Buffer to checksum
292 * Length - Size of the buffer
294 * RETURNS 8 bit checksum of buffer
296 * DESCRIPTION: Computes an 8 bit checksum of the buffer(length) and returns it.
298 ******************************************************************************/
310 if (Buffer && Length)
312 /* Buffer and Length are valid */
314 limit = (UINT8 *) Buffer + Length;
316 for (rover = Buffer; rover < limit; rover++)
318 sum = (UINT8) (sum + *rover);