Home | History | Annotate | Line # | Download | only in include
acapps.h revision 1.3
      1 /******************************************************************************
      2  *
      3  * Module Name: acapps - common include for ACPI applications/tools
      4  *
      5  *****************************************************************************/
      6 
      7 /*
      8  * Copyright (C) 2000 - 2011, Intel Corp.
      9  * All rights reserved.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions, and the following disclaimer,
     16  *    without modification.
     17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     18  *    substantially similar to the "NO WARRANTY" disclaimer below
     19  *    ("Disclaimer") and any redistribution must be conditioned upon
     20  *    including a substantially similar Disclaimer requirement for further
     21  *    binary redistribution.
     22  * 3. Neither the names of the above-listed copyright holders nor the names
     23  *    of any contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * Alternatively, this software may be distributed under the terms of the
     27  * GNU General Public License ("GPL") version 2 as published by the Free
     28  * Software Foundation.
     29  *
     30  * NO WARRANTY
     31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     41  * POSSIBILITY OF SUCH DAMAGES.
     42  */
     43 
     44 #ifndef _ACAPPS
     45 #define _ACAPPS
     46 
     47 
     48 #ifdef _MSC_VER                 /* disable some level-4 warnings */
     49 #pragma warning(disable:4100)   /* warning C4100: unreferenced formal parameter */
     50 #endif
     51 
     52 /* Common info for tool signons */
     53 
     54 #define ACPICA_NAME                 "Intel ACPI Component Architecture"
     55 #define ACPICA_COPYRIGHT            "Copyright (c) 2000 - 2011 Intel Corporation"
     56 
     57 #if ACPI_MACHINE_WIDTH == 64
     58 #define ACPI_WIDTH          "-64"
     59 
     60 #elif ACPI_MACHINE_WIDTH == 32
     61 #define ACPI_WIDTH          "-32"
     62 
     63 #else
     64 #error unknown ACPI_MACHINE_WIDTH
     65 #define ACPI_WIDTH          "-??"
     66 
     67 #endif
     68 
     69 /* Macros for signons and file headers */
     70 #ifdef ACPI_REPRO
     71 #define ACPI_DATE "23 Jun 2011"
     72 #else
     73 #define ACPI_DATE __DATE__
     74 #endif
     75 
     76 #define ACPI_COMMON_SIGNON(UtilityName) \
     77     "\n%s\n%s version %8.8X%s [%s]\n%s\n\n", \
     78     ACPICA_NAME, \
     79     UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, ACPI_DATE, \
     80     ACPICA_COPYRIGHT
     81 
     82 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \
     83     "%s%s\n%s%s version %8.8X%s [%s]\n%s%s\n%s\n", \
     84     Prefix, ACPICA_NAME, \
     85     Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, ACPI_DATE, \
     86     Prefix, ACPICA_COPYRIGHT, \
     87     Prefix
     88 
     89 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
     90 #define ACPI_TABLE_FILE_SUFFIX      ".dat"
     91 
     92 
     93 /*
     94  * getopt
     95  */
     96 int
     97 AcpiGetopt(
     98     int                     argc,
     99     char                    **argv,
    100     char                    *opts);
    101 
    102 extern int                  AcpiGbl_Optind;
    103 extern int                  AcpiGbl_Opterr;
    104 extern char                 *AcpiGbl_Optarg;
    105 
    106 
    107 /*
    108  * adisasm
    109  */
    110 ACPI_STATUS
    111 AdAmlDisassemble (
    112     BOOLEAN                 OutToFile,
    113     char                    *Filename,
    114     char                    *Prefix,
    115     char                    **OutFilename,
    116     BOOLEAN                 GetAllTables);
    117 
    118 void
    119 AdPrintStatistics (
    120     void);
    121 
    122 ACPI_STATUS
    123 AdFindDsdt(
    124     UINT8                   **DsdtPtr,
    125     UINT32                  *DsdtLength);
    126 
    127 void
    128 AdDumpTables (
    129     void);
    130 
    131 ACPI_STATUS
    132 AdGetLocalTables (
    133     char                    *Filename,
    134     BOOLEAN                 GetAllTables);
    135 
    136 ACPI_STATUS
    137 AdParseTable (
    138     ACPI_TABLE_HEADER       *Table,
    139     ACPI_OWNER_ID           *OwnerId,
    140     BOOLEAN                 LoadTable,
    141     BOOLEAN                 External);
    142 
    143 ACPI_STATUS
    144 AdDisplayTables (
    145     char                    *Filename,
    146     ACPI_TABLE_HEADER       *Table);
    147 
    148 ACPI_STATUS
    149 AdDisplayStatistics (
    150     void);
    151 
    152 
    153 /*
    154  * adwalk
    155  */
    156 void
    157 AcpiDmCrossReferenceNamespace (
    158     ACPI_PARSE_OBJECT       *ParseTreeRoot,
    159     ACPI_NAMESPACE_NODE     *NamespaceRoot,
    160     ACPI_OWNER_ID           OwnerId);
    161 
    162 void
    163 AcpiDmDumpTree (
    164     ACPI_PARSE_OBJECT       *Origin);
    165 
    166 void
    167 AcpiDmFindOrphanMethods (
    168     ACPI_PARSE_OBJECT       *Origin);
    169 
    170 void
    171 AcpiDmFinishNamespaceLoad (
    172     ACPI_PARSE_OBJECT       *ParseTreeRoot,
    173     ACPI_NAMESPACE_NODE     *NamespaceRoot,
    174     ACPI_OWNER_ID           OwnerId);
    175 
    176 void
    177 AcpiDmConvertResourceIndexes (
    178     ACPI_PARSE_OBJECT       *ParseTreeRoot,
    179     ACPI_NAMESPACE_NODE     *NamespaceRoot);
    180 
    181 
    182 /*
    183  * adfile
    184  */
    185 ACPI_STATUS
    186 AdInitialize (
    187     void);
    188 
    189 char *
    190 FlGenerateFilename (
    191     char                    *InputFilename,
    192     char                    *Suffix);
    193 
    194 ACPI_STATUS
    195 FlSplitInputPathname (
    196     char                    *InputPath,
    197     char                    **OutDirectoryPath,
    198     char                    **OutFilename);
    199 
    200 char *
    201 AdGenerateFilename (
    202     char                    *Prefix,
    203     char                    *TableId);
    204 
    205 void
    206 AdWriteTable (
    207     ACPI_TABLE_HEADER       *Table,
    208     UINT32                  Length,
    209     char                    *TableName,
    210     char                    *OemTableId);
    211 
    212 #endif /* _ACAPPS */
    213 
    214