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 - 2021, 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  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef _AECOMMON
153 #define _AECOMMON
154 
155 #ifdef _MSC_VER                 /* disable some level-4 warnings */
156 #pragma warning(disable:4100)   /* warning C4100: unreferenced formal parameter */
157 #endif
158 
159 #include "acpi.h"
160 #include "accommon.h"
161 #include "acparser.h"
162 #include "amlcode.h"
163 #include "acnamesp.h"
164 #include "acdebug.h"
165 #include "actables.h"
166 #include "acinterp.h"
167 #include "amlresrc.h"
168 #include "acapps.h"
169 
170 
171 /*
172  * Debug Regions
173  */
174 typedef struct ae_region
175 {
176     ACPI_PHYSICAL_ADDRESS   Address;
177     UINT32                  Length;
178     void                    *Buffer;
179     void                    *NextRegion;
180     UINT8                   SpaceId;
181 
182 } AE_REGION;
183 
184 typedef struct ae_debug_regions
185 {
186     UINT32                  NumberOfRegions;
187     AE_REGION               *RegionList;
188 
189 } AE_DEBUG_REGIONS;
190 
191 
192 /*
193  * Init file entry
194  */
195 typedef struct init_file_entry
196 {
197     char                    *Name;
198     char                    *Value;
199     ACPI_OPERAND_OBJECT     *ObjDesc;
200     BOOLEAN                 IsUsed;
201 
202 } INIT_FILE_ENTRY;
203 
204 extern BOOLEAN              AcpiGbl_UseLocalFaultHandler;
205 extern BOOLEAN              AcpiGbl_VerboseHandlers;
206 extern BOOLEAN              AcpiGbl_IgnoreErrors;
207 extern BOOLEAN              AcpiGbl_AbortLoopOnTimeout;
208 extern UINT8                AcpiGbl_RegionFillValue;
209 extern INIT_FILE_ENTRY      *AcpiGbl_InitEntries;
210 extern UINT32               AcpiGbl_InitFileLineCount;
211 extern UINT8                AcpiGbl_UseHwReducedFadt;
212 extern BOOLEAN              AcpiGbl_DisplayRegionAccess;
213 extern BOOLEAN              AcpiGbl_DoInterfaceTests;
214 extern BOOLEAN              AcpiGbl_LoadTestTables;
215 extern FILE                 *AcpiGbl_NamespaceInitFile;
216 extern ACPI_CONNECTION_INFO AeMyContext;
217 
218 extern UINT8                Ssdt2Code[];
219 extern UINT8                Ssdt3Code[];
220 extern UINT8                Ssdt4Code[];
221 
222 
223 #define TEST_OUTPUT_LEVEL(lvl)          if ((lvl) & OutputLevel)
224 
225 #define OSD_PRINT(lvl,fp)               TEST_OUTPUT_LEVEL(lvl) {\
226                                             AcpiOsPrintf PARAM_LIST(fp);}
227 
228 #define AE_PREFIX                       "ACPI Exec: "
229 
230 void ACPI_SYSTEM_XFACE
231 AeSignalHandler (
232     int                     Sig);
233 
234 ACPI_STATUS
235 AeExceptionHandler (
236     ACPI_STATUS             AmlStatus,
237     ACPI_NAME               Name,
238     UINT16                  Opcode,
239     UINT32                  AmlOffset,
240     void                    *Context);
241 
242 ACPI_STATUS
243 AeBuildLocalTables (
244     ACPI_NEW_TABLE_DESC     *TableList);
245 
246 ACPI_STATUS
247 AeInstallTables (
248     void);
249 
250 ACPI_STATUS
251 AeLoadTables (
252     void);
253 
254 void
255 AeDumpNamespace (
256     void);
257 
258 void
259 AeDumpObject (
260     char                    *MethodName,
261     ACPI_BUFFER             *ReturnObj);
262 
263 void
264 AeDumpBuffer (
265     UINT32                  Address);
266 
267 void
268 AeExecute (
269     char                    *Name);
270 
271 void
272 AeSetScope (
273     char                    *Name);
274 
275 void
276 AeCloseDebugFile (
277     void);
278 
279 void
280 AeOpenDebugFile (
281     char                    *Name);
282 
283 ACPI_STATUS
284 AeDisplayAllMethods (
285     UINT32                  DisplayCount);
286 
287 /* aetests */
288 
289 void
290 AeMiscellaneousTests (
291     void);
292 
293 void
294 AeLateTest (
295     void);
296 
297 /* aeregion */
298 
299 ACPI_STATUS
300 AeRegionHandler (
301     UINT32                  Function,
302     ACPI_PHYSICAL_ADDRESS   Address,
303     UINT32                  BitWidth,
304     UINT64                  *Value,
305     void                    *HandlerContext,
306     void                    *RegionContext);
307 
308 /* aeinstall */
309 
310 ACPI_STATUS
311 AeInstallDeviceHandlers (
312     void);
313 
314 void
315 AeInstallRegionHandlers (
316     void);
317 
318 void
319 AeOverrideRegionHandlers (
320     void);
321 
322 /* aehandlers */
323 
324 ACPI_STATUS
325 AeInstallEarlyHandlers (
326     void);
327 
328 ACPI_STATUS
329 AeInstallLateHandlers (
330     void);
331 
332 UINT32
333 AeGpeHandler (
334     ACPI_HANDLE             GpeDevice,
335     UINT32                  GpeNumber,
336     void                    *Context);
337 
338 void
339 AeGlobalEventHandler (
340     UINT32                  Type,
341     ACPI_HANDLE             GpeDevice,
342     UINT32                  EventNumber,
343     void                    *Context);
344 
345 /* aeinitfile */
346 
347 int
348 AeOpenInitializationFile (
349     char                    *Filename);
350 
351 ACPI_STATUS
352 AeProcessInitFile (
353     void);
354 
355 ACPI_STATUS
356 AeLookupInitFileEntry (
357     char                    *Pathname,
358     ACPI_OPERAND_OBJECT     **ObjDesc);
359 
360 void
361 AeDisplayUnusedInitFileItems (
362     void);
363 
364 void
365 AeDeleteInitFileList (
366     void);
367 
368 /* aeexec */
369 
370 void
371 AeTestBufferArgument (
372     void);
373 
374 void
375 AeTestPackageArgument (
376     void);
377 
378 ACPI_STATUS
379 AeGetDevices (
380     ACPI_HANDLE             ObjHandle,
381     UINT32                  NestingLevel,
382     void                    *Context,
383     void                    **ReturnValue);
384 
385 ACPI_STATUS
386 AeSetupConfiguration (
387     void                    *RegionAddr);
388 
389 ACPI_STATUS
390 ExecuteOSI (
391     char                    *OsiString,
392     UINT64                  ExpectedResult);
393 
394 void
395 AeGenericRegisters (
396     void);
397 
398 #if (!ACPI_REDUCED_HARDWARE)
399 void
400 AfInstallGpeBlock (
401     void);
402 #endif /* !ACPI_REDUCED_HARDWARE */
403 
404 #endif /* _AECOMMON */
405