2 /******************************************************************************
4 * Module Name: aslcodegen - AML code generation
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
119 #include "aslcompiler.h"
120 #include "aslcompiler.y.h"
123 #define _COMPONENT ACPI_COMPILER
124 ACPI_MODULE_NAME ("aslcodegen")
127 /*******************************************************************************
129 * FUNCTION: CgGenerateAmlOutput
135 * DESCRIPTION: Generate AML code. Currently generates the listing file
138 ******************************************************************************/
141 CgGenerateAmlOutput (void)
144 DbgPrint (ASL_DEBUG_OUTPUT, "\nWriting AML\n\n");
146 /* Generate the AML output file */
148 FlSeekFile (ASL_FILE_SOURCE_OUTPUT, 0);
150 Gbl_NextError = Gbl_ErrorLog;
152 TrWalkParseTree (RootNode, ASL_WALK_VISIT_DOWNWARD, CgAmlWriteWalk, NULL, NULL);
157 /*******************************************************************************
159 * FUNCTION: CgAmlWriteWalk
161 * PARAMETERS: ASL_WALK_CALLBACK
165 * DESCRIPTION: Parse tree walk to generate the AML code.
167 ******************************************************************************/
171 ACPI_PARSE_OBJECT *Op,
179 DbgPrint (ASL_TREE_OUTPUT,
180 "%5.5d [%2d]", Op->Asl.LogicalLineNumber, Level);
181 UtPrintFormattedName (Op->Asl.ParseOpcode, Level);
183 if (Op->Asl.ParseOpcode == PARSEOP_NAMESEG ||
184 Op->Asl.ParseOpcode == PARSEOP_NAMESTRING ||
185 Op->Asl.ParseOpcode == PARSEOP_METHODCALL)
187 DbgPrint (ASL_TREE_OUTPUT,
188 "%10.32s ", Op->Asl.ExternalName);
192 DbgPrint (ASL_TREE_OUTPUT, " ");
195 DbgPrint (ASL_TREE_OUTPUT,
196 "Val-%08X POp-%04X AOp-%04X OpLen-%01X PByts-%01X Len-%04X SubLen-%04X PSubLen-%04X Op-%08X Chld-%08X Paren-%08X Flags-%04X AcTyp-%08X C-%2d L-%d\n",
197 (UINT32) Op->Asl.Value.Integer,
200 Op->Asl.AmlOpcodeLength,
201 Op->Asl.AmlPkgLenBytes,
203 Op->Asl.AmlSubtreeLength,
204 Op->Asl.Parent ? Op->Asl.Parent->Asl.AmlSubtreeLength : 0,
208 Op->Asl.CompileFlags,
214 * Generate the AML for this node
221 /*******************************************************************************
223 * FUNCTION: CgLocalWriteAmlData
225 * PARAMETERS: Buffer - Buffer to write
226 * Length - Size of data in buffer
230 * DESCRIPTION: Write a buffer of AML data to the AML output file.
232 ******************************************************************************/
235 CgLocalWriteAmlData (
236 ACPI_PARSE_OBJECT *Op,
242 /* Write the raw data to the AML file */
244 FlWriteFile (ASL_FILE_AML_OUTPUT, Buffer, Length);
246 /* Update the final AML length for this node (used for listings) */
250 Op->Asl.FinalAmlLength += Length;
255 /*******************************************************************************
257 * FUNCTION: CgWriteAmlOpcode
259 * PARAMETERS: Op - Parse node with an AML opcode
263 * DESCRIPTION: Write the AML opcode corresponding to a parse node.
265 ******************************************************************************/
269 ACPI_PARSE_OBJECT *Op)
273 UINT8 OpcodeBytes[2];
280 UINT8 PkgLenFirstByte;
284 /* We expect some DEFAULT_ARGs, just ignore them */
286 if (Op->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG)
291 switch (Op->Asl.AmlOpcode)
293 case AML_UNASSIGNED_OPCODE:
295 /* These opcodes should not get here */
297 printf ("Found a node with an unassigned AML opcode\n");
298 fprintf (stderr, "Found a node with an unassigned AML opcode\n");
301 case AML_INT_RESERVEDFIELD_OP:
303 /* Special opcodes for within a field definition */
308 case AML_INT_ACCESSFIELD_OP:
314 Aml.Opcode = Op->Asl.AmlOpcode;
321 case AML_PACKAGE_LENGTH:
323 /* Value is the length to be encoded (Used in field definitions) */
325 PkgLen.Len = (UINT32) Op->Asl.Value.Integer;
330 /* Check for two-byte opcode */
332 if (Aml.Opcode > 0x00FF)
334 /* Write the high byte first */
336 CgLocalWriteAmlData (Op, &Aml.OpcodeBytes[1], 1);
339 CgLocalWriteAmlData (Op, &Aml.OpcodeBytes[0], 1);
341 /* Subtreelength doesn't include length of package length bytes */
343 PkgLen.Len = Op->Asl.AmlSubtreeLength + Op->Asl.AmlPkgLenBytes;
347 /* Does this opcode have an associated "PackageLength" field? */
349 if (Op->Asl.CompileFlags & NODE_AML_PACKAGE)
351 if (Op->Asl.AmlPkgLenBytes == 1)
353 /* Simplest case -- no bytes to follow, just write the count */
355 CgLocalWriteAmlData (Op, &PkgLen.LenBytes[0], 1);
360 * Encode the "bytes to follow" in the first byte, top two bits.
361 * The low-order nybble of the length is in the bottom 4 bits
363 PkgLenFirstByte = (UINT8) (((UINT32) (Op->Asl.AmlPkgLenBytes - 1) << 6) |
364 (PkgLen.LenBytes[0] & 0x0F));
366 CgLocalWriteAmlData (Op, &PkgLenFirstByte, 1);
368 /* Shift the length over by the 4 bits we just stuffed in the first byte */
372 /* Now we can write the remaining bytes - either 1, 2, or 3 bytes */
374 for (i = 0; i < (UINT32) (Op->Asl.AmlPkgLenBytes - 1); i++)
376 CgLocalWriteAmlData (Op, &PkgLen.LenBytes[i], 1);
385 CgLocalWriteAmlData (Op, (UINT8 *) &Op->Asl.Value.Integer, 1);
390 CgLocalWriteAmlData (Op, (UINT16 *) &Op->Asl.Value.Integer, 2);
395 CgLocalWriteAmlData (Op, (UINT32 *) &Op->Asl.Value.Integer, 4);
400 CgLocalWriteAmlData (Op, &Op->Asl.Value.Integer, 8);
405 CgLocalWriteAmlData (Op, Op->Asl.Value.String, Op->Asl.AmlLength);
409 /* All data opcodes must appear above */
415 /*******************************************************************************
417 * FUNCTION: CgWriteTableHeader
419 * PARAMETERS: Op - The DEFINITIONBLOCK node
423 * DESCRIPTION: Write a table header corresponding to the DEFINITIONBLOCK
425 ******************************************************************************/
429 ACPI_PARSE_OBJECT *Op)
431 ACPI_PARSE_OBJECT *Child;
436 Child = Op->Asl.Child;
440 Child = Child->Asl.Next;
441 strncpy (TableHeader.Signature, Child->Asl.Value.String, 4);
445 Child = Child->Asl.Next;
446 TableHeader.Revision = (UINT8) Child->Asl.Value.Integer;
450 Child = Child->Asl.Next;
451 strncpy (TableHeader.OemId, Child->Asl.Value.String, 6);
455 Child = Child->Asl.Next;
456 strncpy (TableHeader.OemTableId, Child->Asl.Value.String, 8);
460 Child = Child->Asl.Next;
461 TableHeader.OemRevision = (UINT32) Child->Asl.Value.Integer;
465 strncpy (TableHeader.AslCompilerId, CompilerCreatorId, 4);
467 /* Compiler version */
469 TableHeader.AslCompilerRevision = CompilerCreatorRevision;
471 /* Table length. Checksum zero for now, will rewrite later */
473 TableHeader.Length = Gbl_TableLength;
474 TableHeader.Checksum = 0;
476 CgLocalWriteAmlData (Op, &TableHeader, sizeof (ACPI_TABLE_HEADER));
480 /*******************************************************************************
482 * FUNCTION: CgCloseTable
488 * DESCRIPTION: Complete the ACPI table by calculating the checksum and
489 * re-writing the header.
491 ******************************************************************************/
500 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
503 /* Calculate the checksum over the entire file */
505 while (FlReadFile (ASL_FILE_AML_OUTPUT, &FileByte, 1) == AE_OK)
507 Sum = (signed char) (Sum + FileByte);
510 /* Re-write the table header with the checksum */
512 TableHeader.Checksum = (UINT8) (0 - Sum);
514 FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
515 CgLocalWriteAmlData (NULL, &TableHeader, sizeof (ACPI_TABLE_HEADER));
519 /*******************************************************************************
521 * FUNCTION: CgWriteNode
523 * PARAMETERS: Op - Parse node to write.
527 * DESCRIPTION: Write the AML that corresponds to a parse node.
529 ******************************************************************************/
533 ACPI_PARSE_OBJECT *Op)
535 ASL_RESOURCE_NODE *Rnode;
538 Op->Asl.FinalAmlLength = 0;
540 /* Always check for DEFAULT_ARG and other "Noop" nodes */
541 /* TBD: this may not be the best place for this check */
543 if ((Op->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG) ||
544 (Op->Asl.ParseOpcode == PARSEOP_EXTERNAL) ||
545 (Op->Asl.ParseOpcode == PARSEOP_INCLUDE) ||
546 (Op->Asl.ParseOpcode == PARSEOP_INCLUDE_END))
551 switch (Op->Asl.AmlOpcode)
553 case AML_RAW_DATA_BYTE:
554 case AML_RAW_DATA_WORD:
555 case AML_RAW_DATA_DWORD:
556 case AML_RAW_DATA_QWORD:
558 CgLocalWriteAmlData (Op, &Op->Asl.Value.Integer, Op->Asl.AmlLength);
562 case AML_RAW_DATA_BUFFER:
564 CgLocalWriteAmlData (Op, Op->Asl.Value.Buffer, Op->Asl.AmlLength);
568 case AML_RAW_DATA_CHAIN:
570 Rnode = ACPI_CAST_PTR (ASL_RESOURCE_NODE, Op->Asl.Value.Buffer);
573 CgLocalWriteAmlData (Op, Rnode->Buffer, Rnode->BufferLength);
579 /* Internal data opcodes must all appear above */
583 switch (Op->Asl.ParseOpcode)
585 case PARSEOP_DEFAULT_ARG:
589 case PARSEOP_DEFINITIONBLOCK:
591 CgWriteTableHeader (Op);
594 case PARSEOP_NAMESEG:
595 case PARSEOP_NAMESTRING:
596 case PARSEOP_METHODCALL:
598 CgLocalWriteAmlData (Op, Op->Asl.Value.String, Op->Asl.AmlLength);
603 CgWriteAmlOpcode (Op);