sys/contrib/dev/acpica/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 - 2017, 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 NODE_VISITED                0x00000001
 166 #define NODE_AML_PACKAGE            0x00000002
 167 #define NODE_IS_TARGET              0x00000004
 168 #define NODE_IS_RESOURCE_DESC       0x00000008
 169 #define NODE_IS_RESOURCE_FIELD      0x00000010
 170 #define NODE_HAS_NO_EXIT            0x00000020
 171 #define NODE_IF_HAS_NO_EXIT         0x00000040
 172 #define NODE_NAME_INTERNALIZED      0x00000080
 173 #define NODE_METHOD_NO_RETVAL       0x00000100
 174 #define NODE_METHOD_SOME_NO_RETVAL  0x00000200
 175 #define NODE_RESULT_NOT_USED        0x00000400
 176 #define NODE_METHOD_TYPED           0x00000800
 177 #define NODE_COULD_NOT_REDUCE       0x00001000
 178 #define NODE_COMPILE_TIME_CONST     0x00002000
 179 #define NODE_IS_TERM_ARG            0x00004000
 180 #define NODE_WAS_ONES_OP            0x00008000
 181 #define NODE_IS_NAME_DECLARATION    0x00010000
 182 #define NODE_COMPILER_EMITTED       0x00020000
 183 #define NODE_IS_DUPLICATE           0x00040000
 184 #define NODE_IS_RESOURCE_DATA       0x00080000
 185 #define NODE_IS_NULL_RETURN         0x00100000
 186
 187 /* Keeps information about individual control methods */
 188
 189 typedef struct asl_method_info
 190 {
 191     ACPI_PARSE_OBJECT       *Op;
 192     ACPI_PARSE_OBJECT       *CurrentOp;
 193     struct asl_method_info  *Next;
 194     UINT32                  ValidArgTypes[ACPI_METHOD_NUM_ARGS];
 195     UINT32                  ValidReturnTypes;
 196     UINT32                  NumReturnNoValue;
 197     UINT32                  NumReturnWithValue;
 198     UINT8                   NumArguments;
 199     UINT8                   LocalInitialized[ACPI_METHOD_NUM_LOCALS];
 200     UINT8                   ArgInitialized[ACPI_METHOD_NUM_ARGS];
 201     UINT8                   HasBeenTyped;
 202     UINT8                   ShouldBeSerialized;
 203
 204 } ASL_METHOD_INFO;
 205
 206
 207 /* Parse tree walk info for control method analysis */
 208
 209 typedef struct asl_analysis_walk_info
 210 {
 211     ASL_METHOD_INFO         *MethodStack;
 212
 213 } ASL_ANALYSIS_WALK_INFO;
 214
 215
 216 /* An entry in the ParseOpcode to AmlOpcode mapping table */
 217
 218 typedef struct asl_mapping_entry
 219 {
 220     UINT32                      Value;
 221     UINT32                      AcpiBtype;   /* Object type or return type */
 222     UINT16                      AmlOpcode;
 223     UINT8                       Flags;
 224
 225 } ASL_MAPPING_ENTRY;
 226
 227
 228 /* Parse tree walk info structure */
 229
 230 typedef struct asl_walk_info
 231 {
 232     ACPI_PARSE_OBJECT           **NodePtr;
 233     UINT32                      *LevelPtr;
 234
 235 } ASL_WALK_INFO;
 236
 237
 238 /* File info */
 239
 240 typedef struct asl_file_info
 241 {
 242     FILE                        *Handle;
 243     char                        *Filename;
 244     const char                  *ShortDescription;
 245     const char                  *Description;
 246
 247 } ASL_FILE_INFO;
 248
 249 typedef struct asl_file_status
 250 {
 251     UINT32                  Line;
 252     UINT32                  Offset;
 253
 254 } ASL_FILE_STATUS;
 255
 256
 257 /*
 258  * File types. Note: Any changes to this table must also be reflected
 259  * in the Gbl_Files array.
 260  *
 261  * Corresponding filename suffixes are in comments
 262  *
 263  * NOTE: Don't move the first 4 file types
 264  *
 265  * .xxx file extension: this is used as a temporary .aml file for
 266  * the ASL/ASL+ converter and is deleted after conversion. This file
 267  * should never be used in the interpreter.
 268  */
 269 typedef enum
 270 {
 271     ASL_FILE_STDOUT             = 0,
 272     ASL_FILE_STDERR,
 273     ASL_FILE_INPUT,             /* .asl */
 274     ASL_FILE_AML_OUTPUT,        /* .aml */
 275     ASL_FILE_SOURCE_OUTPUT,     /* .src */
 276     ASL_FILE_PREPROCESSOR,      /* .pre */
 277     ASL_FILE_PREPROCESSOR_USER, /* .i   */
 278     ASL_FILE_LISTING_OUTPUT,    /* .lst */
 279     ASL_FILE_HEX_OUTPUT,        /* .hex */
 280     ASL_FILE_NAMESPACE_OUTPUT,  /* .nsp */
 281     ASL_FILE_DEBUG_OUTPUT,      /* .txt */
 282     ASL_FILE_ASM_SOURCE_OUTPUT, /* .asm */
 283     ASL_FILE_C_SOURCE_OUTPUT,   /* .c   */
 284     ASL_FILE_ASM_INCLUDE_OUTPUT,/* .inc */
 285     ASL_FILE_C_INCLUDE_OUTPUT,  /* .h   */
 286     ASL_FILE_C_OFFSET_OUTPUT,   /* .offset.h */
 287     ASL_FILE_MAP_OUTPUT,        /* .map */
 288     ASL_FILE_XREF_OUTPUT,       /* .xrf */
 289     ASL_FILE_CONV_DEBUG_OUTPUT, /* .cdb */
 290     ASL_FILE_CONV_OUTPUT        /* .xxx */
 291
 292 } ASL_FILE_TYPES;
 293
 294
 295 #define ASL_MAX_FILE_TYPE       18
 296 #define ASL_NUM_FILES           (ASL_MAX_FILE_TYPE + 1)
 297
 298 /* Name suffixes used to create filenames for output files */
 299
 300 #define FILE_SUFFIX_ASL_CODE        "asl"
 301 #define FILE_SUFFIX_AML_CODE        "aml"
 302 #define FILE_SUFFIX_SOURCE          "src"
 303 #define FILE_SUFFIX_PREPROCESSOR    "pre"
 304 #define FILE_SUFFIX_PREPROC_USER    "i"
 305 #define FILE_SUFFIX_LISTING         "lst"
 306 #define FILE_SUFFIX_HEX_DUMP        "hex"
 307 #define FILE_SUFFIX_NAMESPACE       "nsp"
 308 #define FILE_SUFFIX_DEBUG           "txt"
 309 #define FILE_SUFFIX_ASM_SOURCE      "asm"
 310 #define FILE_SUFFIX_C_SOURCE        "c"
 311 #define FILE_SUFFIX_ASM_INCLUDE     "inc"
 312 #define FILE_SUFFIX_C_INCLUDE       "h"
 313 #define FILE_SUFFIX_C_OFFSET        "offset.h"
 314 #define FILE_SUFFIX_MAP             "map"
 315 #define FILE_SUFFIX_XREF            "xrf"
 316 #define FILE_SUFFIX_CONVERT_AML     "xxx"
 317 #define FILE_SUFFIX_CONVERT_DEBUG   "cdb"
 318
 319
 320 /* Cache block structure for ParseOps and Strings */
 321
 322 typedef struct asl_cache_info
 323 {
 324     void                            *Next;
 325     char                            Buffer[1];
 326
 327 } ASL_CACHE_INFO;
 328
 329
 330 typedef struct asl_include_dir
 331 {
 332     char                        *Dir;
 333     struct asl_include_dir      *Next;
 334
 335 } ASL_INCLUDE_DIR;
 336
 337
 338 /* An entry in the exception list, one for each error/warning */
 339
 340 typedef struct asl_error_msg
 341 {
 342     UINT32                      LineNumber;
 343     UINT32                      LogicalLineNumber;
 344     UINT32                      LogicalByteOffset;
 345     UINT32                      Column;
 346     char                        *Message;
 347     struct asl_error_msg        *Next;
 348     char                        *Filename;
 349     char                        *SourceLine;
 350     UINT32                      FilenameLength;
 351     UINT16                      MessageId;
 352     UINT8                       Level;
 353
 354 } ASL_ERROR_MSG;
 355
 356
 357 /* An entry in the listing file stack (for include files) */
 358
 359 typedef struct asl_listing_node
 360 {
 361     char                        *Filename;
 362     UINT32                      LineNumber;
 363     struct asl_listing_node     *Next;
 364
 365 } ASL_LISTING_NODE;
 366
 367
 368 /* Callback interface for a parse tree walk */
 369
 370 /*
 371  * TBD - another copy of this is in adisasm.h, fix
 372  */
 373 #ifndef ASL_WALK_CALLBACK_DEFINED
 374 typedef
 375 ACPI_STATUS (*ASL_WALK_CALLBACK) (
 376     ACPI_PARSE_OBJECT           *Op,
 377     UINT32                      Level,
 378     void                        *Context);
 379 #define ASL_WALK_CALLBACK_DEFINED
 380 #endif
 381
 382
 383 typedef struct asl_event_info
 384 {
 385     UINT64                      StartTime;
 386     UINT64                      EndTime;
 387     char                        *EventName;
 388     BOOLEAN                     Valid;
 389
 390 } ASL_EVENT_INFO;
 391
 392
 393 /* Hardware mapping file structures */
 394
 395 typedef struct acpi_gpio_info
 396 {
 397     struct acpi_gpio_info   *Next;
 398     ACPI_PARSE_OBJECT       *Op;
 399     char                    *DeviceName;
 400     ACPI_NAMESPACE_NODE     *TargetNode;
 401     UINT32                  References;
 402     UINT32                  PinCount;
 403     UINT32                  PinIndex;
 404     UINT16                  PinNumber;
 405     UINT8                   Type;
 406     UINT8                   Direction;
 407     UINT8                   Polarity;
 408
 409 } ACPI_GPIO_INFO;
 410
 411 typedef struct acpi_serial_info
 412 {
 413     struct acpi_serial_info *Next;
 414     ACPI_PARSE_OBJECT       *Op;
 415     char                    *DeviceName;
 416     ACPI_NAMESPACE_NODE     *TargetNode;
 417     AML_RESOURCE            *Resource;
 418     UINT32                  Speed;
 419     UINT16                  Address;
 420
 421 } ACPI_SERIAL_INFO;
 422
 423 typedef struct asl_method_local
 424 {
 425     ACPI_PARSE_OBJECT       *Op;
 426     UINT8                   Flags;
 427
 428 } ASL_METHOD_LOCAL;
 429
 430 /* Values for Flags field above */
 431
 432 #define ASL_LOCAL_INITIALIZED   (1)
 433 #define ASL_LOCAL_REFERENCED    (1<<1)
 434 #define ASL_ARG_IS_LOCAL        (1<<2)
 435 #define ASL_ARG_INITIALIZED     (1<<3)
 436 #define ASL_ARG_REFERENCED      (1<<4)
 437
 438 /* Info used to track method counts for cross reference output file */
 439
 440 typedef struct asl_xref_info
 441 {
 442     UINT32                  ThisMethodInvocations;
 443     UINT32                  TotalPredefinedMethods;
 444     UINT32                  TotalUserMethods;
 445     UINT32                  TotalUnreferenceUserMethods;
 446     UINT32                  ThisObjectReferences;
 447     UINT32                  TotalObjects;
 448     UINT32                  TotalUnreferencedObjects;
 449     ACPI_PARSE_OBJECT       *MethodOp;
 450     ACPI_PARSE_OBJECT       *CurrentMethodOp;
 451
 452 } ASL_XREF_INFO;
 453
 454
 455 typedef struct asl_file_node
 456 {
 457     FILE                    *File;
 458     UINT32                  CurrentLineNumber;
 459     void                    *State;
 460     char                    *Filename;
 461     struct asl_file_node    *Next;
 462
 463 } ASL_FILE_NODE;
 464
 465 #endif  /* __ASLTYPES_H */