tbutils.c revision 151937 
1/******************************************************************************
2 *
3 * Module Name: tbutils - Table manipulation utilities
4 *              $Revision: 1.71 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2005, 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 __TBUTILS_C__
118
119#include <contrib/dev/acpica/acpi.h>
120#include <contrib/dev/acpica/actables.h>
121
122
123#define _COMPONENT          ACPI_TABLES
124        ACPI_MODULE_NAME    ("tbutils")
125
126/* Local prototypes */
127
128#ifdef ACPI_OBSOLETE_FUNCTIONS
129ACPI_STATUS
130AcpiTbHandleToObject (
131    UINT16                  TableId,
132    ACPI_TABLE_DESC         **TableDesc);
133#endif
134
135
136/*******************************************************************************
137 *
138 * FUNCTION:    AcpiTbIsTableInstalled
139 *
140 * PARAMETERS:  NewTableDesc        - Descriptor for new table being installed
141 *
142 * RETURN:      Status - AE_ALREADY_EXISTS if the table is already installed
143 *
144 * DESCRIPTION: Determine if an ACPI table is already installed
145 *
146 * MUTEX:       Table data structures should be locked
147 *
148 ******************************************************************************/
149
150ACPI_STATUS
151AcpiTbIsTableInstalled (
152    ACPI_TABLE_DESC         *NewTableDesc)
153{
154    ACPI_TABLE_DESC         *TableDesc;
155
156
157    ACPI_FUNCTION_TRACE ("TbIsTableInstalled");
158
159
160    /* Get the list descriptor and first table descriptor */
161
162    TableDesc = AcpiGbl_TableLists[NewTableDesc->Type].Next;
163
164    /* Examine all installed tables of this type */
165
166    while (TableDesc)
167    {
168        /*
169         * If the table lengths match, perform a full bytewise compare. This
170         * means that we will allow tables with duplicate OemTableId(s), as
171         * long as the tables are different in some way.
172         *
173         * Checking if the table has been loaded into the namespace means that
174         * we don't check for duplicate tables during the initial installation
175         * of tables within the RSDT/XSDT.
176         */
177        if ((TableDesc->LoadedIntoNamespace) &&
178            (TableDesc->Pointer->Length == NewTableDesc->Pointer->Length) &&
179            (!ACPI_MEMCMP (TableDesc->Pointer, NewTableDesc->Pointer,
180                NewTableDesc->Pointer->Length)))
181        {
182            /* Match: this table is already installed */
183
184            ACPI_DEBUG_PRINT ((ACPI_DB_TABLES,
185                "Table [%4.4s] already installed: Rev %X OemTableId [%8.8s]\n",
186                NewTableDesc->Pointer->Signature,
187                NewTableDesc->Pointer->Revision,
188                NewTableDesc->Pointer->OemTableId));
189
190            NewTableDesc->OwnerId       = TableDesc->OwnerId;
191            NewTableDesc->InstalledDesc = TableDesc;
192
193            return_ACPI_STATUS (AE_ALREADY_EXISTS);
194        }
195
196        /* Get next table on the list */
197
198        TableDesc = TableDesc->Next;
199    }
200
201    return_ACPI_STATUS (AE_OK);
202}
203
204
205/*******************************************************************************
206 *
207 * FUNCTION:    AcpiTbValidateTableHeader
208 *
209 * PARAMETERS:  TableHeader         - Logical pointer to the table
210 *
211 * RETURN:      Status
212 *
213 * DESCRIPTION: Check an ACPI table header for validity
214 *
215 * NOTE:  Table pointers are validated as follows:
216 *          1) Table pointer must point to valid physical memory
217 *          2) Signature must be 4 ASCII chars, even if we don't recognize the
218 *             name
219 *          3) Table must be readable for length specified in the header
220 *          4) Table checksum must be valid (with the exception of the FACS
221 *              which has no checksum because it contains variable fields)
222 *
223 ******************************************************************************/
224
225ACPI_STATUS
226AcpiTbValidateTableHeader (
227    ACPI_TABLE_HEADER       *TableHeader)
228{
229    ACPI_NAME               Signature;
230
231
232    ACPI_FUNCTION_NAME ("TbValidateTableHeader");
233
234
235    /* Verify that this is a valid address */
236
237    if (!AcpiOsReadable (TableHeader, sizeof (ACPI_TABLE_HEADER)))
238    {
239        ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
240            "Cannot read table header at %p\n", TableHeader));
241
242        return (AE_BAD_ADDRESS);
243    }
244
245    /* Ensure that the signature is 4 ASCII characters */
246
247    ACPI_MOVE_32_TO_32 (&Signature, TableHeader->Signature);
248    if (!AcpiUtValidAcpiName (Signature))
249    {
250        ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
251            "Table signature at %p [%p] has invalid characters\n",
252            TableHeader, &Signature));
253
254        ACPI_REPORT_WARNING (("Invalid table signature found: [%4.4s]\n",
255            (char *) &Signature));
256
257        ACPI_DUMP_BUFFER (TableHeader, sizeof (ACPI_TABLE_HEADER));
258        return (AE_BAD_SIGNATURE);
259    }
260
261    /* Validate the table length */
262
263    if (TableHeader->Length < sizeof (ACPI_TABLE_HEADER))
264    {
265        ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
266            "Invalid length in table header %p name %4.4s\n",
267            TableHeader, (char *) &Signature));
268
269        ACPI_REPORT_WARNING (("Invalid table header length (0x%X) found\n",
270            (UINT32) TableHeader->Length));
271
272        ACPI_DUMP_BUFFER (TableHeader, sizeof (ACPI_TABLE_HEADER));
273        return (AE_BAD_HEADER);
274    }
275
276    return (AE_OK);
277}
278
279
280/*******************************************************************************
281 *
282 * FUNCTION:    AcpiTbVerifyTableChecksum
283 *
284 * PARAMETERS:  *TableHeader            - ACPI table to verify
285 *
286 * RETURN:      8 bit checksum of table
287 *
288 * DESCRIPTION: Does an 8 bit checksum of table and returns status.  A correct
289 *              table should have a checksum of 0.
290 *
291 ******************************************************************************/
292
293ACPI_STATUS
294AcpiTbVerifyTableChecksum (
295    ACPI_TABLE_HEADER       *TableHeader)
296{
297    UINT8                   Checksum;
298    ACPI_STATUS             Status = AE_OK;
299
300
301    ACPI_FUNCTION_TRACE ("TbVerifyTableChecksum");
302
303
304    /* Compute the checksum on the table */
305
306    Checksum = AcpiTbGenerateChecksum (TableHeader, TableHeader->Length);
307
308    /* Return the appropriate exception */
309
310    if (Checksum)
311    {
312        ACPI_REPORT_WARNING ((
313            "Invalid checksum in table [%4.4s] (%02X, sum %02X is not zero)\n",
314            TableHeader->Signature, (UINT32) TableHeader->Checksum,
315            (UINT32) Checksum));
316
317        Status = AE_BAD_CHECKSUM;
318    }
319    return_ACPI_STATUS (Status);
320}
321
322
323/*******************************************************************************
324 *
325 * FUNCTION:    AcpiTbGenerateChecksum
326 *
327 * PARAMETERS:  Buffer              - Buffer to checksum
328 *              Length              - Size of the buffer
329 *
330 * RETURN:      8 bit checksum of buffer
331 *
332 * DESCRIPTION: Computes an 8 bit checksum of the buffer(length) and returns it.
333 *
334 ******************************************************************************/
335
336UINT8
337AcpiTbGenerateChecksum (
338    void                    *Buffer,
339    UINT32                  Length)
340{
341    const UINT8             *limit;
342    const UINT8             *rover;
343    UINT8                   sum = 0;
344
345
346    if (Buffer && Length)
347    {
348        /*  Buffer and Length are valid   */
349
350        limit = (UINT8 *) Buffer + Length;
351
352        for (rover = Buffer; rover < limit; rover++)
353        {
354            sum = (UINT8) (sum + *rover);
355        }
356    }
357    return (sum);
358}
359
360
361#ifdef ACPI_OBSOLETE_FUNCTIONS
362/*******************************************************************************
363 *
364 * FUNCTION:    AcpiTbHandleToObject
365 *
366 * PARAMETERS:  TableId             - Id for which the function is searching
367 *              TableDesc           - Pointer to return the matching table
368 *                                      descriptor.
369 *
370 * RETURN:      Search the tables to find one with a matching TableId and
371 *              return a pointer to that table descriptor.
372 *
373 ******************************************************************************/
374
375ACPI_STATUS
376AcpiTbHandleToObject (
377    UINT16                  TableId,
378    ACPI_TABLE_DESC         **ReturnTableDesc)
379{
380    UINT32                  i;
381    ACPI_TABLE_DESC         *TableDesc;
382
383
384    ACPI_FUNCTION_NAME ("TbHandleToObject");
385
386
387    for (i = 0; i < ACPI_TABLE_MAX; i++)
388    {
389        TableDesc = AcpiGbl_TableLists[i].Next;
390        while (TableDesc)
391        {
392            if (TableDesc->TableId == TableId)
393            {
394                *ReturnTableDesc = TableDesc;
395                return (AE_OK);
396            }
397
398            TableDesc = TableDesc->Next;
399        }
400    }
401
402    ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "TableId=%X does not exist\n", TableId));
403    return (AE_BAD_PARAMETER);
404}
405#endif
406
407
408