1 /******************************************************************************
3 * Module Name: asltypes.h - compiler data types and struct definitions
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
156 /*******************************************************************************
158 * Structure definitions
160 ******************************************************************************/
163 /* Op flags for the ACPI_PARSE_OBJECT */
165 #define OP_VISITED 0x00000001
166 #define OP_AML_PACKAGE 0x00000002
167 #define OP_IS_TARGET 0x00000004
168 #define OP_IS_RESOURCE_DESC 0x00000008
169 #define OP_IS_RESOURCE_FIELD 0x00000010
170 #define OP_HAS_NO_EXIT 0x00000020
171 #define OP_IF_HAS_NO_EXIT 0x00000040
172 #define OP_NAME_INTERNALIZED 0x00000080
173 #define OP_METHOD_NO_RETVAL 0x00000100
174 #define OP_METHOD_SOME_NO_RETVAL 0x00000200
175 #define OP_RESULT_NOT_USED 0x00000400
176 #define OP_METHOD_TYPED 0x00000800
177 #define OP_COULD_NOT_REDUCE 0x00001000
178 #define OP_COMPILE_TIME_CONST 0x00002000
179 #define OP_IS_TERM_ARG 0x00004000
180 #define OP_WAS_ONES_OP 0x00008000
181 #define OP_IS_NAME_DECLARATION 0x00010000
182 #define OP_COMPILER_EMITTED 0x00020000
183 #define OP_IS_DUPLICATE 0x00040000
184 #define OP_IS_RESOURCE_DATA 0x00080000
185 #define OP_IS_NULL_RETURN 0x00100000
186 #define OP_NOT_FOUND_DURING_LOAD 0x00200000
188 #define ACPI_NUM_OP_FLAGS 0x22
190 /* Keeps information about individual control methods */
192 typedef struct asl_method_info
194 ACPI_PARSE_OBJECT *Op;
195 ACPI_PARSE_OBJECT *CurrentOp;
196 struct asl_method_info *Next;
197 UINT32 ValidArgTypes[ACPI_METHOD_NUM_ARGS];
198 UINT32 ValidReturnTypes;
199 UINT32 NumReturnNoValue;
200 UINT32 NumReturnWithValue;
202 UINT8 LocalInitialized[ACPI_METHOD_NUM_LOCALS];
203 UINT8 ArgInitialized[ACPI_METHOD_NUM_ARGS];
205 UINT8 ShouldBeSerialized;
206 UINT8 CreatesNamedObjects;
211 /* Parse tree walk info for control method analysis */
213 typedef struct asl_analysis_walk_info
215 ASL_METHOD_INFO *MethodStack;
217 } ASL_ANALYSIS_WALK_INFO;
220 /* An entry in the ParseOpcode to AmlOpcode mapping table */
222 typedef struct asl_mapping_entry
225 UINT32 AcpiBtype; /* Object type or return type */
232 /* Parse tree walk info structure */
234 typedef struct asl_walk_info
236 ACPI_PARSE_OBJECT **NodePtr;
244 typedef struct asl_file_info
248 const char *ShortDescription;
249 const char *Description;
253 typedef struct asl_file_status
262 * File types. Note: Any changes to this table must also be reflected
263 * in the Gbl_Files array.
265 * Corresponding filename suffixes are in comments
267 * NOTE: Don't move the first 4 file types
269 * .xxx file extension: this is used as a temporary .aml file for
270 * the ASL/ASL+ converter and is deleted after conversion. This file
271 * should never be used in the interpreter.
277 ASL_FILE_INPUT, /* .asl */
278 ASL_FILE_AML_OUTPUT, /* .aml */
279 ASL_FILE_SOURCE_OUTPUT, /* .src */
280 ASL_FILE_PREPROCESSOR, /* .pre */
281 ASL_FILE_PREPROCESSOR_USER, /* .i */
282 ASL_FILE_LISTING_OUTPUT, /* .lst */
283 ASL_FILE_HEX_OUTPUT, /* .hex */
284 ASL_FILE_NAMESPACE_OUTPUT, /* .nsp */
285 ASL_FILE_DEBUG_OUTPUT, /* .txt */
286 ASL_FILE_ASM_SOURCE_OUTPUT, /* .asm */
287 ASL_FILE_C_SOURCE_OUTPUT, /* .c */
288 ASL_FILE_ASM_INCLUDE_OUTPUT,/* .inc */
289 ASL_FILE_C_INCLUDE_OUTPUT, /* .h */
290 ASL_FILE_C_OFFSET_OUTPUT, /* .offset.h */
291 ASL_FILE_MAP_OUTPUT, /* .map */
292 ASL_FILE_XREF_OUTPUT, /* .xrf */
293 ASL_FILE_CONV_DEBUG_OUTPUT, /* .cdb */
294 ASL_FILE_CONV_OUTPUT /* .xxx */
299 #define ASL_MAX_FILE_TYPE 18
300 #define ASL_NUM_FILES (ASL_MAX_FILE_TYPE + 1)
302 /* Name suffixes used to create filenames for output files */
304 #define FILE_SUFFIX_ASL_CODE "asl"
305 #define FILE_SUFFIX_AML_CODE "aml"
306 #define FILE_SUFFIX_SOURCE "src"
307 #define FILE_SUFFIX_PREPROCESSOR "pre"
308 #define FILE_SUFFIX_PREPROC_USER "i"
309 #define FILE_SUFFIX_LISTING "lst"
310 #define FILE_SUFFIX_HEX_DUMP "hex"
311 #define FILE_SUFFIX_NAMESPACE "nsp"
312 #define FILE_SUFFIX_DEBUG "txt"
313 #define FILE_SUFFIX_ASM_SOURCE "asm"
314 #define FILE_SUFFIX_C_SOURCE "c"
315 #define FILE_SUFFIX_ASM_INCLUDE "inc"
316 #define FILE_SUFFIX_C_INCLUDE "h"
317 #define FILE_SUFFIX_C_OFFSET "offset.h"
318 #define FILE_SUFFIX_MAP "map"
319 #define FILE_SUFFIX_XREF "xrf"
320 #define FILE_SUFFIX_CONVERT_AML "xxx"
321 #define FILE_SUFFIX_CONVERT_DEBUG "cdb"
324 /* Cache block structure for ParseOps and Strings */
326 typedef struct asl_cache_info
334 typedef struct asl_include_dir
337 struct asl_include_dir *Next;
343 * An entry in the exception list, one for each error/warning
344 * Note: SubError nodes would be treated with the same messageId and Level
345 * as the parent error node.
347 typedef struct asl_error_msg
350 UINT32 LogicalLineNumber;
351 UINT32 LogicalByteOffset;
354 struct asl_error_msg *Next;
355 struct asl_error_msg *SubError;
358 UINT32 FilenameLength;
364 /* An entry in the expected messages array */
365 typedef struct asl_expected_message
369 BOOLEAN MessageReceived;
371 } ASL_EXPECTED_MESSAGE;
374 /* An entry in the listing file stack (for include files) */
376 typedef struct asl_listing_node
380 struct asl_listing_node *Next;
385 /* Callback interface for a parse tree walk */
388 * TBD - another copy of this is in adisasm.h, fix
390 #ifndef ASL_WALK_CALLBACK_DEFINED
392 ACPI_STATUS (*ASL_WALK_CALLBACK) (
393 ACPI_PARSE_OBJECT *Op,
396 #define ASL_WALK_CALLBACK_DEFINED
400 typedef struct asl_event_info
410 /* Hardware mapping file structures */
412 typedef struct acpi_gpio_info
414 struct acpi_gpio_info *Next;
415 ACPI_PARSE_OBJECT *Op;
417 ACPI_NAMESPACE_NODE *TargetNode;
428 typedef struct acpi_serial_info
430 struct acpi_serial_info *Next;
431 ACPI_PARSE_OBJECT *Op;
433 ACPI_NAMESPACE_NODE *TargetNode;
434 AML_RESOURCE *Resource;
440 typedef struct asl_method_local
442 ACPI_PARSE_OBJECT *Op;
447 /* Values for Flags field above */
449 #define ASL_LOCAL_INITIALIZED (1)
450 #define ASL_LOCAL_REFERENCED (1<<1)
451 #define ASL_ARG_IS_LOCAL (1<<2)
452 #define ASL_ARG_INITIALIZED (1<<3)
453 #define ASL_ARG_REFERENCED (1<<4)
455 /* Info used to track method counts for cross reference output file */
457 typedef struct asl_xref_info
459 UINT32 ThisMethodInvocations;
460 UINT32 TotalPredefinedMethods;
461 UINT32 TotalUserMethods;
462 UINT32 TotalUnreferenceUserMethods;
463 UINT32 ThisObjectReferences;
465 UINT32 TotalUnreferencedObjects;
466 ACPI_PARSE_OBJECT *MethodOp;
467 ACPI_PARSE_OBJECT *CurrentMethodOp;
472 typedef struct asl_file_node
475 UINT32 CurrentLineNumber;
478 struct asl_file_node *Next;
482 #endif /* __ASLTYPES_H */