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 - 2017, 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 "dtcompiler.h"
154 #include "actables.h"
155 
156 #define _COMPONENT          DT_COMPILER
157         ACPI_MODULE_NAME    ("dtutils")
158 
159 /* Local prototypes */
160 
161 static void
162 DtSum (
163     DT_SUBTABLE             *Subtable,
164     void                    *Context,
165     void                    *ReturnValue);
166 
167 
168 /******************************************************************************
169  *
170  * FUNCTION:    DtError
171  *
172  * PARAMETERS:  Level               - Seriousness (Warning/error, etc.)
173  *              MessageId           - Index into global message buffer
174  *              Op                  - Parse node where error happened
175  *              ExtraMessage        - additional error message
176  *
177  * RETURN:      None
178  *
179  * DESCRIPTION: Common error interface for data table compiler
180  *
181  *****************************************************************************/
182 
183 void
184 DtError (
185     UINT8                   Level,
186     UINT16                  MessageId,
187     DT_FIELD                *FieldObject,
188     char                    *ExtraMessage)
189 {
190 
191     /* Check if user wants to ignore this exception */
192 
193     if (AslIsExceptionIgnored (Level, MessageId))
194     {
195         return;
196     }
197 
198     if (FieldObject)
199     {
200         AslCommonError (Level, MessageId,
201             FieldObject->Line,
202             FieldObject->Line,
203             FieldObject->ByteOffset,
204             FieldObject->Column,
205             Gbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
206     }
207     else
208     {
209         AslCommonError (Level, MessageId, 0,
210             0, 0, 0, 0, ExtraMessage);
211     }
212 }
213 
214 
215 /******************************************************************************
216  *
217  * FUNCTION:    DtNameError
218  *
219  * PARAMETERS:  Level               - Seriousness (Warning/error, etc.)
220  *              MessageId           - Index into global message buffer
221  *              Op                  - Parse node where error happened
222  *              ExtraMessage        - additional error message
223  *
224  * RETURN:      None
225  *
226  * DESCRIPTION: Error interface for named objects
227  *
228  *****************************************************************************/
229 
230 void
231 DtNameError (
232     UINT8                   Level,
233     UINT16                  MessageId,
234     DT_FIELD                *FieldObject,
235     char                    *ExtraMessage)
236 {
237 
238     switch (Level)
239     {
240     case ASL_WARNING2:
241     case ASL_WARNING3:
242 
243         if (Gbl_WarningLevel < Level)
244         {
245             return;
246         }
247         break;
248 
249     default:
250 
251         break;
252     }
253 
254     if (FieldObject)
255     {
256         AslCommonError (Level, MessageId,
257             FieldObject->Line,
258             FieldObject->Line,
259             FieldObject->ByteOffset,
260             FieldObject->NameColumn,
261             Gbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
262     }
263     else
264     {
265         AslCommonError (Level, MessageId, 0,
266             0, 0, 0, 0, ExtraMessage);
267     }
268 }
269 
270 
271 /*******************************************************************************
272  *
273  * FUNCTION:    DtFatal
274  *
275  * PARAMETERS:  None
276  *
277  * RETURN:      None
278  *
279  * DESCRIPTION: Dump the error log and abort the compiler. Used for serious
280  *              compile or I/O errors
281  *
282  ******************************************************************************/
283 
284 void
285 DtFatal (
286     UINT16                  MessageId,
287     DT_FIELD                *FieldObject,
288     char                    *ExtraMessage)
289 {
290 
291     DtError (ASL_ERROR, MessageId, FieldObject, ExtraMessage);
292 
293 /*
294  * TBD: remove this entire function, DtFatal
295  *
296  * We cannot abort the compiler on error, because we may be compiling a
297  * list of files. We must move on to the next file.
298  */
299 #ifdef __OBSOLETE
300     CmCleanupAndExit ();
301     exit (1);
302 #endif
303 }
304 
305 
306 /*******************************************************************************
307  *
308  * FUNCTION:    DtDoConstant
309  *
310  * PARAMETERS:  String              - Only hex constants are supported,
311  *                                    regardless of whether the 0x prefix
312  *                                    is used
313  *
314  * RETURN:      Converted Integer
315  *
316  * DESCRIPTION: Convert a string to an integer, with overflow/error checking.
317  *
318  ******************************************************************************/
319 
320 UINT64
321 DtDoConstant (
322     char                    *String)
323 {
324     UINT64                  ConvertedInteger;
325 
326 
327     /*
328      * TBD: The ImplicitStrtoul64 function does not report overflow
329      * conditions. The input string is simply truncated. If it is
330      * desired to report overflow to the table compiler, this should
331      * somehow be added here. Note: integers that are prefixed with 0x
332      * or not are both hex integers.
333      */
334     ConvertedInteger = AcpiUtImplicitStrtoul64 (String);
335     return (ConvertedInteger);
336 }
337 
338 /******************************************************************************
339  *
340  * FUNCTION:    DtGetFieldValue
341  *
342  * PARAMETERS:  Field               - Current field list pointer
343  *
344  * RETURN:      Field value
345  *
346  * DESCRIPTION: Get field value
347  *
348  *****************************************************************************/
349 
350 char *
351 DtGetFieldValue (
352     DT_FIELD                *Field)
353 {
354     if (!Field)
355     {
356         return (NULL);
357     }
358 
359     return (Field->Value);
360 }
361 
362 
363 /******************************************************************************
364  *
365  * FUNCTION:    DtGetFieldType
366  *
367  * PARAMETERS:  Info                - Data table info
368  *
369  * RETURN:      Field type
370  *
371  * DESCRIPTION: Get field type
372  *
373  *****************************************************************************/
374 
375 UINT8
376 DtGetFieldType (
377     ACPI_DMTABLE_INFO       *Info)
378 {
379     UINT8                   Type;
380 
381 
382     /* DT_FLAG means that this is the start of a block of flag bits */
383     /* TBD - we can make these a separate opcode later */
384 
385     if (Info->Flags & DT_FLAG)
386     {
387         return (DT_FIELD_TYPE_FLAGS_INTEGER);
388     }
389 
390     /* Type is based upon the opcode for this field in the info table */
391 
392     switch (Info->Opcode)
393     {
394     case ACPI_DMT_FLAG0:
395     case ACPI_DMT_FLAG1:
396     case ACPI_DMT_FLAG2:
397     case ACPI_DMT_FLAG3:
398     case ACPI_DMT_FLAG4:
399     case ACPI_DMT_FLAG5:
400     case ACPI_DMT_FLAG6:
401     case ACPI_DMT_FLAG7:
402     case ACPI_DMT_FLAGS0:
403     case ACPI_DMT_FLAGS1:
404     case ACPI_DMT_FLAGS2:
405     case ACPI_DMT_FLAGS4:
406     case ACPI_DMT_FLAGS4_0:
407     case ACPI_DMT_FLAGS4_4:
408     case ACPI_DMT_FLAGS4_8:
409     case ACPI_DMT_FLAGS4_12:
410     case ACPI_DMT_FLAGS16_16:
411 
412         Type = DT_FIELD_TYPE_FLAG;
413         break;
414 
415     case ACPI_DMT_NAME4:
416     case ACPI_DMT_SIG:
417     case ACPI_DMT_NAME6:
418     case ACPI_DMT_NAME8:
419     case ACPI_DMT_STRING:
420 
421         Type = DT_FIELD_TYPE_STRING;
422         break;
423 
424     case ACPI_DMT_BUFFER:
425     case ACPI_DMT_RAW_BUFFER:
426     case ACPI_DMT_BUF7:
427     case ACPI_DMT_BUF10:
428     case ACPI_DMT_BUF12:
429     case ACPI_DMT_BUF16:
430     case ACPI_DMT_BUF128:
431     case ACPI_DMT_PCI_PATH:
432 
433         Type = DT_FIELD_TYPE_BUFFER;
434         break;
435 
436     case ACPI_DMT_GAS:
437     case ACPI_DMT_HESTNTFY:
438     case ACPI_DMT_IORTMEM:
439 
440         Type = DT_FIELD_TYPE_INLINE_SUBTABLE;
441         break;
442 
443     case ACPI_DMT_UNICODE:
444 
445         Type = DT_FIELD_TYPE_UNICODE;
446         break;
447 
448     case ACPI_DMT_UUID:
449 
450         Type = DT_FIELD_TYPE_UUID;
451         break;
452 
453     case ACPI_DMT_DEVICE_PATH:
454 
455         Type = DT_FIELD_TYPE_DEVICE_PATH;
456         break;
457 
458     case ACPI_DMT_LABEL:
459 
460         Type = DT_FIELD_TYPE_LABEL;
461         break;
462 
463     default:
464 
465         Type = DT_FIELD_TYPE_INTEGER;
466         break;
467     }
468 
469     return (Type);
470 }
471 
472 
473 /******************************************************************************
474  *
475  * FUNCTION:    DtGetBufferLength
476  *
477  * PARAMETERS:  Buffer              - List of integers,
478  *                                    for example "10 3A 4F 2E"
479  *
480  * RETURN:      Count of integer
481  *
482  * DESCRIPTION: Get length of bytes needed to store the integers
483  *
484  *****************************************************************************/
485 
486 UINT32
487 DtGetBufferLength (
488     char                    *Buffer)
489 {
490     UINT32                  ByteLength = 0;
491 
492 
493     while (*Buffer)
494     {
495         if (*Buffer == ' ')
496         {
497             ByteLength++;
498 
499             while (*Buffer == ' ')
500             {
501                 Buffer++;
502             }
503         }
504 
505         Buffer++;
506     }
507 
508     return (++ByteLength);
509 }
510 
511 
512 /******************************************************************************
513  *
514  * FUNCTION:    DtGetFieldLength
515  *
516  * PARAMETERS:  Field               - Current field
517  *              Info                - Data table info
518  *
519  * RETURN:      Field length
520  *
521  * DESCRIPTION: Get length of bytes needed to compile the field
522  *
523  * Note: This function must remain in sync with AcpiDmDumpTable.
524  *
525  *****************************************************************************/
526 
527 UINT32
528 DtGetFieldLength (
529     DT_FIELD                *Field,
530     ACPI_DMTABLE_INFO       *Info)
531 {
532     UINT32                  ByteLength = 0;
533     char                    *Value;
534 
535 
536     /* Length is based upon the opcode for this field in the info table */
537 
538     switch (Info->Opcode)
539     {
540     case ACPI_DMT_FLAG0:
541     case ACPI_DMT_FLAG1:
542     case ACPI_DMT_FLAG2:
543     case ACPI_DMT_FLAG3:
544     case ACPI_DMT_FLAG4:
545     case ACPI_DMT_FLAG5:
546     case ACPI_DMT_FLAG6:
547     case ACPI_DMT_FLAG7:
548     case ACPI_DMT_FLAGS0:
549     case ACPI_DMT_FLAGS1:
550     case ACPI_DMT_FLAGS2:
551     case ACPI_DMT_FLAGS4:
552     case ACPI_DMT_FLAGS4_0:
553     case ACPI_DMT_FLAGS4_4:
554     case ACPI_DMT_FLAGS4_8:
555     case ACPI_DMT_FLAGS4_12:
556     case ACPI_DMT_FLAGS16_16:
557     case ACPI_DMT_LABEL:
558     case ACPI_DMT_EXTRA_TEXT:
559 
560         ByteLength = 0;
561         break;
562 
563     case ACPI_DMT_UINT8:
564     case ACPI_DMT_CHKSUM:
565     case ACPI_DMT_SPACEID:
566     case ACPI_DMT_ACCWIDTH:
567     case ACPI_DMT_IVRS:
568     case ACPI_DMT_GTDT:
569     case ACPI_DMT_MADT:
570     case ACPI_DMT_PCCT:
571     case ACPI_DMT_PMTT:
572     case ACPI_DMT_PPTT:
573     case ACPI_DMT_SRAT:
574     case ACPI_DMT_ASF:
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:
582 
583         ByteLength = 1;
584         break;
585 
586     case ACPI_DMT_UINT16:
587     case ACPI_DMT_DMAR:
588     case ACPI_DMT_HEST:
589     case ACPI_DMT_HMAT:
590     case ACPI_DMT_NFIT:
591     case ACPI_DMT_PCI_PATH:
592 
593         ByteLength = 2;
594         break;
595 
596     case ACPI_DMT_UINT24:
597 
598         ByteLength = 3;
599         break;
600 
601     case ACPI_DMT_UINT32:
602     case ACPI_DMT_NAME4:
603     case ACPI_DMT_SIG:
604     case ACPI_DMT_LPIT:
605 
606         ByteLength = 4;
607         break;
608 
609     case ACPI_DMT_UINT40:
610 
611         ByteLength = 5;
612         break;
613 
614     case ACPI_DMT_UINT48:
615     case ACPI_DMT_NAME6:
616 
617         ByteLength = 6;
618         break;
619 
620     case ACPI_DMT_UINT56:
621     case ACPI_DMT_BUF7:
622 
623         ByteLength = 7;
624         break;
625 
626     case ACPI_DMT_UINT64:
627     case ACPI_DMT_NAME8:
628 
629         ByteLength = 8;
630         break;
631 
632     case ACPI_DMT_STRING:
633 
634         Value = DtGetFieldValue (Field);
635         if (Value)
636         {
637             ByteLength = strlen (Value) + 1;
638         }
639         else
640         {   /* At this point, this is a fatal error */
641 
642             sprintf (MsgBuffer, "Expected \"%s\"", Info->Name);
643             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
644             return (0);
645         }
646         break;
647 
648     case ACPI_DMT_GAS:
649 
650         ByteLength = sizeof (ACPI_GENERIC_ADDRESS);
651         break;
652 
653     case ACPI_DMT_HESTNTFY:
654 
655         ByteLength = sizeof (ACPI_HEST_NOTIFY);
656         break;
657 
658     case ACPI_DMT_IORTMEM:
659 
660         ByteLength = sizeof (ACPI_IORT_MEMORY_ACCESS);
661         break;
662 
663     case ACPI_DMT_BUFFER:
664     case ACPI_DMT_RAW_BUFFER:
665 
666         Value = DtGetFieldValue (Field);
667         if (Value)
668         {
669             ByteLength = DtGetBufferLength (Value);
670         }
671         else
672         {   /* At this point, this is a fatal error */
673 
674             sprintf (MsgBuffer, "Expected \"%s\"", Info->Name);
675             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
676             return (0);
677         }
678         break;
679 
680     case ACPI_DMT_BUF10:
681 
682         ByteLength = 10;
683         break;
684 
685     case ACPI_DMT_BUF12:
686 
687         ByteLength = 12;
688         break;
689 
690     case ACPI_DMT_BUF16:
691     case ACPI_DMT_UUID:
692 
693         ByteLength = 16;
694         break;
695 
696     case ACPI_DMT_BUF128:
697 
698         ByteLength = 128;
699         break;
700 
701     case ACPI_DMT_UNICODE:
702 
703         Value = DtGetFieldValue (Field);
704 
705         /* TBD: error if Value is NULL? (as below?) */
706 
707         ByteLength = (strlen (Value) + 1) * sizeof(UINT16);
708         break;
709 
710     default:
711 
712         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid table opcode");
713         return (0);
714     }
715 
716     return (ByteLength);
717 }
718 
719 
720 /******************************************************************************
721  *
722  * FUNCTION:    DtSum
723  *
724  * PARAMETERS:  DT_WALK_CALLBACK:
725  *              Subtable            - Subtable
726  *              Context             - Unused
727  *              ReturnValue         - Store the checksum of subtable
728  *
729  * RETURN:      Status
730  *
731  * DESCRIPTION: Get the checksum of subtable
732  *
733  *****************************************************************************/
734 
735 static void
736 DtSum (
737     DT_SUBTABLE             *Subtable,
738     void                    *Context,
739     void                    *ReturnValue)
740 {
741     UINT8                   Checksum;
742     UINT8                   *Sum = ReturnValue;
743 
744 
745     Checksum = AcpiTbChecksum (Subtable->Buffer, Subtable->Length);
746     *Sum = (UINT8) (*Sum + Checksum);
747 }
748 
749 
750 /******************************************************************************
751  *
752  * FUNCTION:    DtSetTableChecksum
753  *
754  * PARAMETERS:  ChecksumPointer     - Where to return the checksum
755  *
756  * RETURN:      None
757  *
758  * DESCRIPTION: Set checksum of the whole data table into the checksum field
759  *
760  *****************************************************************************/
761 
762 void
763 DtSetTableChecksum (
764     UINT8                   *ChecksumPointer)
765 {
766     UINT8                   Checksum = 0;
767     UINT8                   OldSum;
768 
769 
770     DtWalkTableTree (Gbl_RootTable, DtSum, NULL, &Checksum);
771 
772     OldSum = *ChecksumPointer;
773     Checksum = (UINT8) (Checksum - OldSum);
774 
775     /* Compute the final checksum */
776 
777     Checksum = (UINT8) (0 - Checksum);
778     *ChecksumPointer = Checksum;
779 }
780 
781 
782 /******************************************************************************
783  *
784  * FUNCTION:    DtSetTableLength
785  *
786  * PARAMETERS:  None
787  *
788  * RETURN:      None
789  *
790  * DESCRIPTION: Walk the subtables and set all the length fields
791  *
792  *****************************************************************************/
793 
794 void
795 DtSetTableLength (
796     void)
797 {
798     DT_SUBTABLE             *ParentTable;
799     DT_SUBTABLE             *ChildTable;
800 
801 
802     ParentTable = Gbl_RootTable;
803     ChildTable = NULL;
804 
805     if (!ParentTable)
806     {
807         return;
808     }
809 
810     DtSetSubtableLength (ParentTable);
811 
812     while (1)
813     {
814         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
815         if (ChildTable)
816         {
817             if (ChildTable->LengthField)
818             {
819                 DtSetSubtableLength (ChildTable);
820             }
821 
822             if (ChildTable->Child)
823             {
824                 ParentTable = ChildTable;
825                 ChildTable = NULL;
826             }
827             else
828             {
829                 ParentTable->TotalLength += ChildTable->TotalLength;
830                 if (ParentTable->LengthField)
831                 {
832                     DtSetSubtableLength (ParentTable);
833                 }
834             }
835         }
836         else
837         {
838             ChildTable = ParentTable;
839 
840             if (ChildTable == Gbl_RootTable)
841             {
842                 break;
843             }
844 
845             ParentTable = DtGetParentSubtable (ParentTable);
846 
847             ParentTable->TotalLength += ChildTable->TotalLength;
848             if (ParentTable->LengthField)
849             {
850                 DtSetSubtableLength (ParentTable);
851             }
852         }
853     }
854 }
855 
856 
857 /******************************************************************************
858  *
859  * FUNCTION:    DtWalkTableTree
860  *
861  * PARAMETERS:  StartTable          - Subtable in the tree where walking begins
862  *              UserFunction        - Called during the walk
863  *              Context             - Passed to user function
864  *              ReturnValue         - The return value of UserFunction
865  *
866  * RETURN:      None
867  *
868  * DESCRIPTION: Performs a depth-first walk of the subtable tree
869  *
870  *****************************************************************************/
871 
872 void
873 DtWalkTableTree (
874     DT_SUBTABLE             *StartTable,
875     DT_WALK_CALLBACK        UserFunction,
876     void                    *Context,
877     void                    *ReturnValue)
878 {
879     DT_SUBTABLE             *ParentTable;
880     DT_SUBTABLE             *ChildTable;
881 
882 
883     ParentTable = StartTable;
884     ChildTable = NULL;
885 
886     if (!ParentTable)
887     {
888         return;
889     }
890 
891     UserFunction (ParentTable, Context, ReturnValue);
892 
893     while (1)
894     {
895         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
896         if (ChildTable)
897         {
898             UserFunction (ChildTable, Context, ReturnValue);
899 
900             if (ChildTable->Child)
901             {
902                 ParentTable = ChildTable;
903                 ChildTable = NULL;
904             }
905         }
906         else
907         {
908             ChildTable = ParentTable;
909             if (ChildTable == Gbl_RootTable)
910             {
911                 break;
912             }
913 
914             ParentTable = DtGetParentSubtable (ParentTable);
915 
916             if (ChildTable->Peer == StartTable)
917             {
918                 break;
919             }
920         }
921     }
922 }
923 
924 
925 /*******************************************************************************
926  *
927  * FUNCTION:    UtSubtableCacheCalloc
928  *
929  * PARAMETERS:  None
930  *
931  * RETURN:      Pointer to the buffer. Aborts on allocation failure
932  *
933  * DESCRIPTION: Allocate a subtable object buffer. Bypass the local
934  *              dynamic memory manager for performance reasons (This has a
935  *              major impact on the speed of the compiler.)
936  *
937  ******************************************************************************/
938 
939 DT_SUBTABLE *
940 UtSubtableCacheCalloc (
941     void)
942 {
943     ASL_CACHE_INFO          *Cache;
944 
945 
946     if (Gbl_SubtableCacheNext >= Gbl_SubtableCacheLast)
947     {
948         /* Allocate a new buffer */
949 
950         Cache = UtLocalCalloc (sizeof (Cache->Next) +
951             (sizeof (DT_SUBTABLE) * ASL_SUBTABLE_CACHE_SIZE));
952 
953         /* Link new cache buffer to head of list */
954 
955         Cache->Next = Gbl_SubtableCacheList;
956         Gbl_SubtableCacheList = Cache;
957 
958         /* Setup cache management pointers */
959 
960         Gbl_SubtableCacheNext = ACPI_CAST_PTR (DT_SUBTABLE, Cache->Buffer);
961         Gbl_SubtableCacheLast = Gbl_SubtableCacheNext + ASL_SUBTABLE_CACHE_SIZE;
962     }
963 
964     Gbl_SubtableCount++;
965     return (Gbl_SubtableCacheNext++);
966 }
967 
968 
969 /*******************************************************************************
970  *
971  * FUNCTION:    UtFieldCacheCalloc
972  *
973  * PARAMETERS:  None
974  *
975  * RETURN:      Pointer to the buffer. Aborts on allocation failure
976  *
977  * DESCRIPTION: Allocate a field object buffer. Bypass the local
978  *              dynamic memory manager for performance reasons (This has a
979  *              major impact on the speed of the compiler.)
980  *
981  ******************************************************************************/
982 
983 DT_FIELD *
984 UtFieldCacheCalloc (
985     void)
986 {
987     ASL_CACHE_INFO          *Cache;
988 
989 
990     if (Gbl_FieldCacheNext >= Gbl_FieldCacheLast)
991     {
992         /* Allocate a new buffer */
993 
994         Cache = UtLocalCalloc (sizeof (Cache->Next) +
995             (sizeof (DT_FIELD) * ASL_FIELD_CACHE_SIZE));
996 
997         /* Link new cache buffer to head of list */
998 
999         Cache->Next = Gbl_FieldCacheList;
1000         Gbl_FieldCacheList = Cache;
1001 
1002         /* Setup cache management pointers */
1003 
1004         Gbl_FieldCacheNext = ACPI_CAST_PTR (DT_FIELD, Cache->Buffer);
1005         Gbl_FieldCacheLast = Gbl_FieldCacheNext + ASL_FIELD_CACHE_SIZE;
1006     }
1007 
1008     Gbl_FieldCount++;
1009     return (Gbl_FieldCacheNext++);
1010 }
1011 
1012 
1013 /*******************************************************************************
1014  *
1015  * FUNCTION:    DtDeleteCaches
1016  *
1017  * PARAMETERS:  None
1018  *
1019  * RETURN:      None
1020  *
1021  * DESCRIPTION: Delete all local cache buffer blocks
1022  *
1023  ******************************************************************************/
1024 
1025 void
1026 DtDeleteCaches (
1027     void)
1028 {
1029     UINT32                  BufferCount;
1030     ASL_CACHE_INFO          *Next;
1031 
1032 
1033     /* Field cache */
1034 
1035     BufferCount = 0;
1036     while (Gbl_FieldCacheList)
1037     {
1038         Next = Gbl_FieldCacheList->Next;
1039         ACPI_FREE (Gbl_FieldCacheList);
1040         Gbl_FieldCacheList = Next;
1041         BufferCount++;
1042     }
1043 
1044     DbgPrint (ASL_DEBUG_OUTPUT,
1045         "%u Fields, Buffer size: %u fields (%u bytes), %u Buffers\n",
1046         Gbl_FieldCount, ASL_FIELD_CACHE_SIZE,
1047         (sizeof (DT_FIELD) * ASL_FIELD_CACHE_SIZE), BufferCount);
1048 
1049     Gbl_FieldCount = 0;
1050     Gbl_FieldCacheNext = NULL;
1051     Gbl_FieldCacheLast = NULL;
1052 
1053     /* Subtable cache */
1054 
1055     BufferCount = 0;
1056     while (Gbl_SubtableCacheList)
1057     {
1058         Next = Gbl_SubtableCacheList->Next;
1059         ACPI_FREE (Gbl_SubtableCacheList);
1060         Gbl_SubtableCacheList = Next;
1061         BufferCount++;
1062     }
1063 
1064     DbgPrint (ASL_DEBUG_OUTPUT,
1065         "%u Subtables, Buffer size: %u subtables (%u bytes), %u Buffers\n",
1066         Gbl_SubtableCount, ASL_SUBTABLE_CACHE_SIZE,
1067         (sizeof (DT_SUBTABLE) * ASL_SUBTABLE_CACHE_SIZE), BufferCount);
1068 
1069     Gbl_SubtableCount = 0;
1070     Gbl_SubtableCacheNext = NULL;
1071     Gbl_SubtableCacheLast = NULL;
1072 }
1073