sys/contrib/dev/acpica/include/acapps.h

   1 /******************************************************************************
   2  *
   3  * Module Name: acapps - common include for ACPI applications/tools
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #ifndef _ACAPPS
 117 #define _ACAPPS
 118
 119
 120 #ifdef _MSC_VER                 /* disable some level-4 warnings */
 121 #pragma warning(disable:4100)   /* warning C4100: unreferenced formal parameter */
 122 #endif
 123
 124 /* Common info for tool signons */
 125
 126 #define ACPICA_NAME                 "Intel ACPI Component Architecture"
 127 #define ACPICA_COPYRIGHT            "Copyright (c) 2000 - 2010 Intel Corporation"
 128
 129 #if ACPI_MACHINE_WIDTH == 64
 130 #define ACPI_WIDTH          "-64"
 131
 132 #elif ACPI_MACHINE_WIDTH == 32
 133 #define ACPI_WIDTH          "-32"
 134
 135 #else
 136 #error unknown ACPI_MACHINE_WIDTH
 137 #define ACPI_WIDTH          "-??"
 138
 139 #endif
 140
 141 /* Macros for signons and file headers */
 142
 143 #define ACPI_COMMON_SIGNON(UtilityName) \
 144     "\n%s\n%s version %8.8X%s\n%s\n\n", \
 145     ACPICA_NAME, \
 146     UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \
 147     ACPICA_COPYRIGHT
 148
 149 #define ACPI_COMMON_HEADER(UtilityName, Prefix) \
 150     "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \
 151     Prefix, ACPICA_NAME, \
 152     Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \
 153     Prefix, ACPICA_COPYRIGHT, \
 154     Prefix
 155
 156 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
 157 #define ACPI_TABLE_FILE_SUFFIX      ".dat"
 158
 159
 160 /*
 161  * getopt
 162  */
 163 int
 164 AcpiGetopt(
 165     int                     argc,
 166     char                    **argv,
 167     char                    *opts);
 168
 169 extern int                  AcpiGbl_Optind;
 170 extern int                  AcpiGbl_Opterr;
 171 extern char                 *AcpiGbl_Optarg;
 172
 173
 174 /*
 175  * adisasm
 176  */
 177 ACPI_STATUS
 178 AdAmlDisassemble (
 179     BOOLEAN                 OutToFile,
 180     char                    *Filename,
 181     char                    *Prefix,
 182     char                    **OutFilename,
 183     BOOLEAN                 GetAllTables);
 184
 185 void
 186 AdPrintStatistics (
 187     void);
 188
 189 ACPI_STATUS
 190 AdFindDsdt(
 191     UINT8                   **DsdtPtr,
 192     UINT32                  *DsdtLength);
 193
 194 void
 195 AdDumpTables (
 196     void);
 197
 198 ACPI_STATUS
 199 AdGetLocalTables (
 200     char                    *Filename,
 201     BOOLEAN                 GetAllTables);
 202
 203 ACPI_STATUS
 204 AdParseTable (
 205     ACPI_TABLE_HEADER       *Table,
 206     ACPI_OWNER_ID           *OwnerId,
 207     BOOLEAN                 LoadTable,
 208     BOOLEAN                 External);
 209
 210 ACPI_STATUS
 211 AdDisplayTables (
 212     char                    *Filename,
 213     ACPI_TABLE_HEADER       *Table);
 214
 215 ACPI_STATUS
 216 AdDisplayStatistics (
 217     void);
 218
 219
 220 /*
 221  * adwalk
 222  */
 223 void
 224 AcpiDmCrossReferenceNamespace (
 225     ACPI_PARSE_OBJECT       *ParseTreeRoot,
 226     ACPI_NAMESPACE_NODE     *NamespaceRoot,
 227     ACPI_OWNER_ID           OwnerId);
 228
 229 void
 230 AcpiDmDumpTree (
 231     ACPI_PARSE_OBJECT       *Origin);
 232
 233 void
 234 AcpiDmFindOrphanMethods (
 235     ACPI_PARSE_OBJECT       *Origin);
 236
 237 void
 238 AcpiDmFinishNamespaceLoad (
 239     ACPI_PARSE_OBJECT       *ParseTreeRoot,
 240     ACPI_NAMESPACE_NODE     *NamespaceRoot,
 241     ACPI_OWNER_ID           OwnerId);
 242
 243 void
 244 AcpiDmConvertResourceIndexes (
 245     ACPI_PARSE_OBJECT       *ParseTreeRoot,
 246     ACPI_NAMESPACE_NODE     *NamespaceRoot);
 247
 248
 249 /*
 250  * adfile
 251  */
 252 ACPI_STATUS
 253 AdInitialize (
 254     void);
 255
 256 char *
 257 FlGenerateFilename (
 258     char                    *InputFilename,
 259     char                    *Suffix);
 260
 261 ACPI_STATUS
 262 FlSplitInputPathname (
 263     char                    *InputPath,
 264     char                    **OutDirectoryPath,
 265     char                    **OutFilename);
 266
 267 char *
 268 AdGenerateFilename (
 269     char                    *Prefix,
 270     char                    *TableId);
 271
 272 void
 273 AdWriteTable (
 274     ACPI_TABLE_HEADER       *Table,
 275     UINT32                  Length,
 276     char                    *TableName,
 277     char                    *OemTableId);
 278
 279 #endif /* _ACAPPS */
 280