asltypes.h revision 217365 
1
2/******************************************************************************
3 *
4 * Module Name: asltypes.h - compiler data types and struct definitions
5 *
6 *****************************************************************************/
7
8/*
9 * Copyright (C) 2000 - 2011, Intel Corp.
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 *    notice, this list of conditions, and the following disclaimer,
17 *    without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 *    substantially similar to the "NO WARRANTY" disclaimer below
20 *    ("Disclaimer") and any redistribution must be conditioned upon
21 *    including a substantially similar Disclaimer requirement for further
22 *    binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 *    of any contributors may be used to endorse or promote products derived
25 *    from this software without specific prior written permission.
26 *
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
30 *
31 * NO WARRANTY
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
43 */
44
45
46#ifndef __ASLTYPES_H
47#define __ASLTYPES_H
48
49
50/*******************************************************************************
51 *
52 * Structure definitions
53 *
54 ******************************************************************************/
55
56
57/* Op flags for the ACPI_PARSE_OBJECT */
58
59#define NODE_VISITED                0x00000001
60#define NODE_AML_PACKAGE            0x00000002
61#define NODE_IS_TARGET              0x00000004
62#define NODE_IS_RESOURCE_DESC       0x00000008
63#define NODE_IS_RESOURCE_FIELD      0x00000010
64#define NODE_HAS_NO_EXIT            0x00000020
65#define NODE_IF_HAS_NO_EXIT         0x00000040
66#define NODE_NAME_INTERNALIZED      0x00000080
67#define NODE_METHOD_NO_RETVAL       0x00000100
68#define NODE_METHOD_SOME_NO_RETVAL  0x00000200
69#define NODE_RESULT_NOT_USED        0x00000400
70#define NODE_METHOD_TYPED           0x00000800
71#define NODE_IS_BIT_OFFSET          0x00001000
72#define NODE_COMPILE_TIME_CONST     0x00002000
73#define NODE_IS_TERM_ARG            0x00004000
74#define NODE_WAS_ONES_OP            0x00008000
75#define NODE_IS_NAME_DECLARATION    0x00010000
76#define NODE_COMPILER_EMITTED       0x00020000
77#define NODE_IS_DUPLICATE           0x00040000
78#define NODE_IS_RESOURCE_DATA       0x00080000
79
80/* Keeps information about individual control methods */
81
82typedef struct asl_method_info
83{
84    UINT8                   NumArguments;
85    UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
86    UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
87    UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
88    UINT32                  ValidReturnTypes;
89    UINT32                  NumReturnNoValue;
90    UINT32                  NumReturnWithValue;
91    ACPI_PARSE_OBJECT       *Op;
92    struct asl_method_info  *Next;
93    UINT8                   HasBeenTyped;
94
95} ASL_METHOD_INFO;
96
97
98/* Parse tree walk info for control method analysis */
99
100typedef struct asl_analysis_walk_info
101{
102    ASL_METHOD_INFO         *MethodStack;
103
104} ASL_ANALYSIS_WALK_INFO;
105
106
107/* An entry in the ParseOpcode to AmlOpcode mapping table */
108
109typedef struct asl_mapping_entry
110{
111    UINT32                      Value;
112    UINT32                      AcpiBtype;   /* Object type or return type */
113    UINT16                      AmlOpcode;
114    UINT8                       Flags;
115
116} ASL_MAPPING_ENTRY;
117
118
119/* Parse tree walk info structure */
120
121typedef struct asl_walk_info
122{
123    ACPI_PARSE_OBJECT           **NodePtr;
124    UINT32                      *LevelPtr;
125
126} ASL_WALK_INFO;
127
128
129/* File info */
130
131typedef struct asl_file_info
132{
133    FILE                        *Handle;
134    char                        *Filename;
135
136} ASL_FILE_INFO;
137
138typedef struct asl_file_status
139{
140    UINT32                  Line;
141    UINT32                  Offset;
142
143} ASL_FILE_STATUS;
144
145
146/* File types */
147
148typedef enum
149{
150    ASL_FILE_STDOUT             = 0,
151    ASL_FILE_STDERR,
152    ASL_FILE_INPUT,
153    ASL_FILE_AML_OUTPUT,
154    ASL_FILE_SOURCE_OUTPUT,
155    ASL_FILE_LISTING_OUTPUT,
156    ASL_FILE_HEX_OUTPUT,
157    ASL_FILE_NAMESPACE_OUTPUT,
158    ASL_FILE_DEBUG_OUTPUT,
159    ASL_FILE_ASM_SOURCE_OUTPUT,
160    ASL_FILE_C_SOURCE_OUTPUT,
161    ASL_FILE_ASM_INCLUDE_OUTPUT,
162    ASL_FILE_C_INCLUDE_OUTPUT
163
164} ASL_FILE_TYPES;
165
166
167#define ASL_MAX_FILE_TYPE       12
168#define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
169
170
171typedef struct asl_include_dir
172{
173    char                        *Dir;
174    struct asl_include_dir      *Next;
175
176} ASL_INCLUDE_DIR;
177
178
179/* An entry in the exception list, one for each error/warning */
180
181typedef struct asl_error_msg
182{
183    UINT32                      LineNumber;
184    UINT32                      LogicalLineNumber;
185    UINT32                      LogicalByteOffset;
186    UINT32                      Column;
187    char                        *Message;
188    struct asl_error_msg        *Next;
189    char                        *Filename;
190    UINT32                      FilenameLength;
191    UINT8                       MessageId;
192    UINT8                       Level;
193
194} ASL_ERROR_MSG;
195
196
197/* An entry in the listing file stack (for include files) */
198
199typedef struct asl_listing_node
200{
201    char                        *Filename;
202    UINT32                      LineNumber;
203    struct asl_listing_node     *Next;
204
205} ASL_LISTING_NODE;
206
207
208/* Callback interface for a parse tree walk */
209
210/*
211 * TBD - another copy of this is in adisasm.h, fix
212 */
213#ifndef ASL_WALK_CALLBACK_DEFINED
214typedef
215ACPI_STATUS (*ASL_WALK_CALLBACK) (
216    ACPI_PARSE_OBJECT           *Op,
217    UINT32                      Level,
218    void                        *Context);
219#define ASL_WALK_CALLBACK_DEFINED
220#endif
221
222
223typedef struct asl_event_info
224{
225    UINT64                      StartTime;
226    UINT64                      EndTime;
227    char                        *EventName;
228    BOOLEAN                     Valid;
229
230} ASL_EVENT_INFO;
231
232
233#endif  /* __ASLTYPES_H */
234