xref: /freebsd/sys/contrib/dev/acpica/compiler/asldefine.h (revision 641a6cfb86023499caafe26a4d821a0b885cf00b)
1 
2 /******************************************************************************
3  *
4  * Module Name: asldefine.h - Common defines for the iASL compiler
5  *
6  *****************************************************************************/
7 
8 /*
9  * Copyright (C) 2000 - 2012, Intel Corp.
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions, and the following disclaimer,
17  *    without modification.
18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19  *    substantially similar to the "NO WARRANTY" disclaimer below
20  *    ("Disclaimer") and any redistribution must be conditioned upon
21  *    including a substantially similar Disclaimer requirement for further
22  *    binary redistribution.
23  * 3. Neither the names of the above-listed copyright holders nor the names
24  *    of any contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * Alternatively, this software may be distributed under the terms of the
28  * GNU General Public License ("GPL") version 2 as published by the Free
29  * Software Foundation.
30  *
31  * NO WARRANTY
32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42  * POSSIBILITY OF SUCH DAMAGES.
43  */
44 
45 
46 #ifndef __ASLDEFINE_H
47 #define __ASLDEFINE_H
48 
49 
50 /*
51  * Compiler versions and names
52  */
53 #define ASL_REVISION                ACPI_CA_VERSION
54 #define ASL_COMPILER_NAME           "ASL Optimizing Compiler"
55 #define AML_DISASSEMBLER_NAME       "AML Disassembler"
56 #define ASL_INVOCATION_NAME         "iasl"
57 #define ASL_CREATOR_ID              "INTL"
58 
59 #define ASL_COMPLIANCE              "Supports ACPI Specification Revision 5.0"
60 
61 
62 /* Configuration constants */
63 
64 #define ASL_MAX_ERROR_COUNT         200
65 #define ASL_NODE_CACHE_SIZE         1024
66 #define ASL_STRING_CACHE_SIZE       32768
67 
68 #define ASL_FIRST_PARSE_OPCODE      PARSEOP_ACCESSAS
69 #define ASL_PARSE_OPCODE_BASE       PARSEOP_ACCESSAS        /* First Lex type */
70 
71 
72 /*
73  * Per-parser-generator configuration. These values are used to cheat and
74  * directly access the bison/yacc token name table (yyname or yytname).
75  * Note: These values are the index in yyname for the first lex token
76  * (PARSEOP_ACCCESSAS).
77  */
78 #if defined (YYBISON)
79 #define ASL_YYTNAME_START           3   /* Bison */
80 #elif defined (YYBYACC)
81 #define ASL_YYTNAME_START           257 /* Berkeley yacc */
82 #endif
83 
84 
85 /*
86  * Macros
87  */
88 #define ASL_RESDESC_OFFSET(m)       ACPI_OFFSET (AML_RESOURCE, m)
89 #define ASL_PTR_DIFF(a,b)           ((UINT8 *)(b) - (UINT8 *)(a))
90 #define ASL_PTR_ADD(a,b)            ((UINT8 *)(a) = ((UINT8 *)(a) + (b)))
91 #define ASL_GET_CHILD_NODE(a)       (a)->Asl.Child
92 #define ASL_GET_PEER_NODE(a)        (a)->Asl.Next
93 #define OP_TABLE_ENTRY(a,b,c,d)     {b,d,a,c}
94 
95 
96 /* Internal AML opcodes */
97 
98 #define AML_RAW_DATA_BYTE           (UINT16) 0xAA01 /* write one raw byte */
99 #define AML_RAW_DATA_WORD           (UINT16) 0xAA02 /* write 2 raw bytes */
100 #define AML_RAW_DATA_DWORD          (UINT16) 0xAA04 /* write 4 raw bytes */
101 #define AML_RAW_DATA_QWORD          (UINT16) 0xAA08 /* write 8 raw bytes */
102 #define AML_RAW_DATA_BUFFER         (UINT16) 0xAA0B /* raw buffer with length */
103 #define AML_RAW_DATA_CHAIN          (UINT16) 0xAA0C /* chain of raw buffers */
104 #define AML_PACKAGE_LENGTH          (UINT16) 0xAA10
105 #define AML_UNASSIGNED_OPCODE       (UINT16) 0xEEEE
106 #define AML_DEFAULT_ARG_OP          (UINT16) 0xDDDD
107 
108 
109 /* filename suffixes for output files */
110 
111 #define FILE_SUFFIX_PREPROCESSOR    "i"
112 #define FILE_SUFFIX_AML_CODE        "aml"
113 #define FILE_SUFFIX_LISTING         "lst"
114 #define FILE_SUFFIX_HEX_DUMP        "hex"
115 #define FILE_SUFFIX_DEBUG           "txt"
116 #define FILE_SUFFIX_SOURCE          "src"
117 #define FILE_SUFFIX_NAMESPACE       "nsp"
118 #define FILE_SUFFIX_ASM_SOURCE      "asm"
119 #define FILE_SUFFIX_C_SOURCE        "c"
120 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
121 #define FILE_SUFFIX_ASM_INCLUDE     "inc"
122 #define FILE_SUFFIX_C_INCLUDE       "h"
123 #define FILE_SUFFIX_ASL_CODE        "asl"
124 
125 
126 /* Types for input files */
127 
128 #define ASL_INPUT_TYPE_BINARY       0
129 #define ASL_INPUT_TYPE_ASCII_ASL    1
130 #define ASL_INPUT_TYPE_ASCII_DATA   2
131 
132 
133 /* Misc */
134 
135 #define ASL_EXTERNAL_METHOD         255
136 #define ASL_ABORT                   TRUE
137 #define ASL_NO_ABORT                FALSE
138 #define ASL_EOF                     ACPI_UINT32_MAX
139 
140 
141 /* Support for reserved method names */
142 
143 #define ACPI_VALID_RESERVED_NAME_MAX    0x80000000
144 #define ACPI_NOT_RESERVED_NAME          ACPI_UINT32_MAX
145 #define ACPI_PREDEFINED_NAME            (ACPI_UINT32_MAX - 1)
146 #define ACPI_EVENT_RESERVED_NAME        (ACPI_UINT32_MAX - 2)
147 #define ACPI_COMPILER_RESERVED_NAME     (ACPI_UINT32_MAX - 3)
148 
149 
150 /* String to Integer conversion */
151 
152 #define NEGATIVE                    1
153 #define POSITIVE                    0
154 
155 
156 /* Helper macros for resource tag creation */
157 
158 #define RsCreateMultiBitField \
159     RsCreateResourceField
160 
161 #define RsCreateBitField(Op, Name, ByteOffset, BitOffset) \
162     RsCreateResourceField (Op, Name, ByteOffset, BitOffset, 1)
163 
164 #define RsCreateByteField(Op, Name, ByteOffset) \
165     RsCreateResourceField (Op, Name, ByteOffset, 0, 8);
166 
167 #define RsCreateWordField(Op, Name, ByteOffset) \
168     RsCreateResourceField (Op, Name, ByteOffset, 0, 16);
169 
170 #define RsCreateDwordField(Op, Name, ByteOffset) \
171     RsCreateResourceField (Op, Name, ByteOffset, 0, 32);
172 
173 #define RsCreateQwordField(Op, Name, ByteOffset) \
174     RsCreateResourceField (Op, Name, ByteOffset, 0, 64);
175 
176 #endif /* ASLDEFINE.H */
177 
178