14 * All rights reserved.
15 *
16 * 2. License
17 *
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
21 * property rights.
22 *
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
29 *
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
38 *
39 * The above copyright and patent license is granted only if the following
40 * conditions are met:
41 *
42 * 3. Conditions
43 *
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
55 *
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
66 * make.
67 *
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
72 * distribution.
73 *
74 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * Intel Code.
76 *
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
81 *
82 * 4. Disclaimer and Export Compliance
83 *
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * PARTICULAR PURPOSE.
91 *
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * LIMITED REMEDY.
100 *
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
115 *
116 *****************************************************************************/
117
118
119#ifndef __ASLTYPES_H
120#define __ASLTYPES_H
121
122
123#include <time.h>
124
125
126/*******************************************************************************
127 *
128 * Structure definitions
129 *
130 ******************************************************************************/
131
132
133/* Op flags for the ACPI_PARSE_OBJECT */
134
135#define NODE_VISITED 0x00000001
136#define NODE_AML_PACKAGE 0x00000002
137#define NODE_IS_TARGET 0x00000004
138#define NODE_IS_RESOURCE_DESC 0x00000008
139#define NODE_IS_RESOURCE_FIELD 0x00000010
140#define NODE_HAS_NO_EXIT 0x00000020
141#define NODE_IF_HAS_NO_EXIT 0x00000040
142#define NODE_NAME_INTERNALIZED 0x00000080
143#define NODE_METHOD_NO_RETVAL 0x00000100
144#define NODE_METHOD_SOME_NO_RETVAL 0x00000200
145#define NODE_RESULT_NOT_USED 0x00000400
146#define NODE_METHOD_TYPED 0x00000800
147#define NODE_IS_BIT_OFFSET 0x00001000
148#define NODE_COMPILE_TIME_CONST 0x00002000
149#define NODE_IS_TERM_ARG 0x00004000
150#define NODE_WAS_ONES_OP 0x00008000
151#define NODE_IS_NAME_DECLARATION 0x00010000
152
153/* Keeps information about individual control methods */
154
155typedef struct asl_method_info
156{
157 UINT8 NumArguments;
158 UINT8 LocalInitialized[ACPI_METHOD_NUM_LOCALS];
159 UINT8 ArgInitialized[ACPI_METHOD_NUM_ARGS];
160 UINT32 NumReturnNoValue;
161 UINT32 NumReturnWithValue;
162 ACPI_PARSE_OBJECT *Op;
163 struct asl_method_info *Next;
164 UINT8 HasBeenTyped;
165
166} ASL_METHOD_INFO;
167
168
169/* Parse tree walk info for control method analysis */
170
171typedef struct asl_analysis_walk_info
172{
173 ASL_METHOD_INFO *MethodStack;
174
175} ASL_ANALYSIS_WALK_INFO;
176
177
178/* An entry in the ParseOpcode to AmlOpcode mapping table */
179
180typedef struct asl_mapping_entry
181{
182 UINT32 Value;
183 UINT32 AcpiBtype; /* Object type or return type */
184 UINT16 AmlOpcode;
185 UINT8 Flags;
186
187} ASL_MAPPING_ENTRY;
188
189
190/* An entry in the Reserved Name information table */
191
192#define ASL_RSVD_RETURN_VALUE 0x01
193#define ASL_RSVD_RESOURCE_NAME 0x02
194#define ASL_RSVD_SCOPE 0x04
195
196typedef struct asl_reserved_info
197{
198 char *Name;
199 UINT8 NumArguments;
200 UINT8 Flags;
201
202} ASL_RESERVED_INFO;
203
204
205/* Parse tree walk info structure */
206
207typedef struct asl_walk_info
208{
209 ACPI_PARSE_OBJECT **NodePtr;
210 UINT32 *LevelPtr;
211
212} ASL_WALK_INFO;
213
214
215/* File info */
216
217typedef struct asl_file_info
218{
219 FILE *Handle;
220 char *Filename;
221
222} ASL_FILE_INFO;
223
224
225/* File types */
226
227typedef enum
228{
229 ASL_FILE_STDOUT = 0,
230 ASL_FILE_STDERR,
231 ASL_FILE_INPUT,
232 ASL_FILE_AML_OUTPUT,
233 ASL_FILE_SOURCE_OUTPUT,
234 ASL_FILE_LISTING_OUTPUT,
235 ASL_FILE_HEX_OUTPUT,
236 ASL_FILE_NAMESPACE_OUTPUT,
237 ASL_FILE_DEBUG_OUTPUT,
238 ASL_FILE_ASM_SOURCE_OUTPUT,
239 ASL_FILE_C_SOURCE_OUTPUT,
240 ASL_FILE_ASM_INCLUDE_OUTPUT,
241 ASL_FILE_C_INCLUDE_OUTPUT
242
243} ASL_FILE_TYPES;
244
245
246#define ASL_MAX_FILE_TYPE 12
247#define ASL_NUM_FILES (ASL_MAX_FILE_TYPE + 1)
248
249
250/* An entry in the exception list, one for each error/warning */
251
252typedef struct asl_error_msg
253{
254 UINT32 LineNumber;
255 UINT32 LogicalLineNumber;
256 UINT32 LogicalByteOffset;
257 UINT32 Column;
258 char *Message;
259 struct asl_error_msg *Next;
260 char *Filename;
261 UINT32 FilenameLength;
262 UINT8 MessageId;
263 UINT8 Level;
264
265} ASL_ERROR_MSG;
266
267
268/* An entry in the listing file stack (for include files) */
269
270typedef struct asl_listing_node
271{
272 char *Filename;
273 UINT32 LineNumber;
274 struct asl_listing_node *Next;
275
276} ASL_LISTING_NODE;
277
278
279/* Callback interface for a parse tree walk */
280
281typedef
282ACPI_STATUS (*ASL_WALK_CALLBACK) (
283 ACPI_PARSE_OBJECT *Op,
284 UINT32 Level,
285 void *Context);
286
287
288typedef struct asl_event_info
289{
290 time_t StartTime;
291 time_t EndTime;
292 char *EventName;
293 BOOLEAN Valid;
294
295} ASL_EVENT_INFO;
296
297
298#define ASL_ERROR 0
299#define ASL_WARNING 1
300#define ASL_REMARK 2
301#define ASL_OPTIMIZATION 3
302#define ASL_NUM_REPORT_LEVELS 4
303
304
305typedef enum
306{
307 ASL_MSG_NULL = 0,
308 ASL_MSG_MEMORY_ALLOCATION,
309 ASL_MSG_INPUT_FILE_OPEN,
310 ASL_MSG_OUTPUT_FILENAME,
311 ASL_MSG_OUTPUT_FILE_OPEN,
312 ASL_MSG_LISTING_FILENAME,
313 ASL_MSG_LISTING_FILE_OPEN,
314 ASL_MSG_DEBUG_FILENAME,
315 ASL_MSG_DEBUG_FILE_OPEN,
316 ASL_MSG_INCLUDE_FILE_OPEN,
317 ASL_MSG_ENCODING_LENGTH,
318 ASL_MSG_INVALID_PRIORITY,
319 ASL_MSG_INVALID_PERFORMANCE,
320 ASL_MSG_LOCAL_INIT,
321 ASL_MSG_ARG_INIT,
322 ASL_MSG_UNSUPPORTED,
323 ASL_MSG_RESERVED_WORD,
324 ASL_MSG_BUFFER_LENGTH,
325 ASL_MSG_PACKAGE_LENGTH,
326 ASL_MSG_RETURN_TYPES,
327 ASL_MSG_NOT_FOUND,
328 ASL_MSG_NOT_REACHABLE,
329 ASL_MSG_NOT_EXIST,
330 ASL_MSG_NESTED_COMMENT,
331 ASL_MSG_RESERVED_ARG_COUNT_HI,
332 ASL_MSG_RESERVED_ARG_COUNT_LO,
333 ASL_MSG_RESERVED_RETURN_VALUE,
334 ASL_MSG_ARG_COUNT_HI,
335 ASL_MSG_ARG_COUNT_LO,
336 ASL_MSG_NO_RETVAL,
337 ASL_MSG_SOME_NO_RETVAL,
338 ASL_MSG_COMPILER_INTERNAL,
339 ASL_MSG_BACKWARDS_OFFSET,
340 ASL_MSG_UNKNOWN_RESERVED_NAME,
341 ASL_MSG_NAME_EXISTS,
342 ASL_MSG_INVALID_TYPE,
343 ASL_MSG_MULTIPLE_TYPES,
344 ASL_MSG_SYNTAX,
345 ASL_MSG_NOT_METHOD,
346 ASL_MSG_LONG_LINE,
347 ASL_MSG_RECURSION,
348 ASL_MSG_NOT_PARAMETER,
349 ASL_MSG_OPEN,
350 ASL_MSG_READ,
351 ASL_MSG_WRITE,
352 ASL_MSG_SEEK,
353 ASL_MSG_CLOSE,
354 ASL_MSG_FIELD_ACCESS_WIDTH,
355 ASL_MSG_REGION_BYTE_ACCESS,
356 ASL_MSG_REGION_BUFFER_ACCESS,
357 ASL_MSG_FIELD_UNIT_OFFSET,
358 ASL_MSG_FIELD_UNIT_ACCESS_WIDTH,
359 ASL_MSG_RESOURCE_FIELD,
360 ASL_MSG_BYTES_TO_BITS,
361 ASL_MSG_BITS_TO_BYTES,
362 ASL_MSG_AML_NOT_IMPLEMENTED,
363 ASL_MSG_NO_WHILE,
364 ASL_MSG_INVALID_ESCAPE,
365 ASL_MSG_INVALID_STRING,
366 ASL_MSG_TABLE_SIGNATURE,
367 ASL_MSG_RESOURCE_LIST,
368 ASL_MSG_INVALID_TARGET,
369 ASL_MSG_INVALID_CONSTANT_OP,
370 ASL_MSG_CONSTANT_EVALUATION,
371 ASL_MSG_CONSTANT_FOLDED,
372 ASL_MSG_INVALID_EISAID,
373 ASL_MSG_RESERVED_OPERAND_TYPE,
374 ASL_MSG_RESERVED_METHOD,
375 ASL_MSG_ALPHANUMERIC_STRING,
376 ASL_MSG_RESERVED_USE,
377 ASL_MSG_INVALID_OPERAND,
378 ASL_MSG_MISSING_ENDDEPENDENT,
379 ASL_MSG_MISSING_STARTDEPENDENT,
380 ASL_MSG_DEPENDENT_NESTING,
381 ASL_MSG_NAME_OPTIMIZATION,
382 ASL_MSG_SINGLE_NAME_OPTIMIZATION,
383 ASL_MSG_INTEGER_OPTIMIZATION,
384 ASL_MSG_SCOPE_TYPE,
385 ASL_MSG_CORE_EXCEPTION,
386 ASL_MSG_UNREACHABLE_CODE,
387 ASL_MSG_EARLY_EOF,
388 ASL_MSG_SCOPE_FWD_REF,
389 ASL_MSG_NON_ASCII,
390 ASL_MSG_INVALID_TIME
391
392} ASL_MESSAGE_IDS;
393
394#ifdef ASL_EXCEPTIONS
395
396char *AslMessages [] = {
397/* ASL_MSG_NULL */ NULL,
398/* ASL_MSG_MEMORY_ALLOCATION, */ "Memory allocation failure",
399/* ASL_MSG_INPUT_FILE_OPEN, */ "Could not open input file",
400/* ASL_MSG_OUTPUT_FILENAME, */ "Could not create output filename",
401/* ASL_MSG_OUTPUT_FILE_OPEN, */ "Could not open output AML file",
402/* ASL_MSG_LISTING_FILENAME, */ "Could not create listing filename",
403/* ASL_MSG_LISTING_FILE_OPEN, */ "Could not open listing file",
404/* ASL_MSG_DEBUG_FILENAME, */ "Could not create debug filename",
405/* ASL_MSG_DEBUG_FILE_OPEN, */ "Could not open debug file",
406/* ASL_MSG_INCLUDE_FILE_OPEN, */ "Could not open include file",
407/* ASL_MSG_ENCODING_LENGTH, */ "Package length too long to encode",
408/* ASL_MSG_INVALID_PRIORITY, */ "Invalid priority value",
409/* ASL_MSG_INVALID_PERFORMANCE, */ "Invalid performance/robustness value",
410/* ASL_MSG_LOCAL_INIT, */ "Method local variable is not initialized",
411/* ASL_MSG_ARG_INIT, */ "Method argument is not initialized",
412/* ASL_MSG_UNSUPPORTED, */ "Unsupported feature",
413/* ASL_MSG_RESERVED_WORD, */ "Use of reserved word",
414/* ASL_MSG_BUFFER_LENGTH, */ "Effective AML buffer length is zero",
415/* ASL_MSG_PACKAGE_LENGTH, */ "Effective AML package length is zero",
416/* ASL_MSG_RETURN_TYPES, */ "Not all control paths return a value",
417/* ASL_MSG_NOT_FOUND, */ "Object not found or not accessible from scope",
418/* ASL_MSG_NOT_REACHABLE, */ "Object not accessible from this scope",
419/* ASL_MSG_NOT_EXIST, */ "Object does not exist",
420/* ASL_MSG_NESTED_COMMENT, */ "Nested comment found",
421/* ASL_MSG_RESERVED_ARG_COUNT_HI, */ "Reserved method has too many arguments",
422/* ASL_MSG_RESERVED_ARG_COUNT_LO, */ "Reserved method has too few arguments",
423/* ASL_MSG_RESERVED_RETURN_VALUE, */ "Reserved method must return a value",
424/* ASL_MSG_ARG_COUNT_HI, */ "Too many arguments",
425/* ASL_MSG_ARG_COUNT_LO, */ "Too few arguments",
426/* ASL_MSG_NO_RETVAL, */ "Called method returns no value",
427/* ASL_MSG_SOME_NO_RETVAL, */ "Called method may not always return a value",
428/* ASL_MSG_COMPILER_INTERNAL, */ "Internal compiler error",
429/* ASL_MSG_BACKWARDS_OFFSET, */ "Invalid backwards offset",
430/* ASL_MSG_UNKNOWN_RESERVED_NAME, */ "Unknown reserved name",
431/* ASL_MSG_NAME_EXISTS, */ "Name already exists in scope",
432/* ASL_MSG_INVALID_TYPE, */ "Invalid type",
433/* ASL_MSG_MULTIPLE_TYPES, */ "Multiple types",
434/* ASL_MSG_SYNTAX, */ "",
435/* ASL_MSG_NOT_METHOD, */ "Not a control method, cannot invoke",
436/* ASL_MSG_LONG_LINE, */ "Splitting long input line",
437/* ASL_MSG_RECURSION, */ "Recursive method call",
438/* ASL_MSG_NOT_PARAMETER, */ "Not a parameter, used as local only",
439/* ASL_MSG_OPEN, */ "Could not open file",
440/* ASL_MSG_READ, */ "Could not read file",
441/* ASL_MSG_WRITE, */ "Could not write file",
442/* ASL_MSG_SEEK, */ "Could not seek file",
443/* ASL_MSG_CLOSE, */ "Could not close file",
444/* ASL_MSG_FIELD_ACCESS_WIDTH, */ "Access width is greater than region size",
445/* ASL_MSG_REGION_BYTE_ACCESS, */ "Host Operation Region requires ByteAcc access",
446/* ASL_MSG_REGION_BUFFER_ACCESS, */ "Host Operation Region requires BufferAcc access",
447/* ASL_MSG_FIELD_UNIT_OFFSET, */ "Field Unit extends beyond region limit",
448/* ASL_MSG_FIELD_UNIT_ACCESS_WIDTH, */ "Access width of Field Unit extends beyond region limit",
449/* ASL_MSG_RESOURCE_FIELD, */ "Resource field name cannot be used as a target",
450/* ASL_MSG_BYTES_TO_BITS, */ "Field offset is in bytes, but a bit offset is required",
451/* ASL_MSG_BITS_TO_BYTES, */ "Field offset is in bits, but a byte offset is required",
452/* ASL_MSG_AML_NOT_IMPLEMENTED, */ "Opcode is not implemented in compiler AML code generator",
453/* ASL_MSG_NO_WHILE, */ "No enclosing While statement",
454/* ASL_MSG_INVALID_ESCAPE, */ "Invalid or unknown escape sequence",
455/* ASL_MSG_INVALID_STRING, */ "Invalid Hex/Octal Escape - Non-ASCII or NULL",
456/* ASL_MSG_TABLE_SIGNATURE, */ "Invalid Table Signature",
457/* ASL_MSG_RESOURCE_LIST, */ "Too many resource items (internal error)",
458/* ASL_MSG_INVALID_TARGET, */ "Target operand not allowed in constant expression",
459/* ASL_MSG_INVALID_CONSTANT_OP, */ "Invalid operator in constant expression (not type 3/4/5)",
460/* ASL_MSG_CONSTANT_EVALUATION, */ "Could not evaluate constant expression",
461/* ASL_MSG_CONSTANT_FOLDED, */ "Constant expression evaluated and reduced",
462/* ASL_MSG_INVALID_EISAID, */ "EISAID string must be of the form \"UUUXXXX\" (3 uppercase, 4 hex digits)",
463/* ASL_MSG_RESERVED_OPERAND_TYPE, */ "Invalid operand type for reserved name, must be",
464/* ASL_MSG_RESERVED_METHOD, */ "Reserved name must be a control method",
465/* ASL_MSG_ALPHANUMERIC_STRING, */ "String must be entirely alphanumeric",
466/* ASL_MSG_RESERVED_USE, */ "Invalid use of reserved name",
467/* ASL_MSG_INVALID_OPERAND, */ "Invalid operand",
468/* ASL_MSG_MISSING_ENDDEPENDENT, */ "Missing EndDependentFn() macro in dependent resource list",
469/* ASL_MSG_MISSING_STARTDEPENDENT, */ "Missing StartDependentFn() macro in dependent resource list",
470/* ASL_MSG_DEPENDENT_NESTING, */ "Dependent function macros cannot be nested",\
471/* ASL_MSG_NAME_OPTIMIZATION, */ "NamePath optimized",
472/* ASL_MSG_SINGLE_NAME_OPTIMIZATION, */ "NamePath optimized to NameSeg (uses run-time search path)",
473/* ASL_MSG_INTEGER_OPTIMIZATION, */ "Integer optimized to single-byte AML opcode",
474/* ASL_MSG_SCOPE_TYPE, */ "Existing object has invalid type for Scope operator",
475/* ASL_MSG_CORE_EXCEPTION, */ "From ACPI CA Subsystem",
476/* ASL_MSG_UNREACHABLE_CODE, */ "Statement is unreachable",
477/* ASL_MSG_EARLY_EOF */ "Premature end-of-file reached",
478/* ASL_MSG_SCOPE_FWD_REF */ "Forward references from Scope() not allowed",
479/* ASL_MSG_NON_ASCII */ "Invalid characters found in file",
480/* ASL_MSG_INVALID_TIME */ "Time parameter too long (255 max)"
481
482};
483
484
485char *AslErrorLevel [ASL_NUM_REPORT_LEVELS] = {
486 "Error ",
487 "Warning ",
488 "Remark ",
489 "Optimize"
490};
491
492#define ASL_ERROR_LEVEL_LENGTH 8 /* Length of strings above */
493
494/* Exception counters */
495
496UINT32 Gbl_ExceptionCount[ASL_NUM_REPORT_LEVELS] = {0,0,0,0};
497
498#endif
499
500
501#endif /* __ASLTYPES_H */
| 14 * All rights reserved.
15 *
16 * 2. License
17 *
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
21 * property rights.
22 *
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
29 *
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
38 *
39 * The above copyright and patent license is granted only if the following
40 * conditions are met:
41 *
42 * 3. Conditions
43 *
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
55 *
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
66 * make.
67 *
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
72 * distribution.
73 *
74 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * Intel Code.
76 *
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
81 *
82 * 4. Disclaimer and Export Compliance
83 *
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * PARTICULAR PURPOSE.
91 *
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * LIMITED REMEDY.
100 *
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
115 *
116 *****************************************************************************/
117
118
119#ifndef __ASLTYPES_H
120#define __ASLTYPES_H
121
122
123#include <time.h>
124
125
126/*******************************************************************************
127 *
128 * Structure definitions
129 *
130 ******************************************************************************/
131
132
133/* Op flags for the ACPI_PARSE_OBJECT */
134
135#define NODE_VISITED 0x00000001
136#define NODE_AML_PACKAGE 0x00000002
137#define NODE_IS_TARGET 0x00000004
138#define NODE_IS_RESOURCE_DESC 0x00000008
139#define NODE_IS_RESOURCE_FIELD 0x00000010
140#define NODE_HAS_NO_EXIT 0x00000020
141#define NODE_IF_HAS_NO_EXIT 0x00000040
142#define NODE_NAME_INTERNALIZED 0x00000080
143#define NODE_METHOD_NO_RETVAL 0x00000100
144#define NODE_METHOD_SOME_NO_RETVAL 0x00000200
145#define NODE_RESULT_NOT_USED 0x00000400
146#define NODE_METHOD_TYPED 0x00000800
147#define NODE_IS_BIT_OFFSET 0x00001000
148#define NODE_COMPILE_TIME_CONST 0x00002000
149#define NODE_IS_TERM_ARG 0x00004000
150#define NODE_WAS_ONES_OP 0x00008000
151#define NODE_IS_NAME_DECLARATION 0x00010000
152
153/* Keeps information about individual control methods */
154
155typedef struct asl_method_info
156{
157 UINT8 NumArguments;
158 UINT8 LocalInitialized[ACPI_METHOD_NUM_LOCALS];
159 UINT8 ArgInitialized[ACPI_METHOD_NUM_ARGS];
160 UINT32 NumReturnNoValue;
161 UINT32 NumReturnWithValue;
162 ACPI_PARSE_OBJECT *Op;
163 struct asl_method_info *Next;
164 UINT8 HasBeenTyped;
165
166} ASL_METHOD_INFO;
167
168
169/* Parse tree walk info for control method analysis */
170
171typedef struct asl_analysis_walk_info
172{
173 ASL_METHOD_INFO *MethodStack;
174
175} ASL_ANALYSIS_WALK_INFO;
176
177
178/* An entry in the ParseOpcode to AmlOpcode mapping table */
179
180typedef struct asl_mapping_entry
181{
182 UINT32 Value;
183 UINT32 AcpiBtype; /* Object type or return type */
184 UINT16 AmlOpcode;
185 UINT8 Flags;
186
187} ASL_MAPPING_ENTRY;
188
189
190/* An entry in the Reserved Name information table */
191
192#define ASL_RSVD_RETURN_VALUE 0x01
193#define ASL_RSVD_RESOURCE_NAME 0x02
194#define ASL_RSVD_SCOPE 0x04
195
196typedef struct asl_reserved_info
197{
198 char *Name;
199 UINT8 NumArguments;
200 UINT8 Flags;
201
202} ASL_RESERVED_INFO;
203
204
205/* Parse tree walk info structure */
206
207typedef struct asl_walk_info
208{
209 ACPI_PARSE_OBJECT **NodePtr;
210 UINT32 *LevelPtr;
211
212} ASL_WALK_INFO;
213
214
215/* File info */
216
217typedef struct asl_file_info
218{
219 FILE *Handle;
220 char *Filename;
221
222} ASL_FILE_INFO;
223
224
225/* File types */
226
227typedef enum
228{
229 ASL_FILE_STDOUT = 0,
230 ASL_FILE_STDERR,
231 ASL_FILE_INPUT,
232 ASL_FILE_AML_OUTPUT,
233 ASL_FILE_SOURCE_OUTPUT,
234 ASL_FILE_LISTING_OUTPUT,
235 ASL_FILE_HEX_OUTPUT,
236 ASL_FILE_NAMESPACE_OUTPUT,
237 ASL_FILE_DEBUG_OUTPUT,
238 ASL_FILE_ASM_SOURCE_OUTPUT,
239 ASL_FILE_C_SOURCE_OUTPUT,
240 ASL_FILE_ASM_INCLUDE_OUTPUT,
241 ASL_FILE_C_INCLUDE_OUTPUT
242
243} ASL_FILE_TYPES;
244
245
246#define ASL_MAX_FILE_TYPE 12
247#define ASL_NUM_FILES (ASL_MAX_FILE_TYPE + 1)
248
249
250/* An entry in the exception list, one for each error/warning */
251
252typedef struct asl_error_msg
253{
254 UINT32 LineNumber;
255 UINT32 LogicalLineNumber;
256 UINT32 LogicalByteOffset;
257 UINT32 Column;
258 char *Message;
259 struct asl_error_msg *Next;
260 char *Filename;
261 UINT32 FilenameLength;
262 UINT8 MessageId;
263 UINT8 Level;
264
265} ASL_ERROR_MSG;
266
267
268/* An entry in the listing file stack (for include files) */
269
270typedef struct asl_listing_node
271{
272 char *Filename;
273 UINT32 LineNumber;
274 struct asl_listing_node *Next;
275
276} ASL_LISTING_NODE;
277
278
279/* Callback interface for a parse tree walk */
280
281typedef
282ACPI_STATUS (*ASL_WALK_CALLBACK) (
283 ACPI_PARSE_OBJECT *Op,
284 UINT32 Level,
285 void *Context);
286
287
288typedef struct asl_event_info
289{
290 time_t StartTime;
291 time_t EndTime;
292 char *EventName;
293 BOOLEAN Valid;
294
295} ASL_EVENT_INFO;
296
297
298#define ASL_ERROR 0
299#define ASL_WARNING 1
300#define ASL_REMARK 2
301#define ASL_OPTIMIZATION 3
302#define ASL_NUM_REPORT_LEVELS 4
303
304
305typedef enum
306{
307 ASL_MSG_NULL = 0,
308 ASL_MSG_MEMORY_ALLOCATION,
309 ASL_MSG_INPUT_FILE_OPEN,
310 ASL_MSG_OUTPUT_FILENAME,
311 ASL_MSG_OUTPUT_FILE_OPEN,
312 ASL_MSG_LISTING_FILENAME,
313 ASL_MSG_LISTING_FILE_OPEN,
314 ASL_MSG_DEBUG_FILENAME,
315 ASL_MSG_DEBUG_FILE_OPEN,
316 ASL_MSG_INCLUDE_FILE_OPEN,
317 ASL_MSG_ENCODING_LENGTH,
318 ASL_MSG_INVALID_PRIORITY,
319 ASL_MSG_INVALID_PERFORMANCE,
320 ASL_MSG_LOCAL_INIT,
321 ASL_MSG_ARG_INIT,
322 ASL_MSG_UNSUPPORTED,
323 ASL_MSG_RESERVED_WORD,
324 ASL_MSG_BUFFER_LENGTH,
325 ASL_MSG_PACKAGE_LENGTH,
326 ASL_MSG_RETURN_TYPES,
327 ASL_MSG_NOT_FOUND,
328 ASL_MSG_NOT_REACHABLE,
329 ASL_MSG_NOT_EXIST,
330 ASL_MSG_NESTED_COMMENT,
331 ASL_MSG_RESERVED_ARG_COUNT_HI,
332 ASL_MSG_RESERVED_ARG_COUNT_LO,
333 ASL_MSG_RESERVED_RETURN_VALUE,
334 ASL_MSG_ARG_COUNT_HI,
335 ASL_MSG_ARG_COUNT_LO,
336 ASL_MSG_NO_RETVAL,
337 ASL_MSG_SOME_NO_RETVAL,
338 ASL_MSG_COMPILER_INTERNAL,
339 ASL_MSG_BACKWARDS_OFFSET,
340 ASL_MSG_UNKNOWN_RESERVED_NAME,
341 ASL_MSG_NAME_EXISTS,
342 ASL_MSG_INVALID_TYPE,
343 ASL_MSG_MULTIPLE_TYPES,
344 ASL_MSG_SYNTAX,
345 ASL_MSG_NOT_METHOD,
346 ASL_MSG_LONG_LINE,
347 ASL_MSG_RECURSION,
348 ASL_MSG_NOT_PARAMETER,
349 ASL_MSG_OPEN,
350 ASL_MSG_READ,
351 ASL_MSG_WRITE,
352 ASL_MSG_SEEK,
353 ASL_MSG_CLOSE,
354 ASL_MSG_FIELD_ACCESS_WIDTH,
355 ASL_MSG_REGION_BYTE_ACCESS,
356 ASL_MSG_REGION_BUFFER_ACCESS,
357 ASL_MSG_FIELD_UNIT_OFFSET,
358 ASL_MSG_FIELD_UNIT_ACCESS_WIDTH,
359 ASL_MSG_RESOURCE_FIELD,
360 ASL_MSG_BYTES_TO_BITS,
361 ASL_MSG_BITS_TO_BYTES,
362 ASL_MSG_AML_NOT_IMPLEMENTED,
363 ASL_MSG_NO_WHILE,
364 ASL_MSG_INVALID_ESCAPE,
365 ASL_MSG_INVALID_STRING,
366 ASL_MSG_TABLE_SIGNATURE,
367 ASL_MSG_RESOURCE_LIST,
368 ASL_MSG_INVALID_TARGET,
369 ASL_MSG_INVALID_CONSTANT_OP,
370 ASL_MSG_CONSTANT_EVALUATION,
371 ASL_MSG_CONSTANT_FOLDED,
372 ASL_MSG_INVALID_EISAID,
373 ASL_MSG_RESERVED_OPERAND_TYPE,
374 ASL_MSG_RESERVED_METHOD,
375 ASL_MSG_ALPHANUMERIC_STRING,
376 ASL_MSG_RESERVED_USE,
377 ASL_MSG_INVALID_OPERAND,
378 ASL_MSG_MISSING_ENDDEPENDENT,
379 ASL_MSG_MISSING_STARTDEPENDENT,
380 ASL_MSG_DEPENDENT_NESTING,
381 ASL_MSG_NAME_OPTIMIZATION,
382 ASL_MSG_SINGLE_NAME_OPTIMIZATION,
383 ASL_MSG_INTEGER_OPTIMIZATION,
384 ASL_MSG_SCOPE_TYPE,
385 ASL_MSG_CORE_EXCEPTION,
386 ASL_MSG_UNREACHABLE_CODE,
387 ASL_MSG_EARLY_EOF,
388 ASL_MSG_SCOPE_FWD_REF,
389 ASL_MSG_NON_ASCII,
390 ASL_MSG_INVALID_TIME
391
392} ASL_MESSAGE_IDS;
393
394#ifdef ASL_EXCEPTIONS
395
396char *AslMessages [] = {
397/* ASL_MSG_NULL */ NULL,
398/* ASL_MSG_MEMORY_ALLOCATION, */ "Memory allocation failure",
399/* ASL_MSG_INPUT_FILE_OPEN, */ "Could not open input file",
400/* ASL_MSG_OUTPUT_FILENAME, */ "Could not create output filename",
401/* ASL_MSG_OUTPUT_FILE_OPEN, */ "Could not open output AML file",
402/* ASL_MSG_LISTING_FILENAME, */ "Could not create listing filename",
403/* ASL_MSG_LISTING_FILE_OPEN, */ "Could not open listing file",
404/* ASL_MSG_DEBUG_FILENAME, */ "Could not create debug filename",
405/* ASL_MSG_DEBUG_FILE_OPEN, */ "Could not open debug file",
406/* ASL_MSG_INCLUDE_FILE_OPEN, */ "Could not open include file",
407/* ASL_MSG_ENCODING_LENGTH, */ "Package length too long to encode",
408/* ASL_MSG_INVALID_PRIORITY, */ "Invalid priority value",
409/* ASL_MSG_INVALID_PERFORMANCE, */ "Invalid performance/robustness value",
410/* ASL_MSG_LOCAL_INIT, */ "Method local variable is not initialized",
411/* ASL_MSG_ARG_INIT, */ "Method argument is not initialized",
412/* ASL_MSG_UNSUPPORTED, */ "Unsupported feature",
413/* ASL_MSG_RESERVED_WORD, */ "Use of reserved word",
414/* ASL_MSG_BUFFER_LENGTH, */ "Effective AML buffer length is zero",
415/* ASL_MSG_PACKAGE_LENGTH, */ "Effective AML package length is zero",
416/* ASL_MSG_RETURN_TYPES, */ "Not all control paths return a value",
417/* ASL_MSG_NOT_FOUND, */ "Object not found or not accessible from scope",
418/* ASL_MSG_NOT_REACHABLE, */ "Object not accessible from this scope",
419/* ASL_MSG_NOT_EXIST, */ "Object does not exist",
420/* ASL_MSG_NESTED_COMMENT, */ "Nested comment found",
421/* ASL_MSG_RESERVED_ARG_COUNT_HI, */ "Reserved method has too many arguments",
422/* ASL_MSG_RESERVED_ARG_COUNT_LO, */ "Reserved method has too few arguments",
423/* ASL_MSG_RESERVED_RETURN_VALUE, */ "Reserved method must return a value",
424/* ASL_MSG_ARG_COUNT_HI, */ "Too many arguments",
425/* ASL_MSG_ARG_COUNT_LO, */ "Too few arguments",
426/* ASL_MSG_NO_RETVAL, */ "Called method returns no value",
427/* ASL_MSG_SOME_NO_RETVAL, */ "Called method may not always return a value",
428/* ASL_MSG_COMPILER_INTERNAL, */ "Internal compiler error",
429/* ASL_MSG_BACKWARDS_OFFSET, */ "Invalid backwards offset",
430/* ASL_MSG_UNKNOWN_RESERVED_NAME, */ "Unknown reserved name",
431/* ASL_MSG_NAME_EXISTS, */ "Name already exists in scope",
432/* ASL_MSG_INVALID_TYPE, */ "Invalid type",
433/* ASL_MSG_MULTIPLE_TYPES, */ "Multiple types",
434/* ASL_MSG_SYNTAX, */ "",
435/* ASL_MSG_NOT_METHOD, */ "Not a control method, cannot invoke",
436/* ASL_MSG_LONG_LINE, */ "Splitting long input line",
437/* ASL_MSG_RECURSION, */ "Recursive method call",
438/* ASL_MSG_NOT_PARAMETER, */ "Not a parameter, used as local only",
439/* ASL_MSG_OPEN, */ "Could not open file",
440/* ASL_MSG_READ, */ "Could not read file",
441/* ASL_MSG_WRITE, */ "Could not write file",
442/* ASL_MSG_SEEK, */ "Could not seek file",
443/* ASL_MSG_CLOSE, */ "Could not close file",
444/* ASL_MSG_FIELD_ACCESS_WIDTH, */ "Access width is greater than region size",
445/* ASL_MSG_REGION_BYTE_ACCESS, */ "Host Operation Region requires ByteAcc access",
446/* ASL_MSG_REGION_BUFFER_ACCESS, */ "Host Operation Region requires BufferAcc access",
447/* ASL_MSG_FIELD_UNIT_OFFSET, */ "Field Unit extends beyond region limit",
448/* ASL_MSG_FIELD_UNIT_ACCESS_WIDTH, */ "Access width of Field Unit extends beyond region limit",
449/* ASL_MSG_RESOURCE_FIELD, */ "Resource field name cannot be used as a target",
450/* ASL_MSG_BYTES_TO_BITS, */ "Field offset is in bytes, but a bit offset is required",
451/* ASL_MSG_BITS_TO_BYTES, */ "Field offset is in bits, but a byte offset is required",
452/* ASL_MSG_AML_NOT_IMPLEMENTED, */ "Opcode is not implemented in compiler AML code generator",
453/* ASL_MSG_NO_WHILE, */ "No enclosing While statement",
454/* ASL_MSG_INVALID_ESCAPE, */ "Invalid or unknown escape sequence",
455/* ASL_MSG_INVALID_STRING, */ "Invalid Hex/Octal Escape - Non-ASCII or NULL",
456/* ASL_MSG_TABLE_SIGNATURE, */ "Invalid Table Signature",
457/* ASL_MSG_RESOURCE_LIST, */ "Too many resource items (internal error)",
458/* ASL_MSG_INVALID_TARGET, */ "Target operand not allowed in constant expression",
459/* ASL_MSG_INVALID_CONSTANT_OP, */ "Invalid operator in constant expression (not type 3/4/5)",
460/* ASL_MSG_CONSTANT_EVALUATION, */ "Could not evaluate constant expression",
461/* ASL_MSG_CONSTANT_FOLDED, */ "Constant expression evaluated and reduced",
462/* ASL_MSG_INVALID_EISAID, */ "EISAID string must be of the form \"UUUXXXX\" (3 uppercase, 4 hex digits)",
463/* ASL_MSG_RESERVED_OPERAND_TYPE, */ "Invalid operand type for reserved name, must be",
464/* ASL_MSG_RESERVED_METHOD, */ "Reserved name must be a control method",
465/* ASL_MSG_ALPHANUMERIC_STRING, */ "String must be entirely alphanumeric",
466/* ASL_MSG_RESERVED_USE, */ "Invalid use of reserved name",
467/* ASL_MSG_INVALID_OPERAND, */ "Invalid operand",
468/* ASL_MSG_MISSING_ENDDEPENDENT, */ "Missing EndDependentFn() macro in dependent resource list",
469/* ASL_MSG_MISSING_STARTDEPENDENT, */ "Missing StartDependentFn() macro in dependent resource list",
470/* ASL_MSG_DEPENDENT_NESTING, */ "Dependent function macros cannot be nested",\
471/* ASL_MSG_NAME_OPTIMIZATION, */ "NamePath optimized",
472/* ASL_MSG_SINGLE_NAME_OPTIMIZATION, */ "NamePath optimized to NameSeg (uses run-time search path)",
473/* ASL_MSG_INTEGER_OPTIMIZATION, */ "Integer optimized to single-byte AML opcode",
474/* ASL_MSG_SCOPE_TYPE, */ "Existing object has invalid type for Scope operator",
475/* ASL_MSG_CORE_EXCEPTION, */ "From ACPI CA Subsystem",
476/* ASL_MSG_UNREACHABLE_CODE, */ "Statement is unreachable",
477/* ASL_MSG_EARLY_EOF */ "Premature end-of-file reached",
478/* ASL_MSG_SCOPE_FWD_REF */ "Forward references from Scope() not allowed",
479/* ASL_MSG_NON_ASCII */ "Invalid characters found in file",
480/* ASL_MSG_INVALID_TIME */ "Time parameter too long (255 max)"
481
482};
483
484
485char *AslErrorLevel [ASL_NUM_REPORT_LEVELS] = {
486 "Error ",
487 "Warning ",
488 "Remark ",
489 "Optimize"
490};
491
492#define ASL_ERROR_LEVEL_LENGTH 8 /* Length of strings above */
493
494/* Exception counters */
495
496UINT32 Gbl_ExceptionCount[ASL_NUM_REPORT_LEVELS] = {0,0,0,0};
497
498#endif
499
500
501#endif /* __ASLTYPES_H */
|