2 /******************************************************************************
4 * Module Name: asltypes.h - compiler data types and struct definitions
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
14 * All rights reserved.
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
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
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;
39 * The above copyright and patent license is granted only if the following
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.
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
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
74 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
82 * 4. Disclaimer and Export Compliance
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
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
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.
116 *****************************************************************************/
123 /*******************************************************************************
125 * Structure definitions
127 ******************************************************************************/
130 /* Op flags for the ACPI_PARSE_OBJECT */
132 #define NODE_VISITED 0x00000001
133 #define NODE_AML_PACKAGE 0x00000002
134 #define NODE_IS_TARGET 0x00000004
135 #define NODE_IS_RESOURCE_DESC 0x00000008
136 #define NODE_IS_RESOURCE_FIELD 0x00000010
137 #define NODE_HAS_NO_EXIT 0x00000020
138 #define NODE_IF_HAS_NO_EXIT 0x00000040
139 #define NODE_NAME_INTERNALIZED 0x00000080
140 #define NODE_METHOD_NO_RETVAL 0x00000100
141 #define NODE_METHOD_SOME_NO_RETVAL 0x00000200
142 #define NODE_RESULT_NOT_USED 0x00000400
143 #define NODE_METHOD_TYPED 0x00000800
144 #define NODE_IS_BIT_OFFSET 0x00001000
145 #define NODE_COMPILE_TIME_CONST 0x00002000
146 #define NODE_IS_TERM_ARG 0x00004000
147 #define NODE_WAS_ONES_OP 0x00008000
148 #define NODE_IS_NAME_DECLARATION 0x00010000
149 #define NODE_COMPILER_EMITTED 0x00020000
150 #define NODE_IS_DUPLICATE 0x00040000
152 /* Keeps information about individual control methods */
154 typedef struct asl_method_info
157 UINT8 LocalInitialized[ACPI_METHOD_NUM_LOCALS];
158 UINT8 ArgInitialized[ACPI_METHOD_NUM_ARGS];
159 UINT32 ValidArgTypes[ACPI_METHOD_NUM_ARGS];
160 UINT32 ValidReturnTypes;
161 UINT32 NumReturnNoValue;
162 UINT32 NumReturnWithValue;
163 ACPI_PARSE_OBJECT *Op;
164 struct asl_method_info *Next;
170 /* Parse tree walk info for control method analysis */
172 typedef struct asl_analysis_walk_info
174 ASL_METHOD_INFO *MethodStack;
176 } ASL_ANALYSIS_WALK_INFO;
179 /* An entry in the ParseOpcode to AmlOpcode mapping table */
181 typedef struct asl_mapping_entry
184 UINT32 AcpiBtype; /* Object type or return type */
191 /* An entry in the Reserved Name information table */
193 #define ASL_RSVD_RETURN_VALUE 0x01
194 #define ASL_RSVD_RESOURCE_NAME 0x02
195 #define ASL_RSVD_SCOPE 0x04
197 typedef struct asl_reserved_info
206 /* Parse tree walk info structure */
208 typedef struct asl_walk_info
210 ACPI_PARSE_OBJECT **NodePtr;
218 typedef struct asl_file_info
234 ASL_FILE_SOURCE_OUTPUT,
235 ASL_FILE_LISTING_OUTPUT,
237 ASL_FILE_NAMESPACE_OUTPUT,
238 ASL_FILE_DEBUG_OUTPUT,
239 ASL_FILE_ASM_SOURCE_OUTPUT,
240 ASL_FILE_C_SOURCE_OUTPUT,
241 ASL_FILE_ASM_INCLUDE_OUTPUT,
242 ASL_FILE_C_INCLUDE_OUTPUT
247 #define ASL_MAX_FILE_TYPE 12
248 #define ASL_NUM_FILES (ASL_MAX_FILE_TYPE + 1)
251 /* An entry in the exception list, one for each error/warning */
253 typedef struct asl_error_msg
256 UINT32 LogicalLineNumber;
257 UINT32 LogicalByteOffset;
260 struct asl_error_msg *Next;
262 UINT32 FilenameLength;
269 /* An entry in the listing file stack (for include files) */
271 typedef struct asl_listing_node
275 struct asl_listing_node *Next;
280 /* Callback interface for a parse tree walk */
283 ACPI_STATUS (*ASL_WALK_CALLBACK) (
284 ACPI_PARSE_OBJECT *Op,
289 typedef struct asl_event_info
300 #define ASL_WARNING 1
302 #define ASL_OPTIMIZATION 3
303 #define ASL_NUM_REPORT_LEVELS 4
308 ASL_MSG_ALPHANUMERIC_STRING,
309 ASL_MSG_AML_NOT_IMPLEMENTED,
310 ASL_MSG_ARG_COUNT_HI,
311 ASL_MSG_ARG_COUNT_LO,
313 ASL_MSG_BACKWARDS_OFFSET,
314 ASL_MSG_BITS_TO_BYTES,
315 ASL_MSG_BUFFER_LENGTH,
316 ASL_MSG_BYTES_TO_BITS,
318 ASL_MSG_COMPILER_INTERNAL,
319 ASL_MSG_CONSTANT_EVALUATION,
320 ASL_MSG_CONSTANT_FOLDED,
321 ASL_MSG_CORE_EXCEPTION,
322 ASL_MSG_DEBUG_FILE_OPEN,
323 ASL_MSG_DEBUG_FILENAME,
324 ASL_MSG_DEPENDENT_NESTING,
327 ASL_MSG_DUPLICATE_CASE,
328 ASL_MSG_DUPLICATE_ITEM,
330 ASL_MSG_ENCODING_LENGTH,
331 ASL_MSG_EX_INTERRUPT_LIST,
332 ASL_MSG_EX_INTERRUPT_NUMBER,
333 ASL_MSG_FIELD_ACCESS_WIDTH,
334 ASL_MSG_FIELD_UNIT_ACCESS_WIDTH,
335 ASL_MSG_FIELD_UNIT_OFFSET,
336 ASL_MSG_INCLUDE_FILE_OPEN,
337 ASL_MSG_INPUT_FILE_OPEN,
338 ASL_MSG_INTEGER_LENGTH,
339 ASL_MSG_INTEGER_OPTIMIZATION,
340 ASL_MSG_INTERRUPT_LIST,
341 ASL_MSG_INTERRUPT_NUMBER,
342 ASL_MSG_INVALID_CONSTANT_OP,
343 ASL_MSG_INVALID_EISAID,
344 ASL_MSG_INVALID_ESCAPE,
345 ASL_MSG_INVALID_OPERAND,
346 ASL_MSG_INVALID_PERFORMANCE,
347 ASL_MSG_INVALID_PRIORITY,
348 ASL_MSG_INVALID_STRING,
349 ASL_MSG_INVALID_TARGET,
350 ASL_MSG_INVALID_TIME,
351 ASL_MSG_INVALID_TYPE,
352 ASL_MSG_INVALID_UUID,
354 ASL_MSG_LISTING_FILE_OPEN,
355 ASL_MSG_LISTING_FILENAME,
358 ASL_MSG_MEMORY_ALLOCATION,
359 ASL_MSG_MISSING_ENDDEPENDENT,
360 ASL_MSG_MISSING_STARTDEPENDENT,
361 ASL_MSG_MULTIPLE_TYPES,
363 ASL_MSG_NAME_OPTIMIZATION,
364 ASL_MSG_NESTED_COMMENT,
372 ASL_MSG_NOT_PARAMETER,
373 ASL_MSG_NOT_REACHABLE,
375 ASL_MSG_OUTPUT_FILE_OPEN,
376 ASL_MSG_OUTPUT_FILENAME,
377 ASL_MSG_PACKAGE_LENGTH,
380 ASL_MSG_REGION_BUFFER_ACCESS,
381 ASL_MSG_REGION_BYTE_ACCESS,
382 ASL_MSG_RESERVED_ARG_COUNT_HI,
383 ASL_MSG_RESERVED_ARG_COUNT_LO,
384 ASL_MSG_RESERVED_METHOD,
385 ASL_MSG_RESERVED_OPERAND_TYPE,
386 ASL_MSG_RESERVED_RETURN_VALUE,
387 ASL_MSG_RESERVED_USE,
388 ASL_MSG_RESERVED_WORD,
389 ASL_MSG_RESOURCE_FIELD,
390 ASL_MSG_RESOURCE_INDEX,
391 ASL_MSG_RESOURCE_LIST,
392 ASL_MSG_RESOURCE_SOURCE,
393 ASL_MSG_RETURN_TYPES,
394 ASL_MSG_SCOPE_FWD_REF,
397 ASL_MSG_SINGLE_NAME_OPTIMIZATION,
398 ASL_MSG_SOME_NO_RETVAL,
399 ASL_MSG_STRING_LENGTH,
403 ASL_MSG_TABLE_SIGNATURE,
404 ASL_MSG_TOO_MANY_TEMPS,
405 ASL_MSG_UNKNOWN_RESERVED_NAME,
406 ASL_MSG_UNREACHABLE_CODE,
413 #ifdef ASL_EXCEPTIONS
415 char *AslMessages [] = {
416 /* ASL_MSG_ALPHANUMERIC_STRING */ "String must be entirely alphanumeric",
417 /* ASL_MSG_AML_NOT_IMPLEMENTED */ "Opcode is not implemented in compiler AML code generator",
418 /* ASL_MSG_ARG_COUNT_HI */ "Too many arguments",
419 /* ASL_MSG_ARG_COUNT_LO */ "Too few arguments",
420 /* ASL_MSG_ARG_INIT */ "Method argument is not initialized",
421 /* ASL_MSG_BACKWARDS_OFFSET */ "Invalid backwards offset",
422 /* ASL_MSG_BITS_TO_BYTES */ "Field offset is in bits, but a byte offset is required",
423 /* ASL_MSG_BUFFER_LENGTH */ "Effective AML buffer length is zero",
424 /* ASL_MSG_BYTES_TO_BITS */ "Field offset is in bytes, but a bit offset is required",
425 /* ASL_MSG_CLOSE */ "Could not close file",
426 /* ASL_MSG_COMPILER_INTERNAL */ "Internal compiler error",
427 /* ASL_MSG_CONSTANT_EVALUATION */ "Could not evaluate constant expression",
428 /* ASL_MSG_CONSTANT_FOLDED */ "Constant expression evaluated and reduced",
429 /* ASL_MSG_CORE_EXCEPTION */ "From ACPI CA Subsystem",
430 /* ASL_MSG_DEBUG_FILE_OPEN */ "Could not open debug file",
431 /* ASL_MSG_DEBUG_FILENAME */ "Could not create debug filename",
432 /* ASL_MSG_DEPENDENT_NESTING */ "Dependent function macros cannot be nested",\
433 /* ASL_MSG_DMA_CHANNEL */ "Invalid DMA channel (must be 0-7)",
434 /* ASL_MSG_DMA_LIST */ "Too many DMA channels (8 max)",
435 /* ASL_MSG_DUPLICATE_CASE */ "Case value already specified",
436 /* ASL_MSG_DUPLICATE_ITEM */ "Duplicate value in list",
437 /* ASL_MSG_EARLY_EOF */ "Premature end-of-file reached",
438 /* ASL_MSG_ENCODING_LENGTH */ "Package length too long to encode",
439 /* ASL_MSG_EX_INTERRUPT_LIST */ "Too many interrupts (255 max)",
440 /* ASL_MSG_EX_INTERRUPT_NUMBER */ "Invalid interrupt number (must be 32 bits)",
441 /* ASL_MSG_FIELD_ACCESS_WIDTH */ "Access width is greater than region size",
442 /* ASL_MSG_FIELD_UNIT_ACCESS_WIDTH */ "Access width of Field Unit extends beyond region limit",
443 /* ASL_MSG_FIELD_UNIT_OFFSET */ "Field Unit extends beyond region limit",
444 /* ASL_MSG_INCLUDE_FILE_OPEN */ "Could not open include file",
445 /* ASL_MSG_INPUT_FILE_OPEN */ "Could not open input file",
446 /* ASL_MSG_INTEGER_LENGTH */ "64-bit integer in 32-bit table, truncating",
447 /* ASL_MSG_INTEGER_OPTIMIZATION */ "Integer optimized to single-byte AML opcode",
448 /* ASL_MSG_INTERRUPT_LIST */ "Too many interrupts (16 max)",
449 /* ASL_MSG_INTERRUPT_NUMBER */ "Invalid interrupt number (must be 0-15)",
450 /* ASL_MSG_INVALID_CONSTANT_OP */ "Invalid operator in constant expression (not type 3/4/5)",
451 /* ASL_MSG_INVALID_EISAID */ "EISAID string must be of the form \"UUUXXXX\" (3 uppercase, 4 hex digits)",
452 /* ASL_MSG_INVALID_ESCAPE */ "Invalid or unknown escape sequence",
453 /* ASL_MSG_INVALID_OPERAND */ "Invalid operand",
454 /* ASL_MSG_INVALID_PERFORMANCE */ "Invalid performance/robustness value",
455 /* ASL_MSG_INVALID_PRIORITY */ "Invalid priority value",
456 /* ASL_MSG_INVALID_STRING */ "Invalid Hex/Octal Escape - Non-ASCII or NULL",
457 /* ASL_MSG_INVALID_TARGET */ "Target operand not allowed in constant expression",
458 /* ASL_MSG_INVALID_TIME */ "Time parameter too long (255 max)",
459 /* ASL_MSG_INVALID_TYPE */ "Invalid type",
460 /* ASL_MSG_INVALID_UUID */ "UUID string must be of the form \"aabbccdd-eeff-gghh-iijj-kkllmmnnoopp\"",
461 /* ASL_MSG_LIST_LENGTH */ "Initializer list too long",
462 /* ASL_MSG_LISTING_FILE_OPEN */ "Could not open listing file",
463 /* ASL_MSG_LISTING_FILENAME */ "Could not create listing filename",
464 /* ASL_MSG_LOCAL_INIT */ "Method local variable is not initialized",
465 /* ASL_MSG_LONG_LINE */ "Splitting long input line",
466 /* ASL_MSG_MEMORY_ALLOCATION */ "Memory allocation failure",
467 /* ASL_MSG_MISSING_ENDDEPENDENT */ "Missing EndDependentFn() macro in dependent resource list",
468 /* ASL_MSG_MISSING_STARTDEPENDENT */ "Missing StartDependentFn() macro in dependent resource list",
469 /* ASL_MSG_MULTIPLE_TYPES */ "Multiple types",
470 /* ASL_MSG_NAME_EXISTS */ "Name already exists in scope",
471 /* ASL_MSG_NAME_OPTIMIZATION */ "NamePath optimized",
472 /* ASL_MSG_NESTED_COMMENT */ "Nested comment found",
473 /* ASL_MSG_NO_CASES */ "No Case() statements under Switch()",
474 /* ASL_MSG_NO_RETVAL */ "Called method returns no value",
475 /* ASL_MSG_NO_WHILE */ "No enclosing While statement",
476 /* ASL_MSG_NON_ASCII */ "Invalid characters found in file",
477 /* ASL_MSG_NOT_EXIST */ "Object does not exist",
478 /* ASL_MSG_NOT_FOUND */ "Object not found or not accessible from scope",
479 /* ASL_MSG_NOT_METHOD */ "Not a control method, cannot invoke",
480 /* ASL_MSG_NOT_PARAMETER */ "Not a parameter, used as local only",
481 /* ASL_MSG_NOT_REACHABLE */ "Object not accessible from this scope",
482 /* ASL_MSG_OPEN */ "Could not open file",
483 /* ASL_MSG_OUTPUT_FILE_OPEN */ "Could not open output AML file",
484 /* ASL_MSG_OUTPUT_FILENAME */ "Could not create output filename",
485 /* ASL_MSG_PACKAGE_LENGTH */ "Effective AML package length is zero",
486 /* ASL_MSG_READ */ "Could not read file",
487 /* ASL_MSG_RECURSION */ "Recursive method call",
488 /* ASL_MSG_REGION_BUFFER_ACCESS */ "Host Operation Region requires BufferAcc access",
489 /* ASL_MSG_REGION_BYTE_ACCESS */ "Host Operation Region requires ByteAcc access",
490 /* ASL_MSG_RESERVED_ARG_COUNT_HI */ "Reserved method has too many arguments",
491 /* ASL_MSG_RESERVED_ARG_COUNT_LO */ "Reserved method has too few arguments",
492 /* ASL_MSG_RESERVED_METHOD */ "Reserved name must be a control method",
493 /* ASL_MSG_RESERVED_OPERAND_TYPE */ "Invalid operand type for reserved name, must be",
494 /* ASL_MSG_RESERVED_RETURN_VALUE */ "Reserved method must return a value",
495 /* ASL_MSG_RESERVED_USE */ "Invalid use of reserved name",
496 /* ASL_MSG_RESERVED_WORD */ "Use of reserved word",
497 /* ASL_MSG_RESOURCE_FIELD */ "Resource field name cannot be used as a target",
498 /* ASL_MSG_RESOURCE_INDEX */ "Missing ResourceSourceIndex (required)",
499 /* ASL_MSG_RESOURCE_LIST */ "Too many resource items (internal error)",
500 /* ASL_MSG_RESOURCE_SOURCE */ "Missing ResourceSource string (required)",
501 /* ASL_MSG_RETURN_TYPES */ "Not all control paths return a value",
502 /* ASL_MSG_SCOPE_FWD_REF */ "Forward references from Scope() not allowed",
503 /* ASL_MSG_SCOPE_TYPE */ "Existing object has invalid type for Scope operator",
504 /* ASL_MSG_SEEK */ "Could not seek file",
505 /* ASL_MSG_SINGLE_NAME_OPTIMIZATION */ "NamePath optimized to NameSeg (uses run-time search path)",
506 /* ASL_MSG_SOME_NO_RETVAL */ "Called method may not always return a value",
507 /* ASL_MSG_STRING_LENGTH */ "String constant too long (200 max)",
508 /* ASL_MSG_SWITCH_TYPE */ "Switch expression is not a static Integer/Buffer/String data type, defaulting to Integer",
509 /* ASL_MSG_SYNC_LEVEL */ "SyncLevel must be in the range 0-15",
510 /* ASL_MSG_SYNTAX */ "",
511 /* ASL_MSG_TABLE_SIGNATURE */ "Invalid Table Signature",
512 /* ASL_MSG_TOO_MANY_TEMPS */ "Method requires too many temporary variables (_T_x)",
513 /* ASL_MSG_UNKNOWN_RESERVED_NAME */ "Unknown reserved name",
514 /* ASL_MSG_UNREACHABLE_CODE */ "Statement is unreachable",
515 /* ASL_MSG_UNSUPPORTED */ "Unsupported feature",
516 /* ASL_MSG_VENDOR_LIST */ "Too many vendor data bytes (7 max)",
517 /* ASL_MSG_WRITE */ "Could not write file"
522 char *AslErrorLevel [ASL_NUM_REPORT_LEVELS] = {
529 #define ASL_ERROR_LEVEL_LENGTH 8 /* Length of strings above */
531 /* Exception counters */
533 UINT32 Gbl_ExceptionCount[ASL_NUM_REPORT_LEVELS] = {0,0,0,0};
538 #endif /* __ASLTYPES_H */