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

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: asldefine.h - Common defines for the iASL compiler
   5  *              $Revision: 1.6 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118
 119 #ifndef __ASLDEFINE_H
 120 #define __ASLDEFINE_H
 121
 122
 123 /*
 124  * Compiler versions and names
 125  */
 126 #define CompilerCreatorRevision     ACPI_CA_VERSION
 127
 128 #define IntelAcpiCA                 "Intel ACPI Component Architecture"
 129 #define CompilerId                  "ASL Optimizing Compiler"
 130 #define DisassemblerId              "AML Disassembler"
 131 #define CompilerCopyright           "Copyright (C) 2000 - 2006 Intel Corporation"
 132 #define CompilerCompliance          "Supports ACPI Specification Revision 3.0a"
 133 #define CompilerName                "iasl"
 134 #define CompilerCreatorId           "INTL"
 135
 136
 137 /* Configuration constants */
 138
 139 #define ASL_MAX_ERROR_COUNT         200
 140 #define ASL_NODE_CACHE_SIZE         1024
 141 #define ASL_STRING_CACHE_SIZE       32768
 142
 143 #define ASL_FIRST_PARSE_OPCODE      PARSEOP_ACCESSAS
 144 #define ASL_YYTNAME_START           3
 145
 146 #define ASL_PARSE_OPCODE_BASE       PARSEOP_ACCESSAS        /* First Lex type */
 147
 148
 149 /*
 150  * Macros
 151  */
 152 #define ASL_RESDESC_OFFSET(m)       ACPI_OFFSET (AML_RESOURCE, m)
 153 #define ASL_PTR_DIFF(a,b)           ((UINT8 *)(b) - (UINT8 *)(a))
 154 #define ASL_PTR_ADD(a,b)            ((UINT8 *)(a) = ((UINT8 *)(a) + (b)))
 155 #define ASL_GET_CHILD_NODE(a)       (a)->Asl.Child
 156 #define ASL_GET_PEER_NODE(a)        (a)->Asl.Next
 157 #define OP_TABLE_ENTRY(a,b,c,d)     {b,d,a,c}
 158
 159
 160 /* Internal AML opcodes */
 161
 162 #define AML_RAW_DATA_BYTE           (UINT16) 0xAA01 /* write one raw byte */
 163 #define AML_RAW_DATA_WORD           (UINT16) 0xAA02 /* write 2 raw bytes */
 164 #define AML_RAW_DATA_DWORD          (UINT16) 0xAA04 /* write 4 raw bytes */
 165 #define AML_RAW_DATA_QWORD          (UINT16) 0xAA08 /* write 8 raw bytes */
 166 #define AML_RAW_DATA_BUFFER         (UINT16) 0xAA0B /* raw buffer with length */
 167 #define AML_RAW_DATA_CHAIN          (UINT16) 0xAA0C /* chain of raw buffers */
 168 #define AML_PACKAGE_LENGTH          (UINT16) 0xAA10
 169 #define AML_UNASSIGNED_OPCODE       (UINT16) 0xEEEE
 170 #define AML_DEFAULT_ARG_OP          (UINT16) 0xDDDD
 171
 172
 173 /* filename suffixes for output files */
 174
 175 #define FILE_SUFFIX_AML_CODE        "aml"
 176 #define FILE_SUFFIX_LISTING         "lst"
 177 #define FILE_SUFFIX_HEX_DUMP        "hex"
 178 #define FILE_SUFFIX_DEBUG           "txt"
 179 #define FILE_SUFFIX_SOURCE          "src"
 180 #define FILE_SUFFIX_NAMESPACE       "nsp"
 181 #define FILE_SUFFIX_ASM_SOURCE      "asm"
 182 #define FILE_SUFFIX_C_SOURCE        "c"
 183 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
 184 #define FILE_SUFFIX_ASM_INCLUDE     "inc"
 185 #define FILE_SUFFIX_C_INCLUDE       "h"
 186
 187
 188 /* Misc */
 189
 190 #define ASL_EXTERNAL_METHOD         255
 191 #define ASL_ABORT                   TRUE
 192 #define ASL_NO_ABORT                FALSE
 193
 194
 195 /* Support for reserved method names */
 196
 197 #define ACPI_VALID_RESERVED_NAME_MAX    0x80000000
 198 #define ACPI_NOT_RESERVED_NAME          ACPI_UINT32_MAX
 199 #define ACPI_PREDEFINED_NAME            (ACPI_UINT32_MAX - 1)
 200 #define ACPI_EVENT_RESERVED_NAME        (ACPI_UINT32_MAX - 2)
 201 #define ACPI_COMPILER_RESERVED_NAME     (ACPI_UINT32_MAX - 3)
 202
 203
 204 /* String to Integer conversion */
 205
 206 #define NEGATIVE                    1
 207 #define POSITIVE                    0
 208
 209
 210 #endif /* ASLDEFINE.H */
 211