Subversion Repositories Kolibri OS

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

 *

 * Module Name: dttemplate - ACPI table template 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.h"

#include "acapps.h"

#include "dtcompiler.h"

#include "dttemplate.h" /* Contains the hex ACPI table templates */

#define _COMPONENT          DT_COMPILER

        ACPI_MODULE_NAME    ("dttemplate")

/* Local prototypes */

static BOOLEAN

AcpiUtIsSpecialTable (

    char                    *Signature);

static ACPI_STATUS

DtCreateOneTemplate (

    char                    *Signature,

    ACPI_DMTABLE_DATA       *TableData);

static ACPI_STATUS

DtCreateAllTemplates (

    void);

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

 *

 * FUNCTION:    AcpiUtIsSpecialTable

 *

 * PARAMETERS:  Signature           - ACPI table signature

 *

 * RETURN:      TRUE if signature is a special ACPI table

 *

 * DESCRIPTION: Check for valid ACPI tables that are not in the main ACPI

 *              table data structure (AcpiDmTableData).

 *

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

static BOOLEAN

AcpiUtIsSpecialTable (

    char                    *Signature)

{

    if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT) ||

        ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT) ||

        ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS) ||

        ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))

    {

        return (TRUE);

    }

    return (FALSE);

}

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

 *

 * FUNCTION:    DtCreateTemplates

 *

 * PARAMETERS:  Signature           - ACPI table signature

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Create one or more template files.

 *

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

ACPI_STATUS

DtCreateTemplates (

    char                    *Signature)

{

    ACPI_DMTABLE_DATA       *TableData;

    ACPI_STATUS             Status;

    AslInitializeGlobals ();

    AcpiUtStrupr (Signature);

    /* Create all known templates if requested */

    if (!ACPI_STRNCMP (Signature, "ALL", 3) ||

        !ACPI_STRCMP (Signature, "*"))

    {

        Status = DtCreateAllTemplates ();

        return (Status);

    }

    /*

     * Validate signature and get the template data:

     *  1) Signature must be 4 characters

     *  2) Signature must be a recognized ACPI table

     *  3) There must be a template associated with the signature

     */

    if (strlen (Signature) != ACPI_NAME_SIZE)

    {

        fprintf (stderr, "%s, Invalid ACPI table signature\n", Signature);

        return (AE_ERROR);

    }

    /*

     * Some slack for the two strange tables whose name is different than

     * their signatures: MADT->APIC and FADT->FACP.

     */

    if (!strcmp (Signature, "MADT"))

    {

        Signature = "APIC";

    }

    else if (!strcmp (Signature, "FADT"))

    {

        Signature = "FACP";

    }

    TableData = AcpiDmGetTableData (Signature);

    if (TableData)

    {

        if (!TableData->Template)

        {

            fprintf (stderr, "%4.4s, No template available\n", Signature);

            return (AE_ERROR);

        }

    }

    else if (!AcpiUtIsSpecialTable (Signature))

    {

        fprintf (stderr,

            "%4.4s, Unrecognized ACPI table signature\n", Signature);

        return (AE_ERROR);

    }

    Status = AdInitialize ();

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    Status = DtCreateOneTemplate (Signature, TableData);

    return (Status);

}

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

 *

 * FUNCTION:    DtCreateAllTemplates

 *

 * PARAMETERS:  None

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Create all currently defined template files

 *

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

static ACPI_STATUS

DtCreateAllTemplates (

    void)

{

    ACPI_DMTABLE_DATA       *TableData;

    ACPI_STATUS             Status;

    Status = AdInitialize ();

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    fprintf (stderr, "Creating all supported Template files\n");

    /* Walk entire ACPI table data structure */

    for (TableData = AcpiDmTableData; TableData->Signature; TableData++)

    {

        /* If table has a template, create the template file */

        if (TableData->Template)

        {

            Status = DtCreateOneTemplate (TableData->Signature,

                        TableData);

            if (ACPI_FAILURE (Status))

            {

                return (Status);

            }

        }

    }

    /*

     * Create the "special ACPI tables:

     * 1) DSDT/SSDT are AML tables, not data tables

     * 2) FACS and RSDP have non-standard headers

     */

    Status = DtCreateOneTemplate (ACPI_SIG_DSDT, NULL);

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    Status = DtCreateOneTemplate (ACPI_SIG_SSDT, NULL);

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    Status = DtCreateOneTemplate (ACPI_SIG_FACS, NULL);

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    Status = DtCreateOneTemplate (ACPI_RSDP_NAME, NULL);

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    return (AE_OK);

}

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

 *

 * FUNCTION:    DtCreateOneTemplate

 *

 * PARAMETERS:  Signature           - ACPI signature, NULL terminated.

 *              TableData           - Entry in ACPI table data structure.

 *                                    NULL if a special ACPI table.

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Create one template source file for the requested ACPI table.

 *

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

static ACPI_STATUS

DtCreateOneTemplate (

    char                    *Signature,

    ACPI_DMTABLE_DATA       *TableData)

{

    char                    *DisasmFilename;

    FILE                    *File;

    ACPI_STATUS             Status = AE_OK;

    /* New file will have a .asl suffix */

    DisasmFilename = FlGenerateFilename (

        Signature, FILE_SUFFIX_ASL_CODE);

    if (!DisasmFilename)

    {

        fprintf (stderr, "Could not generate output filename\n");

        return (AE_ERROR);

    }

    /* Probably should prompt to overwrite the file */

    AcpiUtStrlwr (DisasmFilename);

    File = fopen (DisasmFilename, "w+");

    if (!File)

    {

        fprintf (stderr, "Could not open output file %s\n", DisasmFilename);

        return (AE_ERROR);

    }

    /* Emit the common file header */

    AcpiOsRedirectOutput (File);

    AcpiOsPrintf ("/*\n");

    AcpiOsPrintf (ACPI_COMMON_HEADER ("iASL Compiler/Disassembler", " * "));

    AcpiOsPrintf (" * Template for [%4.4s] ACPI Table\n",

        Signature);

    /* Dump the actual ACPI table */

    if (TableData)

    {

        /* Normal case, tables that appear in AcpiDmTableData */

        if (Gbl_VerboseTemplates)

        {

            AcpiOsPrintf (" * Format: [HexOffset DecimalOffset ByteLength]"

                "  FieldName : HexFieldValue\n */\n\n");

        }

        else

        {

            AcpiOsPrintf (" * Format: [ByteLength]"

                "  FieldName : HexFieldValue\n */\n\n");

        }

        AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,

            TableData->Template));

    }

    else

    {

        /* Special ACPI tables - DSDT, SSDT, FACS, RSDP */

        AcpiOsPrintf (" */\n\n");

        if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_DSDT))

        {

            fwrite (TemplateDsdt, sizeof (TemplateDsdt) -1, 1, File);

        }

        else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_SSDT))

        {

            fwrite (TemplateSsdt, sizeof (TemplateSsdt) -1, 1, File);

        }

        else if (ACPI_COMPARE_NAME (Signature, ACPI_SIG_FACS))

        {

            AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,

                TemplateFacs));

        }

        else if (ACPI_COMPARE_NAME (Signature, ACPI_RSDP_NAME))

        {

            AcpiDmDumpDataTable (ACPI_CAST_PTR (ACPI_TABLE_HEADER,

                TemplateRsdp));

        }

        else

        {

            fprintf (stderr,

                "%4.4s, Unrecognized ACPI table signature\n", Signature);

            return (AE_ERROR);

        }

    }

    fprintf (stderr,

        "Created ACPI table template for [%4.4s], written to \"%s\"\n",

        Signature, DisasmFilename);

    fclose (File);

    AcpiOsRedirectOutput (stdout);

    ACPI_FREE (DisasmFilename);

    return (Status);

}