Deleted Added
full compact
acapps.h (213806) acapps.h (217365)
1/******************************************************************************
2 *
3 * Module Name: acapps - common include for ACPI applications/tools
4 *
5 *****************************************************************************/
6
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.
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
12 * All rights reserved.
13 *
9 * All rights reserved.
10 *
14 * 2. License
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.
15 *
25 *
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.
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.
20 *
29 *
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 *****************************************************************************/
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 */
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"
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"
127#define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2010 Intel Corporation"
55#define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2011 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 */
163int
164AcpiGetopt(
165 int argc,
166 char **argv,
167 char *opts);
168
169extern int AcpiGbl_Optind;
170extern int AcpiGbl_Opterr;
171extern char *AcpiGbl_Optarg;
172
173
174/*
175 * adisasm
176 */
177ACPI_STATUS
178AdAmlDisassemble (
179 BOOLEAN OutToFile,
180 char *Filename,
181 char *Prefix,
182 char **OutFilename,
183 BOOLEAN GetAllTables);
184
185void
186AdPrintStatistics (
187 void);
188
189ACPI_STATUS
190AdFindDsdt(
191 UINT8 **DsdtPtr,
192 UINT32 *DsdtLength);
193
194void
195AdDumpTables (
196 void);
197
198ACPI_STATUS
199AdGetLocalTables (
200 char *Filename,
201 BOOLEAN GetAllTables);
202
203ACPI_STATUS
204AdParseTable (
205 ACPI_TABLE_HEADER *Table,
206 ACPI_OWNER_ID *OwnerId,
207 BOOLEAN LoadTable,
208 BOOLEAN External);
209
210ACPI_STATUS
211AdDisplayTables (
212 char *Filename,
213 ACPI_TABLE_HEADER *Table);
214
215ACPI_STATUS
216AdDisplayStatistics (
217 void);
218
219
220/*
221 * adwalk
222 */
223void
224AcpiDmCrossReferenceNamespace (
225 ACPI_PARSE_OBJECT *ParseTreeRoot,
226 ACPI_NAMESPACE_NODE *NamespaceRoot,
227 ACPI_OWNER_ID OwnerId);
228
229void
230AcpiDmDumpTree (
231 ACPI_PARSE_OBJECT *Origin);
232
233void
234AcpiDmFindOrphanMethods (
235 ACPI_PARSE_OBJECT *Origin);
236
237void
238AcpiDmFinishNamespaceLoad (
239 ACPI_PARSE_OBJECT *ParseTreeRoot,
240 ACPI_NAMESPACE_NODE *NamespaceRoot,
241 ACPI_OWNER_ID OwnerId);
242
243void
244AcpiDmConvertResourceIndexes (
245 ACPI_PARSE_OBJECT *ParseTreeRoot,
246 ACPI_NAMESPACE_NODE *NamespaceRoot);
247
248
249/*
250 * adfile
251 */
252ACPI_STATUS
253AdInitialize (
254 void);
255
256char *
257FlGenerateFilename (
258 char *InputFilename,
259 char *Suffix);
260
261ACPI_STATUS
262FlSplitInputPathname (
263 char *InputPath,
264 char **OutDirectoryPath,
265 char **OutFilename);
266
267char *
268AdGenerateFilename (
269 char *Prefix,
270 char *TableId);
271
272void
273AdWriteTable (
274 ACPI_TABLE_HEADER *Table,
275 UINT32 Length,
276 char *TableName,
277 char *OemTableId);
278
279#endif /* _ACAPPS */
280
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
71#define ACPI_COMMON_SIGNON(UtilityName) \
72 "\n%s\n%s version %8.8X%s\n%s\n\n", \
73 ACPICA_NAME, \
74 UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \
75 ACPICA_COPYRIGHT
76
77#define ACPI_COMMON_HEADER(UtilityName, Prefix) \
78 "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \
79 Prefix, ACPICA_NAME, \
80 Prefix, UtilityName, ((UINT32) ACPI_CA_VERSION), ACPI_WIDTH, \
81 Prefix, ACPICA_COPYRIGHT, \
82 Prefix
83
84#define FILE_SUFFIX_DISASSEMBLY "dsl"
85#define ACPI_TABLE_FILE_SUFFIX ".dat"
86
87
88/*
89 * getopt
90 */
91int
92AcpiGetopt(
93 int argc,
94 char **argv,
95 char *opts);
96
97extern int AcpiGbl_Optind;
98extern int AcpiGbl_Opterr;
99extern char *AcpiGbl_Optarg;
100
101
102/*
103 * adisasm
104 */
105ACPI_STATUS
106AdAmlDisassemble (
107 BOOLEAN OutToFile,
108 char *Filename,
109 char *Prefix,
110 char **OutFilename,
111 BOOLEAN GetAllTables);
112
113void
114AdPrintStatistics (
115 void);
116
117ACPI_STATUS
118AdFindDsdt(
119 UINT8 **DsdtPtr,
120 UINT32 *DsdtLength);
121
122void
123AdDumpTables (
124 void);
125
126ACPI_STATUS
127AdGetLocalTables (
128 char *Filename,
129 BOOLEAN GetAllTables);
130
131ACPI_STATUS
132AdParseTable (
133 ACPI_TABLE_HEADER *Table,
134 ACPI_OWNER_ID *OwnerId,
135 BOOLEAN LoadTable,
136 BOOLEAN External);
137
138ACPI_STATUS
139AdDisplayTables (
140 char *Filename,
141 ACPI_TABLE_HEADER *Table);
142
143ACPI_STATUS
144AdDisplayStatistics (
145 void);
146
147
148/*
149 * adwalk
150 */
151void
152AcpiDmCrossReferenceNamespace (
153 ACPI_PARSE_OBJECT *ParseTreeRoot,
154 ACPI_NAMESPACE_NODE *NamespaceRoot,
155 ACPI_OWNER_ID OwnerId);
156
157void
158AcpiDmDumpTree (
159 ACPI_PARSE_OBJECT *Origin);
160
161void
162AcpiDmFindOrphanMethods (
163 ACPI_PARSE_OBJECT *Origin);
164
165void
166AcpiDmFinishNamespaceLoad (
167 ACPI_PARSE_OBJECT *ParseTreeRoot,
168 ACPI_NAMESPACE_NODE *NamespaceRoot,
169 ACPI_OWNER_ID OwnerId);
170
171void
172AcpiDmConvertResourceIndexes (
173 ACPI_PARSE_OBJECT *ParseTreeRoot,
174 ACPI_NAMESPACE_NODE *NamespaceRoot);
175
176
177/*
178 * adfile
179 */
180ACPI_STATUS
181AdInitialize (
182 void);
183
184char *
185FlGenerateFilename (
186 char *InputFilename,
187 char *Suffix);
188
189ACPI_STATUS
190FlSplitInputPathname (
191 char *InputPath,
192 char **OutDirectoryPath,
193 char **OutFilename);
194
195char *
196AdGenerateFilename (
197 char *Prefix,
198 char *TableId);
199
200void
201AdWriteTable (
202 ACPI_TABLE_HEADER *Table,
203 UINT32 Length,
204 char *TableName,
205 char *OemTableId);
206
207#endif /* _ACAPPS */
208