1 /******************************************************************************
2  *
3  * Module Name: acpihelp.h - Include file for AcpiHelp utility
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2020, 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 __ACPIHELP_H
153 #define __ACPIHELP_H
154 
155 
156 #include "acpi.h"
157 #include "accommon.h"
158 #include "acapps.h"
159 
160 #include <sys/types.h>
161 #ifdef WIN32
162 #include <io.h>
163 #include <direct.h>
164 #endif
165 
166 
167 /*
168  * Global variables. Defined in ahmain.c only, externed in all other files
169  */
170 #undef ACPI_GLOBAL
171 #undef ACPI_INIT_GLOBAL
172 
173 #ifdef DEFINE_AHELP_GLOBALS
174 #define ACPI_GLOBAL(type,name) \
175     extern type name; \
176     type name
177 
178 #define ACPI_INIT_GLOBAL(type,name,value) \
179     type name=value
180 
181 #else
182 #ifndef ACPI_GLOBAL
183 #define ACPI_GLOBAL(type,name) \
184     extern type name
185 #endif
186 
187 #ifndef ACPI_INIT_GLOBAL
188 #define ACPI_INIT_GLOBAL(type,name,value) \
189     extern type name
190 #endif
191 #endif
192 
193 
194 #define AH_BUFFER_LENGTH                128
195 #define AH_LINE_BUFFER_LENGTH           512
196 #define AH_MAX_ASL_LINE_LENGTH          70
197 #define AH_MAX_AML_LINE_LENGTH          100
198 
199 ACPI_GLOBAL (char,                      Gbl_Buffer[AH_BUFFER_LENGTH]);
200 ACPI_GLOBAL (char,                      Gbl_LineBuffer[AH_LINE_BUFFER_LENGTH]);
201 extern const AH_PREDEFINED_NAME         AslPredefinedInfo[];
202 extern const AH_DEVICE_ID               AslDeviceIds[];
203 
204 
205 #define AH_DISPLAY_EXCEPTION(Status, Name) \
206     printf ("%.4X: %s\n", Status, Name)
207 
208 #define AH_DISPLAY_EXCEPTION_TEXT(Status, Exception) \
209     printf ("%.4X: %-28s (%s)\n", Status,\
210     Exception->Name, Exception->Description)
211 
212 
213 typedef enum
214 {
215     AH_DECODE_DEFAULT           = 0,
216     AH_DECODE_ASL,
217     AH_DECODE_ASL_KEYWORD,
218     AH_DECODE_PREDEFINED_NAME,
219     AH_DECODE_AML,
220     AH_DECODE_AML_OPCODE,
221     AH_DECODE_AML_TYPE,
222     AH_DECODE_ASL_AML,
223     AH_DECODE_EXCEPTION,
224 
225     AH_DISPLAY_DEVICE_IDS,
226     AH_DISPLAY_UUIDS,
227     AH_DISPLAY_TABLES,
228     AH_DISPLAY_DIRECTIVES,
229     AH_DECODE_ASL_EXCEPTION
230 
231 } AH_OPTION_TYPES;
232 
233 typedef struct ah_aml_opcode
234 {
235     UINT16          OpcodeRangeStart;
236     UINT16          OpcodeRangeEnd;
237     char            *OpcodeString;
238     char            *OpcodeName;
239     char            *Type;
240     char            *FixedArguments;
241     char            *VariableArguments;
242     char            *Grammar;
243 
244 } AH_AML_OPCODE;
245 
246 typedef struct ah_aml_type
247 {
248     char            *Name;
249     char            *Description;
250 
251 } AH_AML_TYPE;
252 
253 typedef struct ah_asl_operator
254 {
255     char            *Name;
256     char            *Syntax;
257     char            *Description;
258 
259 } AH_ASL_OPERATOR;
260 
261 typedef struct ah_asl_keyword
262 {
263     char            *Name;
264     char            *Description;
265     char            *KeywordList;
266 
267 } AH_ASL_KEYWORD;
268 
269 typedef struct ah_directive_info
270 {
271     char            *Name;
272     char            *Description;
273 
274 } AH_DIRECTIVE_INFO;
275 
276 
277 /* Externals for various data tables */
278 
279 extern const AH_AML_OPCODE          Gbl_AmlOpcodeInfo[];
280 extern const AH_AML_TYPE            Gbl_AmlTypesInfo[];
281 extern const AH_ASL_OPERATOR        Gbl_AslOperatorInfo[];
282 extern const AH_ASL_KEYWORD         Gbl_AslKeywordInfo[];
283 extern const AH_UUID                Gbl_AcpiUuids[];
284 extern const AH_DIRECTIVE_INFO      Gbl_PreprocessorDirectives[];
285 extern const AH_TABLE               AcpiGbl_SupportedTables[];
286 
287 
288 void
289 AhFindAmlOpcode (
290     char                    *Name);
291 
292 void
293 AhDecodeAmlOpcode (
294     char                    *Name);
295 
296 void
297 AhDecodeException (
298     char                    *Name);
299 
300 void
301 AhDecodeAslException (
302     char                    *Name);
303 
304 void
305 AhFindPredefinedNames (
306     char                    *Name);
307 
308 void
309 AhFindAslAndAmlOperators (
310     char                    *Name);
311 
312 UINT32
313 AhFindAslOperators (
314     char                    *Name);
315 
316 void
317 AhFindAslKeywords (
318     char                    *Name);
319 
320 void
321 AhFindAmlTypes (
322     char                    *Name);
323 
324 void
325 AhDisplayDeviceIds (
326     char                    *Name);
327 
328 void
329 AhDisplayTables (
330     void);
331 
332 const AH_TABLE *
333 AcpiAhGetTableInfo (
334     char                    *Signature);
335 
336 void
337 AhDisplayUuids (
338     void);
339 
340 void
341 AhDisplayDirectives (
342     void);
343 
344 void
345 AhPrintOneField (
346     UINT32                  Indent,
347     UINT32                  CurrentPosition,
348     UINT32                  MaxPosition,
349     const char              *Field);
350 
351 #endif /* __ACPIHELP_H */
352