acapps.h revision 193249 
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 - 2007, 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#define FILE_SUFFIX_DISASSEMBLY     "dsl"
125#define ACPI_TABLE_FILE_SUFFIX      ".dat"
126
127extern UINT8                    *DsdtPtr;
128extern UINT32                   AcpiDsdtLength;
129extern UINT8                    *AmlStart;
130extern UINT32                   AmlLength;
131
132
133extern int                      AcpiGbl_Optind;
134extern char                     *AcpiGbl_Optarg;
135
136int
137AcpiGetopt(
138    int                     argc,
139    char                    **argv,
140    char                    *opts);
141
142/*
143 * adisasm
144 */
145ACPI_STATUS
146AdAmlDisassemble (
147    BOOLEAN                 OutToFile,
148    char                    *Filename,
149    char                    *Prefix,
150    char                    **OutFilename,
151    BOOLEAN                 GetAllTables);
152
153void
154AdPrintStatistics (void);
155
156ACPI_STATUS
157AdFindDsdt(
158    UINT8                   **DsdtPtr,
159    UINT32                  *DsdtLength);
160
161void
162AdDumpTables (void);
163
164ACPI_STATUS
165AdGetLocalTables (
166    char                    *Filename,
167    BOOLEAN                 GetAllTables);
168
169ACPI_STATUS
170AdParseTable (
171    ACPI_TABLE_HEADER       *Table);
172
173ACPI_STATUS
174AdDisplayTables (
175    char                    *Filename,
176    ACPI_TABLE_HEADER       *Table);
177
178ACPI_STATUS
179AdDisplayStatistics (void);
180
181/*
182 * adwalk
183 */
184void
185AcpiDmCrossReferenceNamespace (
186    ACPI_PARSE_OBJECT       *ParseTreeRoot,
187    ACPI_NAMESPACE_NODE     *NamespaceRoot);
188
189void
190AcpiDmDumpTree (
191    ACPI_PARSE_OBJECT       *Origin);
192
193void
194AcpiDmFindOrphanMethods (
195    ACPI_PARSE_OBJECT       *Origin);
196
197void
198AcpiDmFinishNamespaceLoad (
199    ACPI_PARSE_OBJECT       *ParseTreeRoot,
200    ACPI_NAMESPACE_NODE     *NamespaceRoot);
201
202void
203AcpiDmConvertResourceIndexes (
204    ACPI_PARSE_OBJECT       *ParseTreeRoot,
205    ACPI_NAMESPACE_NODE     *NamespaceRoot);
206
207/*
208 * adfile
209 */
210ACPI_STATUS
211AdInitialize (
212    void);
213
214char *
215FlGenerateFilename (
216    char                    *InputFilename,
217    char                    *Suffix);
218
219ACPI_STATUS
220FlSplitInputPathname (
221    char                    *InputPath,
222    char                    **OutDirectoryPath,
223    char                    **OutFilename);
224
225char *
226FlGenerateFilename (
227    char                    *InputFilename,
228    char                    *Suffix);
229
230char *
231AdGenerateFilename (
232    char                    *Prefix,
233    char                    *TableId);
234
235void
236AdWriteTable (
237    ACPI_TABLE_HEADER       *Table,
238    UINT32                  Length,
239    char                    *TableName,
240    char                    *OemTableId);
241
242#endif /* _ACAPPS */
243
244