1 /******************************************************************************
3 * Module Name: dtutils.c - Utility routines for the data table compiler
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #define __DTUTILS_C__
118 #include <contrib/dev/acpica/compiler/aslcompiler.h>
119 #include <contrib/dev/acpica/compiler/dtcompiler.h>
120 #include <contrib/dev/acpica/include/actables.h>
122 #define _COMPONENT DT_COMPILER
123 ACPI_MODULE_NAME ("dtutils")
125 /* Local prototypes */
129 DT_SUBTABLE *Subtable,
134 /******************************************************************************
138 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
139 * MessageId - Index into global message buffer
140 * Op - Parse node where error happened
141 * ExtraMessage - additional error message
145 * DESCRIPTION: Common error interface for data table compiler
147 *****************************************************************************/
153 DT_FIELD *FieldObject,
161 if (Gbl_WarningLevel < Level)
173 AslCommonError (Level, MessageId,
176 FieldObject->ByteOffset,
178 Gbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
182 AslCommonError (Level, MessageId, 0,
183 0, 0, 0, 0, ExtraMessage);
188 /******************************************************************************
190 * FUNCTION: DtNameError
192 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
193 * MessageId - Index into global message buffer
194 * Op - Parse node where error happened
195 * ExtraMessage - additional error message
199 * DESCRIPTION: Error interface for named objects
201 *****************************************************************************/
207 DT_FIELD *FieldObject,
215 if (Gbl_WarningLevel < Level)
227 AslCommonError (Level, MessageId,
230 FieldObject->ByteOffset,
231 FieldObject->NameColumn,
232 Gbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
236 AslCommonError (Level, MessageId, 0,
237 0, 0, 0, 0, ExtraMessage);
242 /*******************************************************************************
250 * DESCRIPTION: Dump the error log and abort the compiler. Used for serious
251 * compile or I/O errors
253 ******************************************************************************/
258 DT_FIELD *FieldObject,
262 DtError (ASL_ERROR, MessageId, FieldObject, ExtraMessage);
269 /******************************************************************************
271 * FUNCTION: DtStrtoul64
273 * PARAMETERS: String - Null terminated string
274 * ReturnInteger - Where the converted integer is returned
278 * DESCRIPTION: Simple conversion of a string hex integer constant to unsigned
279 * value. Assumes no leading "0x" for the constant.
281 * Portability note: The reason this function exists is because a 64-bit
282 * sscanf is not available in all environments.
284 *****************************************************************************/
289 UINT64 *ReturnInteger)
291 char *ThisChar = String;
293 UINT64 ReturnValue = 0;
297 /* Skip over any white space in the buffer */
299 while ((*ThisChar == ' ') || (*ThisChar == '\t'))
304 /* Skip leading zeros */
306 while ((*ThisChar) == '0')
311 /* Convert character-by-character */
315 if (ACPI_IS_DIGIT (*ThisChar))
317 /* Convert ASCII 0-9 to Decimal value */
319 ThisDigit = ((UINT8) *ThisChar) - '0';
323 ThisDigit = (UINT32) ACPI_TOUPPER (*ThisChar);
324 if (!ACPI_IS_XDIGIT ((char) ThisDigit))
328 return (AE_BAD_CHARACTER);
331 /* Convert ASCII Hex char (A-F) to value */
333 ThisDigit = (ThisDigit - 'A') + 10;
336 /* Insert the 4-bit hex digit */
339 ReturnValue += ThisDigit;
345 /* Value is too large (> 64 bits/8 bytes/16 hex digits) */
351 *ReturnInteger = ReturnValue;
356 /******************************************************************************
358 * FUNCTION: DtGetFileSize
360 * PARAMETERS: Handle - Open file handler
362 * RETURN: Current file size
364 * DESCRIPTION: Get the current size of a file. Seek to the EOF and get the
365 * offset. Seek back to the original location.
367 *****************************************************************************/
377 CurrentOffset = ftell (Handle);
378 fseek (Handle, 0, SEEK_END);
379 LastOffset = ftell (Handle);
380 fseek (Handle, CurrentOffset, SEEK_SET);
382 return ((UINT32) LastOffset);
386 /******************************************************************************
388 * FUNCTION: DtGetFieldValue
390 * PARAMETERS: Field - Current field list pointer
393 * RETURN: Field value
395 * DESCRIPTION: Get field value
397 *****************************************************************************/
405 /* Search the field list for the name */
409 if (!ACPI_STRCMP (Name, Field->Name))
411 return (Field->Value);
421 /******************************************************************************
423 * FUNCTION: DtGetFieldType
425 * PARAMETERS: Info - Data table info
429 * DESCRIPTION: Get field type
431 *****************************************************************************/
435 ACPI_DMTABLE_INFO *Info)
440 /* DT_FLAG means that this is the start of a block of flag bits */
441 /* TBD - we can make these a separate opcode later */
443 if (Info->Flags & DT_FLAG)
445 return (DT_FIELD_TYPE_FLAGS_INTEGER);
448 /* Type is based upon the opcode for this field in the info table */
450 switch (Info->Opcode)
460 case ACPI_DMT_FLAGS0:
461 case ACPI_DMT_FLAGS2:
462 Type = DT_FIELD_TYPE_FLAG;
469 case ACPI_DMT_STRING:
470 Type = DT_FIELD_TYPE_STRING;
473 case ACPI_DMT_BUFFER:
475 case ACPI_DMT_PCI_PATH:
476 Type = DT_FIELD_TYPE_BUFFER;
480 case ACPI_DMT_HESTNTFY:
481 Type = DT_FIELD_TYPE_INLINE_SUBTABLE;
485 Type = DT_FIELD_TYPE_INTEGER;
493 /******************************************************************************
495 * FUNCTION: DtGetBufferLength
497 * PARAMETERS: Buffer - List of integers,
498 * for example "10 3A 4F 2E"
500 * RETURN: Count of integer
502 * DESCRIPTION: Get length of bytes needed to store the integers
504 *****************************************************************************/
510 UINT32 ByteLength = 0;
519 while (*Buffer == ' ')
528 return (++ByteLength);
532 /******************************************************************************
534 * FUNCTION: DtGetFieldLength
536 * PARAMETERS: Field - Current field list pointer
537 * Info - Data table info
539 * RETURN: Field length
541 * DESCRIPTION: Get length of bytes needed to compile the field
543 * Note: This function must remain in sync with AcpiDmDumpTable.
545 *****************************************************************************/
550 ACPI_DMTABLE_INFO *Info)
552 UINT32 ByteLength = 0;
556 /* Length is based upon the opcode for this field in the info table */
558 switch (Info->Opcode)
568 case ACPI_DMT_FLAGS0:
569 case ACPI_DMT_FLAGS2:
574 case ACPI_DMT_CHKSUM:
575 case ACPI_DMT_SPACEID:
580 case ACPI_DMT_HESTNTYP:
581 case ACPI_DMT_FADTPM:
582 case ACPI_DMT_EINJACT:
583 case ACPI_DMT_EINJINST:
584 case ACPI_DMT_ERSTACT:
585 case ACPI_DMT_ERSTINST:
589 case ACPI_DMT_UINT16:
592 case ACPI_DMT_PCI_PATH:
596 case ACPI_DMT_UINT24:
600 case ACPI_DMT_UINT32:
610 case ACPI_DMT_UINT56:
614 case ACPI_DMT_UINT64:
619 case ACPI_DMT_STRING:
620 Value = DtGetFieldValue (Field, Info->Name);
622 /* TBD: error if Value is NULL? (as below?) */
624 ByteLength = ACPI_STRLEN (Value) + 1;
628 ByteLength = sizeof (ACPI_GENERIC_ADDRESS);
631 case ACPI_DMT_HESTNTFY:
632 ByteLength = sizeof (ACPI_HEST_NOTIFY);
635 case ACPI_DMT_BUFFER:
636 Value = DtGetFieldValue (Field, Info->Name);
639 ByteLength = DtGetBufferLength (Value);
642 { /* At this point, this is a fatal error */
644 sprintf (MsgBuffer, "Expected \"%s\"", Info->Name);
645 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
654 DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid table opcode");
662 /******************************************************************************
666 * PARAMETERS: DT_WALK_CALLBACK:
667 * Subtable - Subtable
669 * ReturnValue - Store the checksum of subtable
673 * DESCRIPTION: Get the checksum of subtable
675 *****************************************************************************/
679 DT_SUBTABLE *Subtable,
684 UINT8 *Sum = ReturnValue;
687 Checksum = AcpiTbChecksum (Subtable->Buffer, Subtable->Length);
688 *Sum = (UINT8) (*Sum + Checksum);
692 /******************************************************************************
694 * FUNCTION: DtSetTableChecksum
696 * PARAMETERS: ChecksumPointer - Where to return the checksum
700 * DESCRIPTION: Set checksum of the whole data table into the checksum field
702 *****************************************************************************/
706 UINT8 *ChecksumPointer)
712 DtWalkTableTree (Gbl_RootTable, DtSum, NULL, &Checksum);
714 OldSum = *ChecksumPointer;
715 Checksum = (UINT8) (Checksum - OldSum);
717 /* Compute the final checksum */
719 Checksum = (UINT8) (0 - Checksum);
720 *ChecksumPointer = Checksum;
724 /******************************************************************************
726 * FUNCTION: DtSetTableLength
732 * DESCRIPTION: Walk the subtables and set all the length fields
734 *****************************************************************************/
740 DT_SUBTABLE *ParentTable;
741 DT_SUBTABLE *ChildTable;
744 ParentTable = Gbl_RootTable;
752 DtSetSubtableLength (ParentTable);
756 ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
759 if (ChildTable->LengthField)
761 DtSetSubtableLength (ChildTable);
764 if (ChildTable->Child)
766 ParentTable = ChildTable;
771 ParentTable->TotalLength += ChildTable->TotalLength;
772 if (ParentTable->LengthField)
774 DtSetSubtableLength (ParentTable);
780 ChildTable = ParentTable;
782 if (ChildTable == Gbl_RootTable)
787 ParentTable = DtGetParentSubtable (ParentTable);
789 ParentTable->TotalLength += ChildTable->TotalLength;
790 if (ParentTable->LengthField)
792 DtSetSubtableLength (ParentTable);
799 /******************************************************************************
801 * FUNCTION: DtWalkTableTree
803 * PARAMETERS: StartTable - Subtable in the tree where walking begins
804 * UserFunction - Called during the walk
805 * Context - Passed to user function
806 * ReturnValue - The return value of UserFunction
810 * DESCRIPTION: Performs a depth-first walk of the subtable tree
812 *****************************************************************************/
816 DT_SUBTABLE *StartTable,
817 DT_WALK_CALLBACK UserFunction,
821 DT_SUBTABLE *ParentTable;
822 DT_SUBTABLE *ChildTable;
825 ParentTable = StartTable;
833 UserFunction (ParentTable, Context, ReturnValue);
837 ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
840 UserFunction (ChildTable, Context, ReturnValue);
842 if (ChildTable->Child)
844 ParentTable = ChildTable;
850 ChildTable = ParentTable;
851 if (ChildTable == Gbl_RootTable)
856 ParentTable = DtGetParentSubtable (ParentTable);
858 if (ChildTable->Peer == StartTable)
867 /******************************************************************************
869 * FUNCTION: DtFreeFieldList
875 * DESCRIPTION: Free the field list
877 *****************************************************************************/
883 DT_FIELD *Field = Gbl_FieldList;
887 /* Walk and free entire field list */
891 NextField = Field->Next; /* Save link */
893 if (!(Field->Flags & DT_FIELD_NOT_ALLOCATED))
895 ACPI_FREE (Field->Name);
896 ACPI_FREE (Field->Value);