sys/contrib/dev/acpica/source/compiler/asltypes.h

   1 /******************************************************************************
   2  *
   3  * Module Name: asltypes.h - compiler data types and struct definitions
   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 __ASLTYPES_H
  45 #define __ASLTYPES_H
  46
  47
  48 /*******************************************************************************
  49  *
  50  * Structure definitions
  51  *
  52  ******************************************************************************/
  53
  54
  55 /* Op flags for the ACPI_PARSE_OBJECT */
  56
  57 #define NODE_VISITED                0x00000001
  58 #define NODE_AML_PACKAGE            0x00000002
  59 #define NODE_IS_TARGET              0x00000004
  60 #define NODE_IS_RESOURCE_DESC       0x00000008
  61 #define NODE_IS_RESOURCE_FIELD      0x00000010
  62 #define NODE_HAS_NO_EXIT            0x00000020
  63 #define NODE_IF_HAS_NO_EXIT         0x00000040
  64 #define NODE_NAME_INTERNALIZED      0x00000080
  65 #define NODE_METHOD_NO_RETVAL       0x00000100
  66 #define NODE_METHOD_SOME_NO_RETVAL  0x00000200
  67 #define NODE_RESULT_NOT_USED        0x00000400
  68 #define NODE_METHOD_TYPED           0x00000800
  69 #define NODE_UNUSED_FLAG            0x00001000
  70 #define NODE_COMPILE_TIME_CONST     0x00002000
  71 #define NODE_IS_TERM_ARG            0x00004000
  72 #define NODE_WAS_ONES_OP            0x00008000
  73 #define NODE_IS_NAME_DECLARATION    0x00010000
  74 #define NODE_COMPILER_EMITTED       0x00020000
  75 #define NODE_IS_DUPLICATE           0x00040000
  76 #define NODE_IS_RESOURCE_DATA       0x00080000
  77 #define NODE_IS_NULL_RETURN         0x00100000
  78
  79 /* Keeps information about individual control methods */
  80
  81 typedef struct asl_method_info
  82 {
  83     ACPI_PARSE_OBJECT       *Op;
  84     struct asl_method_info  *Next;
  85     UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
  86     UINT32                  ValidReturnTypes;
  87     UINT32                  NumReturnNoValue;
  88     UINT32                  NumReturnWithValue;
  89     UINT8                   NumArguments;
  90     UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
  91     UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
  92     UINT8                   HasBeenTyped;
  93     UINT8                   ShouldBeSerialized;
  94
  95 } ASL_METHOD_INFO;
  96
  97
  98 /* Parse tree walk info for control method analysis */
  99
 100 typedef struct asl_analysis_walk_info
 101 {
 102     ASL_METHOD_INFO         *MethodStack;
 103
 104 } ASL_ANALYSIS_WALK_INFO;
 105
 106
 107 /* An entry in the ParseOpcode to AmlOpcode mapping table */
 108
 109 typedef struct asl_mapping_entry
 110 {
 111     UINT32                      Value;
 112     UINT32                      AcpiBtype;   /* Object type or return type */
 113     UINT16                      AmlOpcode;
 114     UINT8                       Flags;
 115
 116 } ASL_MAPPING_ENTRY;
 117
 118
 119 /* Parse tree walk info structure */
 120
 121 typedef struct asl_walk_info
 122 {
 123     ACPI_PARSE_OBJECT           **NodePtr;
 124     UINT32                      *LevelPtr;
 125
 126 } ASL_WALK_INFO;
 127
 128
 129 /* File info */
 130
 131 typedef struct asl_file_info
 132 {
 133     FILE                        *Handle;
 134     char                        *Filename;
 135     const char                  *ShortDescription;
 136     const char                  *Description;
 137
 138 } ASL_FILE_INFO;
 139
 140 typedef struct asl_file_status
 141 {
 142     UINT32                  Line;
 143     UINT32                  Offset;
 144
 145 } ASL_FILE_STATUS;
 146
 147
 148 /*
 149  * File types. Note: Any changes to this table must also be reflected
 150  * in the Gbl_Files array.
 151  */
 152 typedef enum
 153 {
 154     ASL_FILE_STDOUT             = 0,
 155     ASL_FILE_STDERR,
 156     ASL_FILE_INPUT,
 157     ASL_FILE_AML_OUTPUT,        /* Don't move these first 4 file types */
 158     ASL_FILE_SOURCE_OUTPUT,
 159     ASL_FILE_PREPROCESSOR,
 160     ASL_FILE_LISTING_OUTPUT,
 161     ASL_FILE_HEX_OUTPUT,
 162     ASL_FILE_NAMESPACE_OUTPUT,
 163     ASL_FILE_DEBUG_OUTPUT,
 164     ASL_FILE_ASM_SOURCE_OUTPUT,
 165     ASL_FILE_C_SOURCE_OUTPUT,
 166     ASL_FILE_ASM_INCLUDE_OUTPUT,
 167     ASL_FILE_C_INCLUDE_OUTPUT,
 168     ASL_FILE_C_OFFSET_OUTPUT
 169
 170 } ASL_FILE_TYPES;
 171
 172
 173 #define ASL_MAX_FILE_TYPE       14
 174 #define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
 175
 176
 177 /* Cache block structure for ParseOps and Strings */
 178
 179 typedef struct asl_cache_info
 180 {
 181     void                            *Next;
 182     char                            Buffer[1];
 183
 184 } ASL_CACHE_INFO;
 185
 186
 187 typedef struct asl_include_dir
 188 {
 189     char                        *Dir;
 190     struct asl_include_dir      *Next;
 191
 192 } ASL_INCLUDE_DIR;
 193
 194
 195 /* An entry in the exception list, one for each error/warning */
 196
 197 typedef struct asl_error_msg
 198 {
 199     UINT32                      LineNumber;
 200     UINT32                      LogicalLineNumber;
 201     UINT32                      LogicalByteOffset;
 202     UINT32                      Column;
 203     char                        *Message;
 204     struct asl_error_msg        *Next;
 205     char                        *Filename;
 206     char                        *SourceLine;
 207     UINT32                      FilenameLength;
 208     UINT16                      MessageId;
 209     UINT8                       Level;
 210
 211 } ASL_ERROR_MSG;
 212
 213
 214 /* An entry in the listing file stack (for include files) */
 215
 216 typedef struct asl_listing_node
 217 {
 218     char                        *Filename;
 219     UINT32                      LineNumber;
 220     struct asl_listing_node     *Next;
 221
 222 } ASL_LISTING_NODE;
 223
 224
 225 /* Callback interface for a parse tree walk */
 226
 227 /*
 228  * TBD - another copy of this is in adisasm.h, fix
 229  */
 230 #ifndef ASL_WALK_CALLBACK_DEFINED
 231 typedef
 232 ACPI_STATUS (*ASL_WALK_CALLBACK) (
 233     ACPI_PARSE_OBJECT           *Op,
 234     UINT32                      Level,
 235     void                        *Context);
 236 #define ASL_WALK_CALLBACK_DEFINED
 237 #endif
 238
 239
 240 typedef struct asl_event_info
 241 {
 242     UINT64                      StartTime;
 243     UINT64                      EndTime;
 244     char                        *EventName;
 245     BOOLEAN                     Valid;
 246
 247 } ASL_EVENT_INFO;
 248
 249
 250 #endif  /* __ASLTYPES_H */