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

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: asldefine.h - Common defines for the iASL compiler
   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 __ASLDEFINE_H
 119 #define __ASLDEFINE_H
 120
 121
 122 /*
 123  * Compiler versions and names
 124  */
 125 #define ASL_REVISION                ACPI_CA_VERSION
 126 #define ASL_COMPILER_NAME           "ASL Optimizing Compiler"
 127 #define AML_DISASSEMBLER_NAME       "AML Disassembler"
 128 #define ASL_INVOCATION_NAME         "iasl"
 129 #define ASL_CREATOR_ID              "INTL"
 130
 131 #define ASL_COMPLIANCE              "Supports ACPI Specification Revision 4.0a"
 132
 133
 134 /* Configuration constants */
 135
 136 #define ASL_MAX_ERROR_COUNT         200
 137 #define ASL_NODE_CACHE_SIZE         1024
 138 #define ASL_STRING_CACHE_SIZE       32768
 139
 140 #define ASL_FIRST_PARSE_OPCODE      PARSEOP_ACCESSAS
 141 #define ASL_YYTNAME_START           3
 142
 143 #define ASL_PARSE_OPCODE_BASE       PARSEOP_ACCESSAS        /* First Lex type */
 144
 145
 146 /*
 147  * Macros
 148  */
 149 #define ASL_RESDESC_OFFSET(m)       ACPI_OFFSET (AML_RESOURCE, m)
 150 #define ASL_PTR_DIFF(a,b)           ((UINT8 *)(b) - (UINT8 *)(a))
 151 #define ASL_PTR_ADD(a,b)            ((UINT8 *)(a) = ((UINT8 *)(a) + (b)))
 152 #define ASL_GET_CHILD_NODE(a)       (a)->Asl.Child
 153 #define ASL_GET_PEER_NODE(a)        (a)->Asl.Next
 154 #define OP_TABLE_ENTRY(a,b,c,d)     {b,d,a,c}
 155
 156
 157 /* Internal AML opcodes */
 158
 159 #define AML_RAW_DATA_BYTE           (UINT16) 0xAA01 /* write one raw byte */
 160 #define AML_RAW_DATA_WORD           (UINT16) 0xAA02 /* write 2 raw bytes */
 161 #define AML_RAW_DATA_DWORD          (UINT16) 0xAA04 /* write 4 raw bytes */
 162 #define AML_RAW_DATA_QWORD          (UINT16) 0xAA08 /* write 8 raw bytes */
 163 #define AML_RAW_DATA_BUFFER         (UINT16) 0xAA0B /* raw buffer with length */
 164 #define AML_RAW_DATA_CHAIN          (UINT16) 0xAA0C /* chain of raw buffers */
 165 #define AML_PACKAGE_LENGTH          (UINT16) 0xAA10
 166 #define AML_UNASSIGNED_OPCODE       (UINT16) 0xEEEE
 167 #define AML_DEFAULT_ARG_OP          (UINT16) 0xDDDD
 168
 169
 170 /* filename suffixes for output files */
 171
 172 #define FILE_SUFFIX_AML_CODE        "aml"
 173 #define FILE_SUFFIX_LISTING         "lst"
 174 #define FILE_SUFFIX_HEX_DUMP        "hex"
 175 #define FILE_SUFFIX_DEBUG           "txt"
 176 #define FILE_SUFFIX_SOURCE          "src"
 177 #define FILE_SUFFIX_NAMESPACE       "nsp"
 178 #define FILE_SUFFIX_ASM_SOURCE      "asm"
 179 #define FILE_SUFFIX_C_SOURCE        "c"
 180 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
 181 #define FILE_SUFFIX_ASM_INCLUDE     "inc"
 182 #define FILE_SUFFIX_C_INCLUDE       "h"
 183 #define FILE_SUFFIX_ASL_CODE        "asl"
 184
 185
 186 /* Types for input files */
 187
 188 #define ASL_INPUT_TYPE_BINARY       0
 189 #define ASL_INPUT_TYPE_ASCII_ASL    1
 190 #define ASL_INPUT_TYPE_ASCII_DATA   2
 191
 192
 193 /* Misc */
 194
 195 #define ASL_EXTERNAL_METHOD         255
 196 #define ASL_ABORT                   TRUE
 197 #define ASL_NO_ABORT                FALSE
 198
 199
 200 /* Support for reserved method names */
 201
 202 #define ACPI_VALID_RESERVED_NAME_MAX    0x80000000
 203 #define ACPI_NOT_RESERVED_NAME          ACPI_UINT32_MAX
 204 #define ACPI_PREDEFINED_NAME            (ACPI_UINT32_MAX - 1)
 205 #define ACPI_EVENT_RESERVED_NAME        (ACPI_UINT32_MAX - 2)
 206 #define ACPI_COMPILER_RESERVED_NAME     (ACPI_UINT32_MAX - 3)
 207
 208
 209 /* String to Integer conversion */
 210
 211 #define NEGATIVE                    1
 212 #define POSITIVE                    0
 213
 214
 215 #endif /* ASLDEFINE.H */
 216