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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include "aslcompiler.h"
153 #include "actables.h"
155 #define _COMPONENT DT_COMPILER
156 ACPI_MODULE_NAME ("dtutils")
158 /* Local prototypes */
162 DT_SUBTABLE
*Subtable
,
167 /******************************************************************************
171 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
172 * MessageId - Index into global message buffer
173 * Op - Parse node where error happened
174 * ExtraMessage - additional error message
178 * DESCRIPTION: Common error interface for data table compiler
180 *****************************************************************************/
186 DT_FIELD
*FieldObject
,
190 /* Check if user wants to ignore this exception */
192 if (AslIsExceptionIgnored (Level
, MessageId
))
199 AslCommonError (Level
, MessageId
,
202 FieldObject
->ByteOffset
,
204 Gbl_Files
[ASL_FILE_INPUT
].Filename
, ExtraMessage
);
208 AslCommonError (Level
, MessageId
, 0,
209 0, 0, 0, 0, ExtraMessage
);
214 /******************************************************************************
216 * FUNCTION: DtNameError
218 * PARAMETERS: Level - Seriousness (Warning/error, etc.)
219 * MessageId - Index into global message buffer
220 * Op - Parse node where error happened
221 * ExtraMessage - additional error message
225 * DESCRIPTION: Error interface for named objects
227 *****************************************************************************/
233 DT_FIELD
*FieldObject
,
242 if (Gbl_WarningLevel
< Level
)
255 AslCommonError (Level
, MessageId
,
258 FieldObject
->ByteOffset
,
259 FieldObject
->NameColumn
,
260 Gbl_Files
[ASL_FILE_INPUT
].Filename
, ExtraMessage
);
264 AslCommonError (Level
, MessageId
, 0,
265 0, 0, 0, 0, ExtraMessage
);
270 /*******************************************************************************
278 * DESCRIPTION: Dump the error log and abort the compiler. Used for serious
279 * compile or I/O errors
281 ******************************************************************************/
286 DT_FIELD
*FieldObject
,
290 DtError (ASL_ERROR
, MessageId
, FieldObject
, ExtraMessage
);
293 * TBD: remove this entire function, DtFatal
295 * We cannot abort the compiler on error, because we may be compiling a
296 * list of files. We must move on to the next file.
305 /*******************************************************************************
307 * FUNCTION: DtDoConstant
309 * PARAMETERS: String - Only hex constants are supported,
310 * regardless of whether the 0x prefix
313 * RETURN: Converted Integer
315 * DESCRIPTION: Convert a string to an integer, with overflow/error checking.
317 ******************************************************************************/
323 UINT64 ConvertedInteger
;
327 * TBD: The ImplicitStrtoul64 function does not report overflow
328 * conditions. The input string is simply truncated. If it is
329 * desired to report overflow to the table compiler, this should
330 * somehow be added here. Note: integers that are prefixed with 0x
331 * or not are both hex integers.
333 ConvertedInteger
= AcpiUtImplicitStrtoul64 (String
);
334 return (ConvertedInteger
);
337 /******************************************************************************
339 * FUNCTION: DtGetFieldValue
341 * PARAMETERS: Field - Current field list pointer
343 * RETURN: Field value
345 * DESCRIPTION: Get field value
347 *****************************************************************************/
358 return (Field
->Value
);
362 /******************************************************************************
364 * FUNCTION: DtGetFieldType
366 * PARAMETERS: Info - Data table info
370 * DESCRIPTION: Get field type
372 *****************************************************************************/
376 ACPI_DMTABLE_INFO
*Info
)
381 /* DT_FLAG means that this is the start of a block of flag bits */
382 /* TBD - we can make these a separate opcode later */
384 if (Info
->Flags
& DT_FLAG
)
386 return (DT_FIELD_TYPE_FLAGS_INTEGER
);
389 /* Type is based upon the opcode for this field in the info table */
391 switch (Info
->Opcode
)
401 case ACPI_DMT_FLAGS0
:
402 case ACPI_DMT_FLAGS1
:
403 case ACPI_DMT_FLAGS2
:
404 case ACPI_DMT_FLAGS4
:
405 case ACPI_DMT_FLAGS4_0
:
406 case ACPI_DMT_FLAGS4_4
:
407 case ACPI_DMT_FLAGS4_8
:
408 case ACPI_DMT_FLAGS4_12
:
409 case ACPI_DMT_FLAGS16_16
:
411 Type
= DT_FIELD_TYPE_FLAG
;
418 case ACPI_DMT_STRING
:
420 Type
= DT_FIELD_TYPE_STRING
;
423 case ACPI_DMT_BUFFER
:
424 case ACPI_DMT_RAW_BUFFER
:
429 case ACPI_DMT_BUF128
:
430 case ACPI_DMT_PCI_PATH
:
432 Type
= DT_FIELD_TYPE_BUFFER
;
436 case ACPI_DMT_HESTNTFY
:
437 case ACPI_DMT_IORTMEM
:
439 Type
= DT_FIELD_TYPE_INLINE_SUBTABLE
;
442 case ACPI_DMT_UNICODE
:
444 Type
= DT_FIELD_TYPE_UNICODE
;
449 Type
= DT_FIELD_TYPE_UUID
;
452 case ACPI_DMT_DEVICE_PATH
:
454 Type
= DT_FIELD_TYPE_DEVICE_PATH
;
459 Type
= DT_FIELD_TYPE_LABEL
;
464 Type
= DT_FIELD_TYPE_INTEGER
;
472 /******************************************************************************
474 * FUNCTION: DtGetBufferLength
476 * PARAMETERS: Buffer - List of integers,
477 * for example "10 3A 4F 2E"
479 * RETURN: Count of integer
481 * DESCRIPTION: Get length of bytes needed to store the integers
483 *****************************************************************************/
489 UINT32 ByteLength
= 0;
498 while (*Buffer
== ' ')
507 return (++ByteLength
);
511 /******************************************************************************
513 * FUNCTION: DtGetFieldLength
515 * PARAMETERS: Field - Current field
516 * Info - Data table info
518 * RETURN: Field length
520 * DESCRIPTION: Get length of bytes needed to compile the field
522 * Note: This function must remain in sync with AcpiDmDumpTable.
524 *****************************************************************************/
529 ACPI_DMTABLE_INFO
*Info
)
531 UINT32 ByteLength
= 0;
535 /* Length is based upon the opcode for this field in the info table */
537 switch (Info
->Opcode
)
547 case ACPI_DMT_FLAGS0
:
548 case ACPI_DMT_FLAGS1
:
549 case ACPI_DMT_FLAGS2
:
550 case ACPI_DMT_FLAGS4
:
551 case ACPI_DMT_FLAGS4_0
:
552 case ACPI_DMT_FLAGS4_4
:
553 case ACPI_DMT_FLAGS4_8
:
554 case ACPI_DMT_FLAGS4_12
:
555 case ACPI_DMT_FLAGS16_16
:
557 case ACPI_DMT_EXTRA_TEXT
:
563 case ACPI_DMT_CHKSUM
:
564 case ACPI_DMT_SPACEID
:
565 case ACPI_DMT_ACCWIDTH
:
575 case ACPI_DMT_HESTNTYP
:
576 case ACPI_DMT_FADTPM
:
577 case ACPI_DMT_EINJACT
:
578 case ACPI_DMT_EINJINST
:
579 case ACPI_DMT_ERSTACT
:
580 case ACPI_DMT_ERSTINST
:
581 case ACPI_DMT_DMAR_SCOPE
:
586 case ACPI_DMT_UINT16
:
591 case ACPI_DMT_PCI_PATH
:
596 case ACPI_DMT_UINT24
:
601 case ACPI_DMT_UINT32
:
610 case ACPI_DMT_UINT40
:
615 case ACPI_DMT_UINT48
:
621 case ACPI_DMT_UINT56
:
627 case ACPI_DMT_UINT64
:
633 case ACPI_DMT_STRING
:
635 Value
= DtGetFieldValue (Field
);
638 ByteLength
= strlen (Value
) + 1;
641 { /* At this point, this is a fatal error */
643 sprintf (MsgBuffer
, "Expected \"%s\"", Info
->Name
);
644 DtFatal (ASL_MSG_COMPILER_INTERNAL
, NULL
, MsgBuffer
);
651 ByteLength
= sizeof (ACPI_GENERIC_ADDRESS
);
654 case ACPI_DMT_HESTNTFY
:
656 ByteLength
= sizeof (ACPI_HEST_NOTIFY
);
659 case ACPI_DMT_IORTMEM
:
661 ByteLength
= sizeof (ACPI_IORT_MEMORY_ACCESS
);
664 case ACPI_DMT_BUFFER
:
665 case ACPI_DMT_RAW_BUFFER
:
667 Value
= DtGetFieldValue (Field
);
670 ByteLength
= DtGetBufferLength (Value
);
673 { /* At this point, this is a fatal error */
675 sprintf (MsgBuffer
, "Expected \"%s\"", Info
->Name
);
676 DtFatal (ASL_MSG_COMPILER_INTERNAL
, NULL
, MsgBuffer
);
697 case ACPI_DMT_BUF128
:
702 case ACPI_DMT_UNICODE
:
704 Value
= DtGetFieldValue (Field
);
706 /* TBD: error if Value is NULL? (as below?) */
708 ByteLength
= (strlen (Value
) + 1) * sizeof(UINT16
);
713 DtFatal (ASL_MSG_COMPILER_INTERNAL
, Field
, "Invalid table opcode");
721 /******************************************************************************
725 * PARAMETERS: DT_WALK_CALLBACK:
726 * Subtable - Subtable
728 * ReturnValue - Store the checksum of subtable
732 * DESCRIPTION: Get the checksum of subtable
734 *****************************************************************************/
738 DT_SUBTABLE
*Subtable
,
743 UINT8
*Sum
= ReturnValue
;
746 Checksum
= AcpiTbChecksum (Subtable
->Buffer
, Subtable
->Length
);
747 *Sum
= (UINT8
) (*Sum
+ Checksum
);
751 /******************************************************************************
753 * FUNCTION: DtSetTableChecksum
755 * PARAMETERS: ChecksumPointer - Where to return the checksum
759 * DESCRIPTION: Set checksum of the whole data table into the checksum field
761 *****************************************************************************/
765 UINT8
*ChecksumPointer
)
771 DtWalkTableTree (Gbl_RootTable
, DtSum
, NULL
, &Checksum
);
773 OldSum
= *ChecksumPointer
;
774 Checksum
= (UINT8
) (Checksum
- OldSum
);
776 /* Compute the final checksum */
778 Checksum
= (UINT8
) (0 - Checksum
);
779 *ChecksumPointer
= Checksum
;
783 /******************************************************************************
785 * FUNCTION: DtSetTableLength
791 * DESCRIPTION: Walk the subtables and set all the length fields
793 *****************************************************************************/
799 DT_SUBTABLE
*ParentTable
;
800 DT_SUBTABLE
*ChildTable
;
803 ParentTable
= Gbl_RootTable
;
811 DtSetSubtableLength (ParentTable
);
815 ChildTable
= DtGetNextSubtable (ParentTable
, ChildTable
);
818 if (ChildTable
->LengthField
)
820 DtSetSubtableLength (ChildTable
);
823 if (ChildTable
->Child
)
825 ParentTable
= ChildTable
;
830 ParentTable
->TotalLength
+= ChildTable
->TotalLength
;
831 if (ParentTable
->LengthField
)
833 DtSetSubtableLength (ParentTable
);
839 ChildTable
= ParentTable
;
841 if (ChildTable
== Gbl_RootTable
)
846 ParentTable
= DtGetParentSubtable (ParentTable
);
848 ParentTable
->TotalLength
+= ChildTable
->TotalLength
;
849 if (ParentTable
->LengthField
)
851 DtSetSubtableLength (ParentTable
);
858 /******************************************************************************
860 * FUNCTION: DtWalkTableTree
862 * PARAMETERS: StartTable - Subtable in the tree where walking begins
863 * UserFunction - Called during the walk
864 * Context - Passed to user function
865 * ReturnValue - The return value of UserFunction
869 * DESCRIPTION: Performs a depth-first walk of the subtable tree
871 *****************************************************************************/
875 DT_SUBTABLE
*StartTable
,
876 DT_WALK_CALLBACK UserFunction
,
880 DT_SUBTABLE
*ParentTable
;
881 DT_SUBTABLE
*ChildTable
;
884 ParentTable
= StartTable
;
892 UserFunction (ParentTable
, Context
, ReturnValue
);
896 ChildTable
= DtGetNextSubtable (ParentTable
, ChildTable
);
899 UserFunction (ChildTable
, Context
, ReturnValue
);
901 if (ChildTable
->Child
)
903 ParentTable
= ChildTable
;
909 ChildTable
= ParentTable
;
910 if (ChildTable
== Gbl_RootTable
)
915 ParentTable
= DtGetParentSubtable (ParentTable
);
917 if (ChildTable
->Peer
== StartTable
)