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