xref: /freebsd/sys/contrib/dev/acpica/compiler/asldefine.h (revision c6db8143eda5c775467145ac73e8ebec47afdd8f)
1 /******************************************************************************
2  *
3  * Module Name: asldefine.h - Common defines for the iASL compiler
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, 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 __ASLDEFINE_H
45 #define __ASLDEFINE_H
46 
47 
48 /*
49  * Compiler versions and names
50  */
51 #define ASL_REVISION                ACPI_CA_VERSION
52 #define ASL_COMPILER_NAME           "ASL Optimizing Compiler"
53 #define AML_DISASSEMBLER_NAME       "AML Disassembler"
54 #define ASL_INVOCATION_NAME         "iasl"
55 #define ASL_CREATOR_ID              "INTL"
56 
57 #define ASL_COMPLIANCE              "Supports ACPI Specification Revision 5.1"
58 
59 
60 /* Configuration constants */
61 
62 #define ASL_MAX_ERROR_COUNT         200
63 #define ASL_PARSEOP_CACHE_SIZE      (1024 * 16)
64 #define ASL_STRING_CACHE_SIZE       (1024 * 64)
65 
66 #define ASL_FIRST_PARSE_OPCODE      PARSEOP_ACCESSAS
67 #define ASL_PARSE_OPCODE_BASE       PARSEOP_ACCESSAS        /* First Lex type */
68 
69 
70 /*
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).
75  */
76 #if defined (YYBISON)
77 #define ASL_YYTNAME_START           3   /* Bison */
78 #elif defined (YYBYACC)
79 #define ASL_YYTNAME_START           257 /* Berkeley yacc */
80 #endif
81 
82 
83 /*
84  * Macros
85  */
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}
92 
93 
94 /* Internal AML opcodes */
95 
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
105 
106 
107 /* filename suffixes for output files */
108 
109 #define FILE_SUFFIX_PREPROCESSOR    "i"
110 #define FILE_SUFFIX_AML_CODE        "aml"
111 #define FILE_SUFFIX_MAP             "map"
112 #define FILE_SUFFIX_LISTING         "lst"
113 #define FILE_SUFFIX_HEX_DUMP        "hex"
114 #define FILE_SUFFIX_DEBUG           "txt"
115 #define FILE_SUFFIX_SOURCE          "src"
116 #define FILE_SUFFIX_NAMESPACE       "nsp"
117 #define FILE_SUFFIX_ASM_SOURCE      "asm"
118 #define FILE_SUFFIX_C_SOURCE        "c"
119 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
120 #define FILE_SUFFIX_ASM_INCLUDE     "inc"
121 #define FILE_SUFFIX_C_INCLUDE       "h"
122 #define FILE_SUFFIX_ASL_CODE        "asl"
123 #define FILE_SUFFIX_C_OFFSET        "offset.h"
124 
125 
126 /* Types for input files */
127 
128 #define ASL_INPUT_TYPE_BINARY       0
129 #define ASL_INPUT_TYPE_ACPI_TABLE   1
130 #define ASL_INPUT_TYPE_ASCII_ASL    2
131 #define ASL_INPUT_TYPE_ASCII_DATA   3
132 
133 
134 /* Misc */
135 
136 #define ASL_EXTERNAL_METHOD         255
137 #define ASL_ABORT                   TRUE
138 #define ASL_NO_ABORT                FALSE
139 #define ASL_EOF                     ACPI_UINT32_MAX
140 
141 
142 /* Listings */
143 
144 #define ASL_LISTING_LINE_PREFIX         ":  "
145 
146 
147 /* Support for reserved method names */
148 
149 #define ACPI_VALID_RESERVED_NAME_MAX    0x80000000
150 #define ACPI_NOT_RESERVED_NAME          ACPI_UINT32_MAX
151 #define ACPI_PREDEFINED_NAME            (ACPI_UINT32_MAX - 1)
152 #define ACPI_EVENT_RESERVED_NAME        (ACPI_UINT32_MAX - 2)
153 #define ACPI_COMPILER_RESERVED_NAME     (ACPI_UINT32_MAX - 3)
154 
155 
156 /* String to Integer conversion */
157 
158 #define NEGATIVE                    1
159 #define POSITIVE                    0
160 
161 
162 /* Helper macros for resource tag creation */
163 
164 #define RsCreateMultiBitField \
165     RsCreateResourceField
166 
167 #define RsCreateBitField(Op, Name, ByteOffset, BitOffset) \
168     RsCreateResourceField (Op, Name, ByteOffset, BitOffset, 1)
169 
170 #define RsCreateByteField(Op, Name, ByteOffset) \
171     RsCreateResourceField (Op, Name, ByteOffset, 0, 8);
172 
173 #define RsCreateWordField(Op, Name, ByteOffset) \
174     RsCreateResourceField (Op, Name, ByteOffset, 0, 16);
175 
176 #define RsCreateDwordField(Op, Name, ByteOffset) \
177     RsCreateResourceField (Op, Name, ByteOffset, 0, 32);
178 
179 #define RsCreateQwordField(Op, Name, ByteOffset) \
180     RsCreateResourceField (Op, Name, ByteOffset, 0, 64);
181 
182 #endif /* ASLDEFINE.H */
183