1 /******************************************************************************
2  *
3  * Module Name: aecommon - common include for the AcpiExec utility
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2016, 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 "amlresrc.h"
60 #include "acapps.h"
61 
62 
63 /*
64  * Debug Regions
65  */
66 typedef struct ae_region
67 {
68     ACPI_PHYSICAL_ADDRESS   Address;
69     UINT32                  Length;
70     void                    *Buffer;
71     void                    *NextRegion;
72     UINT8                   SpaceId;
73 
74 } AE_REGION;
75 
76 typedef struct ae_debug_regions
77 {
78     UINT32                  NumberOfRegions;
79     AE_REGION               *RegionList;
80 
81 } AE_DEBUG_REGIONS;
82 
83 
84 extern BOOLEAN              AcpiGbl_IgnoreErrors;
85 extern UINT8                AcpiGbl_RegionFillValue;
86 extern UINT8                AcpiGbl_UseHwReducedFadt;
87 extern BOOLEAN              AcpiGbl_DisplayRegionAccess;
88 extern BOOLEAN              AcpiGbl_DoInterfaceTests;
89 extern BOOLEAN              AcpiGbl_LoadTestTables;
90 extern FILE                 *AcpiGbl_NamespaceInitFile;
91 extern ACPI_CONNECTION_INFO AeMyContext;
92 
93 
94 #define TEST_OUTPUT_LEVEL(lvl)          if ((lvl) & OutputLevel)
95 
96 #define OSD_PRINT(lvl,fp)               TEST_OUTPUT_LEVEL(lvl) {\
97                                             AcpiOsPrintf PARAM_LIST(fp);}
98 
99 void ACPI_SYSTEM_XFACE
100 AeCtrlCHandler (
101     int                     Sig);
102 
103 ACPI_STATUS
104 AeBuildLocalTables (
105     ACPI_NEW_TABLE_DESC     *TableList);
106 
107 ACPI_STATUS
108 AeInstallTables (
109     void);
110 
111 ACPI_STATUS
112 AeLoadTables (
113     void);
114 
115 void
116 AeDumpNamespace (
117     void);
118 
119 void
120 AeDumpObject (
121     char                    *MethodName,
122     ACPI_BUFFER             *ReturnObj);
123 
124 void
125 AeDumpBuffer (
126     UINT32                  Address);
127 
128 void
129 AeExecute (
130     char                    *Name);
131 
132 void
133 AeSetScope (
134     char                    *Name);
135 
136 void
137 AeCloseDebugFile (
138     void);
139 
140 void
141 AeOpenDebugFile (
142     char                    *Name);
143 
144 ACPI_STATUS
145 AeDisplayAllMethods (
146     UINT32                  DisplayCount);
147 
148 ACPI_STATUS
149 AeInstallEarlyHandlers (
150     void);
151 
152 ACPI_STATUS
153 AeInstallLateHandlers (
154     void);
155 
156 void
157 AeMiscellaneousTests (
158     void);
159 
160 ACPI_STATUS
161 AeRegionHandler (
162     UINT32                  Function,
163     ACPI_PHYSICAL_ADDRESS   Address,
164     UINT32                  BitWidth,
165     UINT64                  *Value,
166     void                    *HandlerContext,
167     void                    *RegionContext);
168 
169 UINT32
170 AeGpeHandler (
171     ACPI_HANDLE             GpeDevice,
172     UINT32                  GpeNumber,
173     void                    *Context);
174 
175 void
176 AeGlobalEventHandler (
177     UINT32                  Type,
178     ACPI_HANDLE             GpeDevice,
179     UINT32                  EventNumber,
180     void                    *Context);
181 
182 /* aeregion */
183 
184 ACPI_STATUS
185 AeInstallDeviceHandlers (
186     void);
187 
188 void
189 AeInstallRegionHandlers (
190     void);
191 
192 void
193 AeOverrideRegionHandlers (
194     void);
195 
196 
197 /* aeinitfile */
198 
199 int
200 AeOpenInitializationFile (
201     char                    *Filename);
202 
203 void
204 AeDoObjectOverrides (
205     void);
206 
207 #endif /* _AECOMMON */
208