sys/contrib/dev/acpica-unix/compiler/asltypes.h

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: asltypes.h - compiler data types and struct definitions
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #ifndef __ASLTYPES_H
 119 #define __ASLTYPES_H
 120
 121
 122 /*******************************************************************************
 123  *
 124  * Structure definitions
 125  *
 126  ******************************************************************************/
 127
 128
 129 /* Op flags for the ACPI_PARSE_OBJECT */
 130
 131 #define NODE_VISITED                0x00000001
 132 #define NODE_AML_PACKAGE            0x00000002
 133 #define NODE_IS_TARGET              0x00000004
 134 #define NODE_IS_RESOURCE_DESC       0x00000008
 135 #define NODE_IS_RESOURCE_FIELD      0x00000010
 136 #define NODE_HAS_NO_EXIT            0x00000020
 137 #define NODE_IF_HAS_NO_EXIT         0x00000040
 138 #define NODE_NAME_INTERNALIZED      0x00000080
 139 #define NODE_METHOD_NO_RETVAL       0x00000100
 140 #define NODE_METHOD_SOME_NO_RETVAL  0x00000200
 141 #define NODE_RESULT_NOT_USED        0x00000400
 142 #define NODE_METHOD_TYPED           0x00000800
 143 #define NODE_IS_BIT_OFFSET          0x00001000
 144 #define NODE_COMPILE_TIME_CONST     0x00002000
 145 #define NODE_IS_TERM_ARG            0x00004000
 146 #define NODE_WAS_ONES_OP            0x00008000
 147 #define NODE_IS_NAME_DECLARATION    0x00010000
 148 #define NODE_COMPILER_EMITTED       0x00020000
 149 #define NODE_IS_DUPLICATE           0x00040000
 150 #define NODE_IS_RESOURCE_DATA       0x00080000
 151
 152 /* Keeps information about individual control methods */
 153
 154 typedef struct asl_method_info
 155 {
 156     UINT8                   NumArguments;
 157     UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
 158     UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
 159     UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
 160     UINT32                  ValidReturnTypes;
 161     UINT32                  NumReturnNoValue;
 162     UINT32                  NumReturnWithValue;
 163     ACPI_PARSE_OBJECT       *Op;
 164     struct asl_method_info  *Next;
 165     UINT8                   HasBeenTyped;
 166
 167 } ASL_METHOD_INFO;
 168
 169
 170 /* Parse tree walk info for control method analysis */
 171
 172 typedef struct asl_analysis_walk_info
 173 {
 174     ASL_METHOD_INFO         *MethodStack;
 175
 176 } ASL_ANALYSIS_WALK_INFO;
 177
 178
 179 /* An entry in the ParseOpcode to AmlOpcode mapping table */
 180
 181 typedef struct asl_mapping_entry
 182 {
 183     UINT32                      Value;
 184     UINT32                      AcpiBtype;   /* Object type or return type */
 185     UINT16                      AmlOpcode;
 186     UINT8                       Flags;
 187
 188 } ASL_MAPPING_ENTRY;
 189
 190
 191 /* Parse tree walk info structure */
 192
 193 typedef struct asl_walk_info
 194 {
 195     ACPI_PARSE_OBJECT           **NodePtr;
 196     UINT32                      *LevelPtr;
 197
 198 } ASL_WALK_INFO;
 199
 200
 201 /* File info */
 202
 203 typedef struct asl_file_info
 204 {
 205     FILE                        *Handle;
 206     char                        *Filename;
 207
 208 } ASL_FILE_INFO;
 209
 210 typedef struct asl_file_status
 211 {
 212     UINT32                  Line;
 213     UINT32                  Offset;
 214
 215 } ASL_FILE_STATUS;
 216
 217
 218 /* File types */
 219
 220 typedef enum
 221 {
 222     ASL_FILE_STDOUT             = 0,
 223     ASL_FILE_STDERR,
 224     ASL_FILE_INPUT,
 225     ASL_FILE_AML_OUTPUT,
 226     ASL_FILE_SOURCE_OUTPUT,
 227     ASL_FILE_LISTING_OUTPUT,
 228     ASL_FILE_HEX_OUTPUT,
 229     ASL_FILE_NAMESPACE_OUTPUT,
 230     ASL_FILE_DEBUG_OUTPUT,
 231     ASL_FILE_ASM_SOURCE_OUTPUT,
 232     ASL_FILE_C_SOURCE_OUTPUT,
 233     ASL_FILE_ASM_INCLUDE_OUTPUT,
 234     ASL_FILE_C_INCLUDE_OUTPUT
 235
 236 } ASL_FILE_TYPES;
 237
 238
 239 #define ASL_MAX_FILE_TYPE       12
 240 #define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
 241
 242
 243 typedef struct asl_include_dir
 244 {
 245     char                        *Dir;
 246     struct asl_include_dir      *Next;
 247
 248 } ASL_INCLUDE_DIR;
 249
 250
 251 /* An entry in the exception list, one for each error/warning */
 252
 253 typedef struct asl_error_msg
 254 {
 255     UINT32                      LineNumber;
 256     UINT32                      LogicalLineNumber;
 257     UINT32                      LogicalByteOffset;
 258     UINT32                      Column;
 259     char                        *Message;
 260     struct asl_error_msg        *Next;
 261     char                        *Filename;
 262     UINT32                      FilenameLength;
 263     UINT8                       MessageId;
 264     UINT8                       Level;
 265
 266 } ASL_ERROR_MSG;
 267
 268
 269 /* An entry in the listing file stack (for include files) */
 270
 271 typedef struct asl_listing_node
 272 {
 273     char                        *Filename;
 274     UINT32                      LineNumber;
 275     struct asl_listing_node     *Next;
 276
 277 } ASL_LISTING_NODE;
 278
 279
 280 /* Callback interface for a parse tree walk */
 281
 282 /*
 283  * TBD - another copy of this is in adisasm.h, fix
 284  */
 285 #ifndef ASL_WALK_CALLBACK_DEFINED
 286 typedef
 287 ACPI_STATUS (*ASL_WALK_CALLBACK) (
 288     ACPI_PARSE_OBJECT           *Op,
 289     UINT32                      Level,
 290     void                        *Context);
 291 #define ASL_WALK_CALLBACK_DEFINED
 292 #endif
 293
 294
 295 typedef struct asl_event_info
 296 {
 297     UINT64                      StartTime;
 298     UINT64                      EndTime;
 299     char                        *EventName;
 300     BOOLEAN                     Valid;
 301
 302 } ASL_EVENT_INFO;
 303
 304
 305 #endif  /* __ASLTYPES_H */