xref: /freebsd/sys/contrib/dev/acpica/compiler/cvdisasm.c (revision af051161437e44a6ceabf9e196f0eb8f33d92b86)
10d84335fSJung-uk Kim /******************************************************************************
20d84335fSJung-uk Kim  *
30d84335fSJung-uk Kim  * Module Name: cvcompiler - ASL-/ASL+ converter functions
40d84335fSJung-uk Kim  *
50d84335fSJung-uk Kim  *****************************************************************************/
60d84335fSJung-uk Kim 
70d84335fSJung-uk Kim /******************************************************************************
80d84335fSJung-uk Kim  *
90d84335fSJung-uk Kim  * 1. Copyright Notice
100d84335fSJung-uk Kim  *
110d84335fSJung-uk Kim  * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
120d84335fSJung-uk Kim  * All rights reserved.
130d84335fSJung-uk Kim  *
140d84335fSJung-uk Kim  * 2. License
150d84335fSJung-uk Kim  *
160d84335fSJung-uk Kim  * 2.1. This is your license from Intel Corp. under its intellectual property
170d84335fSJung-uk Kim  * rights. You may have additional license terms from the party that provided
180d84335fSJung-uk Kim  * you this software, covering your right to use that party's intellectual
190d84335fSJung-uk Kim  * property rights.
200d84335fSJung-uk Kim  *
210d84335fSJung-uk Kim  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
220d84335fSJung-uk Kim  * copy of the source code appearing in this file ("Covered Code") an
230d84335fSJung-uk Kim  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
240d84335fSJung-uk Kim  * base code distributed originally by Intel ("Original Intel Code") to copy,
250d84335fSJung-uk Kim  * make derivatives, distribute, use and display any portion of the Covered
260d84335fSJung-uk Kim  * Code in any form, with the right to sublicense such rights; and
270d84335fSJung-uk Kim  *
280d84335fSJung-uk Kim  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
290d84335fSJung-uk Kim  * license (with the right to sublicense), under only those claims of Intel
300d84335fSJung-uk Kim  * patents that are infringed by the Original Intel Code, to make, use, sell,
310d84335fSJung-uk Kim  * offer to sell, and import the Covered Code and derivative works thereof
320d84335fSJung-uk Kim  * solely to the minimum extent necessary to exercise the above copyright
330d84335fSJung-uk Kim  * license, and in no event shall the patent license extend to any additions
340d84335fSJung-uk Kim  * to or modifications of the Original Intel Code. No other license or right
350d84335fSJung-uk Kim  * is granted directly or by implication, estoppel or otherwise;
360d84335fSJung-uk Kim  *
370d84335fSJung-uk Kim  * The above copyright and patent license is granted only if the following
380d84335fSJung-uk Kim  * conditions are met:
390d84335fSJung-uk Kim  *
400d84335fSJung-uk Kim  * 3. Conditions
410d84335fSJung-uk Kim  *
420d84335fSJung-uk Kim  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
430d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
440d84335fSJung-uk Kim  * Code or modification with rights to further distribute source must include
450d84335fSJung-uk Kim  * the above Copyright Notice, the above License, this list of Conditions,
460d84335fSJung-uk Kim  * and the following Disclaimer and Export Compliance provision. In addition,
470d84335fSJung-uk Kim  * Licensee must cause all Covered Code to which Licensee contributes to
480d84335fSJung-uk Kim  * contain a file documenting the changes Licensee made to create that Covered
490d84335fSJung-uk Kim  * Code and the date of any change. Licensee must include in that file the
500d84335fSJung-uk Kim  * documentation of any changes made by any predecessor Licensee. Licensee
510d84335fSJung-uk Kim  * must include a prominent statement that the modification is derived,
520d84335fSJung-uk Kim  * directly or indirectly, from Original Intel Code.
530d84335fSJung-uk Kim  *
540d84335fSJung-uk Kim  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
550d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
560d84335fSJung-uk Kim  * Code or modification without rights to further distribute source must
570d84335fSJung-uk Kim  * include the following Disclaimer and Export Compliance provision in the
580d84335fSJung-uk Kim  * documentation and/or other materials provided with distribution. In
590d84335fSJung-uk Kim  * addition, Licensee may not authorize further sublicense of source of any
600d84335fSJung-uk Kim  * portion of the Covered Code, and must include terms to the effect that the
610d84335fSJung-uk Kim  * license from Licensee to its licensee is limited to the intellectual
620d84335fSJung-uk Kim  * property embodied in the software Licensee provides to its licensee, and
630d84335fSJung-uk Kim  * not to intellectual property embodied in modifications its licensee may
640d84335fSJung-uk Kim  * make.
650d84335fSJung-uk Kim  *
660d84335fSJung-uk Kim  * 3.3. Redistribution of Executable. Redistribution in executable form of any
670d84335fSJung-uk Kim  * substantial portion of the Covered Code or modification must reproduce the
680d84335fSJung-uk Kim  * above Copyright Notice, and the following Disclaimer and Export Compliance
690d84335fSJung-uk Kim  * provision in the documentation and/or other materials provided with the
700d84335fSJung-uk Kim  * distribution.
710d84335fSJung-uk Kim  *
720d84335fSJung-uk Kim  * 3.4. Intel retains all right, title, and interest in and to the Original
730d84335fSJung-uk Kim  * Intel Code.
740d84335fSJung-uk Kim  *
750d84335fSJung-uk Kim  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
760d84335fSJung-uk Kim  * Intel shall be used in advertising or otherwise to promote the sale, use or
770d84335fSJung-uk Kim  * other dealings in products derived from or relating to the Covered Code
780d84335fSJung-uk Kim  * without prior written authorization from Intel.
790d84335fSJung-uk Kim  *
800d84335fSJung-uk Kim  * 4. Disclaimer and Export Compliance
810d84335fSJung-uk Kim  *
820d84335fSJung-uk Kim  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
830d84335fSJung-uk Kim  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
840d84335fSJung-uk Kim  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
850d84335fSJung-uk Kim  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
860d84335fSJung-uk Kim  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
870d84335fSJung-uk Kim  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
880d84335fSJung-uk Kim  * PARTICULAR PURPOSE.
890d84335fSJung-uk Kim  *
900d84335fSJung-uk Kim  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
910d84335fSJung-uk Kim  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
920d84335fSJung-uk Kim  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
930d84335fSJung-uk Kim  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
940d84335fSJung-uk Kim  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
950d84335fSJung-uk Kim  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
960d84335fSJung-uk Kim  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
970d84335fSJung-uk Kim  * LIMITED REMEDY.
980d84335fSJung-uk Kim  *
990d84335fSJung-uk Kim  * 4.3. Licensee shall not export, either directly or indirectly, any of this
1000d84335fSJung-uk Kim  * software or system incorporating such software without first obtaining any
1010d84335fSJung-uk Kim  * required license or other approval from the U. S. Department of Commerce or
1020d84335fSJung-uk Kim  * any other agency or department of the United States Government. In the
1030d84335fSJung-uk Kim  * event Licensee exports any such software from the United States or
1040d84335fSJung-uk Kim  * re-exports any such software from a foreign destination, Licensee shall
1050d84335fSJung-uk Kim  * ensure that the distribution and export/re-export of the software is in
1060d84335fSJung-uk Kim  * compliance with all laws, regulations, orders, or other restrictions of the
1070d84335fSJung-uk Kim  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
1080d84335fSJung-uk Kim  * any of its subsidiaries will export/re-export any technical data, process,
1090d84335fSJung-uk Kim  * software, or service, directly or indirectly, to any country for which the
1100d84335fSJung-uk Kim  * United States government or any agency thereof requires an export license,
1110d84335fSJung-uk Kim  * other governmental approval, or letter of assurance, without first obtaining
1120d84335fSJung-uk Kim  * such license, approval or letter.
1130d84335fSJung-uk Kim  *
1140d84335fSJung-uk Kim  *****************************************************************************
1150d84335fSJung-uk Kim  *
1160d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
1170d84335fSJung-uk Kim  * following license:
1180d84335fSJung-uk Kim  *
1190d84335fSJung-uk Kim  * Redistribution and use in source and binary forms, with or without
1200d84335fSJung-uk Kim  * modification, are permitted provided that the following conditions
1210d84335fSJung-uk Kim  * are met:
1220d84335fSJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
1230d84335fSJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
1240d84335fSJung-uk Kim  *    without modification.
1250d84335fSJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1260d84335fSJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
1270d84335fSJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
1280d84335fSJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
1290d84335fSJung-uk Kim  *    binary redistribution.
1300d84335fSJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
1310d84335fSJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
1320d84335fSJung-uk Kim  *    from this software without specific prior written permission.
1330d84335fSJung-uk Kim  *
1340d84335fSJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1350d84335fSJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1360d84335fSJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1370d84335fSJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1380d84335fSJung-uk Kim  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1390d84335fSJung-uk Kim  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1400d84335fSJung-uk Kim  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1410d84335fSJung-uk Kim  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1420d84335fSJung-uk Kim  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1430d84335fSJung-uk Kim  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1440d84335fSJung-uk Kim  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1450d84335fSJung-uk Kim  *
1460d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
1470d84335fSJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
1480d84335fSJung-uk Kim  * Software Foundation.
1490d84335fSJung-uk Kim  *
1500d84335fSJung-uk Kim  *****************************************************************************/
1510d84335fSJung-uk Kim 
1520d84335fSJung-uk Kim #include <contrib/dev/acpica/compiler/aslcompiler.h>
1530d84335fSJung-uk Kim #include <contrib/dev/acpica/include/acparser.h>
1540d84335fSJung-uk Kim #include <contrib/dev/acpica/include/amlcode.h>
1550d84335fSJung-uk Kim #include <contrib/dev/acpica/include/acdebug.h>
1560d84335fSJung-uk Kim #include <contrib/dev/acpica/include/acconvert.h>
1570d84335fSJung-uk Kim 
1580d84335fSJung-uk Kim 
1590d84335fSJung-uk Kim static void
1600d84335fSJung-uk Kim CvPrintInclude(
1610d84335fSJung-uk Kim     ACPI_FILE_NODE          *FNode,
1620d84335fSJung-uk Kim     UINT32                  Level);
1630d84335fSJung-uk Kim 
1640d84335fSJung-uk Kim static BOOLEAN
1650d84335fSJung-uk Kim CvListIsSingleton (
1660d84335fSJung-uk Kim     ACPI_COMMENT_NODE       *CommentList);
1670d84335fSJung-uk Kim 
1680d84335fSJung-uk Kim 
1690d84335fSJung-uk Kim /*******************************************************************************
1700d84335fSJung-uk Kim  *
1710d84335fSJung-uk Kim  * FUNCTION:    CvPrintOneCommentList
1720d84335fSJung-uk Kim  *
1730d84335fSJung-uk Kim  * PARAMETERS:  CommentList
1740d84335fSJung-uk Kim  *              Level
1750d84335fSJung-uk Kim  *
1760d84335fSJung-uk Kim  * RETURN:      None
1770d84335fSJung-uk Kim  *
1780d84335fSJung-uk Kim  * DESCRIPTION: Prints all comments within the given list.
1790d84335fSJung-uk Kim  *              This is referred as ASL_CV_PRINT_ONE_COMMENT_LIST.
1800d84335fSJung-uk Kim  *
1810d84335fSJung-uk Kim  ******************************************************************************/
1820d84335fSJung-uk Kim 
1830d84335fSJung-uk Kim void
1840d84335fSJung-uk Kim CvPrintOneCommentList (
1850d84335fSJung-uk Kim     ACPI_COMMENT_NODE       *CommentList,
1860d84335fSJung-uk Kim     UINT32                  Level)
1870d84335fSJung-uk Kim {
1880d84335fSJung-uk Kim     ACPI_COMMENT_NODE       *Current = CommentList;
1890d84335fSJung-uk Kim     ACPI_COMMENT_NODE       *Previous;
1900d84335fSJung-uk Kim 
1910d84335fSJung-uk Kim 
1920d84335fSJung-uk Kim     while (Current)
1930d84335fSJung-uk Kim     {
1940d84335fSJung-uk Kim         Previous = Current;
1950d84335fSJung-uk Kim         if (Current->Comment)
1960d84335fSJung-uk Kim         {
1970d84335fSJung-uk Kim             AcpiDmIndent(Level);
1980d84335fSJung-uk Kim             AcpiOsPrintf("%s\n", Current->Comment);
1990d84335fSJung-uk Kim             Current->Comment = NULL;
2000d84335fSJung-uk Kim         }
2010d84335fSJung-uk Kim         Current = Current->Next;
2020d84335fSJung-uk Kim         AcpiOsReleaseObject(AcpiGbl_RegCommentCache, Previous);
2030d84335fSJung-uk Kim     }
2040d84335fSJung-uk Kim }
2050d84335fSJung-uk Kim 
2060d84335fSJung-uk Kim 
2070d84335fSJung-uk Kim /*******************************************************************************
2080d84335fSJung-uk Kim  *
2090d84335fSJung-uk Kim  * FUNCTION:    CvListIsSingleton
2100d84335fSJung-uk Kim  *
2110d84335fSJung-uk Kim  * PARAMETERS:  CommentList -- check to see if this is a single item list.
2120d84335fSJung-uk Kim  *
2130d84335fSJung-uk Kim  * RETURN:      BOOLEAN
2140d84335fSJung-uk Kim  *
2150d84335fSJung-uk Kim  * DESCRIPTION: Returns TRUE if CommentList only contains 1 node.
2160d84335fSJung-uk Kim  *
2170d84335fSJung-uk Kim  ******************************************************************************/
2180d84335fSJung-uk Kim 
2190d84335fSJung-uk Kim static BOOLEAN
2200d84335fSJung-uk Kim CvListIsSingleton (
2210d84335fSJung-uk Kim     ACPI_COMMENT_NODE       *CommentList)
2220d84335fSJung-uk Kim 
2230d84335fSJung-uk Kim {
2240d84335fSJung-uk Kim     if (!CommentList)
2250d84335fSJung-uk Kim     {
2260d84335fSJung-uk Kim         return FALSE;
2270d84335fSJung-uk Kim     }
2280d84335fSJung-uk Kim     else if (CommentList->Next)
2290d84335fSJung-uk Kim     {
2300d84335fSJung-uk Kim         return FALSE;
2310d84335fSJung-uk Kim     }
2320d84335fSJung-uk Kim 
2330d84335fSJung-uk Kim     return TRUE;
2340d84335fSJung-uk Kim }
2350d84335fSJung-uk Kim 
2360d84335fSJung-uk Kim 
2370d84335fSJung-uk Kim /*******************************************************************************
2380d84335fSJung-uk Kim  *
2390d84335fSJung-uk Kim  * FUNCTION:    CvPrintOneCommentType
2400d84335fSJung-uk Kim  *
2410d84335fSJung-uk Kim  * PARAMETERS:  Op
2420d84335fSJung-uk Kim  *              CommentType
2430d84335fSJung-uk Kim  *              EndStr - String to print after printing the comment
2440d84335fSJung-uk Kim  *              Level  - indentation level for comment lists.
2450d84335fSJung-uk Kim  *
2460d84335fSJung-uk Kim  * RETURN:      None
2470d84335fSJung-uk Kim  *
2480d84335fSJung-uk Kim  * DESCRIPTION: Prints all comments of CommentType within the given Op and
2490d84335fSJung-uk Kim  *              clears the printed comment from the Op.
2500d84335fSJung-uk Kim  *              This is referred as ASL_CV_PRINT_ONE_COMMENT.
2510d84335fSJung-uk Kim  *
2520d84335fSJung-uk Kim  ******************************************************************************/
2530d84335fSJung-uk Kim 
2540d84335fSJung-uk Kim void
2550d84335fSJung-uk Kim CvPrintOneCommentType (
2560d84335fSJung-uk Kim     ACPI_PARSE_OBJECT       *Op,
2570d84335fSJung-uk Kim     UINT8                   CommentType,
2580d84335fSJung-uk Kim     char*                   EndStr,
2590d84335fSJung-uk Kim     UINT32                  Level)
2600d84335fSJung-uk Kim {
2610d84335fSJung-uk Kim     BOOLEAN                 CommentExists = FALSE;
2620d84335fSJung-uk Kim     char                    **CommentToPrint = NULL;
2630d84335fSJung-uk Kim 
2640d84335fSJung-uk Kim 
2650d84335fSJung-uk Kim     switch (CommentType)
2660d84335fSJung-uk Kim     {
2670d84335fSJung-uk Kim     case AML_COMMENT_STANDARD:
2680d84335fSJung-uk Kim 
2690d84335fSJung-uk Kim         if (CvListIsSingleton (Op->Common.CommentList))
2700d84335fSJung-uk Kim         {
2710d84335fSJung-uk Kim             CvPrintOneCommentList (Op->Common.CommentList, Level);
2720d84335fSJung-uk Kim             AcpiOsPrintf ("\n");
2730d84335fSJung-uk Kim         }
2740d84335fSJung-uk Kim         else
2750d84335fSJung-uk Kim         {
2760d84335fSJung-uk Kim             CvPrintOneCommentList (Op->Common.CommentList, Level);
2770d84335fSJung-uk Kim         }
2780d84335fSJung-uk Kim         Op->Common.CommentList = NULL;
2790d84335fSJung-uk Kim         return;
2800d84335fSJung-uk Kim 
2810d84335fSJung-uk Kim     case AML_COMMENT_ENDBLK:
2820d84335fSJung-uk Kim 
2830d84335fSJung-uk Kim         if (Op->Common.EndBlkComment)
2840d84335fSJung-uk Kim         {
2850d84335fSJung-uk Kim             CvPrintOneCommentList (Op->Common.EndBlkComment, Level);
2860d84335fSJung-uk Kim             Op->Common.EndBlkComment = NULL;
2870d84335fSJung-uk Kim             AcpiDmIndent(Level);
2880d84335fSJung-uk Kim         }
2890d84335fSJung-uk Kim         return;
2900d84335fSJung-uk Kim 
2910d84335fSJung-uk Kim     case AMLCOMMENT_INLINE:
2920d84335fSJung-uk Kim 
2930d84335fSJung-uk Kim         CommentToPrint = &Op->Common.InlineComment;
2940d84335fSJung-uk Kim         break;
2950d84335fSJung-uk Kim 
2960d84335fSJung-uk Kim     case AML_COMMENT_END_NODE:
2970d84335fSJung-uk Kim 
2980d84335fSJung-uk Kim         CommentToPrint = &Op->Common.EndNodeComment;
2990d84335fSJung-uk Kim         break;
3000d84335fSJung-uk Kim 
3010d84335fSJung-uk Kim     case AML_NAMECOMMENT:
3020d84335fSJung-uk Kim 
3030d84335fSJung-uk Kim         CommentToPrint = &Op->Common.NameComment;
3040d84335fSJung-uk Kim         break;
3050d84335fSJung-uk Kim 
3060d84335fSJung-uk Kim     case AML_COMMENT_CLOSE_BRACE:
3070d84335fSJung-uk Kim 
3080d84335fSJung-uk Kim         CommentToPrint = &Op->Common.CloseBraceComment;
3090d84335fSJung-uk Kim         break;
3100d84335fSJung-uk Kim 
3110d84335fSJung-uk Kim     default:
3120d84335fSJung-uk Kim         return;
3130d84335fSJung-uk Kim     }
3140d84335fSJung-uk Kim 
3150d84335fSJung-uk Kim     if (*CommentToPrint)
3160d84335fSJung-uk Kim     {
317*af051161SJung-uk Kim         CommentExists = TRUE;
3180d84335fSJung-uk Kim         AcpiOsPrintf ("%s", *CommentToPrint);
3190d84335fSJung-uk Kim         *CommentToPrint = NULL;
3200d84335fSJung-uk Kim     }
3210d84335fSJung-uk Kim 
3220d84335fSJung-uk Kim     if (CommentExists && EndStr)
3230d84335fSJung-uk Kim     {
3240d84335fSJung-uk Kim         AcpiOsPrintf ("%s", EndStr);
3250d84335fSJung-uk Kim     }
3260d84335fSJung-uk Kim }
3270d84335fSJung-uk Kim 
3280d84335fSJung-uk Kim 
3290d84335fSJung-uk Kim /*******************************************************************************
3300d84335fSJung-uk Kim  *
3310d84335fSJung-uk Kim  * FUNCTION:    CvCloseBraceWriteComment
3320d84335fSJung-uk Kim  *
3330d84335fSJung-uk Kim  * PARAMETERS:  Op
3340d84335fSJung-uk Kim  *              Level
3350d84335fSJung-uk Kim  *
3360d84335fSJung-uk Kim  * RETURN:      none
3370d84335fSJung-uk Kim  *
3380d84335fSJung-uk Kim  * DESCRIPTION: Print a close brace } and any open brace comments associated
3390d84335fSJung-uk Kim  *              with this parse object.
3400d84335fSJung-uk Kim  *              This is referred as ASL_CV_CLOSE_BRACE.
3410d84335fSJung-uk Kim  *
3420d84335fSJung-uk Kim  ******************************************************************************/
3430d84335fSJung-uk Kim 
3440d84335fSJung-uk Kim void
3450d84335fSJung-uk Kim CvCloseBraceWriteComment(
3460d84335fSJung-uk Kim     ACPI_PARSE_OBJECT       *Op,
3470d84335fSJung-uk Kim     UINT32                  Level)
3480d84335fSJung-uk Kim {
3490d84335fSJung-uk Kim     if (!Gbl_CaptureComments)
3500d84335fSJung-uk Kim     {
3510d84335fSJung-uk Kim         AcpiOsPrintf ("}");
3520d84335fSJung-uk Kim         return;
3530d84335fSJung-uk Kim     }
3540d84335fSJung-uk Kim 
3550d84335fSJung-uk Kim     CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level);
3560d84335fSJung-uk Kim     AcpiOsPrintf ("}");
3570d84335fSJung-uk Kim     CvPrintOneCommentType (Op, AML_COMMENT_CLOSE_BRACE, NULL, Level);
3580d84335fSJung-uk Kim }
3590d84335fSJung-uk Kim 
3600d84335fSJung-uk Kim 
3610d84335fSJung-uk Kim /*******************************************************************************
3620d84335fSJung-uk Kim  *
3630d84335fSJung-uk Kim  * FUNCTION:    CvCloseParenWriteComment
3640d84335fSJung-uk Kim  *
3650d84335fSJung-uk Kim  * PARAMETERS:  Op
3660d84335fSJung-uk Kim  *              Level
3670d84335fSJung-uk Kim  *
3680d84335fSJung-uk Kim  * RETURN:      none
3690d84335fSJung-uk Kim  *
3700d84335fSJung-uk Kim  * DESCRIPTION: Print a closing paren ) and any end node comments associated
3710d84335fSJung-uk Kim  *              with this parse object.
3720d84335fSJung-uk Kim  *              This is referred as ASL_CV_CLOSE_PAREN.
3730d84335fSJung-uk Kim  *
3740d84335fSJung-uk Kim  ******************************************************************************/
3750d84335fSJung-uk Kim 
3760d84335fSJung-uk Kim void
3770d84335fSJung-uk Kim CvCloseParenWriteComment(
3780d84335fSJung-uk Kim     ACPI_PARSE_OBJECT       *Op,
3790d84335fSJung-uk Kim     UINT32                  Level)
3800d84335fSJung-uk Kim {
3810d84335fSJung-uk Kim     if (!Gbl_CaptureComments)
3820d84335fSJung-uk Kim     {
3830d84335fSJung-uk Kim         AcpiOsPrintf (")");
3840d84335fSJung-uk Kim         return;
3850d84335fSJung-uk Kim     }
3860d84335fSJung-uk Kim 
3870d84335fSJung-uk Kim     /*
3880d84335fSJung-uk Kim      * If this op has a BLOCK_BRACE, then output the comment when the
3890d84335fSJung-uk Kim      * disassembler calls CvCloseBraceWriteComment
3900d84335fSJung-uk Kim      */
3910d84335fSJung-uk Kim     if (AcpiDmBlockType (Op) == BLOCK_PAREN)
3920d84335fSJung-uk Kim     {
3930d84335fSJung-uk Kim         CvPrintOneCommentType (Op, AML_COMMENT_ENDBLK, NULL, Level);
3940d84335fSJung-uk Kim     }
3950d84335fSJung-uk Kim 
3960d84335fSJung-uk Kim     AcpiOsPrintf (")");
3970d84335fSJung-uk Kim 
3980d84335fSJung-uk Kim     if (Op->Common.EndNodeComment)
3990d84335fSJung-uk Kim     {
4000d84335fSJung-uk Kim         CvPrintOneCommentType (Op, AML_COMMENT_END_NODE, NULL, Level);
4010d84335fSJung-uk Kim     }
4020d84335fSJung-uk Kim     else if ((Op->Common.Parent->Common.AmlOpcode == AML_IF_OP) &&
4030d84335fSJung-uk Kim          Op->Common.Parent->Common.EndNodeComment)
4040d84335fSJung-uk Kim     {
4050d84335fSJung-uk Kim         CvPrintOneCommentType (Op->Common.Parent,
4060d84335fSJung-uk Kim             AML_COMMENT_END_NODE, NULL, Level);
4070d84335fSJung-uk Kim     }
4080d84335fSJung-uk Kim }
4090d84335fSJung-uk Kim 
4100d84335fSJung-uk Kim 
4110d84335fSJung-uk Kim /*******************************************************************************
4120d84335fSJung-uk Kim  *
4130d84335fSJung-uk Kim  * FUNCTION:    CvFileHasSwitched
4140d84335fSJung-uk Kim  *
4150d84335fSJung-uk Kim  * PARAMETERS:  Op
4160d84335fSJung-uk Kim  *
4170d84335fSJung-uk Kim  * RETURN:      BOOLEAN
4180d84335fSJung-uk Kim  *
4190d84335fSJung-uk Kim  * DESCRIPTION: Determine whether if a file has switched.
4200d84335fSJung-uk Kim  *              TRUE - file has switched.
4210d84335fSJung-uk Kim  *              FALSE - file has not switched.
4220d84335fSJung-uk Kim  *              This is referred as ASL_CV_FILE_HAS_SWITCHED.
4230d84335fSJung-uk Kim  *
4240d84335fSJung-uk Kim  ******************************************************************************/
4250d84335fSJung-uk Kim 
4260d84335fSJung-uk Kim BOOLEAN
4270d84335fSJung-uk Kim CvFileHasSwitched(
4280d84335fSJung-uk Kim     ACPI_PARSE_OBJECT       *Op)
4290d84335fSJung-uk Kim {
4300d84335fSJung-uk Kim     if (Op->Common.CvFilename   &&
4310d84335fSJung-uk Kim         AcpiGbl_CurrentFilename &&
4320d84335fSJung-uk Kim         AcpiUtStricmp(Op->Common.CvFilename, AcpiGbl_CurrentFilename))
4330d84335fSJung-uk Kim     {
4340d84335fSJung-uk Kim         return TRUE;
4350d84335fSJung-uk Kim     }
4360d84335fSJung-uk Kim     return FALSE;
4370d84335fSJung-uk Kim }
4380d84335fSJung-uk Kim 
4390d84335fSJung-uk Kim 
4400d84335fSJung-uk Kim /*******************************************************************************
4410d84335fSJung-uk Kim  *
4420d84335fSJung-uk Kim  * FUNCTION:    CvPrintInclude
4430d84335fSJung-uk Kim  *
4440d84335fSJung-uk Kim  * PARAMETERS:  FNode - Write an Include statement for the file that is pointed
4450d84335fSJung-uk Kim  *                      by FNode->File.
4460d84335fSJung-uk Kim  *              Level - indentation level
4470d84335fSJung-uk Kim  *
4480d84335fSJung-uk Kim  * RETURN:      None
4490d84335fSJung-uk Kim  *
4500d84335fSJung-uk Kim  * DESCRIPTION: Write the ASL Include statement for FNode->File in the file
4510d84335fSJung-uk Kim  *              indicated by FNode->Parent->File. Note this function emits
4520d84335fSJung-uk Kim  *              actual ASL code rather than comments. This switches the output
4530d84335fSJung-uk Kim  *              file to FNode->Parent->File.
4540d84335fSJung-uk Kim  *
4550d84335fSJung-uk Kim  ******************************************************************************/
4560d84335fSJung-uk Kim 
4570d84335fSJung-uk Kim static void
4580d84335fSJung-uk Kim CvPrintInclude(
4590d84335fSJung-uk Kim     ACPI_FILE_NODE          *FNode,
4600d84335fSJung-uk Kim     UINT32                  Level)
4610d84335fSJung-uk Kim {
4620d84335fSJung-uk Kim     if (!FNode || FNode->IncludeWritten)
4630d84335fSJung-uk Kim     {
4640d84335fSJung-uk Kim         return;
4650d84335fSJung-uk Kim     }
4660d84335fSJung-uk Kim 
4670d84335fSJung-uk Kim     CvDbgPrint ("Writing include for %s within %s\n", FNode->Filename, FNode->Parent->Filename);
4680d84335fSJung-uk Kim     AcpiOsRedirectOutput (FNode->Parent->File);
4690d84335fSJung-uk Kim     CvPrintOneCommentList (FNode->IncludeComment, Level);
4700d84335fSJung-uk Kim     AcpiDmIndent (Level);
4710d84335fSJung-uk Kim     AcpiOsPrintf ("Include (\"%s\")\n", FNode->Filename);
4720d84335fSJung-uk Kim     CvDbgPrint ("emitted the following: Include (\"%s\")\n", FNode->Filename);
4730d84335fSJung-uk Kim     FNode->IncludeWritten = TRUE;
4740d84335fSJung-uk Kim }
4750d84335fSJung-uk Kim 
4760d84335fSJung-uk Kim 
4770d84335fSJung-uk Kim /*******************************************************************************
4780d84335fSJung-uk Kim  *
4790d84335fSJung-uk Kim  * FUNCTION:    CvSwitchFiles
4800d84335fSJung-uk Kim  *
4810d84335fSJung-uk Kim  * PARAMETERS:  Level - indentation level
4820d84335fSJung-uk Kim  *              Op
4830d84335fSJung-uk Kim  *
4840d84335fSJung-uk Kim  * RETURN:      None
4850d84335fSJung-uk Kim  *
4860d84335fSJung-uk Kim  * DESCRIPTION: Switch the outputfile and write ASL Include statement. Note,
4870d84335fSJung-uk Kim  *              this function emits actual ASL code rather than comments.
4880d84335fSJung-uk Kim  *              This is referred as ASL_CV_SWITCH_FILES.
4890d84335fSJung-uk Kim  *
4900d84335fSJung-uk Kim  ******************************************************************************/
4910d84335fSJung-uk Kim 
4920d84335fSJung-uk Kim void
4930d84335fSJung-uk Kim CvSwitchFiles(
4940d84335fSJung-uk Kim     UINT32                  Level,
4950d84335fSJung-uk Kim     ACPI_PARSE_OBJECT       *Op)
4960d84335fSJung-uk Kim {
4970d84335fSJung-uk Kim     char                    *Filename = Op->Common.CvFilename;
4980d84335fSJung-uk Kim     ACPI_FILE_NODE          *FNode;
499*af051161SJung-uk Kim     ACPI_FILE_NODE          *Current;
5000d84335fSJung-uk Kim 
5010d84335fSJung-uk Kim     CvDbgPrint ("Switching from %s to %s\n", AcpiGbl_CurrentFilename, Filename);
5020d84335fSJung-uk Kim     FNode = CvFilenameExists (Filename, AcpiGbl_FileTreeRoot);
5030d84335fSJung-uk Kim     if (!FNode)
5040d84335fSJung-uk Kim     {
5050d84335fSJung-uk Kim         /*
5060d84335fSJung-uk Kim          * At this point, each Filename should exist in AcpiGbl_FileTreeRoot
5070d84335fSJung-uk Kim          * if it does not exist, then abort.
5080d84335fSJung-uk Kim          */
5090d84335fSJung-uk Kim         FlDeleteFile (ASL_FILE_AML_OUTPUT);
5100d84335fSJung-uk Kim         sprintf (MsgBuffer, "\"Cannot find %s\" - %s", Filename, strerror (errno));
5110d84335fSJung-uk Kim         AslCommonError (ASL_ERROR, ASL_MSG_OPEN, 0, 0, 0, 0, NULL, MsgBuffer);
5120d84335fSJung-uk Kim         AslAbort ();
5130d84335fSJung-uk Kim     }
514*af051161SJung-uk Kim     Current = FNode;
5150d84335fSJung-uk Kim 
5160d84335fSJung-uk Kim     /*
5170d84335fSJung-uk Kim      * If the previous file is a descendent of the current file,
5180d84335fSJung-uk Kim      * make sure that Include statements from the current file
5190d84335fSJung-uk Kim      * to the previous have been emitted.
5200d84335fSJung-uk Kim      */
521*af051161SJung-uk Kim     while (Current &&
522*af051161SJung-uk Kim            Current->Parent &&
523*af051161SJung-uk Kim            AcpiUtStricmp (Current->Filename, AcpiGbl_CurrentFilename))
5240d84335fSJung-uk Kim     {
525*af051161SJung-uk Kim         CvPrintInclude (Current, Level);
526*af051161SJung-uk Kim         Current = Current->Parent;
5270d84335fSJung-uk Kim     }
5280d84335fSJung-uk Kim 
529*af051161SJung-uk Kim     /* Redirect output to Op->Common.CvFilename */
5300d84335fSJung-uk Kim 
5310d84335fSJung-uk Kim     AcpiOsRedirectOutput (FNode->File);
5320d84335fSJung-uk Kim     AcpiGbl_CurrentFilename = FNode->Filename;
5330d84335fSJung-uk Kim }
534