xref: /illumos-gate/usr/src/cmd/acpi/iasl/asltypes.h (revision 35786f68)
1bc36eafdSMike Gerdts /******************************************************************************
2bc36eafdSMike Gerdts  *
3bc36eafdSMike Gerdts  * Module Name: asltypes.h - compiler data types and struct definitions
4bc36eafdSMike Gerdts  *
5bc36eafdSMike Gerdts  *****************************************************************************/
6bc36eafdSMike Gerdts 
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi  *
9*35786f68SRobert Mustacchi  * 1. Copyright Notice
10*35786f68SRobert Mustacchi  *
11*35786f68SRobert Mustacchi  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12bc36eafdSMike Gerdts  * All rights reserved.
13bc36eafdSMike Gerdts  *
14*35786f68SRobert Mustacchi  * 2. License
15*35786f68SRobert Mustacchi  *
16*35786f68SRobert Mustacchi  * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi  * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi  * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi  * property rights.
20*35786f68SRobert Mustacchi  *
21*35786f68SRobert Mustacchi  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi  * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi  * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi  * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi  * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi  *
28*35786f68SRobert Mustacchi  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi  * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi  * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi  * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi  * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi  * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi  * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi  * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi  *
37*35786f68SRobert Mustacchi  * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi  * conditions are met:
39*35786f68SRobert Mustacchi  *
40*35786f68SRobert Mustacchi  * 3. Conditions
41*35786f68SRobert Mustacchi  *
42*35786f68SRobert Mustacchi  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi  * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi  * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi  * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi  * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi  * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi  * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi  * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi  * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi  * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi  *
54*35786f68SRobert Mustacchi  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi  * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi  * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi  * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi  * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi  * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi  * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi  * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi  * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi  * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi  * make.
65*35786f68SRobert Mustacchi  *
66*35786f68SRobert Mustacchi  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi  * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi  * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi  * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi  * distribution.
71*35786f68SRobert Mustacchi  *
72*35786f68SRobert Mustacchi  * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi  * Intel Code.
74*35786f68SRobert Mustacchi  *
75*35786f68SRobert Mustacchi  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi  * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi  * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi  * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi  *
80*35786f68SRobert Mustacchi  * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi  *
82*35786f68SRobert Mustacchi  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi  * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi  *
90*35786f68SRobert Mustacchi  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi  * LIMITED REMEDY.
98*35786f68SRobert Mustacchi  *
99*35786f68SRobert Mustacchi  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi  * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi  * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi  * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi  * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi  * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi  * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi  * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi  * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi  * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi  * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi  * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi  * such license, approval or letter.
113*35786f68SRobert Mustacchi  *
114*35786f68SRobert Mustacchi  *****************************************************************************
115*35786f68SRobert Mustacchi  *
116*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi  * following license:
118*35786f68SRobert Mustacchi  *
119bc36eafdSMike Gerdts  * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts  * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts  * are met:
122bc36eafdSMike Gerdts  * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts  *    notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts  *    without modification.
125bc36eafdSMike Gerdts  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts  *    substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts  *    ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts  *    including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts  *    binary redistribution.
130bc36eafdSMike Gerdts  * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts  *    of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts  *    from this software without specific prior written permission.
133bc36eafdSMike Gerdts  *
134bc36eafdSMike Gerdts  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135bc36eafdSMike Gerdts  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137bc36eafdSMike Gerdts  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi  *
146*35786f68SRobert Mustacchi  * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi  * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi  * Software Foundation.
149*35786f68SRobert Mustacchi  *
150*35786f68SRobert Mustacchi  *****************************************************************************/
151bc36eafdSMike Gerdts 
152bc36eafdSMike Gerdts #ifndef __ASLTYPES_H
153bc36eafdSMike Gerdts #define __ASLTYPES_H
154bc36eafdSMike Gerdts 
155bc36eafdSMike Gerdts 
156bc36eafdSMike Gerdts /*******************************************************************************
157bc36eafdSMike Gerdts  *
158bc36eafdSMike Gerdts  * Structure definitions
159bc36eafdSMike Gerdts  *
160bc36eafdSMike Gerdts  ******************************************************************************/
161bc36eafdSMike Gerdts 
162bc36eafdSMike Gerdts 
163bc36eafdSMike Gerdts /* Op flags for the ACPI_PARSE_OBJECT */
164bc36eafdSMike Gerdts 
165*35786f68SRobert Mustacchi #define OP_VISITED                  0x00000001
166*35786f68SRobert Mustacchi #define OP_AML_PACKAGE              0x00000002
167*35786f68SRobert Mustacchi #define OP_IS_TARGET                0x00000004
168*35786f68SRobert Mustacchi #define OP_IS_RESOURCE_DESC         0x00000008
169*35786f68SRobert Mustacchi #define OP_IS_RESOURCE_FIELD        0x00000010
170*35786f68SRobert Mustacchi #define OP_HAS_NO_EXIT              0x00000020
171*35786f68SRobert Mustacchi #define OP_IF_HAS_NO_EXIT           0x00000040
172*35786f68SRobert Mustacchi #define OP_NAME_INTERNALIZED        0x00000080
173*35786f68SRobert Mustacchi #define OP_METHOD_NO_RETVAL         0x00000100
174*35786f68SRobert Mustacchi #define OP_METHOD_SOME_NO_RETVAL    0x00000200
175*35786f68SRobert Mustacchi #define OP_RESULT_NOT_USED          0x00000400
176*35786f68SRobert Mustacchi #define OP_METHOD_TYPED             0x00000800
177*35786f68SRobert Mustacchi #define OP_COULD_NOT_REDUCE         0x00001000
178*35786f68SRobert Mustacchi #define OP_COMPILE_TIME_CONST       0x00002000
179*35786f68SRobert Mustacchi #define OP_IS_TERM_ARG              0x00004000
180*35786f68SRobert Mustacchi #define OP_WAS_ONES_OP              0x00008000
181*35786f68SRobert Mustacchi #define OP_IS_NAME_DECLARATION      0x00010000
182*35786f68SRobert Mustacchi #define OP_COMPILER_EMITTED         0x00020000
183*35786f68SRobert Mustacchi #define OP_IS_DUPLICATE             0x00040000
184*35786f68SRobert Mustacchi #define OP_IS_RESOURCE_DATA         0x00080000
185*35786f68SRobert Mustacchi #define OP_IS_NULL_RETURN           0x00100000
186*35786f68SRobert Mustacchi #define OP_NOT_FOUND_DURING_LOAD    0x00200000
187*35786f68SRobert Mustacchi 
188*35786f68SRobert Mustacchi #define ACPI_NUM_OP_FLAGS           0x22
189bc36eafdSMike Gerdts 
190bc36eafdSMike Gerdts /* Keeps information about individual control methods */
191bc36eafdSMike Gerdts 
192bc36eafdSMike Gerdts typedef struct asl_method_info
193bc36eafdSMike Gerdts {
194bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *Op;
195bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *CurrentOp;
196bc36eafdSMike Gerdts     struct asl_method_info  *Next;
197bc36eafdSMike Gerdts     UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
198bc36eafdSMike Gerdts     UINT32                  ValidReturnTypes;
199bc36eafdSMike Gerdts     UINT32                  NumReturnNoValue;
200bc36eafdSMike Gerdts     UINT32                  NumReturnWithValue;
201bc36eafdSMike Gerdts     UINT8                   NumArguments;
202bc36eafdSMike Gerdts     UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
203bc36eafdSMike Gerdts     UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
204bc36eafdSMike Gerdts     UINT8                   HasBeenTyped;
205bc36eafdSMike Gerdts     UINT8                   ShouldBeSerialized;
206*35786f68SRobert Mustacchi     UINT8                   CreatesNamedObjects;
207bc36eafdSMike Gerdts 
208bc36eafdSMike Gerdts } ASL_METHOD_INFO;
209bc36eafdSMike Gerdts 
210bc36eafdSMike Gerdts 
211bc36eafdSMike Gerdts /* Parse tree walk info for control method analysis */
212bc36eafdSMike Gerdts 
213bc36eafdSMike Gerdts typedef struct asl_analysis_walk_info
214bc36eafdSMike Gerdts {
215bc36eafdSMike Gerdts     ASL_METHOD_INFO         *MethodStack;
216bc36eafdSMike Gerdts 
217bc36eafdSMike Gerdts } ASL_ANALYSIS_WALK_INFO;
218bc36eafdSMike Gerdts 
219bc36eafdSMike Gerdts 
220bc36eafdSMike Gerdts /* An entry in the ParseOpcode to AmlOpcode mapping table */
221bc36eafdSMike Gerdts 
222bc36eafdSMike Gerdts typedef struct asl_mapping_entry
223bc36eafdSMike Gerdts {
224bc36eafdSMike Gerdts     UINT32                      Value;
225bc36eafdSMike Gerdts     UINT32                      AcpiBtype;   /* Object type or return type */
226bc36eafdSMike Gerdts     UINT16                      AmlOpcode;
227bc36eafdSMike Gerdts     UINT8                       Flags;
228bc36eafdSMike Gerdts 
229bc36eafdSMike Gerdts } ASL_MAPPING_ENTRY;
230bc36eafdSMike Gerdts 
231bc36eafdSMike Gerdts 
232bc36eafdSMike Gerdts /* Parse tree walk info structure */
233bc36eafdSMike Gerdts 
234bc36eafdSMike Gerdts typedef struct asl_walk_info
235bc36eafdSMike Gerdts {
236bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           **NodePtr;
237bc36eafdSMike Gerdts     UINT32                      *LevelPtr;
238bc36eafdSMike Gerdts 
239bc36eafdSMike Gerdts } ASL_WALK_INFO;
240bc36eafdSMike Gerdts 
241bc36eafdSMike Gerdts 
242bc36eafdSMike Gerdts /* File info */
243bc36eafdSMike Gerdts 
244bc36eafdSMike Gerdts typedef struct asl_file_info
245bc36eafdSMike Gerdts {
246bc36eafdSMike Gerdts     FILE                        *Handle;
247bc36eafdSMike Gerdts     char                        *Filename;
248bc36eafdSMike Gerdts     const char                  *ShortDescription;
249bc36eafdSMike Gerdts     const char                  *Description;
250bc36eafdSMike Gerdts 
251bc36eafdSMike Gerdts } ASL_FILE_INFO;
252bc36eafdSMike Gerdts 
253bc36eafdSMike Gerdts typedef struct asl_file_status
254bc36eafdSMike Gerdts {
255bc36eafdSMike Gerdts     UINT32                  Line;
256bc36eafdSMike Gerdts     UINT32                  Offset;
257bc36eafdSMike Gerdts 
258bc36eafdSMike Gerdts } ASL_FILE_STATUS;
259bc36eafdSMike Gerdts 
260bc36eafdSMike Gerdts 
261bc36eafdSMike Gerdts /*
262bc36eafdSMike Gerdts  * File types. Note: Any changes to this table must also be reflected
263bc36eafdSMike Gerdts  * in the Gbl_Files array.
264bc36eafdSMike Gerdts  *
265bc36eafdSMike Gerdts  * Corresponding filename suffixes are in comments
266bc36eafdSMike Gerdts  *
267bc36eafdSMike Gerdts  * NOTE: Don't move the first 4 file types
268*35786f68SRobert Mustacchi  *
269*35786f68SRobert Mustacchi  * .xxx file extension: this is used as a temporary .aml file for
270*35786f68SRobert Mustacchi  * the ASL/ASL+ converter and is deleted after conversion. This file
271*35786f68SRobert Mustacchi  * should never be used in the interpreter.
272bc36eafdSMike Gerdts  */
273bc36eafdSMike Gerdts typedef enum
274bc36eafdSMike Gerdts {
275bc36eafdSMike Gerdts     ASL_FILE_STDOUT             = 0,
276bc36eafdSMike Gerdts     ASL_FILE_STDERR,
277bc36eafdSMike Gerdts     ASL_FILE_INPUT,             /* .asl */
278bc36eafdSMike Gerdts     ASL_FILE_AML_OUTPUT,        /* .aml */
279bc36eafdSMike Gerdts     ASL_FILE_SOURCE_OUTPUT,     /* .src */
280bc36eafdSMike Gerdts     ASL_FILE_PREPROCESSOR,      /* .pre */
281bc36eafdSMike Gerdts     ASL_FILE_PREPROCESSOR_USER, /* .i   */
282bc36eafdSMike Gerdts     ASL_FILE_LISTING_OUTPUT,    /* .lst */
283bc36eafdSMike Gerdts     ASL_FILE_HEX_OUTPUT,        /* .hex */
284bc36eafdSMike Gerdts     ASL_FILE_NAMESPACE_OUTPUT,  /* .nsp */
285bc36eafdSMike Gerdts     ASL_FILE_DEBUG_OUTPUT,      /* .txt */
286bc36eafdSMike Gerdts     ASL_FILE_ASM_SOURCE_OUTPUT, /* .asm */
287bc36eafdSMike Gerdts     ASL_FILE_C_SOURCE_OUTPUT,   /* .c   */
288bc36eafdSMike Gerdts     ASL_FILE_ASM_INCLUDE_OUTPUT,/* .inc */
289bc36eafdSMike Gerdts     ASL_FILE_C_INCLUDE_OUTPUT,  /* .h   */
290bc36eafdSMike Gerdts     ASL_FILE_C_OFFSET_OUTPUT,   /* .offset.h */
291bc36eafdSMike Gerdts     ASL_FILE_MAP_OUTPUT,        /* .map */
292*35786f68SRobert Mustacchi     ASL_FILE_XREF_OUTPUT,       /* .xrf */
293*35786f68SRobert Mustacchi     ASL_FILE_CONV_DEBUG_OUTPUT, /* .cdb */
294*35786f68SRobert Mustacchi     ASL_FILE_CONV_OUTPUT        /* .xxx */
295bc36eafdSMike Gerdts 
296bc36eafdSMike Gerdts } ASL_FILE_TYPES;
297bc36eafdSMike Gerdts 
298bc36eafdSMike Gerdts 
299*35786f68SRobert Mustacchi #define ASL_MAX_FILE_TYPE       18
300bc36eafdSMike Gerdts #define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
301bc36eafdSMike Gerdts 
302bc36eafdSMike Gerdts /* Name suffixes used to create filenames for output files */
303bc36eafdSMike Gerdts 
304bc36eafdSMike Gerdts #define FILE_SUFFIX_ASL_CODE        "asl"
305bc36eafdSMike Gerdts #define FILE_SUFFIX_AML_CODE        "aml"
306bc36eafdSMike Gerdts #define FILE_SUFFIX_SOURCE          "src"
307bc36eafdSMike Gerdts #define FILE_SUFFIX_PREPROCESSOR    "pre"
308bc36eafdSMike Gerdts #define FILE_SUFFIX_PREPROC_USER    "i"
309bc36eafdSMike Gerdts #define FILE_SUFFIX_LISTING         "lst"
310bc36eafdSMike Gerdts #define FILE_SUFFIX_HEX_DUMP        "hex"
311bc36eafdSMike Gerdts #define FILE_SUFFIX_NAMESPACE       "nsp"
312bc36eafdSMike Gerdts #define FILE_SUFFIX_DEBUG           "txt"
313bc36eafdSMike Gerdts #define FILE_SUFFIX_ASM_SOURCE      "asm"
314bc36eafdSMike Gerdts #define FILE_SUFFIX_C_SOURCE        "c"
315bc36eafdSMike Gerdts #define FILE_SUFFIX_ASM_INCLUDE     "inc"
316bc36eafdSMike Gerdts #define FILE_SUFFIX_C_INCLUDE       "h"
317bc36eafdSMike Gerdts #define FILE_SUFFIX_C_OFFSET        "offset.h"
318bc36eafdSMike Gerdts #define FILE_SUFFIX_MAP             "map"
319bc36eafdSMike Gerdts #define FILE_SUFFIX_XREF            "xrf"
320*35786f68SRobert Mustacchi #define FILE_SUFFIX_CONVERT_AML     "xxx"
321*35786f68SRobert Mustacchi #define FILE_SUFFIX_CONVERT_DEBUG   "cdb"
322bc36eafdSMike Gerdts 
323bc36eafdSMike Gerdts 
324bc36eafdSMike Gerdts /* Cache block structure for ParseOps and Strings */
325bc36eafdSMike Gerdts 
326bc36eafdSMike Gerdts typedef struct asl_cache_info
327bc36eafdSMike Gerdts {
328bc36eafdSMike Gerdts     void                            *Next;
329bc36eafdSMike Gerdts     char                            Buffer[1];
330bc36eafdSMike Gerdts 
331bc36eafdSMike Gerdts } ASL_CACHE_INFO;
332bc36eafdSMike Gerdts 
333bc36eafdSMike Gerdts 
334bc36eafdSMike Gerdts typedef struct asl_include_dir
335bc36eafdSMike Gerdts {
336bc36eafdSMike Gerdts     char                        *Dir;
337bc36eafdSMike Gerdts     struct asl_include_dir      *Next;
338bc36eafdSMike Gerdts 
339bc36eafdSMike Gerdts } ASL_INCLUDE_DIR;
340bc36eafdSMike Gerdts 
341bc36eafdSMike Gerdts 
342*35786f68SRobert Mustacchi /*
343*35786f68SRobert Mustacchi  * An entry in the exception list, one for each error/warning
344*35786f68SRobert Mustacchi  * Note: SubError nodes would be treated with the same messageId and Level
345*35786f68SRobert Mustacchi  * as the parent error node.
346*35786f68SRobert Mustacchi  */
347bc36eafdSMike Gerdts typedef struct asl_error_msg
348bc36eafdSMike Gerdts {
349bc36eafdSMike Gerdts     UINT32                      LineNumber;
350bc36eafdSMike Gerdts     UINT32                      LogicalLineNumber;
351bc36eafdSMike Gerdts     UINT32                      LogicalByteOffset;
352bc36eafdSMike Gerdts     UINT32                      Column;
353bc36eafdSMike Gerdts     char                        *Message;
354bc36eafdSMike Gerdts     struct asl_error_msg        *Next;
355*35786f68SRobert Mustacchi     struct asl_error_msg        *SubError;
356bc36eafdSMike Gerdts     char                        *Filename;
357bc36eafdSMike Gerdts     char                        *SourceLine;
358bc36eafdSMike Gerdts     UINT32                      FilenameLength;
359bc36eafdSMike Gerdts     UINT16                      MessageId;
360bc36eafdSMike Gerdts     UINT8                       Level;
361bc36eafdSMike Gerdts 
362bc36eafdSMike Gerdts } ASL_ERROR_MSG;
363bc36eafdSMike Gerdts 
364*35786f68SRobert Mustacchi /* An entry in the expected messages array */
365*35786f68SRobert Mustacchi typedef struct asl_expected_message
366*35786f68SRobert Mustacchi {
367*35786f68SRobert Mustacchi     UINT32                       MessageId;
368*35786f68SRobert Mustacchi     char                         *MessageIdStr;
369*35786f68SRobert Mustacchi     BOOLEAN                      MessageReceived;
370*35786f68SRobert Mustacchi 
371*35786f68SRobert Mustacchi } ASL_EXPECTED_MESSAGE;
372*35786f68SRobert Mustacchi 
373bc36eafdSMike Gerdts 
374bc36eafdSMike Gerdts /* An entry in the listing file stack (for include files) */
375bc36eafdSMike Gerdts 
376bc36eafdSMike Gerdts typedef struct asl_listing_node
377bc36eafdSMike Gerdts {
378bc36eafdSMike Gerdts     char                        *Filename;
379bc36eafdSMike Gerdts     UINT32                      LineNumber;
380bc36eafdSMike Gerdts     struct asl_listing_node     *Next;
381bc36eafdSMike Gerdts 
382bc36eafdSMike Gerdts } ASL_LISTING_NODE;
383bc36eafdSMike Gerdts 
384bc36eafdSMike Gerdts 
385bc36eafdSMike Gerdts /* Callback interface for a parse tree walk */
386bc36eafdSMike Gerdts 
387bc36eafdSMike Gerdts /*
388bc36eafdSMike Gerdts  * TBD - another copy of this is in adisasm.h, fix
389bc36eafdSMike Gerdts  */
390bc36eafdSMike Gerdts #ifndef ASL_WALK_CALLBACK_DEFINED
391bc36eafdSMike Gerdts typedef
392bc36eafdSMike Gerdts ACPI_STATUS (*ASL_WALK_CALLBACK) (
393bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op,
394bc36eafdSMike Gerdts     UINT32                      Level,
395bc36eafdSMike Gerdts     void                        *Context);
396bc36eafdSMike Gerdts #define ASL_WALK_CALLBACK_DEFINED
397bc36eafdSMike Gerdts #endif
398bc36eafdSMike Gerdts 
399bc36eafdSMike Gerdts 
400bc36eafdSMike Gerdts typedef struct asl_event_info
401bc36eafdSMike Gerdts {
402bc36eafdSMike Gerdts     UINT64                      StartTime;
403bc36eafdSMike Gerdts     UINT64                      EndTime;
404bc36eafdSMike Gerdts     char                        *EventName;
405bc36eafdSMike Gerdts     BOOLEAN                     Valid;
406bc36eafdSMike Gerdts 
407bc36eafdSMike Gerdts } ASL_EVENT_INFO;
408bc36eafdSMike Gerdts 
409bc36eafdSMike Gerdts 
410bc36eafdSMike Gerdts /* Hardware mapping file structures */
411bc36eafdSMike Gerdts 
412bc36eafdSMike Gerdts typedef struct acpi_gpio_info
413bc36eafdSMike Gerdts {
414bc36eafdSMike Gerdts     struct acpi_gpio_info   *Next;
415bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *Op;
416bc36eafdSMike Gerdts     char                    *DeviceName;
417bc36eafdSMike Gerdts     ACPI_NAMESPACE_NODE     *TargetNode;
418bc36eafdSMike Gerdts     UINT32                  References;
419bc36eafdSMike Gerdts     UINT32                  PinCount;
420bc36eafdSMike Gerdts     UINT32                  PinIndex;
421bc36eafdSMike Gerdts     UINT16                  PinNumber;
422bc36eafdSMike Gerdts     UINT8                   Type;
423bc36eafdSMike Gerdts     UINT8                   Direction;
424bc36eafdSMike Gerdts     UINT8                   Polarity;
425bc36eafdSMike Gerdts 
426bc36eafdSMike Gerdts } ACPI_GPIO_INFO;
427bc36eafdSMike Gerdts 
428bc36eafdSMike Gerdts typedef struct acpi_serial_info
429bc36eafdSMike Gerdts {
430bc36eafdSMike Gerdts     struct acpi_serial_info *Next;
431bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *Op;
432bc36eafdSMike Gerdts     char                    *DeviceName;
433bc36eafdSMike Gerdts     ACPI_NAMESPACE_NODE     *TargetNode;
434bc36eafdSMike Gerdts     AML_RESOURCE            *Resource;
435bc36eafdSMike Gerdts     UINT32                  Speed;
436bc36eafdSMike Gerdts     UINT16                  Address;
437bc36eafdSMike Gerdts 
438bc36eafdSMike Gerdts } ACPI_SERIAL_INFO;
439bc36eafdSMike Gerdts 
440bc36eafdSMike Gerdts typedef struct asl_method_local
441bc36eafdSMike Gerdts {
442bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *Op;
443bc36eafdSMike Gerdts     UINT8                   Flags;
444bc36eafdSMike Gerdts 
445bc36eafdSMike Gerdts } ASL_METHOD_LOCAL;
446bc36eafdSMike Gerdts 
447bc36eafdSMike Gerdts /* Values for Flags field above */
448bc36eafdSMike Gerdts 
449bc36eafdSMike Gerdts #define ASL_LOCAL_INITIALIZED   (1)
450bc36eafdSMike Gerdts #define ASL_LOCAL_REFERENCED    (1<<1)
451bc36eafdSMike Gerdts #define ASL_ARG_IS_LOCAL        (1<<2)
452bc36eafdSMike Gerdts #define ASL_ARG_INITIALIZED     (1<<3)
453bc36eafdSMike Gerdts #define ASL_ARG_REFERENCED      (1<<4)
454bc36eafdSMike Gerdts 
455bc36eafdSMike Gerdts /* Info used to track method counts for cross reference output file */
456bc36eafdSMike Gerdts 
457bc36eafdSMike Gerdts typedef struct asl_xref_info
458bc36eafdSMike Gerdts {
459bc36eafdSMike Gerdts     UINT32                  ThisMethodInvocations;
460bc36eafdSMike Gerdts     UINT32                  TotalPredefinedMethods;
461bc36eafdSMike Gerdts     UINT32                  TotalUserMethods;
462bc36eafdSMike Gerdts     UINT32                  TotalUnreferenceUserMethods;
463bc36eafdSMike Gerdts     UINT32                  ThisObjectReferences;
464bc36eafdSMike Gerdts     UINT32                  TotalObjects;
465bc36eafdSMike Gerdts     UINT32                  TotalUnreferencedObjects;
466bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *MethodOp;
467bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *CurrentMethodOp;
468bc36eafdSMike Gerdts 
469bc36eafdSMike Gerdts } ASL_XREF_INFO;
470bc36eafdSMike Gerdts 
471bc36eafdSMike Gerdts 
472*35786f68SRobert Mustacchi typedef struct asl_file_node
473*35786f68SRobert Mustacchi {
474*35786f68SRobert Mustacchi     FILE                    *File;
475*35786f68SRobert Mustacchi     UINT32                  CurrentLineNumber;
476*35786f68SRobert Mustacchi     void                    *State;
477*35786f68SRobert Mustacchi     char                    *Filename;
478*35786f68SRobert Mustacchi     struct asl_file_node    *Next;
479*35786f68SRobert Mustacchi 
480*35786f68SRobert Mustacchi } ASL_FILE_NODE;
481*35786f68SRobert Mustacchi 
482bc36eafdSMike Gerdts #endif  /* __ASLTYPES_H */
483