asltypes.h revision 278970 
1/******************************************************************************
2 *
3 * Module Name: asltypes.h - compiler data types and struct definitions
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2015, 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 __ASLTYPES_H
45#define __ASLTYPES_H
46
47
48/*******************************************************************************
49 *
50 * Structure definitions
51 *
52 ******************************************************************************/
53
54
55/* Op flags for the ACPI_PARSE_OBJECT */
56
57#define NODE_VISITED                0x00000001
58#define NODE_AML_PACKAGE            0x00000002
59#define NODE_IS_TARGET              0x00000004
60#define NODE_IS_RESOURCE_DESC       0x00000008
61#define NODE_IS_RESOURCE_FIELD      0x00000010
62#define NODE_HAS_NO_EXIT            0x00000020
63#define NODE_IF_HAS_NO_EXIT         0x00000040
64#define NODE_NAME_INTERNALIZED      0x00000080
65#define NODE_METHOD_NO_RETVAL       0x00000100
66#define NODE_METHOD_SOME_NO_RETVAL  0x00000200
67#define NODE_RESULT_NOT_USED        0x00000400
68#define NODE_METHOD_TYPED           0x00000800
69#define NODE_UNUSED_FLAG            0x00001000
70#define NODE_COMPILE_TIME_CONST     0x00002000
71#define NODE_IS_TERM_ARG            0x00004000
72#define NODE_WAS_ONES_OP            0x00008000
73#define NODE_IS_NAME_DECLARATION    0x00010000
74#define NODE_COMPILER_EMITTED       0x00020000
75#define NODE_IS_DUPLICATE           0x00040000
76#define NODE_IS_RESOURCE_DATA       0x00080000
77#define NODE_IS_NULL_RETURN         0x00100000
78
79/* Keeps information about individual control methods */
80
81typedef struct asl_method_info
82{
83    ACPI_PARSE_OBJECT       *Op;
84    struct asl_method_info  *Next;
85    UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
86    UINT32                  ValidReturnTypes;
87    UINT32                  NumReturnNoValue;
88    UINT32                  NumReturnWithValue;
89    UINT8                   NumArguments;
90    UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
91    UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
92    UINT8                   HasBeenTyped;
93    UINT8                   ShouldBeSerialized;
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    const char                  *ShortDescription;
136    const char                  *Description;
137
138} ASL_FILE_INFO;
139
140typedef struct asl_file_status
141{
142    UINT32                  Line;
143    UINT32                  Offset;
144
145} ASL_FILE_STATUS;
146
147
148/*
149 * File types. Note: Any changes to this table must also be reflected
150 * in the Gbl_Files array.
151 */
152typedef enum
153{
154    ASL_FILE_STDOUT             = 0,
155    ASL_FILE_STDERR,
156    ASL_FILE_INPUT,
157    ASL_FILE_AML_OUTPUT,        /* Don't move these first 4 file types */
158    ASL_FILE_SOURCE_OUTPUT,
159    ASL_FILE_PREPROCESSOR,
160    ASL_FILE_LISTING_OUTPUT,
161    ASL_FILE_HEX_OUTPUT,
162    ASL_FILE_NAMESPACE_OUTPUT,
163    ASL_FILE_DEBUG_OUTPUT,
164    ASL_FILE_ASM_SOURCE_OUTPUT,
165    ASL_FILE_C_SOURCE_OUTPUT,
166    ASL_FILE_ASM_INCLUDE_OUTPUT,
167    ASL_FILE_C_INCLUDE_OUTPUT,
168    ASL_FILE_C_OFFSET_OUTPUT,
169    ASL_FILE_MAP_OUTPUT
170
171} ASL_FILE_TYPES;
172
173
174#define ASL_MAX_FILE_TYPE       15
175#define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
176
177
178/* Cache block structure for ParseOps and Strings */
179
180typedef struct asl_cache_info
181{
182    void                            *Next;
183    char                            Buffer[1];
184
185} ASL_CACHE_INFO;
186
187
188typedef struct asl_include_dir
189{
190    char                        *Dir;
191    struct asl_include_dir      *Next;
192
193} ASL_INCLUDE_DIR;
194
195
196/* An entry in the exception list, one for each error/warning */
197
198typedef struct asl_error_msg
199{
200    UINT32                      LineNumber;
201    UINT32                      LogicalLineNumber;
202    UINT32                      LogicalByteOffset;
203    UINT32                      Column;
204    char                        *Message;
205    struct asl_error_msg        *Next;
206    char                        *Filename;
207    char                        *SourceLine;
208    UINT32                      FilenameLength;
209    UINT16                      MessageId;
210    UINT8                       Level;
211
212} ASL_ERROR_MSG;
213
214
215/* An entry in the listing file stack (for include files) */
216
217typedef struct asl_listing_node
218{
219    char                        *Filename;
220    UINT32                      LineNumber;
221    struct asl_listing_node     *Next;
222
223} ASL_LISTING_NODE;
224
225
226/* Callback interface for a parse tree walk */
227
228/*
229 * TBD - another copy of this is in adisasm.h, fix
230 */
231#ifndef ASL_WALK_CALLBACK_DEFINED
232typedef
233ACPI_STATUS (*ASL_WALK_CALLBACK) (
234    ACPI_PARSE_OBJECT           *Op,
235    UINT32                      Level,
236    void                        *Context);
237#define ASL_WALK_CALLBACK_DEFINED
238#endif
239
240
241typedef struct asl_event_info
242{
243    UINT64                      StartTime;
244    UINT64                      EndTime;
245    char                        *EventName;
246    BOOLEAN                     Valid;
247
248} ASL_EVENT_INFO;
249
250
251/* Hardware mapping file structures */
252
253typedef struct acpi_gpio_info
254{
255    struct acpi_gpio_info   *Next;
256    ACPI_PARSE_OBJECT       *Op;
257    char                    *DeviceName;
258    ACPI_NAMESPACE_NODE     *TargetNode;
259    UINT32                  References;
260    UINT32                  PinCount;
261    UINT32                  PinIndex;
262    UINT16                  PinNumber;
263    UINT8                   Type;
264    UINT8                   Direction;
265    UINT8                   Polarity;
266
267} ACPI_GPIO_INFO;
268
269typedef struct acpi_serial_info
270{
271    struct acpi_serial_info *Next;
272    ACPI_PARSE_OBJECT       *Op;
273    char                    *DeviceName;
274    ACPI_NAMESPACE_NODE     *TargetNode;
275    AML_RESOURCE            *Resource;
276    UINT32                  Speed;
277    UINT16                  Address;
278
279} ACPI_SERIAL_INFO;
280
281
282#endif  /* __ASLTYPES_H */
283