drivers/acpi/compiler/asltypes.h

   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 - 2015, 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 #ifndef __ASLTYPES_H
 117 #define __ASLTYPES_H
 118
 119
 120 /*******************************************************************************
 121  *
 122  * Structure definitions
 123  *
 124  ******************************************************************************/
 125
 126
 127 /* Op flags for the ACPI_PARSE_OBJECT */
 128
 129 #define NODE_VISITED                0x00000001
 130 #define NODE_AML_PACKAGE            0x00000002
 131 #define NODE_IS_TARGET              0x00000004
 132 #define NODE_IS_RESOURCE_DESC       0x00000008
 133 #define NODE_IS_RESOURCE_FIELD      0x00000010
 134 #define NODE_HAS_NO_EXIT            0x00000020
 135 #define NODE_IF_HAS_NO_EXIT         0x00000040
 136 #define NODE_NAME_INTERNALIZED      0x00000080
 137 #define NODE_METHOD_NO_RETVAL       0x00000100
 138 #define NODE_METHOD_SOME_NO_RETVAL  0x00000200
 139 #define NODE_RESULT_NOT_USED        0x00000400
 140 #define NODE_METHOD_TYPED           0x00000800
 141 #define NODE_UNUSED_FLAG            0x00001000
 142 #define NODE_COMPILE_TIME_CONST     0x00002000
 143 #define NODE_IS_TERM_ARG            0x00004000
 144 #define NODE_WAS_ONES_OP            0x00008000
 145 #define NODE_IS_NAME_DECLARATION    0x00010000
 146 #define NODE_COMPILER_EMITTED       0x00020000
 147 #define NODE_IS_DUPLICATE           0x00040000
 148 #define NODE_IS_RESOURCE_DATA       0x00080000
 149 #define NODE_IS_NULL_RETURN         0x00100000
 150
 151 /* Keeps information about individual control methods */
 152
 153 typedef struct asl_method_info
 154 {
 155     ACPI_PARSE_OBJECT       *Op;
 156     struct asl_method_info  *Next;
 157     UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
 158     UINT32                  ValidReturnTypes;
 159     UINT32                  NumReturnNoValue;
 160     UINT32                  NumReturnWithValue;
 161     UINT8                   NumArguments;
 162     UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
 163     UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
 164     UINT8                   HasBeenTyped;
 165     UINT8                   ShouldBeSerialized;
 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     const char                  *ShortDescription;
 208     const char                  *Description;
 209
 210 } ASL_FILE_INFO;
 211
 212 typedef struct asl_file_status
 213 {
 214     UINT32                  Line;
 215     UINT32                  Offset;
 216
 217 } ASL_FILE_STATUS;
 218
 219
 220 /*
 221  * File types. Note: Any changes to this table must also be reflected
 222  * in the Gbl_Files array.
 223  */
 224 typedef enum
 225 {
 226     ASL_FILE_STDOUT             = 0,
 227     ASL_FILE_STDERR,
 228     ASL_FILE_INPUT,
 229     ASL_FILE_AML_OUTPUT,        /* Don't move these first 4 file types */
 230     ASL_FILE_SOURCE_OUTPUT,
 231     ASL_FILE_PREPROCESSOR,
 232     ASL_FILE_LISTING_OUTPUT,
 233     ASL_FILE_HEX_OUTPUT,
 234     ASL_FILE_NAMESPACE_OUTPUT,
 235     ASL_FILE_DEBUG_OUTPUT,
 236     ASL_FILE_ASM_SOURCE_OUTPUT,
 237     ASL_FILE_C_SOURCE_OUTPUT,
 238     ASL_FILE_ASM_INCLUDE_OUTPUT,
 239     ASL_FILE_C_INCLUDE_OUTPUT,
 240     ASL_FILE_C_OFFSET_OUTPUT,
 241     ASL_FILE_MAP_OUTPUT
 242
 243 } ASL_FILE_TYPES;
 244
 245
 246 #define ASL_MAX_FILE_TYPE       15
 247 #define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
 248
 249
 250 /* Cache block structure for ParseOps and Strings */
 251
 252 typedef struct asl_cache_info
 253 {
 254     void                            *Next;
 255     char                            Buffer[1];
 256
 257 } ASL_CACHE_INFO;
 258
 259
 260 typedef struct asl_include_dir
 261 {
 262     char                        *Dir;
 263     struct asl_include_dir      *Next;
 264
 265 } ASL_INCLUDE_DIR;
 266
 267
 268 /* An entry in the exception list, one for each error/warning */
 269
 270 typedef struct asl_error_msg
 271 {
 272     UINT32                      LineNumber;
 273     UINT32                      LogicalLineNumber;
 274     UINT32                      LogicalByteOffset;
 275     UINT32                      Column;
 276     char                        *Message;
 277     struct asl_error_msg        *Next;
 278     char                        *Filename;
 279     char                        *SourceLine;
 280     UINT32                      FilenameLength;
 281     UINT16                      MessageId;
 282     UINT8                       Level;
 283
 284 } ASL_ERROR_MSG;
 285
 286
 287 /* An entry in the listing file stack (for include files) */
 288
 289 typedef struct asl_listing_node
 290 {
 291     char                        *Filename;
 292     UINT32                      LineNumber;
 293     struct asl_listing_node     *Next;
 294
 295 } ASL_LISTING_NODE;
 296
 297
 298 /* Callback interface for a parse tree walk */
 299
 300 /*
 301  * TBD - another copy of this is in adisasm.h, fix
 302  */
 303 #ifndef ASL_WALK_CALLBACK_DEFINED
 304 typedef
 305 ACPI_STATUS (*ASL_WALK_CALLBACK) (
 306     ACPI_PARSE_OBJECT           *Op,
 307     UINT32                      Level,
 308     void                        *Context);
 309 #define ASL_WALK_CALLBACK_DEFINED
 310 #endif
 311
 312
 313 typedef struct asl_event_info
 314 {
 315     UINT64                      StartTime;
 316     UINT64                      EndTime;
 317     char                        *EventName;
 318     BOOLEAN                     Valid;
 319
 320 } ASL_EVENT_INFO;
 321
 322
 323 /* Hardware mapping file structures */
 324
 325 typedef struct acpi_gpio_info
 326 {
 327     struct acpi_gpio_info   *Next;
 328     ACPI_PARSE_OBJECT       *Op;
 329     char                    *DeviceName;
 330     ACPI_NAMESPACE_NODE     *TargetNode;
 331     UINT32                  References;
 332     UINT32                  PinCount;
 333     UINT32                  PinIndex;
 334     UINT16                  PinNumber;
 335     UINT8                   Type;
 336     UINT8                   Direction;
 337     UINT8                   Polarity;
 338
 339 } ACPI_GPIO_INFO;
 340
 341 typedef struct acpi_serial_info
 342 {
 343     struct acpi_serial_info *Next;
 344     ACPI_PARSE_OBJECT       *Op;
 345     char                    *DeviceName;
 346     ACPI_NAMESPACE_NODE     *TargetNode;
 347     AML_RESOURCE            *Resource;
 348     UINT32                  Speed;
 349     UINT16                  Address;
 350
 351 } ACPI_SERIAL_INFO;
 352
 353
 354 #endif  /* __ASLTYPES_H */