1 /******************************************************************************
2 *
3 * Module Name: aecommon - common include for the AcpiExec utility
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2014, 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 _AECOMMON
45 #define _AECOMMON
46
47 #ifdef _MSC_VER /* disable some level-4 warnings */
48 #pragma warning(disable:4100) /* warning C4100: unreferenced formal parameter */
49 #endif
50
51 #include "acpi.h"
52 #include "accommon.h"
53 #include "acparser.h"
54 #include "amlcode.h"
55 #include "acnamesp.h"
56 #include "acdebug.h"
57 #include "actables.h"
58 #include "acinterp.h"
59 #include "acapps.h"
60
61 #include <stdio.h>
62 #include <stdlib.h>
63 #include <string.h>
64 #include <signal.h>
65
66 extern BOOLEAN AcpiGbl_IgnoreErrors;
67 extern UINT8 AcpiGbl_RegionFillValue;
68 extern UINT8 AcpiGbl_UseHwReducedFadt;
69 extern BOOLEAN AcpiGbl_DisplayRegionAccess;
70 extern BOOLEAN AcpiGbl_DoInterfaceTests;
71 extern BOOLEAN AcpiGbl_LoadTestTables;
72
73 /* Check for unexpected exceptions */
74
75 #define AE_CHECK_STATUS(Name, Status, Expected) \
76 if (Status != Expected) \
77 { \
78 AcpiOsPrintf ("Unexpected %s from %s (%s-%d)\n", \
79 AcpiFormatException (Status), #Name, _AcpiModuleName, __LINE__); \
80 }
81
82 /* Check for unexpected non-AE_OK errors */
83
84 #define AE_CHECK_OK(Name, Status) AE_CHECK_STATUS (Name, Status, AE_OK);
85
86 typedef struct ae_table_desc
87 {
88 ACPI_TABLE_HEADER *Table;
89 struct ae_table_desc *Next;
90
91 } AE_TABLE_DESC;
92
93 /*
94 * Debug Regions
95 */
96 typedef struct ae_region
97 {
98 ACPI_PHYSICAL_ADDRESS Address;
99 UINT32 Length;
100 void *Buffer;
101 void *NextRegion;
102 UINT8 SpaceId;
103
104 } AE_REGION;
105
106 typedef struct ae_debug_regions
107 {
108 UINT32 NumberOfRegions;
109 AE_REGION *RegionList;
110
111 } AE_DEBUG_REGIONS;
112
113
114 #define TEST_OUTPUT_LEVEL(lvl) if ((lvl) & OutputLevel)
115
116 #define OSD_PRINT(lvl,fp) TEST_OUTPUT_LEVEL(lvl) {\
117 AcpiOsPrintf PARAM_LIST(fp);}
118
119 void ACPI_SYSTEM_XFACE
120 AeCtrlCHandler (
121 int Sig);
122
123 ACPI_STATUS
124 AeBuildLocalTables (
125 UINT32 TableCount,
126 AE_TABLE_DESC *TableList);
127
128 ACPI_STATUS
129 AeInstallTables (
130 void);
131
132 void
133 AeDumpNamespace (
134 void);
135
136 void
137 AeDumpObject (
138 char *MethodName,
139 ACPI_BUFFER *ReturnObj);
140
141 void
142 AeDumpBuffer (
143 UINT32 Address);
144
145 void
146 AeExecute (
147 char *Name);
148
149 void
150 AeSetScope (
151 char *Name);
152
153 void
154 AeCloseDebugFile (
155 void);
156
157 void
158 AeOpenDebugFile (
159 char *Name);
160
161 ACPI_STATUS
162 AeDisplayAllMethods (
163 UINT32 DisplayCount);
164
165 ACPI_STATUS
166 AeInstallEarlyHandlers (
167 void);
168
169 ACPI_STATUS
170 AeInstallLateHandlers (
171 void);
172
173 void
174 AeMiscellaneousTests (
175 void);
176
177 ACPI_STATUS
178 AeRegionHandler (
179 UINT32 Function,
180 ACPI_PHYSICAL_ADDRESS Address,
181 UINT32 BitWidth,
182 UINT64 *Value,
183 void *HandlerContext,
184 void *RegionContext);
185
186 UINT32
187 AeGpeHandler (
188 ACPI_HANDLE GpeDevice,
189 UINT32 GpeNumber,
190 void *Context);
191
192 void
193 AeGlobalEventHandler (
194 UINT32 Type,
195 ACPI_HANDLE GpeDevice,
196 UINT32 EventNumber,
197 void *Context);
198
199 #endif /* _AECOMMON */