1 /******************************************************************************
3 * Module Name: cvcompiler - ASL-/ASL+ converter functions
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/compiler/aslcompiler.h>
153 #include <contrib/dev/acpica/include/acparser.h>
154 #include <contrib/dev/acpica/include/amlcode.h>
155 #include <contrib/dev/acpica/include/acdebug.h>
156 #include <contrib/dev/acpica/include/acconvert.h>
159 /* Local prototypes */
163 ACPI_FILE_NODE *FNode,
168 ACPI_COMMENT_NODE *CommentList);
171 /*******************************************************************************
173 * FUNCTION: CvPrintOneCommentList
175 * PARAMETERS: CommentList
180 * DESCRIPTION: Prints all comments within the given list.
181 * This is referred as ASL_CV_PRINT_ONE_COMMENT_LIST.
183 ******************************************************************************/
186 CvPrintOneCommentList (
187 ACPI_COMMENT_NODE *CommentList,
190 ACPI_COMMENT_NODE *Current = CommentList;
191 ACPI_COMMENT_NODE *Previous;
197 if (Current->Comment)
200 AcpiOsPrintf("%s\n", Current->Comment);
201 Current->Comment = NULL;
204 Current = Current->Next;
205 AcpiOsReleaseObject(AcpiGbl_RegCommentCache, Previous);
210 /*******************************************************************************
212 * FUNCTION: CvListIsSingleton
214 * PARAMETERS: CommentList - check to see if this is a single item list.
218 * DESCRIPTION: Returns TRUE if CommentList only contains 1 node.
220 ******************************************************************************/
224 ACPI_COMMENT_NODE *CommentList)
232 else if (CommentList->Next)
241 /*******************************************************************************
243 * FUNCTION: CvPrintOneCommentType
247 * EndStr - String to print after printing the comment
248 * Level - indentation level for comment lists.
252 * DESCRIPTION: Prints all comments of CommentType within the given Op and
253 * clears the printed comment from the Op.
254 * This is referred as ASL_CV_PRINT_ONE_COMMENT.
256 ******************************************************************************/
259 CvPrintOneCommentType (
260 ACPI_PARSE_OBJECT *Op,
265 BOOLEAN CommentExists = FALSE;
266 char **CommentToPrint = NULL;
271 case AML_COMMENT_STANDARD:
273 if (CvListIsSingleton (Op->Common.CommentList))
275 CvPrintOneCommentList (Op->Common.CommentList, Level);
280 CvPrintOneCommentList (Op->Common.CommentList, Level);
283 Op->Common.CommentList = NULL;
286 case AML_COMMENT_ENDBLK:
288 if (Op->Common.EndBlkComment)
290 CvPrintOneCommentList (Op->Common.EndBlkComment, Level);
291 Op->Common.EndBlkComment = NULL;
296 case AMLCOMMENT_INLINE:
298 CommentToPrint = &Op->Common.InlineComment;
301 case AML_COMMENT_END_NODE:
303 CommentToPrint = &Op->Common.EndNodeComment;
306 case AML_NAMECOMMENT:
308 CommentToPrint = &Op->Common.NameComment;
311 case AML_COMMENT_CLOSE_BRACE:
313 CommentToPrint = &Op->Common.CloseBraceComment;
322 CommentExists = TRUE;
323 AcpiOsPrintf ("%s", *CommentToPrint);
324 *CommentToPrint = NULL;
327 if (CommentExists && EndStr)
329 AcpiOsPrintf ("%s", EndStr);
334 /*******************************************************************************
336 * FUNCTION: CvCloseBraceWriteComment
343 * DESCRIPTION: Print a close brace } and any open brace comments associated
344 * with this parse object.
345 * This is referred as ASL_CV_CLOSE_BRACE.
347 ******************************************************************************/
350 CvCloseBraceWriteComment(
351 ACPI_PARSE_OBJECT *Op,
355 if (!Gbl_CaptureComments)
361 CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level);
363 CvPrintOneCommentType (Op, AML_COMMENT_CLOSE_BRACE, NULL, Level);
367 /*******************************************************************************
369 * FUNCTION: CvCloseParenWriteComment
376 * DESCRIPTION: Print a closing paren ) and any end node comments associated
377 * with this parse object.
378 * This is referred as ASL_CV_CLOSE_PAREN.
380 ******************************************************************************/
383 CvCloseParenWriteComment(
384 ACPI_PARSE_OBJECT *Op,
388 if (!Gbl_CaptureComments)
395 * If this op has a BLOCK_BRACE, then output the comment when the
396 * disassembler calls CvCloseBraceWriteComment
398 if (AcpiDmBlockType (Op) == BLOCK_PAREN)
400 CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level);
405 if (Op->Common.EndNodeComment)
407 CvPrintOneCommentType (Op, AML_COMMENT_END_NODE, NULL, Level);
409 else if ((Op->Common.Parent->Common.AmlOpcode == AML_IF_OP) &&
410 Op->Common.Parent->Common.EndNodeComment)
412 CvPrintOneCommentType (Op->Common.Parent,
413 AML_COMMENT_END_NODE, NULL, Level);
418 /*******************************************************************************
420 * FUNCTION: CvFileHasSwitched
426 * DESCRIPTION: Determine whether if a file has switched.
427 * TRUE - file has switched.
428 * FALSE - file has not switched.
429 * This is referred as ASL_CV_FILE_HAS_SWITCHED.
431 ******************************************************************************/
435 ACPI_PARSE_OBJECT *Op)
438 if (Op->Common.CvFilename &&
439 AcpiGbl_CurrentFilename &&
440 AcpiUtStricmp(Op->Common.CvFilename, AcpiGbl_CurrentFilename))
449 /*******************************************************************************
451 * FUNCTION: CvPrintInclude
453 * PARAMETERS: FNode - Write an Include statement for the file that is pointed
455 * Level - indentation level
459 * DESCRIPTION: Write the ASL Include statement for FNode->File in the file
460 * indicated by FNode->Parent->File. Note this function emits
461 * actual ASL code rather than comments. This switches the output
462 * file to FNode->Parent->File.
464 ******************************************************************************/
468 ACPI_FILE_NODE *FNode,
472 if (!FNode || FNode->IncludeWritten)
477 CvDbgPrint ("Writing include for %s within %s\n",
478 FNode->Filename, FNode->Parent->Filename);
479 AcpiOsRedirectOutput (FNode->Parent->File);
480 CvPrintOneCommentList (FNode->IncludeComment, Level);
482 AcpiDmIndent (Level);
483 AcpiOsPrintf ("Include (\"%s\")\n", FNode->Filename);
484 CvDbgPrint ("emitted the following: Include (\"%s\")\n",
486 FNode->IncludeWritten = TRUE;
490 /*******************************************************************************
492 * FUNCTION: CvSwitchFiles
494 * PARAMETERS: Level - indentation level
499 * DESCRIPTION: Switch the outputfile and write ASL Include statement. Note,
500 * this function emits actual ASL code rather than comments.
501 * This is referred as ASL_CV_SWITCH_FILES.
503 ******************************************************************************/
508 ACPI_PARSE_OBJECT *Op)
510 char *Filename = Op->Common.CvFilename;
511 ACPI_FILE_NODE *FNode;
512 ACPI_FILE_NODE *Current;
515 CvDbgPrint ("Switching from %s to %s\n", AcpiGbl_CurrentFilename,
517 FNode = CvFilenameExists (Filename, AcpiGbl_FileTreeRoot);
521 * At this point, each Filename should exist in AcpiGbl_FileTreeRoot
522 * if it does not exist, then abort.
524 FlDeleteFile (ASL_FILE_AML_OUTPUT);
525 sprintf (MsgBuffer, "\"Cannot find %s\" - %s",
526 Filename, strerror (errno));
527 AslCommonError (ASL_ERROR, ASL_MSG_OPEN, 0, 0, 0, 0,
535 * If the previous file is a descendent of the current file,
536 * make sure that Include statements from the current file
537 * to the previous have been emitted.
541 AcpiUtStricmp (Current->Filename, AcpiGbl_CurrentFilename))
543 CvPrintInclude (Current, Level);
544 Current = Current->Parent;
547 /* Redirect output to Op->Common.CvFilename */
549 AcpiOsRedirectOutput (FNode->File);
550 AcpiGbl_CurrentFilename = FNode->Filename;