1 /******************************************************************************
2  *
3  * Module Name: dtutils.c - Utility routines for the data table compiler
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
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.
133  *
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.
145  *
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.
149  *
150  *****************************************************************************/
151 
152 #include "aslcompiler.h"
153 #include "actables.h"
154 
155 #define _COMPONENT          DT_COMPILER
156         ACPI_MODULE_NAME    ("dtutils")
157 
158 /* Local prototypes */
159 
160 static void
161 DtSum (
162     DT_SUBTABLE             *Subtable,
163     void                    *Context,
164     void                    *ReturnValue);
165 
166 
167 /******************************************************************************
168  *
169  * FUNCTION:    DtError
170  *
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
175  *
176  * RETURN:      None
177  *
178  * DESCRIPTION: Common error interface for data table compiler
179  *
180  *****************************************************************************/
181 
182 void
183 DtError (
184     UINT8                   Level,
185     UINT16                  MessageId,
186     DT_FIELD                *FieldObject,
187     char                    *ExtraMessage)
188 {
189     UINT32                  Line = 0;
190 
191 
192     /* Field object could be NULL */
193 
194     if (FieldObject)
195     {
196         Line = FieldObject->Line;
197     }
198 
199     /* Check if user wants to ignore this exception */
200 
201     if (AslIsExceptionIgnored (AslGbl_Files[ASL_FILE_INPUT].Filename,
202         Line, Level, MessageId))
203     {
204         return;
205     }
206 
207     if (FieldObject)
208     {
209         AslCommonError (Level, MessageId,
210             FieldObject->Line,
211             FieldObject->Line,
212             FieldObject->ByteOffset,
213             FieldObject->Column,
214             AslGbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
215     }
216     else
217     {
218         AslCommonError (Level, MessageId, 0,
219             0, 0, 0, 0, ExtraMessage);
220     }
221 }
222 
223 
224 /******************************************************************************
225  *
226  * FUNCTION:    DtNameError
227  *
228  * PARAMETERS:  Level               - Seriousness (Warning/error, etc.)
229  *              MessageId           - Index into global message buffer
230  *              Op                  - Parse node where error happened
231  *              ExtraMessage        - additional error message
232  *
233  * RETURN:      None
234  *
235  * DESCRIPTION: Error interface for named objects
236  *
237  *****************************************************************************/
238 
239 void
240 DtNameError (
241     UINT8                   Level,
242     UINT16                  MessageId,
243     DT_FIELD                *FieldObject,
244     char                    *ExtraMessage)
245 {
246 
247     switch (Level)
248     {
249     case ASL_WARNING2:
250     case ASL_WARNING3:
251 
252         if (AslGbl_WarningLevel < Level)
253         {
254             return;
255         }
256         break;
257 
258     default:
259 
260         break;
261     }
262 
263     if (FieldObject)
264     {
265         AslCommonError (Level, MessageId,
266             FieldObject->Line,
267             FieldObject->Line,
268             FieldObject->ByteOffset,
269             FieldObject->NameColumn,
270             AslGbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
271     }
272     else
273     {
274         AslCommonError (Level, MessageId, 0,
275             0, 0, 0, 0, ExtraMessage);
276     }
277 }
278 
279 
280 /*******************************************************************************
281  *
282  * FUNCTION:    DtFatal
283  *
284  * PARAMETERS:  None
285  *
286  * RETURN:      None
287  *
288  * DESCRIPTION: Dump the error log and abort the compiler. Used for serious
289  *              compile or I/O errors
290  *
291  ******************************************************************************/
292 
293 void
294 DtFatal (
295     UINT16                  MessageId,
296     DT_FIELD                *FieldObject,
297     char                    *ExtraMessage)
298 {
299 
300     DtError (ASL_ERROR, MessageId, FieldObject, ExtraMessage);
301 
302 /*
303  * TBD: remove this entire function, DtFatal
304  *
305  * We cannot abort the compiler on error, because we may be compiling a
306  * list of files. We must move on to the next file.
307  */
308 #ifdef __OBSOLETE
309     CmCleanupAndExit ();
310     exit (1);
311 #endif
312 }
313 
314 
315 /*******************************************************************************
316  *
317  * FUNCTION:    DtDoConstant
318  *
319  * PARAMETERS:  String              - Only hex constants are supported,
320  *                                    regardless of whether the 0x prefix
321  *                                    is used
322  *
323  * RETURN:      Converted Integer
324  *
325  * DESCRIPTION: Convert a string to an integer, with overflow/error checking.
326  *
327  ******************************************************************************/
328 
329 UINT64
330 DtDoConstant (
331     char                    *String)
332 {
333     UINT64                  ConvertedInteger;
334 
335 
336     /*
337      * TBD: The ImplicitStrtoul64 function does not report overflow
338      * conditions. The input string is simply truncated. If it is
339      * desired to report overflow to the table compiler, this should
340      * somehow be added here. Note: integers that are prefixed with 0x
341      * or not are both hex integers.
342      */
343     ConvertedInteger = AcpiUtImplicitStrtoul64 (String);
344     return (ConvertedInteger);
345 }
346 
347 /******************************************************************************
348  *
349  * FUNCTION:    DtGetFieldValue
350  *
351  * PARAMETERS:  Field               - Current field list pointer
352  *
353  * RETURN:      Field value
354  *
355  * DESCRIPTION: Get field value
356  *
357  *****************************************************************************/
358 
359 char *
360 DtGetFieldValue (
361     DT_FIELD                *Field)
362 {
363     if (!Field)
364     {
365         return (NULL);
366     }
367 
368     return (Field->Value);
369 }
370 
371 
372 /******************************************************************************
373  *
374  * FUNCTION:    DtGetFieldType
375  *
376  * PARAMETERS:  Info                - Data table info
377  *
378  * RETURN:      Field type
379  *
380  * DESCRIPTION: Get field type
381  *
382  *****************************************************************************/
383 
384 UINT8
385 DtGetFieldType (
386     ACPI_DMTABLE_INFO       *Info)
387 {
388     UINT8                   Type;
389 
390 
391     /* DT_FLAG means that this is the start of a block of flag bits */
392     /* TBD - we can make these a separate opcode later */
393 
394     if (Info->Flags & DT_FLAG)
395     {
396         return (DT_FIELD_TYPE_FLAGS_INTEGER);
397     }
398 
399     /* Type is based upon the opcode for this field in the info table */
400 
401     switch (Info->Opcode)
402     {
403     case ACPI_DMT_FLAG0:
404     case ACPI_DMT_FLAG1:
405     case ACPI_DMT_FLAG2:
406     case ACPI_DMT_FLAG3:
407     case ACPI_DMT_FLAG4:
408     case ACPI_DMT_FLAG5:
409     case ACPI_DMT_FLAG6:
410     case ACPI_DMT_FLAG7:
411     case ACPI_DMT_FLAGS0:
412     case ACPI_DMT_FLAGS1:
413     case ACPI_DMT_FLAGS2:
414     case ACPI_DMT_FLAGS4:
415     case ACPI_DMT_FLAGS4_0:
416     case ACPI_DMT_FLAGS4_4:
417     case ACPI_DMT_FLAGS4_8:
418     case ACPI_DMT_FLAGS4_12:
419     case ACPI_DMT_FLAGS16_16:
420 
421         Type = DT_FIELD_TYPE_FLAG;
422         break;
423 
424     case ACPI_DMT_NAME4:
425     case ACPI_DMT_SIG:
426     case ACPI_DMT_NAME6:
427     case ACPI_DMT_NAME8:
428     case ACPI_DMT_STRING:
429     case ACPI_DMT_IVRS_UNTERMINATED_STRING:
430 
431         Type = DT_FIELD_TYPE_STRING;
432         break;
433 
434     case ACPI_DMT_BUFFER:
435     case ACPI_DMT_RAW_BUFFER:
436     case ACPI_DMT_BUF7:
437     case ACPI_DMT_BUF10:
438     case ACPI_DMT_BUF12:
439     case ACPI_DMT_BUF16:
440     case ACPI_DMT_BUF128:
441     case ACPI_DMT_PCI_PATH:
442     case ACPI_DMT_PMTT_VENDOR:
443 
444         Type = DT_FIELD_TYPE_BUFFER;
445         break;
446 
447     case ACPI_DMT_GAS:
448     case ACPI_DMT_HESTNTFY:
449     case ACPI_DMT_IORTMEM:
450 
451         Type = DT_FIELD_TYPE_INLINE_SUBTABLE;
452         break;
453 
454     case ACPI_DMT_UNICODE:
455     case ACPI_DMT_WPBT_UNICODE:
456 
457         Type = DT_FIELD_TYPE_UNICODE;
458         break;
459 
460     case ACPI_DMT_UUID:
461 
462         Type = DT_FIELD_TYPE_UUID;
463         break;
464 
465     case ACPI_DMT_DEVICE_PATH:
466 
467         Type = DT_FIELD_TYPE_DEVICE_PATH;
468         break;
469 
470     case ACPI_DMT_LABEL:
471 
472         Type = DT_FIELD_TYPE_LABEL;
473         break;
474 
475     default:
476 
477         Type = DT_FIELD_TYPE_INTEGER;
478         break;
479     }
480 
481     return (Type);
482 }
483 
484 
485 /******************************************************************************
486  *
487  * FUNCTION:    DtGetBufferLength
488  *
489  * PARAMETERS:  Buffer              - List of integers,
490  *                                    for example "10 3A 4F 2E"
491  *
492  * RETURN:      Count of integer
493  *
494  * DESCRIPTION: Get length of bytes needed to store the integers
495  *
496  *****************************************************************************/
497 
498 UINT32
499 DtGetBufferLength (
500     char                    *Buffer)
501 {
502     UINT32                  ByteLength = 0;
503 
504 
505     while (*Buffer)
506     {
507         if (*Buffer == ' ')
508         {
509             ByteLength++;
510 
511             while (*Buffer == ' ')
512             {
513                 Buffer++;
514             }
515         }
516 
517         Buffer++;
518     }
519 
520     return (++ByteLength);
521 }
522 
523 
524 /******************************************************************************
525  *
526  * FUNCTION:    DtGetFieldLength
527  *
528  * PARAMETERS:  Field               - Current field
529  *              Info                - Data table info
530  *
531  * RETURN:      Field length
532  *
533  * DESCRIPTION: Get length of bytes needed to compile the field
534  *
535  * Note: This function must remain in sync with AcpiDmDumpTable.
536  *
537  *****************************************************************************/
538 
539 UINT32
540 DtGetFieldLength (
541     DT_FIELD                *Field,
542     ACPI_DMTABLE_INFO       *Info)
543 {
544     UINT32                  ByteLength = 0;
545     char                    *Value;
546 
547 
548     /* Length is based upon the opcode for this field in the info table */
549 
550     switch (Info->Opcode)
551     {
552     case ACPI_DMT_FLAG0:
553     case ACPI_DMT_FLAG1:
554     case ACPI_DMT_FLAG2:
555     case ACPI_DMT_FLAG3:
556     case ACPI_DMT_FLAG4:
557     case ACPI_DMT_FLAG5:
558     case ACPI_DMT_FLAG6:
559     case ACPI_DMT_FLAG7:
560     case ACPI_DMT_FLAGS0:
561     case ACPI_DMT_FLAGS1:
562     case ACPI_DMT_FLAGS2:
563     case ACPI_DMT_FLAGS4:
564     case ACPI_DMT_FLAGS4_0:
565     case ACPI_DMT_FLAGS4_4:
566     case ACPI_DMT_FLAGS4_8:
567     case ACPI_DMT_FLAGS4_12:
568     case ACPI_DMT_FLAGS16_16:
569     case ACPI_DMT_LABEL:
570     case ACPI_DMT_EXTRA_TEXT:
571 
572         ByteLength = 0;
573         break;
574 
575     case ACPI_DMT_UINT8:
576     case ACPI_DMT_CHKSUM:
577     case ACPI_DMT_SPACEID:
578     case ACPI_DMT_ACCWIDTH:
579     case ACPI_DMT_CEDT:
580     case ACPI_DMT_IVRS:
581     case ACPI_DMT_IVRS_DE:
582     case ACPI_DMT_GTDT:
583     case ACPI_DMT_MADT:
584     case ACPI_DMT_PCCT:
585     case ACPI_DMT_PMTT:
586     case ACPI_DMT_PPTT:
587     case ACPI_DMT_RGRT:
588     case ACPI_DMT_SDEV:
589     case ACPI_DMT_SRAT:
590     case ACPI_DMT_AEST:
591     case ACPI_DMT_AEST_RES:
592     case ACPI_DMT_AEST_XFACE:
593     case ACPI_DMT_AEST_XRUPT:
594     case ACPI_DMT_ASF:
595     case ACPI_DMT_HESTNTYP:
596     case ACPI_DMT_FADTPM:
597     case ACPI_DMT_EINJACT:
598     case ACPI_DMT_EINJINST:
599     case ACPI_DMT_ERSTACT:
600     case ACPI_DMT_ERSTINST:
601     case ACPI_DMT_DMAR_SCOPE:
602     case ACPI_DMT_VIOT:
603 
604         ByteLength = 1;
605         break;
606 
607     case ACPI_DMT_UINT16:
608     case ACPI_DMT_DMAR:
609     case ACPI_DMT_HEST:
610     case ACPI_DMT_HMAT:
611     case ACPI_DMT_NFIT:
612     case ACPI_DMT_PCI_PATH:
613     case ACPI_DMT_PHAT:
614 
615         ByteLength = 2;
616         break;
617 
618     case ACPI_DMT_UINT24:
619 
620         ByteLength = 3;
621         break;
622 
623     case ACPI_DMT_UINT32:
624     case ACPI_DMT_AEST_CACHE:
625     case ACPI_DMT_AEST_GIC:
626     case ACPI_DMT_NAME4:
627     case ACPI_DMT_SIG:
628     case ACPI_DMT_LPIT:
629     case ACPI_DMT_TPM2:
630 
631         ByteLength = 4;
632         break;
633 
634     case ACPI_DMT_UINT40:
635 
636         ByteLength = 5;
637         break;
638 
639     case ACPI_DMT_UINT48:
640     case ACPI_DMT_NAME6:
641 
642         ByteLength = 6;
643         break;
644 
645     case ACPI_DMT_UINT56:
646     case ACPI_DMT_BUF7:
647 
648         ByteLength = 7;
649         break;
650 
651     case ACPI_DMT_UINT64:
652     case ACPI_DMT_NAME8:
653 
654         ByteLength = 8;
655         break;
656 
657     case ACPI_DMT_STRING:
658 
659         Value = DtGetFieldValue (Field);
660         if (Value)
661         {
662             ByteLength = strlen (Value) + 1;
663         }
664         else
665         {   /* At this point, this is a fatal error */
666 
667             sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", Info->Name);
668             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
669             return (0);
670         }
671         break;
672 
673     case ACPI_DMT_IVRS_UNTERMINATED_STRING:
674 
675         Value = DtGetFieldValue (Field);
676         if (Value)
677         {
678             ByteLength = strlen (Value);
679         }
680         else
681         {   /* At this point, this is a fatal error */
682 
683             sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", Info->Name);
684             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
685             return (0);
686         }
687         break;
688 
689     case ACPI_DMT_GAS:
690 
691         ByteLength = sizeof (ACPI_GENERIC_ADDRESS);
692         break;
693 
694     case ACPI_DMT_HESTNTFY:
695 
696         ByteLength = sizeof (ACPI_HEST_NOTIFY);
697         break;
698 
699     case ACPI_DMT_IORTMEM:
700 
701         ByteLength = sizeof (ACPI_IORT_MEMORY_ACCESS);
702         break;
703 
704     case ACPI_DMT_BUFFER:
705     case ACPI_DMT_RAW_BUFFER:
706     case ACPI_DMT_PMTT_VENDOR:
707 
708         Value = DtGetFieldValue (Field);
709         if (Value)
710         {
711             ByteLength = DtGetBufferLength (Value);
712         }
713         else
714         {   /* At this point, this is a fatal error */
715 
716             sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", Info->Name);
717             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
718             return (0);
719         }
720         break;
721 
722     case ACPI_DMT_BUF10:
723 
724         ByteLength = 10;
725         break;
726 
727     case ACPI_DMT_BUF12:
728 
729         ByteLength = 12;
730         break;
731 
732     case ACPI_DMT_BUF16:
733     case ACPI_DMT_UUID:
734 
735         ByteLength = 16;
736         break;
737 
738     case ACPI_DMT_BUF128:
739 
740         ByteLength = 128;
741         break;
742 
743     case ACPI_DMT_UNICODE:
744     case ACPI_DMT_WPBT_UNICODE:
745 
746         Value = DtGetFieldValue (Field);
747 
748         /* TBD: error if Value is NULL? (as below?) */
749 
750         ByteLength = (strlen (Value) + 1) * sizeof (UINT16);
751         break;
752 
753     default:
754 
755         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid table opcode");
756         return (0);
757     }
758 
759     return (ByteLength);
760 }
761 
762 
763 /******************************************************************************
764  *
765  * FUNCTION:    DtSum
766  *
767  * PARAMETERS:  DT_WALK_CALLBACK:
768  *              Subtable            - Subtable
769  *              Context             - Unused
770  *              ReturnValue         - Store the checksum of subtable
771  *
772  * RETURN:      Status
773  *
774  * DESCRIPTION: Get the checksum of subtable
775  *
776  *****************************************************************************/
777 
778 static void
779 DtSum (
780     DT_SUBTABLE             *Subtable,
781     void                    *Context,
782     void                    *ReturnValue)
783 {
784     UINT8                   Checksum;
785     UINT8                   *Sum = ReturnValue;
786 
787 
788     Checksum = AcpiTbChecksum (Subtable->Buffer, Subtable->Length);
789     *Sum = (UINT8) (*Sum + Checksum);
790 }
791 
792 
793 /******************************************************************************
794  *
795  * FUNCTION:    DtSetTableChecksum
796  *
797  * PARAMETERS:  ChecksumPointer     - Where to return the checksum
798  *
799  * RETURN:      None
800  *
801  * DESCRIPTION: Set checksum of the whole data table into the checksum field
802  *
803  *****************************************************************************/
804 
805 void
806 DtSetTableChecksum (
807     UINT8                   *ChecksumPointer)
808 {
809     UINT8                   Checksum = 0;
810     UINT8                   OldSum;
811 
812 
813     DtWalkTableTree (AslGbl_RootTable, DtSum, NULL, &Checksum);
814 
815     OldSum = *ChecksumPointer;
816     Checksum = (UINT8) (Checksum - OldSum);
817 
818     /* Compute the final checksum */
819 
820     Checksum = (UINT8) (0 - Checksum);
821     *ChecksumPointer = Checksum;
822 }
823 
824 
825 /******************************************************************************
826  *
827  * FUNCTION:    DtSetTableLength
828  *
829  * PARAMETERS:  None
830  *
831  * RETURN:      None
832  *
833  * DESCRIPTION: Walk the subtables and set all the length fields
834  *
835  *****************************************************************************/
836 
837 void
838 DtSetTableLength (
839     void)
840 {
841     DT_SUBTABLE             *ParentTable;
842     DT_SUBTABLE             *ChildTable;
843 
844 
845     ParentTable = AslGbl_RootTable;
846     ChildTable = NULL;
847 
848     if (!ParentTable)
849     {
850         return;
851     }
852 
853     DtSetSubtableLength (ParentTable);
854 
855     while (1)
856     {
857         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
858         if (ChildTable)
859         {
860             if (ChildTable->LengthField)
861             {
862                 DtSetSubtableLength (ChildTable);
863             }
864 
865             if (ChildTable->Child)
866             {
867                 ParentTable = ChildTable;
868                 ChildTable = NULL;
869             }
870             else
871             {
872                 ParentTable->TotalLength += ChildTable->TotalLength;
873                 if (ParentTable->LengthField)
874                 {
875                     DtSetSubtableLength (ParentTable);
876                 }
877             }
878         }
879         else
880         {
881             ChildTable = ParentTable;
882 
883             if (ChildTable == AslGbl_RootTable)
884             {
885                 break;
886             }
887 
888             ParentTable = DtGetParentSubtable (ParentTable);
889 
890             ParentTable->TotalLength += ChildTable->TotalLength;
891             if (ParentTable->LengthField)
892             {
893                 DtSetSubtableLength (ParentTable);
894             }
895         }
896     }
897 }
898 
899 
900 /******************************************************************************
901  *
902  * FUNCTION:    DtWalkTableTree
903  *
904  * PARAMETERS:  StartTable          - Subtable in the tree where walking begins
905  *              UserFunction        - Called during the walk
906  *              Context             - Passed to user function
907  *              ReturnValue         - The return value of UserFunction
908  *
909  * RETURN:      None
910  *
911  * DESCRIPTION: Performs a depth-first walk of the subtable tree
912  *
913  *****************************************************************************/
914 
915 void
916 DtWalkTableTree (
917     DT_SUBTABLE             *StartTable,
918     DT_WALK_CALLBACK        UserFunction,
919     void                    *Context,
920     void                    *ReturnValue)
921 {
922     DT_SUBTABLE             *ParentTable;
923     DT_SUBTABLE             *ChildTable;
924 
925 
926     ParentTable = StartTable;
927     ChildTable = NULL;
928 
929     if (!ParentTable)
930     {
931         return;
932     }
933 
934     UserFunction (ParentTable, Context, ReturnValue);
935 
936     while (1)
937     {
938         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
939         if (ChildTable)
940         {
941             UserFunction (ChildTable, Context, ReturnValue);
942 
943             if (ChildTable->Child)
944             {
945                 ParentTable = ChildTable;
946                 ChildTable = NULL;
947             }
948         }
949         else
950         {
951             ChildTable = ParentTable;
952             if (ChildTable == AslGbl_RootTable)
953             {
954                 break;
955             }
956 
957             ParentTable = DtGetParentSubtable (ParentTable);
958 
959             if (ChildTable->Peer == StartTable)
960             {
961                 break;
962             }
963         }
964     }
965 }
966