1 /******************************************************************************
3 * Module Name: asldefine.h - Common defines for the iASL compiler
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
49 * Compiler versions and names
51 #define ASL_COMPILER_NAME "ASL+ Optimizing Compiler/Disassembler"
52 #define AML_DISASSEMBLER_NAME "AML/ASL+ Disassembler"
53 #define ASL_INVOCATION_NAME "iasl"
54 #define ASL_CREATOR_ID "INTL"
55 #define ASL_DEFINE "__IASL__"
57 #define ASL_COMPLIANCE "Supports ACPI Specification Revision 6.1"
60 /* Configuration constants */
62 #define ASL_MAX_ERROR_COUNT 200
63 #define ASL_PARSEOP_CACHE_SIZE (1024 * 16)
64 #define ASL_STRING_CACHE_SIZE (1024 * 64)
66 #define ASL_FIRST_PARSE_OPCODE PARSEOP_ACCESSAS
67 #define ASL_PARSE_OPCODE_BASE PARSEOP_ACCESSAS /* First Lex type */
71 * Per-parser-generator configuration. These values are used to cheat and
72 * directly access the bison/yacc token name table (yyname or yytname).
73 * Note: These values are the index in yyname for the first lex token
74 * (PARSEOP_ACCCESSAS).
77 #define ASL_YYTNAME_START 3 /* Bison */
78 #elif defined (YYBYACC)
79 #define ASL_YYTNAME_START 257 /* Berkeley yacc */
86 #define ASL_RESDESC_OFFSET(m) ACPI_OFFSET (AML_RESOURCE, m)
87 #define ASL_PTR_DIFF(a,b) ((UINT8 *)(b) - (UINT8 *)(a))
88 #define ASL_PTR_ADD(a,b) ((UINT8 *)(a) = ((UINT8 *)(a) + (b)))
89 #define ASL_GET_CHILD_NODE(a) (a)->Asl.Child
90 #define ASL_GET_PEER_NODE(a) (a)->Asl.Next
91 #define OP_TABLE_ENTRY(a,b,c,d) {b,d,a,c}
94 /* Internal AML opcodes */
96 #define AML_RAW_DATA_BYTE (UINT16) 0xAA01 /* write one raw byte */
97 #define AML_RAW_DATA_WORD (UINT16) 0xAA02 /* write 2 raw bytes */
98 #define AML_RAW_DATA_DWORD (UINT16) 0xAA04 /* write 4 raw bytes */
99 #define AML_RAW_DATA_QWORD (UINT16) 0xAA08 /* write 8 raw bytes */
100 #define AML_RAW_DATA_BUFFER (UINT16) 0xAA0B /* raw buffer with length */
101 #define AML_RAW_DATA_CHAIN (UINT16) 0xAA0C /* chain of raw buffers */
102 #define AML_PACKAGE_LENGTH (UINT16) 0xAA10
103 #define AML_UNASSIGNED_OPCODE (UINT16) 0xEEEE
104 #define AML_DEFAULT_ARG_OP (UINT16) 0xDDDD
107 /* Types for input files */
109 #define ASL_INPUT_TYPE_BINARY 0
110 #define ASL_INPUT_TYPE_BINARY_ACPI_TABLE 1
111 #define ASL_INPUT_TYPE_ASCII_ASL 2
112 #define ASL_INPUT_TYPE_ASCII_DATA 3
117 #define ASL_EXTERNAL_METHOD 255
118 #define ASL_ABORT TRUE
119 #define ASL_NO_ABORT FALSE
120 #define ASL_EOF ACPI_UINT32_MAX
121 #define ASL_IGNORE_LINE (ACPI_UINT32_MAX -1)
126 #define ASL_LISTING_LINE_PREFIX ": "
129 /* Support for reserved method names */
131 #define ACPI_VALID_RESERVED_NAME_MAX 0x80000000
132 #define ACPI_NOT_RESERVED_NAME ACPI_UINT32_MAX
133 #define ACPI_PREDEFINED_NAME (ACPI_UINT32_MAX - 1)
134 #define ACPI_EVENT_RESERVED_NAME (ACPI_UINT32_MAX - 2)
135 #define ACPI_COMPILER_RESERVED_NAME (ACPI_UINT32_MAX - 3)
138 /* Helper macros for resource tag creation */
140 #define RsCreateMultiBitField \
141 RsCreateResourceField
143 #define RsCreateBitField(Op, Name, ByteOffset, BitOffset) \
144 RsCreateResourceField (Op, Name, ByteOffset, BitOffset, 1)
146 #define RsCreateByteField(Op, Name, ByteOffset) \
147 RsCreateResourceField (Op, Name, ByteOffset, 0, 8);
149 #define RsCreateWordField(Op, Name, ByteOffset) \
150 RsCreateResourceField (Op, Name, ByteOffset, 0, 16);
152 #define RsCreateDwordField(Op, Name, ByteOffset) \
153 RsCreateResourceField (Op, Name, ByteOffset, 0, 32);
155 #define RsCreateQwordField(Op, Name, ByteOffset) \
156 RsCreateResourceField (Op, Name, ByteOffset, 0, 64);
160 * Macros for debug output
163 #define DEBUG_MAX_LINE_LENGTH 61
164 #define DEBUG_SPACES_PER_INDENT 3
165 #define DEBUG_FULL_LINE_LENGTH 71
167 #define ASL_PARSE_TREE_FULL_LINE "\n%71.71s"
169 /* Header/Trailer for original parse tree directly from the parser */
171 #define ASL_PARSE_TREE_HEADER1 \
172 "%*s Value P_Op Flags Line# End# LogL# EndL#\n", 65, " "
174 #define ASL_PARSE_TREE_DEBUG1 \
175 " %4.4X %8.8X %5d %5d %5d %5d"
177 /* Header/Trailer for processed parse tree used for AML generation */
179 #define ASL_PARSE_TREE_HEADER2 \
180 "%*s NameString Value P_Op A_Op OpLen PByts Len SubLen PSubLen OpPtr"\
181 " Parent Child Next Flags AcTyp Final Col"\
182 " Line# End# LogL# EndL#\n", 60, " "
184 #define ASL_PARSE_TREE_DEBUG2 \
185 " %08X %04X %04X %01X %04X %04X %05X %05X "\
186 "%08X %08X %08X %08X %08X %08X %04X %02d %5d %5d %5d %5d\n"
188 #endif /* ASLDEFINE.H */