FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/compiler/dtio.c

     /******************************************************************************
      *
      * Module Name: dtio.c - File I/O support for data table compiler
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 1. Copyright Notice
     *
     * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
     * All rights reserved.
     *
     * 2. License
     *
     * 2.1. This is your license from Intel Corp. under its intellectual property
     * rights. You may have additional license terms from the party that provided
     * you this software, covering your right to use that party's intellectual
     * property rights.
     *
     * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     * copy of the source code appearing in this file ("Covered Code") an
     * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     * base code distributed originally by Intel ("Original Intel Code") to copy,
     * make derivatives, distribute, use and display any portion of the Covered
     * Code in any form, with the right to sublicense such rights; and
     *
     * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     * license (with the right to sublicense), under only those claims of Intel
     * patents that are infringed by the Original Intel Code, to make, use, sell,
     * offer to sell, and import the Covered Code and derivative works thereof
     * solely to the minimum extent necessary to exercise the above copyright
     * license, and in no event shall the patent license extend to any additions
     * to or modifications of the Original Intel Code. No other license or right
     * is granted directly or by implication, estoppel or otherwise;
     *
     * The above copyright and patent license is granted only if the following
     * conditions are met:
     *
     * 3. Conditions
     *
     * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification with rights to further distribute source must include
     * the above Copyright Notice, the above License, this list of Conditions,
     * and the following Disclaimer and Export Compliance provision. In addition,
     * Licensee must cause all Covered Code to which Licensee contributes to
     * contain a file documenting the changes Licensee made to create that Covered
     * Code and the date of any change. Licensee must include in that file the
     * documentation of any changes made by any predecessor Licensee. Licensee
     * must include a prominent statement that the modification is derived,
     * directly or indirectly, from Original Intel Code.
     *
     * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification without rights to further distribute source must
     * include the following Disclaimer and Export Compliance provision in the
     * documentation and/or other materials provided with distribution. In
     * addition, Licensee may not authorize further sublicense of source of any
     * portion of the Covered Code, and must include terms to the effect that the
     * license from Licensee to its licensee is limited to the intellectual
     * property embodied in the software Licensee provides to its licensee, and
     * not to intellectual property embodied in modifications its licensee may
     * make.
     *
     * 3.3. Redistribution of Executable. Redistribution in executable form of any
     * substantial portion of the Covered Code or modification must reproduce the
     * above Copyright Notice, and the following Disclaimer and Export Compliance
     * provision in the documentation and/or other materials provided with the
     * distribution.
     *
     * 3.4. Intel retains all right, title, and interest in and to the Original
     * Intel Code.
     *
     * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     * Intel shall be used in advertising or otherwise to promote the sale, use or
     * other dealings in products derived from or relating to the Covered Code
     * without prior written authorization from Intel.
     *
     * 4. Disclaimer and Export Compliance
     *
     * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     * PARTICULAR PURPOSE.
     *
     * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     * LIMITED REMEDY.
     *
     * 4.3. Licensee shall not export, either directly or indirectly, any of this
    * software or system incorporating such software without first obtaining any
    * required license or other approval from the U. S. Department of Commerce or
    * any other agency or department of the United States Government. In the
    * event Licensee exports any such software from the United States or
    * re-exports any such software from a foreign destination, Licensee shall
    * ensure that the distribution and export/re-export of the software is in
    * compliance with all laws, regulations, orders, or other restrictions of the
    * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    * any of its subsidiaries will export/re-export any technical data, process,
    * software, or service, directly or indirectly, to any country for which the
    * United States government or any agency thereof requires an export license,
    * other governmental approval, or letter of assurance, without first obtaining
    * such license, approval or letter.
    *
    *****************************************************************************
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * following license:
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions, and the following disclaimer,
    *    without modification.
    * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    *    substantially similar to the "NO WARRANTY" disclaimer below
    *    ("Disclaimer") and any redistribution must be conditioned upon
    *    including a substantially similar Disclaimer requirement for further
    *    binary redistribution.
    * 3. Neither the names of the above-listed copyright holders nor the names
    *    of any contributors may be used to endorse or promote products derived
    *    from this software without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * GNU General Public License ("GPL") version 2 as published by the Free
    * Software Foundation.
    *
    *****************************************************************************/
   
   #include <contrib/dev/acpica/compiler/aslcompiler.h>
   #include <contrib/dev/acpica/include/acapps.h>
   
   #define _COMPONENT          DT_COMPILER
           ACPI_MODULE_NAME    ("dtio")
   
   
   /* Local prototypes */
   
   static char *
   DtTrim (
       char                    *String);
   
   static ACPI_STATUS
   DtParseLine (
       char                    *LineBuffer,
       UINT32                  Line,
       UINT32                  Offset);
   
   static void
   DtWriteBinary (
       DT_SUBTABLE             *Subtable,
       void                    *Context,
       void                    *ReturnValue);
   
   static void
   DtDumpBuffer (
       UINT32                  FileId,
       UINT8                   *Buffer,
       UINT32                  Offset,
       UINT32                  Length);
   
   static void
   DtDumpSubtableInfo (
       DT_SUBTABLE             *Subtable,
       void                    *Context,
       void                    *ReturnValue);
   
   static void
   DtDumpSubtableTree (
       DT_SUBTABLE             *Subtable,
       void                    *Context,
       void                    *ReturnValue);
   
   
   /* States for DtGetNextLine */
   
   #define DT_NORMAL_TEXT              0
   #define DT_START_QUOTED_STRING      1
   #define DT_START_COMMENT            2
   #define DT_SLASH_ASTERISK_COMMENT   3
   #define DT_SLASH_SLASH_COMMENT      4
   #define DT_END_COMMENT              5
   #define DT_MERGE_LINES              6
   #define DT_ESCAPE_SEQUENCE          7
   
   static UINT32               AslGbl_NextLineOffset;
   
   
   /******************************************************************************
    *
    * FUNCTION:    DtTrim
    *
    * PARAMETERS:  String              - Current source code line to trim
    *
    * RETURN:      Trimmed line. Must be freed by caller.
    *
    * DESCRIPTION: Trim left and right spaces
    *
    *****************************************************************************/
   
   static char *
   DtTrim (
       char                    *String)
   {
       char                    *Start;
       char                    *End;
       char                    *ReturnString;
       ACPI_SIZE               Length;
   
   
       /* Skip lines that start with a space */
   
       if (*String == 0 || !strcmp (String, " "))
       {
           ReturnString = UtLocalCacheCalloc (1);
           return (ReturnString);
       }
   
       /* Setup pointers to start and end of input string */
   
       Start = String;
       End = String + strlen (String) - 1;
   
       /* Find first non-whitespace character */
   
       while ((Start <= End) && ((*Start == ' ') || (*Start == '\t')))
       {
           Start++;
       }
   
       /* Find last non-space character */
   
       while (End >= Start)
       {
           if (*End == '\n')
           {
               End--;
               continue;
           }
   
           if (*End != ' ')
           {
               break;
           }
   
           End--;
       }
   
       /* Remove any quotes around the string */
   
       if (*Start == '\"')
       {
           Start++;
       }
       if (*End == '\"')
       {
           End--;
       }
   
       /* Create the trimmed return string */
   
       Length = ACPI_PTR_DIFF (End, Start) + 1;
       ReturnString = UtLocalCacheCalloc (Length + 1);
       if (strlen (Start))
       {
           strncpy (ReturnString, Start, Length);
       }
   
       ReturnString[Length] = 0;
       return (ReturnString);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    DtParseLine
    *
    * PARAMETERS:  LineBuffer          - Current source code line
    *              Line                - Current line number in the source
    *              Offset              - Current byte offset of the line
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Parse one source line
    *
    *****************************************************************************/
   
   static ACPI_STATUS
   DtParseLine (
       char                    *LineBuffer,
       UINT32                  Line,
       UINT32                  Offset)
   {
       char                    *Start;
       char                    *End;
       char                    *TmpName;
       char                    *TmpValue;
       char                    *Name;
       char                    *Value;
       char                    *Colon;
       UINT32                  Length;
       DT_FIELD                *Field;
       UINT32                  Column;
       UINT32                  NameColumn;
       BOOLEAN                 IsNullString = FALSE;
   
   
       if (!LineBuffer)
       {
           return (AE_OK);
       }
   
       /* All lines after "Raw Table Data" are ignored */
   
       if (strstr (LineBuffer, ACPI_RAW_TABLE_DATA_HEADER))
       {
           return (AE_NOT_FOUND);
       }
   
       Colon = strchr (LineBuffer, ':');
       if (!Colon)
       {
           return (AE_OK);
       }
   
       Start = LineBuffer;
       End = Colon;
   
       while (Start < Colon)
       {
           if (*Start == '[')
           {
               /* Found left bracket, go to the right bracket */
   
               while (Start < Colon && *Start != ']')
               {
                   Start++;
               }
           }
           else if (*Start != ' ')
           {
               break;
           }
   
           Start++;
       }
   
       /*
        * There are two column values. One for the field name,
        * and one for the field value.
        */
       Column = ACPI_PTR_DIFF (Colon, LineBuffer) + 3;
       NameColumn = ACPI_PTR_DIFF (Start, LineBuffer) + 1;
   
       Length = ACPI_PTR_DIFF (End, Start);
   
       TmpName = UtLocalCalloc (Length + 1);
       strncpy (TmpName, Start, Length);
       Name = DtTrim (TmpName);
       ACPI_FREE (TmpName);
   
       Start = End = (Colon + 1);
       while (*End)
       {
           /* Found left quotation, go to the right quotation and break */
   
           if (*End == '"')
           {
               End++;
   
               /* Check for an explicit null string */
   
               if (*End == '"')
               {
                   IsNullString = TRUE;
               }
               while (*End && (*End != '"'))
               {
                   End++;
               }
   
               End++;
               break;
           }
   
           /*
            * Special "comment" fields at line end, ignore them.
            * Note: normal slash-slash and slash-asterisk comments are
            * stripped already by the DtGetNextLine parser.
            *
            * TBD: Perhaps DtGetNextLine should parse the following type
            * of comments also.
            */
           if (*End == '[')
           {
               End--;
               break;
           }
   
           End++;
       }
   
       Length = ACPI_PTR_DIFF (End, Start);
       TmpValue = UtLocalCalloc (Length + 1);
   
       strncpy (TmpValue, Start, Length);
       Value = DtTrim (TmpValue);
       ACPI_FREE (TmpValue);
   
       /* Create a new field object only if we have a valid value field */
   
       if ((Value && *Value) || IsNullString)
       {
           Field = UtFieldCacheCalloc ();
           Field->Name = Name;
           Field->Value = Value;
           Field->Line = Line;
           Field->ByteOffset = Offset;
           Field->NameColumn = NameColumn;
           Field->Column = Column;
           Field->StringLength = Length;
   
           DtLinkField (Field);
       }
       /* Else -- Ignore this field, it has no valid data */
   
       return (AE_OK);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    DtGetNextLine
    *
    * PARAMETERS:  Handle              - Open file handle for the source file
    *
    * RETURN:      Filled line buffer and offset of start-of-line (ASL_EOF on EOF)
    *
    * DESCRIPTION: Get the next valid source line. Removes all comments.
    *              Ignores empty lines.
    *
    * Handles both slash-asterisk and slash-slash comments.
    * Also, quoted strings, but no escapes within.
    *
    * Line is returned in AslGbl_CurrentLineBuffer.
    * Line number in original file is returned in AslGbl_CurrentLineNumber.
    *
    *****************************************************************************/
   
   UINT32
   DtGetNextLine (
       FILE                    *Handle,
       UINT32                  Flags)
   {
       BOOLEAN                 LineNotAllBlanks = FALSE;
       UINT32                  State = DT_NORMAL_TEXT;
       UINT32                  CurrentLineOffset;
       UINT32                  i;
       int                     c;
       int                     c1;
   
   
       memset (AslGbl_CurrentLineBuffer, 0, AslGbl_LineBufferSize);
       for (i = 0; ;)
       {
           /*
            * If line is too long, expand the line buffers. Also increases
            * AslGbl_LineBufferSize.
            */
           if (i >= AslGbl_LineBufferSize)
           {
               UtExpandLineBuffers ();
           }
   
           c = getc (Handle);
           if (c == EOF)
           {
               switch (State)
               {
               case DT_START_QUOTED_STRING:
               case DT_SLASH_ASTERISK_COMMENT:
   
                   AcpiOsPrintf ("**** EOF within comment/string %u\n", State);
                   break;
   
               default:
   
                   break;
               }
   
               /* Standalone EOF is OK */
   
               if (i == 0)
               {
                   return (ASL_EOF);
               }
   
               /*
                * Received an EOF in the middle of a line. Terminate the
                * line with a newline. The next call to this function will
                * return a standalone EOF. Thus, the upper parsing software
                * never has to deal with an EOF within a valid line (or
                * the last line does not get tossed on the floor.)
                */
               c = '\n';
               State = DT_NORMAL_TEXT;
           }
           else if (c == '\r')
           {
               c1 = getc (Handle);
               if (c1 == '\n')
               {
                   /*
                    * Skip the carriage return as if it didn't exist. This is
                    * onlt meant for input files in DOS format in unix. fopen in
                    * unix may not support "text mode" and leaves CRLF intact.
                    */
                   c = '\n';
               }
               else
               {
                   /* This was not a CRLF. Only a CR */
   
                   ungetc(c1, Handle);
   
                   DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL,
                       "Carriage return without linefeed detected");
                   return (ASL_EOF);
               }
           }
   
           switch (State)
           {
           case DT_NORMAL_TEXT:
   
               /* Normal text, insert char into line buffer */
   
               AslGbl_CurrentLineBuffer[i] = (char) c;
               switch (c)
               {
               case '/':
   
                   State = DT_START_COMMENT;
                   break;
   
               case '"':
   
                   State = DT_START_QUOTED_STRING;
                   LineNotAllBlanks = TRUE;
                   i++;
                   break;
   
               case '\\':
                   /*
                    * The continuation char MUST be last char on this line.
                    * Otherwise, it will be assumed to be a valid ASL char.
                    */
                   State = DT_MERGE_LINES;
                   break;
   
               case '\n':
   
                   CurrentLineOffset = AslGbl_NextLineOffset;
                   AslGbl_NextLineOffset = (UINT32) ftell (Handle);
                   AslGbl_CurrentLineNumber++;
   
                   /*
                    * Exit if line is complete. Ignore empty lines (only \n)
                    * or lines that contain nothing but blanks.
                    */
                   if ((i != 0) && LineNotAllBlanks)
                   {
                       if ((i + 1) >= AslGbl_LineBufferSize)
                       {
                           UtExpandLineBuffers ();
                       }
   
                       AslGbl_CurrentLineBuffer[i+1] = 0; /* Terminate string */
                       return (CurrentLineOffset);
                   }
   
                   /* Toss this line and start a new one */
   
                   i = 0;
                   LineNotAllBlanks = FALSE;
                   break;
   
               default:
   
                   if (c != ' ')
                   {
                       LineNotAllBlanks = TRUE;
                   }
   
                   i++;
                   break;
               }
               break;
   
           case DT_START_QUOTED_STRING:
   
               /* Insert raw chars until end of quoted string */
   
               AslGbl_CurrentLineBuffer[i] = (char) c;
               i++;
   
               switch (c)
               {
               case '"':
   
                   State = DT_NORMAL_TEXT;
                   break;
   
               case '\\':
   
                   State = DT_ESCAPE_SEQUENCE;
                   break;
   
               case '\n':
   
                   if (!(Flags & DT_ALLOW_MULTILINE_QUOTES))
                   {
                       AcpiOsPrintf (
                           "ERROR at line %u: Unterminated quoted string\n",
                           AslGbl_CurrentLineNumber++);
                       State = DT_NORMAL_TEXT;
                   }
                   break;
   
               default:    /* Get next character */
   
                   break;
               }
               break;
   
           case DT_ESCAPE_SEQUENCE:
   
               /* Just copy the escaped character. TBD: sufficient for table compiler? */
   
               AslGbl_CurrentLineBuffer[i] = (char) c;
               i++;
               State = DT_START_QUOTED_STRING;
               break;
   
           case DT_START_COMMENT:
   
               /* Open comment if this character is an asterisk or slash */
   
               switch (c)
               {
               case '*':
   
                   State = DT_SLASH_ASTERISK_COMMENT;
                   break;
   
               case '/':
   
                   State = DT_SLASH_SLASH_COMMENT;
                   break;
   
               default:    /* Not a comment */
   
                   i++;    /* Save the preceding slash */
                   if (i >= AslGbl_LineBufferSize)
                   {
                       UtExpandLineBuffers ();
                   }
   
                   AslGbl_CurrentLineBuffer[i] = (char) c;
                   i++;
                   State = DT_NORMAL_TEXT;
                   break;
               }
               break;
   
           case DT_SLASH_ASTERISK_COMMENT:
   
               /* Ignore chars until an asterisk-slash is found */
   
               switch (c)
               {
               case '\n':
   
                   AslGbl_NextLineOffset = (UINT32) ftell (Handle);
                   AslGbl_CurrentLineNumber++;
                   break;
   
               case '*':
   
                   State = DT_END_COMMENT;
                   break;
   
               default:
   
                   break;
               }
               break;
   
           case DT_SLASH_SLASH_COMMENT:
   
               /* Ignore chars until end-of-line */
   
               if (c == '\n')
               {
                   /* We will exit via the NORMAL_TEXT path */
   
                   ungetc (c, Handle);
                   State = DT_NORMAL_TEXT;
               }
               break;
   
           case DT_END_COMMENT:
   
               /* End comment if this char is a slash */
   
               switch (c)
               {
               case '/':
   
                   State = DT_NORMAL_TEXT;
                   break;
   
               case '\n':
   
                   AslGbl_NextLineOffset = (UINT32) ftell (Handle);
                   AslGbl_CurrentLineNumber++;
                   break;
   
               case '*':
   
                   /* Consume all adjacent asterisks */
                   break;
   
               default:
   
                   State = DT_SLASH_ASTERISK_COMMENT;
                   break;
               }
               break;
   
           case DT_MERGE_LINES:
   
               if (c != '\n')
               {
                   /*
                    * This is not a continuation backslash, it is a normal
                    * normal ASL backslash - for example: Scope(\_SB_)
                    */
                   i++; /* Keep the backslash that is already in the buffer */
   
                   ungetc (c, Handle);
                   State = DT_NORMAL_TEXT;
               }
               else
               {
                   /*
                    * This is a continuation line -- a backlash followed
                    * immediately by a newline. Insert a space between the
                    * lines (overwrite the backslash)
                    */
                   AslGbl_CurrentLineBuffer[i] = ' ';
                   i++;
   
                   /* Ignore newline, this will merge the lines */
   
                   AslGbl_NextLineOffset = (UINT32) ftell (Handle);
                   AslGbl_CurrentLineNumber++;
                   State = DT_NORMAL_TEXT;
               }
               break;
   
           default:
   
               DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, "Unknown input state");
               return (ASL_EOF);
           }
       }
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    DtScanFile
    *
    * PARAMETERS:  Handle              - Open file handle for the source file
    *
    * RETURN:      Pointer to start of the constructed parse tree.
    *
    * DESCRIPTION: Scan source file, link all field names and values
    *              to the global parse tree: AslGbl_FieldList
    *
    *****************************************************************************/
   
   DT_FIELD *
   DtScanFile (
       FILE                    *Handle)
   {
       ACPI_STATUS             Status;
       UINT32                  Offset;
   
   
       ACPI_FUNCTION_NAME (DtScanFile);
   
   
       /* Get the file size */
   
       AslGbl_InputByteCount = CmGetFileSize (Handle);
       if (AslGbl_InputByteCount == ACPI_UINT32_MAX)
       {
           AslAbort ();
       }
   
       AslGbl_CurrentLineNumber = 0;
       AslGbl_CurrentLineOffset = 0;
       AslGbl_NextLineOffset = 0;
   
       /* Scan line-by-line */
   
       while ((Offset = DtGetNextLine (Handle, 0)) != ASL_EOF)
       {
           ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Line %2.2u/%4.4X - %s",
               AslGbl_CurrentLineNumber, Offset, AslGbl_CurrentLineBuffer));
   
           Status = DtParseLine (AslGbl_CurrentLineBuffer,
               AslGbl_CurrentLineNumber, Offset);
           if (Status == AE_NOT_FOUND)
           {
               break;
           }
       }
   
       /* Dump the parse tree if debug enabled */
   
       DtDumpFieldList (AslGbl_FieldList);
       return (AslGbl_FieldList);
   }
   
   
   /*
    * Output functions
    */
   
   /******************************************************************************
    *
    * FUNCTION:    DtWriteBinary
    *
    * PARAMETERS:  DT_WALK_CALLBACK
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Write one subtable of a binary ACPI table
    *
    *****************************************************************************/
   
   static void
   DtWriteBinary (
       DT_SUBTABLE             *Subtable,
       void                    *Context,
       void                    *ReturnValue)
   {
   
       FlWriteFile (ASL_FILE_AML_OUTPUT, Subtable->Buffer, Subtable->Length);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    DtOutputBinary
    *
    * PARAMETERS:
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Write entire binary ACPI table (result of compilation)
    *
    *****************************************************************************/
   
   void
   DtOutputBinary (
       DT_SUBTABLE             *RootTable)
   {
   
       if (!RootTable)
       {
           return;
       }
   
       /* Walk the entire parse tree, emitting the binary data */
   
       DtWalkTableTree (RootTable, DtWriteBinary, NULL, NULL);
   
       AslGbl_TableLength = CmGetFileSize (AslGbl_Files[ASL_FILE_AML_OUTPUT].Handle);
       if (AslGbl_TableLength == ACPI_UINT32_MAX)
       {
           AslAbort ();
       }
   }
   
   
   /*
    * Listing support
    */
   
   /******************************************************************************
    *
    * FUNCTION:    DtDumpBuffer
    *
    * PARAMETERS:  FileID              - Where to write buffer data
    *              Buffer              - Buffer to dump
    *              Offset              - Offset in current table
    *              Length              - Buffer Length
    *
    * RETURN:      None
    *
    * DESCRIPTION: Another copy of DumpBuffer routine (unfortunately).
    *
    * TBD: merge dump buffer routines
    *
    *****************************************************************************/
   
   static void
   DtDumpBuffer (
       UINT32                  FileId,
       UINT8                   *Buffer,
       UINT32                  Offset,
       UINT32                  Length)
   {
       UINT32                  i;
       UINT32                  j;
       UINT8                   BufChar;
   
   
       FlPrintFile (FileId, "Output: [%3.3Xh %4.4d %3.3Xh] ",
           Offset, Offset, Length);
   
       i = 0;
       while (i < Length)
       {
           if (i >= 16)
           {
               FlPrintFile (FileId, "%24s", "");
           }
   
           /* Print 16 hex chars */
   
           for (j = 0; j < 16;)
           {
               if (i + j >= Length)
               {
                   /* Dump fill spaces */
   
                   FlPrintFile (FileId, "   ");
                   j++;
                   continue;
               }
   
               FlPrintFile (FileId, "%02X ", Buffer[i+j]);
               j++;
           }
   
           FlPrintFile (FileId, " ");
           for (j = 0; j < 16; j++)
           {
               if (i + j >= Length)
               {
                   FlPrintFile (FileId, "\n\n");
                   return;
               }
   
               BufChar = Buffer[(ACPI_SIZE) i + j];
               if (isprint (BufChar))
               {
                   FlPrintFile (FileId, "%c", BufChar);
               }
               else
               {
                   FlPrintFile (FileId, ".");
              }
          }
  
          /* Done with that line. */
  
          FlPrintFile (FileId, "\n");
          i += 16;
      }
  
      FlPrintFile (FileId, "\n\n");
  }
  
  
  /******************************************************************************
   *
   * FUNCTION:    DtDumpFieldList
   *
   * PARAMETERS:  Field               - Root field
   *
   * RETURN:      None
   *
   * DESCRIPTION: Dump the entire field list
   *
   *****************************************************************************/
  
  void
  DtDumpFieldList (
      DT_FIELD                *Field)
  {
  
      if (!AslGbl_DebugFlag || !Field)
      {
          return;
      }
  
      DbgPrint (ASL_DEBUG_OUTPUT,  "\nField List:\n"
          "LineNo   ByteOff  NameCol  Column   TableOff "
          "Flags %32s : %s\n\n", "Name", "Value");
  
      while (Field)
      {
          DbgPrint (ASL_DEBUG_OUTPUT,
              "%.08X %.08X %.08X %.08X %.08X %2.2X    %32s : %s\n",
              Field->Line, Field->ByteOffset, Field->NameColumn,
              Field->Column, Field->TableOffset, Field->Flags,
              Field->Name, Field->Value);
  
          Field = Field->Next;
      }
  
      DbgPrint (ASL_DEBUG_OUTPUT,  "\n\n");
  }
  
  
  /******************************************************************************
   *
   * FUNCTION:    DtDumpSubtableInfo, DtDumpSubtableTree
   *
   * PARAMETERS:  DT_WALK_CALLBACK
   *
   * RETURN:      None
   *
   * DESCRIPTION: Info - dump a subtable tree entry with extra information.
   *              Tree - dump a subtable tree formatted by depth indentation.
   *
   *****************************************************************************/
  
  static void
  DtDumpSubtableInfo (
      DT_SUBTABLE             *Subtable,
      void                    *Context,
      void                    *ReturnValue)
  {
  
      DbgPrint (ASL_DEBUG_OUTPUT,
          "[%.04X] %24s %.08X %.08X %.08X %.08X %p %p %p %p\n",
          Subtable->Depth, Subtable->Name, Subtable->Length, Subtable->TotalLength,
          Subtable->SizeOfLengthField, Subtable->Flags, Subtable,
          Subtable->Parent, Subtable->Child, Subtable->Peer);
  }
  
  static void
  DtDumpSubtableTree (
      DT_SUBTABLE             *Subtable,
      void                    *Context,
      void                    *ReturnValue)
  {
  
      DbgPrint (ASL_DEBUG_OUTPUT,
          "[%.04X] %24s %*s%p (%.02X) - (%.02X)        %.02X\n",
          Subtable->Depth, Subtable->Name, (4 * Subtable->Depth), " ",
          Subtable, Subtable->Length, Subtable->TotalLength, *Subtable->Buffer);
  }
  
  
  /******************************************************************************
   *
   * FUNCTION:    DtDumpSubtableList
   *
   * PARAMETERS:  None
   *
   * RETURN:      None
   *
   * DESCRIPTION: Dump the raw list of subtables with information, and also
   *              dump the subtable list in formatted tree format. Assists with
   *              the development of new table code.
   *
   *****************************************************************************/
  
  void
  DtDumpSubtableList (
      void)
  {
  
      if (!AslGbl_DebugFlag || !AslGbl_RootTable)
      {
          return;
      }
  
      DbgPrint (ASL_DEBUG_OUTPUT,
          "Subtable Info:\n"
          "Depth                      Name Length   TotalLen LenSize  Flags    "
          "This     Parent   Child    Peer\n\n");
      DtWalkTableTree (AslGbl_RootTable, DtDumpSubtableInfo, NULL, NULL);
  
      DbgPrint (ASL_DEBUG_OUTPUT,
          "\nSubtable Tree: (Depth, Name, Subtable, Length, TotalLength, Integer Value)\n\n");
      DtWalkTableTree (AslGbl_RootTable, DtDumpSubtableTree, NULL, NULL);
  
      DbgPrint (ASL_DEBUG_OUTPUT, "\n");
  }
  
  
  /******************************************************************************
   *
   * FUNCTION:    DtWriteFieldToListing
   *
   * PARAMETERS:  Buffer              - Contains the compiled data
   *              Field               - Field node for the input line
   *              Length              - Length of the output data
   *
   * RETURN:      None
   *
   * DESCRIPTION: Write one field to the listing file (if listing is enabled).
   *
   *****************************************************************************/
  
  void
  DtWriteFieldToListing (
      UINT8                   *Buffer,
      DT_FIELD                *Field,
      UINT32                  Length)
  {
      UINT8                   FileByte;
  
  
      if (!AslGbl_ListingFlag || !Field)
      {
          return;
      }
  
      /* Dump the original source line */
  
      FlPrintFile (ASL_FILE_LISTING_OUTPUT, "Input:  ");
      FlSeekFile (ASL_FILE_INPUT, Field->ByteOffset);
  
      while (FlReadFile (ASL_FILE_INPUT, &FileByte, 1) == AE_OK)
      {
          FlWriteFile (ASL_FILE_LISTING_OUTPUT, &FileByte, 1);
          if (FileByte == '\n')
          {
              break;
          }
      }
  
      /* Dump the line as parsed and represented internally */
  
      FlPrintFile (ASL_FILE_LISTING_OUTPUT, "Parsed: %*s : %.64s",
          Field->Column-4, Field->Name, Field->Value);
  
      if (strlen (Field->Value) > 64)
      {
          FlPrintFile (ASL_FILE_LISTING_OUTPUT, "...Additional data, length 0x%X\n",
              (UINT32) strlen (Field->Value));
      }
  
      FlPrintFile (ASL_FILE_LISTING_OUTPUT, "\n");
  
      /* Dump the hex data that will be output for this field */
  
      DtDumpBuffer (ASL_FILE_LISTING_OUTPUT, Buffer, Field->TableOffset, Length);
  }
  
  
  /******************************************************************************
   *
   * FUNCTION:    DtWriteTableToListing
   *
   * PARAMETERS:  None
   *
   * RETURN:      None
   *
   * DESCRIPTION: Write the entire compiled table to the listing file
   *              in hex format
   *
   *****************************************************************************/
  
  void
  DtWriteTableToListing (
      void)
  {
      UINT8                   *Buffer;
  
  
      if (!AslGbl_ListingFlag)
      {
          return;
      }
  
      /* Read the entire table from the output file */
  
      Buffer = UtLocalCalloc (AslGbl_TableLength);
      FlSeekFile (ASL_FILE_AML_OUTPUT, 0);
      FlReadFile (ASL_FILE_AML_OUTPUT, Buffer, AslGbl_TableLength);
  
      /* Dump the raw table data */
  
      AcpiOsRedirectOutput (AslGbl_Files[ASL_FILE_LISTING_OUTPUT].Handle);
  
      AcpiOsPrintf ("\n%s: Length %d (0x%X)\n\n",
          ACPI_RAW_TABLE_DATA_HEADER, AslGbl_TableLength, AslGbl_TableLength);
      AcpiUtDumpBuffer (Buffer, AslGbl_TableLength, DB_BYTE_DISPLAY, 0);
  
      AcpiOsRedirectOutput (stdout);
      ACPI_FREE (Buffer);
  }

Cache object: b94512c6cbde78787603b6a4c390571b