aecommon.h revision 1.1 1 /******************************************************************************
2 *
3 * Module Name: aecommon - common include for the AcpiExec utility
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 _AECOMMON
117 #define _AECOMMON
118
119 #ifdef _MSC_VER /* disable some level-4 warnings */
120 #pragma warning(disable:4100) /* warning C4100: unreferenced formal parameter */
121 #endif
122
123 #include <stdio.h>
124 #include <stdlib.h>
125 #include <string.h>
126 #include <signal.h>
127
128 #include "acpi.h"
129 #include "accommon.h"
130 #include "acparser.h"
131 #include "amlcode.h"
132 #include "acnamesp.h"
133 #include "acdebug.h"
134 #include "actables.h"
135 #include "acinterp.h"
136 #include "acapps.h"
137
138 extern FILE *AcpiGbl_DebugFile;
139 extern BOOLEAN AcpiGbl_IgnoreErrors;
140 extern UINT8 AcpiGbl_RegionFillValue;
141
142
143 typedef struct ae_table_desc
144 {
145 ACPI_TABLE_HEADER *Table;
146 struct ae_table_desc *Next;
147
148 } AE_TABLE_DESC;
149
150 /*
151 * Debug Regions
152 */
153 typedef struct ae_region
154 {
155 ACPI_PHYSICAL_ADDRESS Address;
156 UINT32 Length;
157 void *Buffer;
158 void *NextRegion;
159 UINT8 SpaceId;
160
161 } AE_REGION;
162
163 typedef struct ae_debug_regions
164 {
165 UINT32 NumberOfRegions;
166 AE_REGION *RegionList;
167
168 } AE_DEBUG_REGIONS;
169
170
171 #define TEST_OUTPUT_LEVEL(lvl) if ((lvl) & OutputLevel)
172
173 #define OSD_PRINT(lvl,fp) TEST_OUTPUT_LEVEL(lvl) {\
174 AcpiOsPrintf PARAM_LIST(fp);}
175
176 void __cdecl
177 AeCtrlCHandler (
178 int Sig);
179
180 ACPI_STATUS
181 AeBuildLocalTables (
182 UINT32 TableCount,
183 AE_TABLE_DESC *TableList);
184
185 ACPI_STATUS
186 AeInstallTables (
187 void);
188
189 void
190 AeDumpNamespace (
191 void);
192
193 void
194 AeDumpObject (
195 char *MethodName,
196 ACPI_BUFFER *ReturnObj);
197
198 void
199 AeDumpBuffer (
200 UINT32 Address);
201
202 void
203 AeExecute (
204 char *Name);
205
206 void
207 AeSetScope (
208 char *Name);
209
210 void
211 AeCloseDebugFile (
212 void);
213
214 void
215 AeOpenDebugFile (
216 char *Name);
217
218 ACPI_STATUS
219 AeDisplayAllMethods (
220 UINT32 DisplayCount);
221
222 ACPI_STATUS
223 AeInstallHandlers (
224 void);
225
226 void
227 AeMiscellaneousTests (
228 void);
229
230 ACPI_STATUS
231 AeRegionHandler (
232 UINT32 Function,
233 ACPI_PHYSICAL_ADDRESS Address,
234 UINT32 BitWidth,
235 UINT64 *Value,
236 void *HandlerContext,
237 void *RegionContext);
238
239 UINT32
240 AeGpeHandler (
241 void *Context);
242
243 #endif /* _AECOMMON */
244
245