xref: /freebsd/sys/contrib/dev/acpica/compiler/aslcodegen.c (revision 44b0f624aee0d43179bf3874c70e03b6ae49a4db)
1 /******************************************************************************
2  *
3  * Module Name: aslcodegen - AML code generation
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2019, 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 "aslcompiler.y.h"
154 #include <contrib/dev/acpica/include/amlcode.h>
155 #include <contrib/dev/acpica/include/acconvert.h>
156 
157 #define _COMPONENT          ACPI_COMPILER
158         ACPI_MODULE_NAME    ("aslcodegen")
159 
160 /* Local prototypes */
161 
162 static ACPI_STATUS
163 CgAmlWriteWalk (
164     ACPI_PARSE_OBJECT       *Op,
165     UINT32                  Level,
166     void                    *Context);
167 
168 static void
169 CgWriteAmlOpcode (
170     ACPI_PARSE_OBJECT       *Op);
171 
172 static void
173 CgWriteTableHeader (
174     ACPI_PARSE_OBJECT       *Op);
175 
176 static void
177 CgWriteNode (
178     ACPI_PARSE_OBJECT       *Op);
179 
180 static void
181 CgUpdateHeader (
182     ACPI_PARSE_OBJECT       *Op);
183 
184 
185 /*******************************************************************************
186  *
187  * FUNCTION:    CgGenerateAmlOutput
188  *
189  * PARAMETERS:  None.
190  *
191  * RETURN:      None
192  *
193  * DESCRIPTION: Generate AML code. Currently generates the listing file
194  *              simultaneously.
195  *
196  ******************************************************************************/
197 
198 void
199 CgGenerateAmlOutput (
200     void)
201 {
202 
203     /* Generate the AML output file */
204 
205     TrWalkParseTree (AslGbl_CurrentDB,
206         ASL_WALK_VISIT_DOWNWARD | ASL_WALK_VISIT_DB_SEPARATELY,
207         CgAmlWriteWalk, NULL, NULL);
208 
209     DbgPrint (ASL_TREE_OUTPUT, ASL_PARSE_TREE_HEADER2);
210     CgUpdateHeader (AslGbl_CurrentDB);
211 }
212 
213 
214 /*******************************************************************************
215  *
216  * FUNCTION:    CgAmlWriteWalk
217  *
218  * PARAMETERS:  ASL_WALK_CALLBACK
219  *
220  * RETURN:      Status
221  *
222  * DESCRIPTION: Parse tree walk to generate the AML code.
223  *
224  ******************************************************************************/
225 
226 static ACPI_STATUS
227 CgAmlWriteWalk (
228     ACPI_PARSE_OBJECT       *Op,
229     UINT32                  Level,
230     void                    *Context)
231 {
232 
233     /* Generate the AML for this node */
234 
235     CgWriteNode (Op);
236 
237     if (!AslGbl_DebugFlag)
238     {
239         return (AE_OK);
240     }
241 
242     /* Print header at level 0. Alignment assumes 32-bit pointers */
243 
244     if (!Level)
245     {
246         DbgPrint (ASL_TREE_OUTPUT,
247             "\nFinal parse tree used for AML output:\n");
248         DbgPrint (ASL_TREE_OUTPUT, ASL_PARSE_TREE_HEADER2);
249     }
250 
251     /* Dump ParseOp name and possible value */
252 
253     switch (Op->Asl.ParseOpcode)
254     {
255     case PARSEOP_NAMESEG:
256     case PARSEOP_NAMESTRING:
257     case PARSEOP_METHODCALL:
258     case PARSEOP_STRING_LITERAL:
259 
260         UtDumpStringOp (Op, Level);
261         break;
262 
263     default:
264 
265         UtDumpBasicOp (Op, Level);
266         break;
267     }
268 
269     DbgPrint (ASL_TREE_OUTPUT, ASL_PARSE_TREE_DEBUG2,
270         /* 1  */ (UINT32) Op->Asl.Value.Integer,
271         /* 2  */ Op->Asl.ParseOpcode,
272         /* 3  */ Op->Asl.AmlOpcode,
273         /* 4  */ Op->Asl.AmlOpcodeLength,
274         /* 5  */ Op->Asl.AmlPkgLenBytes,
275         /* 6  */ Op->Asl.AmlLength,
276         /* 7  */ Op->Asl.AmlSubtreeLength,
277         /* 8  */ Op->Asl.Parent ? Op->Asl.Parent->Asl.AmlSubtreeLength : 0,
278         /* 9  */ Op,
279         /* 10 */ Op->Asl.Parent,
280         /* 11 */ Op->Asl.Child,
281         /* 12 */ Op->Asl.Next,
282         /* 13 */ Op->Asl.CompileFlags,
283         /* 14 */ Op->Asl.AcpiBtype,
284         /* 15 */ Op->Asl.FinalAmlLength,
285         /* 16 */ Op->Asl.Column,
286         /* 17 */ Op->Asl.LineNumber,
287         /* 18 */ Op->Asl.EndLine,
288         /* 19 */ Op->Asl.LogicalLineNumber,
289         /* 20 */ Op->Asl.EndLogicalLine);
290 
291     TrPrintOpFlags (Op->Asl.CompileFlags, ASL_TREE_OUTPUT);
292     DbgPrint (ASL_TREE_OUTPUT, "\n");
293     return (AE_OK);
294 }
295 
296 
297 /*******************************************************************************
298  *
299  * FUNCTION:    CgLocalWriteAmlData
300  *
301  * PARAMETERS:  Op              - Current parse op
302  *              Buffer          - Buffer to write
303  *              Length          - Size of data in buffer
304  *
305  * RETURN:      None
306  *
307  * DESCRIPTION: Write a buffer of AML data to the AML output file.
308  *
309  ******************************************************************************/
310 
311 void
312 CgLocalWriteAmlData (
313     ACPI_PARSE_OBJECT       *Op,
314     void                    *Buffer,
315     UINT32                  Length)
316 {
317 
318     /* Write the raw data to the AML file */
319 
320     FlWriteFile (ASL_FILE_AML_OUTPUT, Buffer, Length);
321 
322     /* Update the final AML length for this node (used for listings) */
323 
324     if (Op)
325     {
326         Op->Asl.FinalAmlLength += Length;
327     }
328 }
329 
330 
331 /*******************************************************************************
332  *
333  * FUNCTION:    CgWriteAmlOpcode
334  *
335  * PARAMETERS:  Op            - Parse node with an AML opcode
336  *
337  * RETURN:      None.
338  *
339  * DESCRIPTION: Write the AML opcode corresponding to a parse node.
340  *
341  ******************************************************************************/
342 
343 static void
344 CgWriteAmlOpcode (
345     ACPI_PARSE_OBJECT       *Op)
346 {
347     UINT8                   PkgLenFirstByte;
348     UINT32                  i;
349     union {
350         UINT16                  Opcode;
351         UINT8                   OpcodeBytes[2];
352     } Aml;
353     union {
354         UINT32                  Len;
355         UINT8                   LenBytes[4];
356     } PkgLen;
357 
358 
359     /* We expect some DEFAULT_ARGs, just ignore them */
360 
361     if (Op->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
362     {
363         return;
364     }
365 
366     /*
367      * Before printing the bytecode, generate comment byte codes
368      * associated with this node.
369      */
370     if (AcpiGbl_CaptureComments)
371     {
372         CgWriteAmlComment(Op);
373     }
374 
375     switch (Op->Asl.AmlOpcode)
376     {
377     case AML_UNASSIGNED_OPCODE:
378 
379         /* These opcodes should not get here */
380 
381         printf ("Found a node with an unassigned AML opcode\n");
382         FlPrintFile (ASL_FILE_STDERR,
383             "Found a node with an unassigned AML opcode\n");
384         return;
385 
386     case AML_INT_RESERVEDFIELD_OP:
387 
388         /* Special opcodes for within a field definition */
389 
390         Aml.Opcode = AML_FIELD_OFFSET_OP;
391         break;
392 
393     case AML_INT_ACCESSFIELD_OP:
394 
395         Aml.Opcode = AML_FIELD_ACCESS_OP;
396         break;
397 
398     case AML_INT_CONNECTION_OP:
399 
400         Aml.Opcode = AML_FIELD_CONNECTION_OP;
401         break;
402 
403     default:
404 
405         Aml.Opcode = Op->Asl.AmlOpcode;
406         break;
407     }
408 
409 
410     switch (Aml.Opcode)
411     {
412     case AML_PACKAGE_LENGTH:
413 
414         /* Value is the length to be encoded (Used in field definitions) */
415 
416         PkgLen.Len = (UINT32) Op->Asl.Value.Integer;
417         break;
418 
419     default:
420 
421         /* Check for two-byte opcode */
422 
423         if (Aml.Opcode > 0x00FF)
424         {
425             /* Write the high byte first */
426 
427             CgLocalWriteAmlData (Op, &Aml.OpcodeBytes[1], 1);
428         }
429 
430         CgLocalWriteAmlData (Op, &Aml.OpcodeBytes[0], 1);
431 
432         /* Subtreelength doesn't include length of package length bytes */
433 
434         PkgLen.Len = Op->Asl.AmlSubtreeLength + Op->Asl.AmlPkgLenBytes;
435         break;
436     }
437 
438     /* Does this opcode have an associated "PackageLength" field? */
439 
440     if (Op->Asl.CompileFlags & OP_AML_PACKAGE)
441     {
442         if (Op->Asl.AmlPkgLenBytes == 1)
443         {
444             /* Simplest case -- no bytes to follow, just write the count */
445 
446             CgLocalWriteAmlData (Op, &PkgLen.LenBytes[0], 1);
447         }
448         else if (Op->Asl.AmlPkgLenBytes != 0)
449         {
450             /*
451              * Encode the "bytes to follow" in the first byte, top two bits.
452              * The low-order nybble of the length is in the bottom 4 bits
453              */
454             PkgLenFirstByte = (UINT8)
455                 (((UINT32) (Op->Asl.AmlPkgLenBytes - 1) << 6) |
456                 (PkgLen.LenBytes[0] & 0x0F));
457 
458             CgLocalWriteAmlData (Op, &PkgLenFirstByte, 1);
459 
460             /*
461              * Shift the length over by the 4 bits we just stuffed
462              * in the first byte
463              */
464             PkgLen.Len >>= 4;
465 
466             /*
467              * Now we can write the remaining bytes -
468              * either 1, 2, or 3 bytes
469              */
470             for (i = 0; i < (UINT32) (Op->Asl.AmlPkgLenBytes - 1); i++)
471             {
472                 CgLocalWriteAmlData (Op, &PkgLen.LenBytes[i], 1);
473             }
474         }
475     }
476 
477     switch (Aml.Opcode)
478     {
479     case AML_BYTE_OP:
480 
481         CgLocalWriteAmlData (Op, &Op->Asl.Value.Integer, 1);
482         break;
483 
484     case AML_WORD_OP:
485 
486         CgLocalWriteAmlData (Op, &Op->Asl.Value.Integer, 2);
487        break;
488 
489     case AML_DWORD_OP:
490 
491         CgLocalWriteAmlData (Op, &Op->Asl.Value.Integer, 4);
492         break;
493 
494     case AML_QWORD_OP:
495 
496         CgLocalWriteAmlData (Op, &Op->Asl.Value.Integer, 8);
497         break;
498 
499     case AML_STRING_OP:
500 
501         CgLocalWriteAmlData (Op, Op->Asl.Value.String, Op->Asl.AmlLength);
502         break;
503 
504     default:
505 
506         /* All data opcodes must appear above */
507 
508         break;
509     }
510 }
511 
512 
513 /*******************************************************************************
514  *
515  * FUNCTION:    CgWriteTableHeader
516  *
517  * PARAMETERS:  Op        - The DEFINITIONBLOCK node
518  *
519  * RETURN:      None
520  *
521  * DESCRIPTION: Write a table header corresponding to the DEFINITIONBLOCK
522  *
523  * NOTE: Input strings should be validated before this function is invoked.
524  *
525  ******************************************************************************/
526 
527 static void
528 CgWriteTableHeader (
529     ACPI_PARSE_OBJECT       *Op)
530 {
531     ACPI_PARSE_OBJECT       *Child;
532     UINT32                  CommentLength;
533     ACPI_COMMENT_NODE       *Current;
534 
535 
536     memset (&AslGbl_TableHeader, 0, sizeof (ACPI_TABLE_HEADER));
537 
538     /* AML filename */
539 
540     Child = Op->Asl.Child;
541 
542     /* Signature */
543 
544     Child = Child->Asl.Next;
545 
546     /*
547      * For ASL-/ASL+ converter: replace the table signature with
548      * "XXXX" and save the original table signature. This results in an AML
549      * file with the signature "XXXX". The converter should remove this AML
550      * file. In the event where this AML file does not get deleted, the
551      * "XXXX" table signature prevents this AML file from running on the AML
552      * interpreter.
553      */
554     if (AcpiGbl_CaptureComments)
555     {
556         ACPI_COPY_NAMESEG (AcpiGbl_TableSig, Child->Asl.Value.String);
557         Child->Asl.Value.String = ACPI_SIG_XXXX;
558     }
559 
560     ACPI_COPY_NAMESEG (AslGbl_TableHeader.Signature, Child->Asl.Value.String);
561 
562     /* Revision */
563 
564     Child = Child->Asl.Next;
565     AslGbl_TableHeader.Revision = (UINT8) Child->Asl.Value.Integer;
566 
567     /* Command-line Revision override */
568 
569     if (AslGbl_RevisionOverride)
570     {
571         AslGbl_TableHeader.Revision = AslGbl_RevisionOverride;
572     }
573 
574     /* OEMID */
575 
576     Child = Child->Asl.Next;
577     memcpy (AslGbl_TableHeader.OemId, Child->Asl.Value.String,
578         strlen (Child->Asl.Value.String));
579 
580     /* OEM TableID */
581 
582     Child = Child->Asl.Next;
583     memcpy (AslGbl_TableHeader.OemTableId, Child->Asl.Value.String,
584         strlen (Child->Asl.Value.String));
585 
586     /* OEM Revision */
587 
588     Child = Child->Asl.Next;
589     AslGbl_TableHeader.OemRevision = (UINT32) Child->Asl.Value.Integer;
590 
591     /* Compiler ID */
592 
593     ACPI_COPY_NAMESEG (AslGbl_TableHeader.AslCompilerId, ASL_CREATOR_ID);
594 
595     /* Compiler version */
596 
597     AslGbl_TableHeader.AslCompilerRevision = ACPI_CA_VERSION;
598 
599     /* Table length. Checksum zero for now, will rewrite later */
600 
601     AslGbl_TableHeader.Length = sizeof (ACPI_TABLE_HEADER) +
602         Op->Asl.AmlSubtreeLength;
603 
604     /* Calculate the comment lengths for this definition block parseOp */
605 
606     if (AcpiGbl_CaptureComments)
607     {
608         CvDbgPrint ("Calculating comment lengths for %s in write header\n",
609             Op->Asl.ParseOpName);
610 
611         /*
612          * Take the filename without extensions, add 3 for the new extension
613          * and another 3 for the a908 bytecode and null terminator.
614          */
615         AslGbl_TableHeader.Length += strrchr (AslGbl_ParseTreeRoot->Asl.Filename, '.')
616             - AslGbl_ParseTreeRoot->Asl.Filename + 1 + 3 + 3;
617 
618         Op->Asl.AmlSubtreeLength +=
619             strlen (AslGbl_ParseTreeRoot->Asl.Filename) + 3;
620 
621         CvDbgPrint ("     Length: %lu\n",
622             strlen (AslGbl_ParseTreeRoot->Asl.Filename) + 3);
623 
624         if (Op->Asl.CommentList)
625         {
626             Current = Op->Asl.CommentList;
627             while (Current)
628             {
629                 CommentLength = strlen (Current->Comment)+3;
630                 CvDbgPrint ("Length of standard comment): %d\n", CommentLength);
631                 CvDbgPrint ("    Comment string: %s\n\n", Current->Comment);
632                 AslGbl_TableHeader.Length += CommentLength;
633                 Op->Asl.AmlSubtreeLength += CommentLength;
634                 Current = Current->Next;
635                 CvDbgPrint ("    Length: %u\n", CommentLength);
636             }
637         }
638         if (Op->Asl.CloseBraceComment)
639         {
640             CommentLength = strlen (Op->Asl.CloseBraceComment)+3;
641             CvDbgPrint ("Length of inline comment +3: %d\n", CommentLength);
642             CvDbgPrint ("    Comment string: %s\n\n", Op->Asl.CloseBraceComment);
643             AslGbl_TableHeader.Length += CommentLength;
644             Op->Asl.AmlSubtreeLength += CommentLength;
645             CvDbgPrint ("    Length: %u\n", CommentLength);
646         }
647     }
648 
649     AslGbl_TableHeader.Checksum = 0;
650     Op->Asl.FinalAmlOffset = ftell (AslGbl_Files[ASL_FILE_AML_OUTPUT].Handle);
651 
652     /* Write entire header and clear the table header global */
653 
654     CgLocalWriteAmlData (Op, &AslGbl_TableHeader, sizeof (ACPI_TABLE_HEADER));
655     memset (&AslGbl_TableHeader, 0, sizeof (ACPI_TABLE_HEADER));
656 }
657 
658 
659 /*******************************************************************************
660  *
661  * FUNCTION:    CgUpdateHeader
662  *
663  * PARAMETERS:  Op                  - Op for the Definition Block
664  *
665  * RETURN:      None.
666  *
667  * DESCRIPTION: Complete the ACPI table by calculating the checksum and
668  *              re-writing the header for the input definition block
669  *
670  ******************************************************************************/
671 
672 static void
673 CgUpdateHeader (
674     ACPI_PARSE_OBJECT       *Op)
675 {
676     signed char             Sum;
677     UINT32                  i;
678     UINT32                  Length;
679     UINT8                   FileByte;
680     UINT8                   Checksum;
681 
682 
683     /* Calculate the checksum over the entire definition block */
684 
685     Sum = 0;
686     Length = sizeof (ACPI_TABLE_HEADER) + Op->Asl.AmlSubtreeLength;
687     FlSeekFile (ASL_FILE_AML_OUTPUT, Op->Asl.FinalAmlOffset);
688 
689     for (i = 0; i < Length; i++)
690     {
691         if (FlReadFile (ASL_FILE_AML_OUTPUT, &FileByte, 1) != AE_OK)
692         {
693             printf ("EOF while reading checksum bytes\n");
694             return;
695         }
696 
697         Sum = (signed char) (Sum + FileByte);
698     }
699 
700     Checksum = (UINT8) (0 - Sum);
701 
702     /* Re-write the the checksum byte */
703 
704     FlSeekFile (ASL_FILE_AML_OUTPUT, Op->Asl.FinalAmlOffset +
705         ACPI_OFFSET (ACPI_TABLE_HEADER, Checksum));
706 
707     FlWriteFile (ASL_FILE_AML_OUTPUT, &Checksum, 1);
708 
709     /*
710      * Seek to the end of the file. This is done to support multiple file
711      * compilation. Doing this simplifies other parts of the codebase because
712      * it eliminates the need to seek for a different starting place.
713      */
714     FlSeekFile (ASL_FILE_AML_OUTPUT, Op->Asl.FinalAmlOffset + Length);
715 }
716 
717 
718 /*******************************************************************************
719  *
720  * FUNCTION:    CgWriteNode
721  *
722  * PARAMETERS:  Op            - Parse node to write.
723  *
724  * RETURN:      None.
725  *
726  * DESCRIPTION: Write the AML that corresponds to a parse node.
727  *
728  ******************************************************************************/
729 
730 static void
731 CgWriteNode (
732     ACPI_PARSE_OBJECT       *Op)
733 {
734     ASL_RESOURCE_NODE       *Rnode;
735 
736 
737     /* Write all comments here. */
738 
739     if (AcpiGbl_CaptureComments)
740     {
741         CgWriteAmlComment(Op);
742     }
743 
744     /* Always check for DEFAULT_ARG and other "Noop" nodes */
745     /* TBD: this may not be the best place for this check */
746 
747     if ((Op->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)  ||
748         (Op->Asl.ParseOpcode == PARSEOP_INCLUDE)      ||
749         (Op->Asl.ParseOpcode == PARSEOP_INCLUDE_END))
750     {
751         return;
752     }
753 
754     Op->Asl.FinalAmlLength = 0;
755 
756     switch (Op->Asl.AmlOpcode)
757     {
758     case AML_RAW_DATA_BYTE:
759     case AML_RAW_DATA_WORD:
760     case AML_RAW_DATA_DWORD:
761     case AML_RAW_DATA_QWORD:
762 
763         CgLocalWriteAmlData (Op, &Op->Asl.Value.Integer, Op->Asl.AmlLength);
764         return;
765 
766 
767     case AML_RAW_DATA_BUFFER:
768 
769         CgLocalWriteAmlData (Op, Op->Asl.Value.Buffer, Op->Asl.AmlLength);
770         return;
771 
772 
773     case AML_RAW_DATA_CHAIN:
774 
775         Rnode = ACPI_CAST_PTR (ASL_RESOURCE_NODE, Op->Asl.Value.Buffer);
776         while (Rnode)
777         {
778             CgLocalWriteAmlData (Op, Rnode->Buffer, Rnode->BufferLength);
779             Rnode = Rnode->Next;
780         }
781         return;
782 
783     default:
784 
785         /* Internal data opcodes must all appear above */
786 
787         break;
788     }
789 
790     switch (Op->Asl.ParseOpcode)
791     {
792     case PARSEOP_DEFAULT_ARG:
793 
794         break;
795 
796     case PARSEOP_DEFINITION_BLOCK:
797 
798         CgWriteTableHeader (Op);
799         if (AcpiGbl_CaptureComments)
800         {
801             CgWriteAmlDefBlockComment (Op);
802         }
803         break;
804 
805     case PARSEOP_NAMESEG:
806     case PARSEOP_NAMESTRING:
807     case PARSEOP_METHODCALL:
808 
809         CgLocalWriteAmlData (Op, Op->Asl.Value.String, Op->Asl.AmlLength);
810         break;
811 
812     default:
813 
814         CgWriteAmlOpcode (Op);
815         break;
816     }
817 }
818