1 /******************************************************************************
2  *
3  * Module Name: asltypes.h - compiler data types and struct definitions
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2023, 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 __ASLTYPES_H
153 #define __ASLTYPES_H
154 
155 
156 /*******************************************************************************
157  *
158  * Structure definitions
159  *
160  ******************************************************************************/
161 
162 
163 /* Op flags for the ACPI_PARSE_OBJECT */
164 
165 #define OP_VISITED                  0x00000001
166 #define OP_AML_PACKAGE              0x00000002
167 #define OP_IS_TARGET                0x00000004
168 #define OP_IS_RESOURCE_DESC         0x00000008
169 #define OP_IS_RESOURCE_FIELD        0x00000010
170 #define OP_HAS_NO_EXIT              0x00000020
171 #define OP_IF_HAS_NO_EXIT           0x00000040
172 #define OP_NAME_INTERNALIZED        0x00000080
173 #define OP_METHOD_NO_RETVAL         0x00000100
174 #define OP_METHOD_SOME_NO_RETVAL    0x00000200
175 #define OP_RESULT_NOT_USED          0x00000400
176 #define OP_METHOD_TYPED             0x00000800
177 #define OP_COULD_NOT_REDUCE         0x00001000
178 #define OP_COMPILE_TIME_CONST       0x00002000
179 #define OP_IS_TERM_ARG              0x00004000
180 #define OP_WAS_ONES_OP              0x00008000
181 #define OP_IS_NAME_DECLARATION      0x00010000
182 #define OP_COMPILER_EMITTED         0x00020000
183 #define OP_IS_DUPLICATE             0x00040000
184 #define OP_IS_RESOURCE_DATA         0x00080000
185 #define OP_IS_NULL_RETURN           0x00100000
186 #define OP_NOT_FOUND_DURING_LOAD    0x00200000
187 
188 #define ACPI_NUM_OP_FLAGS           0x22
189 
190 /* Keeps information about individual control methods */
191 
192 typedef struct asl_method_info
193 {
194     ACPI_PARSE_OBJECT       *Op;
195     ACPI_PARSE_OBJECT       *CurrentOp;
196     struct asl_method_info  *Next;
197     UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
198     UINT32                  ValidReturnTypes;
199     UINT32                  NumReturnNoValue;
200     UINT32                  NumReturnWithValue;
201     UINT8                   NumArguments;
202     UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
203     UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
204     UINT8                   HasBeenTyped;
205     UINT8                   ShouldBeSerialized;
206     UINT8                   CreatesNamedObjects;
207 
208 } ASL_METHOD_INFO;
209 
210 
211 /* Parse tree walk info for control method analysis */
212 
213 typedef struct asl_analysis_walk_info
214 {
215     ASL_METHOD_INFO         *MethodStack;
216 
217 } ASL_ANALYSIS_WALK_INFO;
218 
219 
220 /* An entry in the ParseOpcode to AmlOpcode mapping table */
221 
222 typedef struct asl_mapping_entry
223 {
224     UINT32                  Value;
225     UINT32                  AcpiBtype;   /* Object type or return type */
226     UINT16                  AmlOpcode;
227     UINT8                   Flags;
228 
229 } ASL_MAPPING_ENTRY;
230 
231 
232 /* Parse tree walk info structure */
233 
234 typedef struct asl_walk_info
235 {
236     ACPI_PARSE_OBJECT       **NodePtr;
237     UINT32                  *LevelPtr;
238 
239 } ASL_WALK_INFO;
240 
241 
242 /* File info */
243 
244 typedef struct asl_file_info
245 {
246     FILE                    *Handle;
247     char                    *Filename;
248 
249 } ASL_FILE_INFO;
250 
251 typedef struct asl_file_status
252 {
253     UINT32                  Line;
254     UINT32                  Offset;
255 
256 } ASL_FILE_STATUS;
257 
258 
259 typedef UINT32                      ASL_FILE_SWITCH_STATUS;    /* File switch status */
260 #define SWITCH_TO_DIFFERENT_FILE    0
261 #define SWITCH_TO_SAME_FILE         1
262 #define FILE_NOT_FOUND              2
263 
264 /*
265  * File types. Note: Any changes to this table must also be reflected
266  * in the Gbl_Files array.
267  *
268  * Corresponding filename suffixes are in comments
269  *
270  * NOTE: Don't move the first 4 file types
271  *
272  * .xxx file extension: this is used as a temporary .aml file for
273  * the ASL/ASL+ converter and is deleted after conversion. This file
274  * should never be used in the interpreter.
275  */
276 typedef enum
277 {
278     ASL_FILE_STDOUT             = 0,
279     ASL_FILE_STDERR,
280     ASL_FILE_INPUT,             /* .asl */
281     ASL_FILE_AML_OUTPUT,        /* .aml */
282     ASL_FILE_SOURCE_OUTPUT,     /* .src */
283     ASL_FILE_PREPROCESSOR,      /* .pre */
284     ASL_FILE_PREPROCESSOR_USER, /* .i   */
285     ASL_FILE_LISTING_OUTPUT,    /* .lst */
286     ASL_FILE_HEX_OUTPUT,        /* .hex */
287     ASL_FILE_NAMESPACE_OUTPUT,  /* .nsp */
288     ASL_FILE_DEBUG_OUTPUT,      /* .txt */
289     ASL_FILE_ASM_SOURCE_OUTPUT, /* .asm */
290     ASL_FILE_C_SOURCE_OUTPUT,   /* .c   */
291     ASL_FILE_ASM_INCLUDE_OUTPUT,/* .inc */
292     ASL_FILE_C_INCLUDE_OUTPUT,  /* .h   */
293     ASL_FILE_C_OFFSET_OUTPUT,   /* .offset.h */
294     ASL_FILE_MAP_OUTPUT,        /* .map */
295     ASL_FILE_XREF_OUTPUT,       /* .xrf */
296     ASL_FILE_CONV_DEBUG_OUTPUT, /* .cdb */
297     ASL_FILE_CONV_OUTPUT        /* .xxx */
298 
299 } ASL_FILE_TYPES;
300 
301 #define ASL_MAX_FILE_TYPE       18
302 #define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
303 
304 typedef struct asl_file_desc
305 {
306     const char              *ShortDescription;
307     const char              *Description;
308 
309 } ASL_FILE_DESC;
310 
311 
312 /* Name suffixes used to create filenames for output files */
313 
314 #define FILE_SUFFIX_ASL_CODE        "asl"
315 #define FILE_SUFFIX_AML_CODE        "aml"
316 #define FILE_SUFFIX_SOURCE          "src"
317 #define FILE_SUFFIX_PREPROCESSOR    "pre"
318 #define FILE_SUFFIX_PREPROC_USER    "i"
319 #define FILE_SUFFIX_LISTING         "lst"
320 #define FILE_SUFFIX_HEX_DUMP        "hex"
321 #define FILE_SUFFIX_NAMESPACE       "nsp"
322 #define FILE_SUFFIX_DEBUG           "txt"
323 #define FILE_SUFFIX_ASM_SOURCE      "asm"
324 #define FILE_SUFFIX_C_SOURCE        "c"
325 #define FILE_SUFFIX_ASM_INCLUDE     "inc"
326 #define FILE_SUFFIX_C_INCLUDE       "h"
327 #define FILE_SUFFIX_C_OFFSET        "offset.h"
328 #define FILE_SUFFIX_MAP             "map"
329 #define FILE_SUFFIX_XREF            "xrf"
330 #define FILE_SUFFIX_CONVERT_AML     "xxx"
331 #define FILE_SUFFIX_CONVERT_DEBUG   "cdb"
332 
333 
334 /* Cache block structure for ParseOps and Strings */
335 
336 typedef struct asl_cache_info
337 {
338     void                    *Next;
339     char                    Buffer[];
340 
341 } ASL_CACHE_INFO;
342 
343 
344 typedef struct asl_include_dir
345 {
346     char                    *Dir;
347     struct asl_include_dir  *Next;
348 
349 } ASL_INCLUDE_DIR;
350 
351 
352 /*
353  * An entry in the exception list, one for each error/warning
354  * Note: SubError nodes would be treated with the same messageId and Level
355  * as the parent error node.
356  *
357  * The source filename represents the name of the .src of where the error
358  * occurred. This is useful for errors that occur inside of include files.
359  * Since include files aren't recorded as a part of the global files list,
360  * this provides a way to get the included file.
361  */
362 typedef struct asl_error_msg
363 {
364     UINT32                      LineNumber;
365     UINT32                      LogicalLineNumber;
366     UINT32                      LogicalByteOffset;
367     UINT32                      Column;
368     char                        *Message;
369     struct asl_error_msg        *Next;
370     struct asl_error_msg        *SubError;
371     char                        *Filename;
372     char                        *SourceLine;
373     char                        *SourceFilename;
374     UINT32                      FilenameLength;
375     UINT16                      MessageId;
376     UINT8                       Level;
377 
378 } ASL_ERROR_MSG;
379 
380 /* An entry in the expected messages array */
381 
382 typedef struct asl_expected_message
383 {
384     UINT32                      MessageId;
385     char                        *MessageIdStr;
386     BOOLEAN                     MessageReceived;
387 
388 } ASL_EXPECTED_MESSAGE;
389 
390 /*
391  * An entry in the line-based expected messages list
392  *
393  * TBD: might be possible to merge this with ASL_EXPECTED_MESSAGE
394  */
395 typedef struct asl_expected_msg_node
396 {
397     struct asl_expected_msg_node    *Next;
398     UINT32                          MessageId;
399     char                            *MessageIdStr;
400     struct asl_location_node        *LocationList;
401 
402 } ASL_EXPECTED_MSG_NODE;
403 
404 typedef struct asl_location_node
405 {
406     struct asl_location_node    *Next;
407     char                        *Filename;
408     UINT32                      LineNumber;
409     UINT32                      Column;
410     UINT32                      LogicalByteOffset;
411     BOOLEAN                     MessageReceived;
412 
413 } ASL_LOCATION_NODE;
414 
415 
416 /* An entry in the listing file stack (for include files) */
417 
418 typedef struct asl_listing_node
419 {
420     char                        *Filename;
421     UINT32                      LineNumber;
422     struct asl_listing_node     *Next;
423 
424 } ASL_LISTING_NODE;
425 
426 
427 /* Callback interface for a parse tree walk */
428 
429 /*
430  * TBD - another copy of this is in adisasm.h, fix
431  */
432 #ifndef ASL_WALK_CALLBACK_DEFINED
433 typedef
434 ACPI_STATUS (*ASL_WALK_CALLBACK) (
435     ACPI_PARSE_OBJECT           *Op,
436     UINT32                      Level,
437     void                        *Context);
438 #define ASL_WALK_CALLBACK_DEFINED
439 #endif
440 
441 
442 typedef struct asl_event_info
443 {
444     UINT64                      StartTime;
445     UINT64                      EndTime;
446     char                        *EventName;
447     BOOLEAN                     Valid;
448 
449 } ASL_EVENT_INFO;
450 
451 
452 /* Hardware mapping file structures */
453 
454 typedef struct acpi_gpio_info
455 {
456     struct acpi_gpio_info   *Next;
457     ACPI_PARSE_OBJECT       *Op;
458     char                    *DeviceName;
459     ACPI_NAMESPACE_NODE     *TargetNode;
460     UINT32                  References;
461     UINT32                  PinCount;
462     UINT32                  PinIndex;
463     UINT16                  PinNumber;
464     UINT8                   Type;
465     UINT8                   Direction;
466     UINT8                   Polarity;
467 
468 } ACPI_GPIO_INFO;
469 
470 typedef struct acpi_serial_info
471 {
472     struct acpi_serial_info *Next;
473     ACPI_PARSE_OBJECT       *Op;
474     char                    *DeviceName;
475     ACPI_NAMESPACE_NODE     *TargetNode;
476     AML_RESOURCE            *Resource;
477     UINT32                  Speed;
478     UINT16                  Address;
479 
480 } ACPI_SERIAL_INFO;
481 
482 typedef struct asl_method_local
483 {
484     ACPI_PARSE_OBJECT       *Op;
485     UINT8                   Flags;
486 
487 } ASL_METHOD_LOCAL;
488 
489 /* Values for Flags field above */
490 
491 #define ASL_LOCAL_INITIALIZED   (1)
492 #define ASL_LOCAL_REFERENCED    (1<<1)
493 #define ASL_ARG_IS_LOCAL        (1<<2)
494 #define ASL_ARG_INITIALIZED     (1<<3)
495 #define ASL_ARG_REFERENCED      (1<<4)
496 
497 /* Info used to track method counts for cross reference output file */
498 
499 typedef struct asl_xref_info
500 {
501     UINT32                  ThisMethodInvocations;
502     UINT32                  TotalPredefinedMethods;
503     UINT32                  TotalUserMethods;
504     UINT32                  TotalUnreferenceUserMethods;
505     UINT32                  ThisObjectReferences;
506     UINT32                  TotalObjects;
507     UINT32                  TotalUnreferencedObjects;
508     ACPI_PARSE_OBJECT       *MethodOp;
509     ACPI_PARSE_OBJECT       *CurrentMethodOp;
510 
511 } ASL_XREF_INFO;
512 
513 
514 typedef struct asl_file_node
515 {
516     FILE                    *File;
517     UINT32                  CurrentLineNumber;
518     void                    *State;
519     char                    *Filename;
520     struct asl_file_node    *Next;
521 
522 } ASL_FILE_NODE;
523 
524 typedef struct asl_files_node
525 {
526     struct asl_file_info    Files[ASL_NUM_FILES];
527     struct asl_files_node   *Next;
528     char                    *TableSignature;
529     char                    *TableId;
530     UINT32                  TotalLineCount;
531     UINT32                  OriginalInputFileSize;
532     UINT32                  TotalKeywords;
533     UINT32                  TotalFields;
534     UINT32                  OutputByteLength;
535     UINT32                  TotalNamedObjects;
536     UINT32                  TotalExecutableOpcodes;
537     BOOLEAN                 ParserErrorDetected;
538     UINT8                   FileType;
539 
540 } ASL_GLOBAL_FILE_NODE;
541 
542 #endif  /* __ASLTYPES_H */
543