Subversion Repositories Kolibri OS

 *

 * Module Name: asllisting - Listing file generation

 *

 *****************************************************************************/

 *

 * 1. Copyright Notice

 *

 * Some or all of this work - Copyright (c) 1999 - 2011, 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.

 *

 *****************************************************************************/

#include "aslcompiler.y.h"

#include "amlcode.h"

#include "acparser.h"

#include "acnamesp.h"

        ACPI_MODULE_NAME    ("aslisting")

LsDumpAscii (

    UINT32                  FileId,

    UINT32                  Count,

    UINT8                   *Buffer);

LsDumpAsciiInComment (

    UINT32                  FileId,

    UINT32                  Count,

    UINT8                   *Buffer);

LsAmlListingWalk (

    ACPI_PARSE_OBJECT       *Op,

    UINT32                  Level,

    void                    *Context);

LsGenerateListing (

    UINT32                  FileId);

LsPushNode (

    char                    *Filename);

LsPopNode (

    void);

LsCheckException (

    UINT32                  LineNumber,

    UINT32                  FileId);

LsFlushListingBuffer (

    UINT32                  FileId);

LsWriteListingHexBytes (

    UINT8                   *Buffer,

    UINT32                  Length,

    UINT32                  FileId);

LsWriteOneSourceLine (

    UINT32                  FileId);

LsFinishSourceListing (

    UINT32                  FileId);

LsWriteSourceLines (

    UINT32                  ToLineNumber,

    UINT32                  ToLogicalLineNumber,

    UINT32                  FileId);

LsWriteNodeToListing (

    ACPI_PARSE_OBJECT       *Op,

    UINT32                  FileId);

LsDoHexOutputC (

    void);

LsDoHexOutputAsm (

    void);

LsDoHexOutputAsl (

    void);

LsTreeWriteWalk (

    ACPI_PARSE_OBJECT       *Op,

    UINT32                  Level,

    void                    *Context);

 *

 * FUNCTION:    LsTreeWriteWalk

 *

 * PARAMETERS:  ASL_WALK_CALLBACK

 *

 *

 * RETURN:      None.

 *

 * DESCRIPTION: Dump entire parse tree, for compiler debug only

 *

 ******************************************************************************/

LsTreeWriteWalk (

    ACPI_PARSE_OBJECT       *Op,

    UINT32                  Level,

    void                    *Context)

{

        "%5.5d [%2d]", Op->Asl.LogicalLineNumber, Level);

    UtPrintFormattedName (Op->Asl.ParseOpcode, Level);

    return (AE_OK);

}

LsDumpParseTree (

    void)

{

    {

        return;

    }

    TrWalkParseTree (RootNode, ASL_WALK_VISIT_DOWNWARD,

        LsTreeWriteWalk, NULL, NULL);

}

 *

 * FUNCTION:    LsDumpAscii

 *

 * PARAMETERS:  FileId          - ID of current listing file

 *              Count           - Number of bytes to convert

 *              Buffer          - Buffer of bytes to convert

 *

 * RETURN:      None.

 *

 * DESCRIPTION: Convert hex bytes to ascii

 *

 ******************************************************************************/

LsDumpAscii (

    UINT32                  FileId,

    UINT32                  Count,

    UINT8                   *Buffer)

{

    UINT8                   BufChar;

    UINT32                  i;

    for (i = 0; i < Count; i++)

    {

        BufChar = Buffer[i];

        if (isprint (BufChar))

        {

            FlPrintFile (FileId, "%c", BufChar);

        }

        else

        {

            /* Not a printable character, just put out a dot */

        }

    }

    FlPrintFile (FileId, "\"");

}

 *

 * FUNCTION:    LsDumpAsciiInComment

 *

 * PARAMETERS:  FileId          - ID of current listing file

 *              Count           - Number of bytes to convert

 *              Buffer          - Buffer of bytes to convert

 *

 * RETURN:      None.

 *

 * DESCRIPTION: Convert hex bytes to ascii

 *

 ******************************************************************************/

LsDumpAsciiInComment (

    UINT32                  FileId,

    UINT32                  Count,

    UINT8                   *Buffer)

{

    UINT8                   BufChar = 0;

    UINT8                   LastChar;

    UINT32                  i;

    for (i = 0; i < Count; i++)

    {

        LastChar = BufChar;

        BufChar = Buffer[i];

        {

            /* Handle embedded C comment sequences */

                ((LastChar == '/') && (BufChar == '*')))

            {

                /* Insert a space to break the sequence */

            }

        }

        else

        {

            /* Not a printable character, just put out a dot */

        }

    }

    FlPrintFile (FileId, "\"");

}

 *

 * FUNCTION:    LsAmlListingWalk

 *

 * PARAMETERS:  ASL_WALK_CALLBACK

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Process one node during a listing file generation.

 *

 ******************************************************************************/

LsAmlListingWalk (

    ACPI_PARSE_OBJECT       *Op,

    UINT32                  Level,

    void                    *Context)

{

    UINT8                   FileByte;

    UINT32                  i;

    UINT32                  FileId = (UINT32) ACPI_TO_INTEGER (Context);

    {

        /* Buffer is a resource template, don't dump the data all at once */

    }

    {

        if (ACPI_FAILURE (FlReadFile (ASL_FILE_AML_OUTPUT, &FileByte, 1)))

        {

            FlFileError (ASL_FILE_AML_OUTPUT, ASL_MSG_READ);

            AslAbort ();

        }

        LsWriteListingHexBytes (&FileByte, 1, FileId);

    }

}

 *

 * FUNCTION:    LsGenerateListing

 *

 * PARAMETERS:  FileId      - ID of listing file

 *

 * RETURN:      None

 *

 * DESCRIPTION: Generate a listing file.  This can be one of the several types

 *              of "listings" supported.

 *

 ******************************************************************************/

LsGenerateListing (

    UINT32                  FileId)

{

    FlSeekFile (ASL_FILE_AML_OUTPUT, 0);

    Gbl_SourceLine = 0;

    Gbl_CurrentHexColumn = 0;

    LsPushNode (Gbl_Files[ASL_FILE_INPUT].Filename);

                        NULL, (void *) ACPI_TO_POINTER (FileId));

}

 *

 * FUNCTION:    LsDoListings

 *

 * PARAMETERS:  None.

 *

 * RETURN:      None

 *

 * DESCRIPTION: Generate all requested listing files.

 *

 ******************************************************************************/

LsDoListings (

    void)

{

    {

        LsGenerateListing (ASL_FILE_C_SOURCE_OUTPUT);

    }

    {

        LsGenerateListing (ASL_FILE_LISTING_OUTPUT);

    }

    {

        LsGenerateListing (ASL_FILE_ASM_SOURCE_OUTPUT);

    }

    {

        LsGenerateListing (ASL_FILE_C_INCLUDE_OUTPUT);

    }

    {

        LsGenerateListing (ASL_FILE_ASM_INCLUDE_OUTPUT);

    }

}

 *

 * FUNCTION:    LsPushNode

 *

 * PARAMETERS:  Filename        - Pointer to the include filename

 *

 * RETURN:      None

 *

 * DESCRIPTION: Push a listing node on the listing/include file stack.  This

 *              stack enables tracking of include files (infinitely nested)

 *              and resumption of the listing of the parent file when the

 *              include file is finished.

 *

 ******************************************************************************/

LsPushNode (

    char                    *Filename)

{

    ASL_LISTING_NODE        *Lnode;

    Lnode->LineNumber = 0;

    Gbl_ListingNode = Lnode;

}

 *

 * FUNCTION:    LsPopNode

 *

 * PARAMETERS:  None

 *

 * RETURN:      List head after current head is popped off

 *

 * DESCRIPTION: Pop the current head of the list, free it, and return the

 *              next node on the stack (the new current node).

 *

 ******************************************************************************/

LsPopNode (

    void)

{

    ASL_LISTING_NODE        *Lnode;

    if ((!Lnode) ||

        (!Lnode->Next))

    {

        AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL, NULL,

            "Could not pop empty listing stack");

        return Gbl_ListingNode;

    }

    ACPI_FREE (Lnode);

}

 *

 * FUNCTION:    LsCheckException

 *

 * PARAMETERS:  LineNumber          - Current logical (cumulative) line #

 *              FileId              - ID of output listing file

 *

 * RETURN:      None

 *

 * DESCRIPTION: Check if there is an exception for this line, and if there is,

 *              put it in the listing immediately.  Handles multiple errors

 *              per line.  Gbl_NextError points to the next error in the

 *              sorted (by line #) list of compile errors/warnings.

 *

 ******************************************************************************/

LsCheckException (

    UINT32                  LineNumber,

    UINT32                  FileId)

{

        (LineNumber < Gbl_NextError->LogicalLineNumber ))

    {

        return;

    }

    {

        while (Gbl_NextError &&

              (LineNumber >= Gbl_NextError->LogicalLineNumber))

        {

            AePrintException (FileId, Gbl_NextError, "\n[****iasl****]\n");

        }

    }

}

 *

 * FUNCTION:    LsFlushListingBuffer

 *

 * PARAMETERS:  FileId          - ID of the listing file

 *

 * RETURN:      None

 *

 * DESCRIPTION: Flush out the current contents of the 16-byte hex AML code

 *              buffer.  Usually called at the termination of a single line

 *              of source code or when the buffer is full.

 *

 ******************************************************************************/

LsFlushListingBuffer (

    UINT32                  FileId)

{

    UINT32                  i;

    {

        return;

    }

    {

    case ASL_FILE_LISTING_OUTPUT:

        {

            FlPrintFile (FileId, "%2.2X ", Gbl_AmlBuffer[i]);

        }

        {

            FlWriteFile (FileId, ".", 1);

        }

        break;

        {

            if (i > 0)

            {

                FlPrintFile (FileId, ",");

            }

            FlPrintFile (FileId, "0%2.2Xh", Gbl_AmlBuffer[i]);

        }

        {

            FlWriteFile (FileId, " ", 1);

        }

            Gbl_CurrentAmlOffset - HEX_LISTING_LINE_SIZE);

        break;

        {

            FlPrintFile (FileId, "0x%2.2X,", Gbl_AmlBuffer[i]);

        }

        {

            FlWriteFile (FileId, " ", 1);

        }

            Gbl_CurrentAmlOffset - HEX_LISTING_LINE_SIZE);

        FlPrintFile (FileId, " */");

        break;

        /* No other types supported */

        return;

    }

    Gbl_HexBytesWereWritten = TRUE;

}

 *

 * FUNCTION:    LsWriteListingHexBytes

 *

 * PARAMETERS:  Buffer          - AML code buffer

 *              Length          - Number of AML bytes to write

 *              FileId          - ID of current listing file.

 *

 * RETURN:      None

 *

 * DESCRIPTION: Write the contents of the AML buffer to the listing file via

 *              the listing buffer.  The listing buffer is flushed every 16

 *              AML bytes.

 *

 ******************************************************************************/

LsWriteListingHexBytes (

    UINT8                   *Buffer,

    UINT32                  Length,

    UINT32                  FileId)

{

    UINT32                  i;

    {

        /* Print line header when buffer is empty */

        {

            if (Gbl_HasIncludeFiles)

            {

                FlPrintFile (FileId, "%*s", 10, " ");

            }

            {

            case ASL_FILE_LISTING_OUTPUT:

                break;

                break;

                break;

                /* No other types supported */

                return;

            }

        }

        Gbl_CurrentAmlOffset++;

        {

            LsFlushListingBuffer (FileId);

        }

    }

}

 *

 * FUNCTION:    LsWriteOneSourceLine

 *

 * PARAMETERS:  FileID          - ID of current listing file

 *

 * RETURN:      FALSE on EOF (input source file), TRUE otherwise

 *

 * DESCRIPTION: Read one line from the input source file and echo it to the

 *              listing file, prefixed with the line number, and if the source

 *              file contains include files, prefixed with the current filename

 *

 ******************************************************************************/

LsWriteOneSourceLine (

    UINT32                  FileId)

{

    UINT8                   FileByte;

    Gbl_ListingNode->LineNumber++;

    {

        FlPrintFile (FileId, "     *");

    }

    if (FileId == ASL_FILE_ASM_SOURCE_OUTPUT)

    {

        FlPrintFile (FileId, "; ");

    }

    {

        /*

         * This file contains "include" statements, print the current

         * filename and line number within the current file

         */

        FlPrintFile (FileId, "%12s %5d....",

                    Gbl_ListingNode->Filename, Gbl_ListingNode->LineNumber);

    }

    else

    {

        /* No include files, just print the line number */

    }

    {

        if (FileId == ASL_FILE_C_SOURCE_OUTPUT)

        {

            if (FileByte == '/')

            {

                FileByte = '*';

            }

        }

        if (FileByte == '\n')

        {

            /*

             * Check if an error occurred on this source line during the compile.

             * If so, we print the error message after the source line.

             */

            LsCheckException (Gbl_SourceLine, FileId);

            return (1);

        }

    }

}

 *

 * FUNCTION:    LsFinishSourceListing

 *

 * PARAMETERS:  FileId          - ID of current listing file.

 *

 * RETURN:      None

 *

 * DESCRIPTION: Cleanup routine for the listing file.  Flush the hex AML

 *              listing buffer, and flush out any remaining lines in the

 *              source input file.

 *

 ******************************************************************************/

LsFinishSourceListing (

    UINT32                  FileId)

{

        (FileId == ASL_FILE_C_INCLUDE_OUTPUT))

    {

        return;

    }

    Gbl_CurrentAmlOffset = 0;

    {

        FlPrintFile (FileId, "    /*\n");

    }

    { ; }

    {

        FlPrintFile (FileId, "\n     */\n    };\n");

    }

    {

        /* Print a summary of the compile exceptions */

        AePrintErrorLog (FileId);

        FlPrintFile (FileId, "\n\n");

        UtDisplaySummary (FileId);

        FlPrintFile (FileId, "\n\n");

    }

}

 *

 * FUNCTION:    LsWriteSourceLines

 *

 * PARAMETERS:  ToLineNumber            -

 *              ToLogicalLineNumber     - Write up to this source line number

 *              FileId                  - ID of current listing file

 *

 * RETURN:      None

 *

 * DESCRIPTION: Read then write source lines to the listing file until we have

 *              reached the specified logical (cumulative) line number.  This

 *              automatically echos out comment blocks and other non-AML

 *              generating text until we get to the actual AML-generating line

 *              of ASL code specified by the logical line number.

 *

 ******************************************************************************/

LsWriteSourceLines (

    UINT32                  ToLineNumber,

    UINT32                  ToLogicalLineNumber,

    UINT32                  FileId)

{

        (FileId == ASL_FILE_C_INCLUDE_OUTPUT))

    {

        return;

    }

    {

        /*

         * If we just completed writing some AML hex bytes, output a linefeed

         * to add some whitespace for readability.

         */

        if (Gbl_HexBytesWereWritten)

        {

            FlPrintFile (FileId, "\n");

            Gbl_HexBytesWereWritten = FALSE;

        }

        {

            FlPrintFile (FileId, "    /*\n");

        }

                LsWriteOneSourceLine (FileId))

        { ; }

        {

            FlPrintFile (FileId, "     */");

        }

        FlPrintFile (FileId, "\n");

    }

}

 *

 * FUNCTION:    LsWriteNodeToListing

 *

 * PARAMETERS:  Op            - Parse node to write to the listing file.

 *              FileId          - ID of current listing file

 *

 * RETURN:      None.

 *

 * DESCRIPTION: Write "a node" to the listing file.  This means to

 *              1) Write out all of the source text associated with the node

 *              2) Write out all of the AML bytes associated with the node

 *              3) Write any compiler exceptions associated with the node

 *

 ******************************************************************************/

LsWriteNodeToListing (

    ACPI_PARSE_OBJECT       *Op,

    UINT32                  FileId)

{

    const ACPI_OPCODE_INFO  *OpInfo;

    UINT32                  OpClass;

    char                    *Pathname;

    UINT32                  Length;

    UINT32                  i;

    OpClass = OpInfo->Class;

     * I start a named output block

     */

    if (FileId == ASL_FILE_C_SOURCE_OUTPUT)

    {

        switch (Op->Asl.ParseOpcode)

        {

        case PARSEOP_DEFINITIONBLOCK:

        case PARSEOP_METHODCALL:

        case PARSEOP_INCLUDE:

        case PARSEOP_INCLUDE_END:

        case PARSEOP_DEFAULT_ARG:

            switch (OpClass)

            {

            case AML_CLASS_NAMED_OBJECT:

                switch (Op->Asl.AmlOpcode)

                {

                case AML_SCOPE_OP:

                case AML_ALIAS_OP:

                    break;

                    if (Op->Asl.ExternalName)

                    {

                        LsFlushListingBuffer (FileId);

                        FlPrintFile (FileId, "    };\n");

                    }

                    break;

                }

                break;

                /* Don't care about other objects */

                break;

            }

            break;

        }

    }

    {

    case PARSEOP_DEFINITIONBLOCK:

        {

            FlPrintFile (FileId,

                "%s_%s_Header \\\n",

                Gbl_TableSignature, Gbl_TableId);

        }

        if (FileId == ASL_FILE_C_SOURCE_OUTPUT)

        {

            FlPrintFile (FileId,

                "    unsigned char    %s_%s_Header [] =\n    {\n",

                Gbl_TableSignature, Gbl_TableId);

        }

        if (FileId == ASL_FILE_ASM_INCLUDE_OUTPUT)

        {

            FlPrintFile (FileId,

                "extrn %s_%s_Header : byte\n",

                Gbl_TableSignature, Gbl_TableId);

        }

        if (FileId == ASL_FILE_C_INCLUDE_OUTPUT)

        {

            FlPrintFile (FileId,

                "extern unsigned char    %s_%s_Header [];\n",

                Gbl_TableSignature, Gbl_TableId);

        }

        return;

            FileId);

        return;

            FileId);