xref: /freebsd/sys/contrib/dev/acpica/compiler/dtutils.c (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
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 - 2022, 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 <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include <contrib/dev/acpica/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_FLAGS8_2:
415     case ACPI_DMT_FLAGS4:
416     case ACPI_DMT_FLAGS4_0:
417     case ACPI_DMT_FLAGS4_4:
418     case ACPI_DMT_FLAGS4_8:
419     case ACPI_DMT_FLAGS4_12:
420     case ACPI_DMT_FLAGS16_16:
421 
422         Type = DT_FIELD_TYPE_FLAG;
423         break;
424 
425     case ACPI_DMT_NAME4:
426     case ACPI_DMT_SIG:
427     case ACPI_DMT_NAME6:
428     case ACPI_DMT_NAME8:
429     case ACPI_DMT_STRING:
430     case ACPI_DMT_IVRS_UNTERMINATED_STRING:
431 
432         Type = DT_FIELD_TYPE_STRING;
433         break;
434 
435     case ACPI_DMT_BUFFER:
436     case ACPI_DMT_RAW_BUFFER:
437     case ACPI_DMT_BUF7:
438     case ACPI_DMT_BUF10:
439     case ACPI_DMT_BUF12:
440     case ACPI_DMT_BUF16:
441     case ACPI_DMT_BUF18:
442     case ACPI_DMT_BUF128:
443     case ACPI_DMT_PCI_PATH:
444     case ACPI_DMT_PMTT_VENDOR:
445 
446         Type = DT_FIELD_TYPE_BUFFER;
447         break;
448 
449     case ACPI_DMT_GAS:
450     case ACPI_DMT_HESTNTFY:
451     case ACPI_DMT_IORTMEM:
452 
453         Type = DT_FIELD_TYPE_INLINE_SUBTABLE;
454         break;
455 
456     case ACPI_DMT_UNICODE:
457     case ACPI_DMT_WPBT_UNICODE:
458 
459         Type = DT_FIELD_TYPE_UNICODE;
460         break;
461 
462     case ACPI_DMT_UUID:
463 
464         Type = DT_FIELD_TYPE_UUID;
465         break;
466 
467     case ACPI_DMT_DEVICE_PATH:
468 
469         Type = DT_FIELD_TYPE_DEVICE_PATH;
470         break;
471 
472     case ACPI_DMT_LABEL:
473 
474         Type = DT_FIELD_TYPE_LABEL;
475         break;
476 
477     default:
478 
479         Type = DT_FIELD_TYPE_INTEGER;
480         break;
481     }
482 
483     return (Type);
484 }
485 
486 
487 /******************************************************************************
488  *
489  * FUNCTION:    DtGetBufferLength
490  *
491  * PARAMETERS:  Buffer              - List of integers,
492  *                                    for example "10 3A 4F 2E"
493  *
494  * RETURN:      Count of integer
495  *
496  * DESCRIPTION: Get length of bytes needed to store the integers
497  *
498  *****************************************************************************/
499 
500 UINT32
501 DtGetBufferLength (
502     char                    *Buffer)
503 {
504     UINT32                  ByteLength = 0;
505 
506 
507     while (*Buffer)
508     {
509         if (*Buffer == ' ')
510         {
511             ByteLength++;
512 
513             while (*Buffer == ' ')
514             {
515                 Buffer++;
516             }
517         }
518 
519         Buffer++;
520     }
521 
522     return (++ByteLength);
523 }
524 
525 
526 /******************************************************************************
527  *
528  * FUNCTION:    DtGetFieldLength
529  *
530  * PARAMETERS:  Field               - Current field
531  *              Info                - Data table info
532  *
533  * RETURN:      Field length
534  *
535  * DESCRIPTION: Get length of bytes needed to compile the field
536  *
537  * Note: This function must remain in sync with AcpiDmDumpTable.
538  *
539  *****************************************************************************/
540 
541 UINT32
542 DtGetFieldLength (
543     DT_FIELD                *Field,
544     ACPI_DMTABLE_INFO       *Info)
545 {
546     UINT32                  ByteLength = 0;
547     char                    *Value;
548 
549 
550     /* Length is based upon the opcode for this field in the info table */
551 
552     switch (Info->Opcode)
553     {
554     case ACPI_DMT_FLAG0:
555     case ACPI_DMT_FLAG1:
556     case ACPI_DMT_FLAG2:
557     case ACPI_DMT_FLAG3:
558     case ACPI_DMT_FLAG4:
559     case ACPI_DMT_FLAG5:
560     case ACPI_DMT_FLAG6:
561     case ACPI_DMT_FLAG7:
562     case ACPI_DMT_FLAGS0:
563     case ACPI_DMT_FLAGS1:
564     case ACPI_DMT_FLAGS2:
565     case ACPI_DMT_FLAGS8_2:
566     case ACPI_DMT_FLAGS4:
567     case ACPI_DMT_FLAGS4_0:
568     case ACPI_DMT_FLAGS4_4:
569     case ACPI_DMT_FLAGS4_8:
570     case ACPI_DMT_FLAGS4_12:
571     case ACPI_DMT_FLAGS16_16:
572     case ACPI_DMT_LABEL:
573     case ACPI_DMT_EXTRA_TEXT:
574 
575         ByteLength = 0;
576         break;
577 
578     case ACPI_DMT_UINT8:
579     case ACPI_DMT_CHKSUM:
580     case ACPI_DMT_SPACEID:
581     case ACPI_DMT_ACCWIDTH:
582     case ACPI_DMT_CEDT:
583     case ACPI_DMT_IVRS:
584     case ACPI_DMT_IVRS_DE:
585     case ACPI_DMT_GTDT:
586     case ACPI_DMT_MADT:
587     case ACPI_DMT_NHLT1:
588     case ACPI_DMT_NHLT1a:
589     case ACPI_DMT_NHLT1b:
590     case ACPI_DMT_NHLT1c:
591     case ACPI_DMT_NHLT1d:
592     case ACPI_DMT_NHLT1f:
593     case ACPI_DMT_PCCT:
594     case ACPI_DMT_PMTT:
595     case ACPI_DMT_PPTT:
596     case ACPI_DMT_RGRT:
597     case ACPI_DMT_SDEV:
598     case ACPI_DMT_SRAT:
599     case ACPI_DMT_AEST:
600     case ACPI_DMT_AEST_RES:
601     case ACPI_DMT_AEST_XFACE:
602     case ACPI_DMT_AEST_XRUPT:
603     case ACPI_DMT_ASF:
604     case ACPI_DMT_CDAT:
605     case ACPI_DMT_HESTNTYP:
606     case ACPI_DMT_FADTPM:
607     case ACPI_DMT_EINJACT:
608     case ACPI_DMT_EINJINST:
609     case ACPI_DMT_ERSTACT:
610     case ACPI_DMT_ERSTINST:
611     case ACPI_DMT_DMAR_SCOPE:
612     case ACPI_DMT_VIOT:
613 
614         ByteLength = 1;
615         break;
616 
617     case ACPI_DMT_UINT16:
618     case ACPI_DMT_DMAR:
619     case ACPI_DMT_HEST:
620     case ACPI_DMT_HMAT:
621     case ACPI_DMT_NFIT:
622     case ACPI_DMT_NHLT1e:
623     case ACPI_DMT_PCI_PATH:
624     case ACPI_DMT_PHAT:
625 
626         ByteLength = 2;
627         break;
628 
629     case ACPI_DMT_UINT24:
630 
631         ByteLength = 3;
632         break;
633 
634     case ACPI_DMT_UINT32:
635     case ACPI_DMT_AEST_CACHE:
636     case ACPI_DMT_AEST_GIC:
637     case ACPI_DMT_NAME4:
638     case ACPI_DMT_SIG:
639     case ACPI_DMT_LPIT:
640     case ACPI_DMT_TPM2:
641 
642         ByteLength = 4;
643         break;
644 
645     case ACPI_DMT_UINT40:
646 
647         ByteLength = 5;
648         break;
649 
650     case ACPI_DMT_UINT48:
651     case ACPI_DMT_NAME6:
652 
653         ByteLength = 6;
654         break;
655 
656     case ACPI_DMT_UINT56:
657     case ACPI_DMT_BUF7:
658 
659         ByteLength = 7;
660         break;
661 
662     case ACPI_DMT_UINT64:
663     case ACPI_DMT_NAME8:
664 
665         ByteLength = 8;
666         break;
667 
668     case ACPI_DMT_STRING:
669 
670         Value = DtGetFieldValue (Field);
671         if (Value)
672         {
673             ByteLength = strlen (Value) + 1;
674         }
675         else
676         {   /* At this point, this is a fatal error */
677 
678             sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", Info->Name);
679             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
680             return (0);
681         }
682         break;
683 
684     case ACPI_DMT_IVRS_UNTERMINATED_STRING:
685 
686         Value = DtGetFieldValue (Field);
687         if (Value)
688         {
689             ByteLength = strlen (Value);
690         }
691         else
692         {   /* At this point, this is a fatal error */
693 
694             sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", Info->Name);
695             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
696             return (0);
697         }
698         break;
699 
700     case ACPI_DMT_GAS:
701 
702         ByteLength = sizeof (ACPI_GENERIC_ADDRESS);
703         break;
704 
705     case ACPI_DMT_HESTNTFY:
706 
707         ByteLength = sizeof (ACPI_HEST_NOTIFY);
708         break;
709 
710     case ACPI_DMT_IORTMEM:
711 
712         ByteLength = sizeof (ACPI_IORT_MEMORY_ACCESS);
713         break;
714 
715     case ACPI_DMT_BUFFER:
716     case ACPI_DMT_RAW_BUFFER:
717     case ACPI_DMT_PMTT_VENDOR:
718 
719         Value = DtGetFieldValue (Field);
720         if (Value)
721         {
722             ByteLength = DtGetBufferLength (Value);
723         }
724         else
725         {   /* At this point, this is a fatal error */
726 
727             sprintf (AslGbl_MsgBuffer, "Expected \"%s\"", Info->Name);
728             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, AslGbl_MsgBuffer);
729             return (0);
730         }
731         break;
732 
733     case ACPI_DMT_BUF10:
734 
735         ByteLength = 10;
736         break;
737 
738     case ACPI_DMT_BUF12:
739 
740         ByteLength = 12;
741         break;
742 
743     case ACPI_DMT_BUF16:
744     case ACPI_DMT_UUID:
745 
746         ByteLength = 16;
747         break;
748 
749     case ACPI_DMT_BUF18:
750 
751         ByteLength = 18;
752         break;
753 
754     case ACPI_DMT_BUF128:
755 
756         ByteLength = 128;
757         break;
758 
759     case ACPI_DMT_UNICODE:
760     case ACPI_DMT_WPBT_UNICODE:
761 
762         Value = DtGetFieldValue (Field);
763 
764         /* TBD: error if Value is NULL? (as below?) */
765 
766         ByteLength = (strlen (Value) + 1) * sizeof (UINT16);
767         break;
768 
769     default:
770 
771         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid table opcode");
772         return (0);
773     }
774 
775     return (ByteLength);
776 }
777 
778 
779 /******************************************************************************
780  *
781  * FUNCTION:    DtSum
782  *
783  * PARAMETERS:  DT_WALK_CALLBACK:
784  *              Subtable            - Subtable
785  *              Context             - Unused
786  *              ReturnValue         - Store the checksum of subtable
787  *
788  * RETURN:      Status
789  *
790  * DESCRIPTION: Get the checksum of subtable
791  *
792  *****************************************************************************/
793 
794 static void
795 DtSum (
796     DT_SUBTABLE             *Subtable,
797     void                    *Context,
798     void                    *ReturnValue)
799 {
800     UINT8                   Checksum;
801     UINT8                   *Sum = ReturnValue;
802 
803 
804     Checksum = AcpiUtChecksum (Subtable->Buffer, Subtable->Length);
805     *Sum = (UINT8) (*Sum + Checksum);
806 }
807 
808 
809 /******************************************************************************
810  *
811  * FUNCTION:    DtSetTableChecksum
812  *
813  * PARAMETERS:  ChecksumPointer     - Where to return the checksum
814  *
815  * RETURN:      None
816  *
817  * DESCRIPTION: Set checksum of the whole data table into the checksum field
818  *
819  *****************************************************************************/
820 
821 void
822 DtSetTableChecksum (
823     UINT8                   *ChecksumPointer)
824 {
825     UINT8                   Checksum = 0;
826     UINT8                   OldSum;
827 
828 
829     DtWalkTableTree (AslGbl_RootTable, DtSum, NULL, &Checksum);
830 
831     OldSum = *ChecksumPointer;
832     Checksum = (UINT8) (Checksum - OldSum);
833 
834     /* Compute the final checksum */
835 
836     Checksum = (UINT8) (0 - Checksum);
837     *ChecksumPointer = Checksum;
838 }
839 
840 
841 /******************************************************************************
842  *
843  * FUNCTION:    DtSetTableLength
844  *
845  * PARAMETERS:  None
846  *
847  * RETURN:      None
848  *
849  * DESCRIPTION: Walk the subtables and set all the length fields
850  *
851  *****************************************************************************/
852 
853 void
854 DtSetTableLength (
855     void)
856 {
857     DT_SUBTABLE             *ParentTable;
858     DT_SUBTABLE             *ChildTable;
859 
860 
861     ParentTable = AslGbl_RootTable;
862     ChildTable = NULL;
863 
864     if (!ParentTable)
865     {
866         return;
867     }
868 
869     DtSetSubtableLength (ParentTable);
870 
871     while (1)
872     {
873         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
874         if (ChildTable)
875         {
876             if (ChildTable->LengthField)
877             {
878                 DtSetSubtableLength (ChildTable);
879             }
880 
881             if (ChildTable->Child)
882             {
883                 ParentTable = ChildTable;
884                 ChildTable = NULL;
885             }
886             else
887             {
888                 ParentTable->TotalLength += ChildTable->TotalLength;
889                 if (ParentTable->LengthField)
890                 {
891                     DtSetSubtableLength (ParentTable);
892                 }
893             }
894         }
895         else
896         {
897             ChildTable = ParentTable;
898 
899             if (ChildTable == AslGbl_RootTable)
900             {
901                 break;
902             }
903 
904             ParentTable = DtGetParentSubtable (ParentTable);
905 
906             ParentTable->TotalLength += ChildTable->TotalLength;
907             if (ParentTable->LengthField)
908             {
909                 DtSetSubtableLength (ParentTable);
910             }
911         }
912     }
913 }
914 
915 
916 /******************************************************************************
917  *
918  * FUNCTION:    DtWalkTableTree
919  *
920  * PARAMETERS:  StartTable          - Subtable in the tree where walking begins
921  *              UserFunction        - Called during the walk
922  *              Context             - Passed to user function
923  *              ReturnValue         - The return value of UserFunction
924  *
925  * RETURN:      None
926  *
927  * DESCRIPTION: Performs a depth-first walk of the subtable tree
928  *
929  *****************************************************************************/
930 
931 void
932 DtWalkTableTree (
933     DT_SUBTABLE             *StartTable,
934     DT_WALK_CALLBACK        UserFunction,
935     void                    *Context,
936     void                    *ReturnValue)
937 {
938     DT_SUBTABLE             *ParentTable;
939     DT_SUBTABLE             *ChildTable;
940 
941 
942     ParentTable = StartTable;
943     ChildTable = NULL;
944 
945     if (!ParentTable)
946     {
947         return;
948     }
949 
950     UserFunction (ParentTable, Context, ReturnValue);
951 
952     while (1)
953     {
954         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
955         if (ChildTable)
956         {
957             UserFunction (ChildTable, Context, ReturnValue);
958 
959             if (ChildTable->Child)
960             {
961                 ParentTable = ChildTable;
962                 ChildTable = NULL;
963             }
964         }
965         else
966         {
967             ChildTable = ParentTable;
968             if (ChildTable == AslGbl_RootTable)
969             {
970                 break;
971             }
972 
973             ParentTable = DtGetParentSubtable (ParentTable);
974 
975             if (ChildTable->Peer == StartTable)
976             {
977                 break;
978             }
979         }
980     }
981 }
982