xref: /illumos-gate/usr/src/cmd/acpi/iasl/asldefine.h (revision 35786f6866ae52207d0f1a25fe7ca5f652f32ce0)
1 /******************************************************************************
2  *
3  * Module Name: asldefine.h - Common defines for the iASL compiler
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #ifndef __ASLDEFINE_H
153 #define __ASLDEFINE_H
154 
155 
156 /*
157  * Compiler versions and names
158  */
159 #define ASL_COMPILER_NAME           "ASL+ Optimizing Compiler/Disassembler"
160 #define AML_DISASSEMBLER_NAME       "AML/ASL+ Disassembler"
161 #define ASL_INVOCATION_NAME         "iasl"
162 #define ASL_CREATOR_ID              "INTL"
163 #define ASL_DEFINE                  "__IASL__"
164 #define ASL_PREFIX                  "iASL: "
165 #define ASL_COMPLIANCE              "Supports ACPI Specification Revision 6.2A"
166 
167 
168 /* Configuration constants */
169 
170 #define ASL_MAX_ERROR_COUNT         200
171 #define ASL_PARSEOP_CACHE_SIZE      (1024 * 16)
172 #define ASL_STRING_CACHE_SIZE       (1024 * 64)
173 
174 #define ASL_FIRST_PARSE_OPCODE      PARSEOP_ACCESSAS
175 #define ASL_PARSE_OPCODE_BASE       PARSEOP_ACCESSAS        /* First Lex type */
176 
177 
178 /*
179  * Per-parser-generator configuration. These values are used to cheat and
180  * directly access the bison/yacc token name table (yyname or yytname).
181  * Note: These values are the index in yyname for the first lex token
182  * (PARSEOP_ACCCESSAS).
183  */
184 #if defined (YYBISON)
185 #define ASL_YYTNAME_START           3   /* Bison */
186 #elif defined (YYBYACC)
187 #define ASL_YYTNAME_START           257 /* Berkeley yacc */
188 #endif
189 
190 
191 /*
192  * Macros
193  */
194 #define ASL_RESDESC_OFFSET(m)       ACPI_OFFSET (AML_RESOURCE, m)
195 #define ASL_PTR_DIFF(a,b)           ((UINT8 *)(b) - (UINT8 *)(a))
196 #define ASL_PTR_ADD(a,b)            ((UINT8 *)(a) = ((UINT8 *)(a) + (b)))
197 #define ASL_GET_CHILD_NODE(a)       (a)->Asl.Child
198 #define ASL_GET_PEER_NODE(a)        (a)->Asl.Next
199 #define OP_TABLE_ENTRY(a,b,c,d)     {b,d,a,c}
200 
201 
202 /* Internal AML opcodes */
203 
204 #define AML_RAW_DATA_BYTE           (UINT16) 0xAA01 /* write one raw byte */
205 #define AML_RAW_DATA_WORD           (UINT16) 0xAA02 /* write 2 raw bytes */
206 #define AML_RAW_DATA_DWORD          (UINT16) 0xAA04 /* write 4 raw bytes */
207 #define AML_RAW_DATA_QWORD          (UINT16) 0xAA08 /* write 8 raw bytes */
208 #define AML_RAW_DATA_BUFFER         (UINT16) 0xAA0B /* raw buffer with length */
209 #define AML_RAW_DATA_CHAIN          (UINT16) 0xAA0C /* chain of raw buffers */
210 #define AML_PACKAGE_LENGTH          (UINT16) 0xAA10
211 #define AML_UNASSIGNED_OPCODE       (UINT16) 0xEEEE
212 #define AML_DEFAULT_ARG_OP          (UINT16) 0xDDDD
213 
214 
215 /* Types for input files */
216 
217 #define ASL_INPUT_TYPE_BINARY               0
218 #define ASL_INPUT_TYPE_BINARY_ACPI_TABLE    1
219 #define ASL_INPUT_TYPE_ASCII_ASL            2
220 #define ASL_INPUT_TYPE_ASCII_DATA           3
221 
222 
223 /* Misc */
224 
225 #define ASL_EXTERNAL_METHOD         255
226 #define ASL_ABORT                   TRUE
227 #define ASL_NO_ABORT                FALSE
228 #define ASL_EOF                     ACPI_UINT32_MAX
229 #define ASL_IGNORE_LINE            (ACPI_UINT32_MAX -1)
230 
231 
232 /* Listings */
233 
234 #define ASL_LISTING_LINE_PREFIX         ":  "
235 
236 
237 /* Support for reserved method names */
238 
239 #define ACPI_VALID_RESERVED_NAME_MAX    0x80000000
240 #define ACPI_NOT_RESERVED_NAME          ACPI_UINT32_MAX
241 #define ACPI_PREDEFINED_NAME            (ACPI_UINT32_MAX - 1)
242 #define ACPI_EVENT_RESERVED_NAME        (ACPI_UINT32_MAX - 2)
243 #define ACPI_COMPILER_RESERVED_NAME     (ACPI_UINT32_MAX - 3)
244 
245 
246 /* Helper macros for resource tag creation */
247 
248 #define RsCreateMultiBitField \
249     RsCreateResourceField
250 
251 #define RsCreateBitField(Op, Name, ByteOffset, BitOffset) \
252     RsCreateResourceField (Op, Name, ByteOffset, BitOffset, 1)
253 
254 #define RsCreateByteField(Op, Name, ByteOffset) \
255     RsCreateResourceField (Op, Name, ByteOffset, 0, 8);
256 
257 #define RsCreateWordField(Op, Name, ByteOffset) \
258     RsCreateResourceField (Op, Name, ByteOffset, 0, 16);
259 
260 #define RsCreateDwordField(Op, Name, ByteOffset) \
261     RsCreateResourceField (Op, Name, ByteOffset, 0, 32);
262 
263 #define RsCreateQwordField(Op, Name, ByteOffset) \
264     RsCreateResourceField (Op, Name, ByteOffset, 0, 64);
265 
266 
267 /*
268  * Macros for debug output
269  */
270 #define DEBUG_MAX_LINE_LENGTH       61
271 #define DEBUG_SPACES_PER_INDENT     3
272 #define DEBUG_FULL_LINE_LENGTH      71
273 
274 #define ASL_PARSE_TREE_FULL_LINE    "\n%71.71s"
275 
276 /* Header/Trailer for original parse tree directly from the parser */
277 
278 #define ASL_PARSE_TREE_HEADER1 \
279     "%*s Value P_Op Flags     Line#  End# LogL# EndL#\n", 65, " "
280 
281 #define ASL_PARSE_TREE_DEBUG1 \
282     " %4.4X %8.8X %5d %5d %5d %5d"
283 
284 /* Header/Trailer for processed parse tree used for AML generation */
285 
286 #define ASL_PARSE_TREE_HEADER2 \
287     "%*s NameString Value    P_Op A_Op OpLen PByts Len  SubLen PSubLen OpPtr"\
288     "    Parent   Child    Next     Flags    AcTyp    Final Col"\
289     " Line#  End# LogL# EndL#\n", 60, " "
290 
291 #define ASL_PARSE_TREE_DEBUG2 \
292     " %08X %04X %04X %01X     %04X  %04X %05X  %05X   "\
293     "%08X %08X %08X %08X %08X %08X %04X  %02d  %5d %5d %5d %5d"
294 
295 /*
296  * Macros for ASL/ASL+ converter
297  */
298 #define COMMENT_CAPTURE_ON    Gbl_CommentState.CaptureComments = TRUE;
299 #define COMMENT_CAPTURE_OFF   Gbl_CommentState.CaptureComments = FALSE;
300 
301 
302 #endif /* ASLDEFINE.H */
303