Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
| 3 | * Name: amlcode.h - Definitions for AML, as included in "definition blocks" |
| 4 | * Declarations and definitions contained herein are derived |
| 5 | * directly from the ACPI specification. |
| 6 | * |
| 7 | *****************************************************************************/ |
| 8 | |
| 9 | /* |
Bob Moore | 4a90c7e | 2006-01-13 16:22:00 -0500 | [diff] [blame] | 10 | * Copyright (C) 2000 - 2006, R. Byron Moore |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | * All rights reserved. |
| 12 | * |
| 13 | * Redistribution and use in source and binary forms, with or without |
| 14 | * modification, are permitted provided that the following conditions |
| 15 | * are met: |
| 16 | * 1. Redistributions of source code must retain the above copyright |
| 17 | * notice, this list of conditions, and the following disclaimer, |
| 18 | * without modification. |
| 19 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer |
| 20 | * substantially similar to the "NO WARRANTY" disclaimer below |
| 21 | * ("Disclaimer") and any redistribution must be conditioned upon |
| 22 | * including a substantially similar Disclaimer requirement for further |
| 23 | * binary redistribution. |
| 24 | * 3. Neither the names of the above-listed copyright holders nor the names |
| 25 | * of any contributors may be used to endorse or promote products derived |
| 26 | * from this software without specific prior written permission. |
| 27 | * |
| 28 | * Alternatively, this software may be distributed under the terms of the |
| 29 | * GNU General Public License ("GPL") version 2 as published by the Free |
| 30 | * Software Foundation. |
| 31 | * |
| 32 | * NO WARRANTY |
| 33 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 34 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 35 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR |
| 36 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 37 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 38 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 39 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 40 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| 41 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| 42 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 43 | * POSSIBILITY OF SUCH DAMAGES. |
| 44 | */ |
| 45 | |
| 46 | #ifndef __AMLCODE_H__ |
| 47 | #define __AMLCODE_H__ |
| 48 | |
| 49 | /* primary opcodes */ |
| 50 | |
| 51 | #define AML_NULL_CHAR (u16) 0x00 |
| 52 | |
| 53 | #define AML_ZERO_OP (u16) 0x00 |
| 54 | #define AML_ONE_OP (u16) 0x01 |
| 55 | #define AML_UNASSIGNED (u16) 0x02 |
| 56 | #define AML_ALIAS_OP (u16) 0x06 |
| 57 | #define AML_NAME_OP (u16) 0x08 |
| 58 | #define AML_BYTE_OP (u16) 0x0a |
| 59 | #define AML_WORD_OP (u16) 0x0b |
| 60 | #define AML_DWORD_OP (u16) 0x0c |
| 61 | #define AML_STRING_OP (u16) 0x0d |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 62 | #define AML_QWORD_OP (u16) 0x0e /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | #define AML_SCOPE_OP (u16) 0x10 |
| 64 | #define AML_BUFFER_OP (u16) 0x11 |
| 65 | #define AML_PACKAGE_OP (u16) 0x12 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 66 | #define AML_VAR_PACKAGE_OP (u16) 0x13 /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | #define AML_METHOD_OP (u16) 0x14 |
| 68 | #define AML_DUAL_NAME_PREFIX (u16) 0x2e |
| 69 | #define AML_MULTI_NAME_PREFIX_OP (u16) 0x2f |
| 70 | #define AML_NAME_CHAR_SUBSEQ (u16) 0x30 |
| 71 | #define AML_NAME_CHAR_FIRST (u16) 0x41 |
Robert Moore | 73459f7 | 2005-06-24 00:00:00 -0400 | [diff] [blame] | 72 | #define AML_EXTENDED_OP_PREFIX (u16) 0x5b |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | #define AML_ROOT_PREFIX (u16) 0x5c |
| 74 | #define AML_PARENT_PREFIX (u16) 0x5e |
| 75 | #define AML_LOCAL_OP (u16) 0x60 |
| 76 | #define AML_LOCAL0 (u16) 0x60 |
| 77 | #define AML_LOCAL1 (u16) 0x61 |
| 78 | #define AML_LOCAL2 (u16) 0x62 |
| 79 | #define AML_LOCAL3 (u16) 0x63 |
| 80 | #define AML_LOCAL4 (u16) 0x64 |
| 81 | #define AML_LOCAL5 (u16) 0x65 |
| 82 | #define AML_LOCAL6 (u16) 0x66 |
| 83 | #define AML_LOCAL7 (u16) 0x67 |
| 84 | #define AML_ARG_OP (u16) 0x68 |
| 85 | #define AML_ARG0 (u16) 0x68 |
| 86 | #define AML_ARG1 (u16) 0x69 |
| 87 | #define AML_ARG2 (u16) 0x6a |
| 88 | #define AML_ARG3 (u16) 0x6b |
| 89 | #define AML_ARG4 (u16) 0x6c |
| 90 | #define AML_ARG5 (u16) 0x6d |
| 91 | #define AML_ARG6 (u16) 0x6e |
| 92 | #define AML_STORE_OP (u16) 0x70 |
| 93 | #define AML_REF_OF_OP (u16) 0x71 |
| 94 | #define AML_ADD_OP (u16) 0x72 |
| 95 | #define AML_CONCAT_OP (u16) 0x73 |
| 96 | #define AML_SUBTRACT_OP (u16) 0x74 |
| 97 | #define AML_INCREMENT_OP (u16) 0x75 |
| 98 | #define AML_DECREMENT_OP (u16) 0x76 |
| 99 | #define AML_MULTIPLY_OP (u16) 0x77 |
| 100 | #define AML_DIVIDE_OP (u16) 0x78 |
| 101 | #define AML_SHIFT_LEFT_OP (u16) 0x79 |
| 102 | #define AML_SHIFT_RIGHT_OP (u16) 0x7a |
| 103 | #define AML_BIT_AND_OP (u16) 0x7b |
| 104 | #define AML_BIT_NAND_OP (u16) 0x7c |
| 105 | #define AML_BIT_OR_OP (u16) 0x7d |
| 106 | #define AML_BIT_NOR_OP (u16) 0x7e |
| 107 | #define AML_BIT_XOR_OP (u16) 0x7f |
| 108 | #define AML_BIT_NOT_OP (u16) 0x80 |
| 109 | #define AML_FIND_SET_LEFT_BIT_OP (u16) 0x81 |
| 110 | #define AML_FIND_SET_RIGHT_BIT_OP (u16) 0x82 |
| 111 | #define AML_DEREF_OF_OP (u16) 0x83 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 112 | #define AML_CONCAT_RES_OP (u16) 0x84 /* ACPI 2.0 */ |
| 113 | #define AML_MOD_OP (u16) 0x85 /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | #define AML_NOTIFY_OP (u16) 0x86 |
| 115 | #define AML_SIZE_OF_OP (u16) 0x87 |
| 116 | #define AML_INDEX_OP (u16) 0x88 |
| 117 | #define AML_MATCH_OP (u16) 0x89 |
| 118 | #define AML_CREATE_DWORD_FIELD_OP (u16) 0x8a |
| 119 | #define AML_CREATE_WORD_FIELD_OP (u16) 0x8b |
| 120 | #define AML_CREATE_BYTE_FIELD_OP (u16) 0x8c |
| 121 | #define AML_CREATE_BIT_FIELD_OP (u16) 0x8d |
| 122 | #define AML_TYPE_OP (u16) 0x8e |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 123 | #define AML_CREATE_QWORD_FIELD_OP (u16) 0x8f /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | #define AML_LAND_OP (u16) 0x90 |
| 125 | #define AML_LOR_OP (u16) 0x91 |
| 126 | #define AML_LNOT_OP (u16) 0x92 |
| 127 | #define AML_LEQUAL_OP (u16) 0x93 |
| 128 | #define AML_LGREATER_OP (u16) 0x94 |
| 129 | #define AML_LLESS_OP (u16) 0x95 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 130 | #define AML_TO_BUFFER_OP (u16) 0x96 /* ACPI 2.0 */ |
| 131 | #define AML_TO_DECSTRING_OP (u16) 0x97 /* ACPI 2.0 */ |
| 132 | #define AML_TO_HEXSTRING_OP (u16) 0x98 /* ACPI 2.0 */ |
| 133 | #define AML_TO_INTEGER_OP (u16) 0x99 /* ACPI 2.0 */ |
| 134 | #define AML_TO_STRING_OP (u16) 0x9c /* ACPI 2.0 */ |
| 135 | #define AML_COPY_OP (u16) 0x9d /* ACPI 2.0 */ |
| 136 | #define AML_MID_OP (u16) 0x9e /* ACPI 2.0 */ |
| 137 | #define AML_CONTINUE_OP (u16) 0x9f /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | #define AML_IF_OP (u16) 0xa0 |
| 139 | #define AML_ELSE_OP (u16) 0xa1 |
| 140 | #define AML_WHILE_OP (u16) 0xa2 |
| 141 | #define AML_NOOP_OP (u16) 0xa3 |
| 142 | #define AML_RETURN_OP (u16) 0xa4 |
| 143 | #define AML_BREAK_OP (u16) 0xa5 |
| 144 | #define AML_BREAK_POINT_OP (u16) 0xcc |
| 145 | #define AML_ONES_OP (u16) 0xff |
| 146 | |
| 147 | /* prefixed opcodes */ |
| 148 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 149 | #define AML_EXTENDED_OPCODE (u16) 0x5b00 /* prefix for 2-byte opcodes */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | |
| 151 | #define AML_MUTEX_OP (u16) 0x5b01 |
| 152 | #define AML_EVENT_OP (u16) 0x5b02 |
| 153 | #define AML_SHIFT_RIGHT_BIT_OP (u16) 0x5b10 |
| 154 | #define AML_SHIFT_LEFT_BIT_OP (u16) 0x5b11 |
| 155 | #define AML_COND_REF_OF_OP (u16) 0x5b12 |
| 156 | #define AML_CREATE_FIELD_OP (u16) 0x5b13 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 157 | #define AML_LOAD_TABLE_OP (u16) 0x5b1f /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | #define AML_LOAD_OP (u16) 0x5b20 |
| 159 | #define AML_STALL_OP (u16) 0x5b21 |
| 160 | #define AML_SLEEP_OP (u16) 0x5b22 |
| 161 | #define AML_ACQUIRE_OP (u16) 0x5b23 |
| 162 | #define AML_SIGNAL_OP (u16) 0x5b24 |
| 163 | #define AML_WAIT_OP (u16) 0x5b25 |
| 164 | #define AML_RESET_OP (u16) 0x5b26 |
| 165 | #define AML_RELEASE_OP (u16) 0x5b27 |
| 166 | #define AML_FROM_BCD_OP (u16) 0x5b28 |
| 167 | #define AML_TO_BCD_OP (u16) 0x5b29 |
| 168 | #define AML_UNLOAD_OP (u16) 0x5b2a |
| 169 | #define AML_REVISION_OP (u16) 0x5b30 |
| 170 | #define AML_DEBUG_OP (u16) 0x5b31 |
| 171 | #define AML_FATAL_OP (u16) 0x5b32 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 172 | #define AML_TIMER_OP (u16) 0x5b33 /* ACPI 3.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | #define AML_REGION_OP (u16) 0x5b80 |
| 174 | #define AML_FIELD_OP (u16) 0x5b81 |
| 175 | #define AML_DEVICE_OP (u16) 0x5b82 |
| 176 | #define AML_PROCESSOR_OP (u16) 0x5b83 |
| 177 | #define AML_POWER_RES_OP (u16) 0x5b84 |
| 178 | #define AML_THERMAL_ZONE_OP (u16) 0x5b85 |
| 179 | #define AML_INDEX_FIELD_OP (u16) 0x5b86 |
| 180 | #define AML_BANK_FIELD_OP (u16) 0x5b87 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 181 | #define AML_DATA_REGION_OP (u16) 0x5b88 /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | |
Bob Moore | 958dd24 | 2006-05-12 17:12:00 -0400 | [diff] [blame] | 183 | /* |
| 184 | * Combination opcodes (actually two one-byte opcodes) |
| 185 | * Used by the disassembler and i_aSL compiler |
| 186 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 187 | #define AML_LGREATEREQUAL_OP (u16) 0x9295 |
| 188 | #define AML_LLESSEQUAL_OP (u16) 0x9294 |
| 189 | #define AML_LNOTEQUAL_OP (u16) 0x9293 |
| 190 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | /* |
| 192 | * Internal opcodes |
| 193 | * Use only "Unknown" AML opcodes, don't attempt to use |
| 194 | * any valid ACPI ASCII values (A-Z, 0-9, '-') |
| 195 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | #define AML_INT_NAMEPATH_OP (u16) 0x002d |
| 197 | #define AML_INT_NAMEDFIELD_OP (u16) 0x0030 |
| 198 | #define AML_INT_RESERVEDFIELD_OP (u16) 0x0031 |
| 199 | #define AML_INT_ACCESSFIELD_OP (u16) 0x0032 |
| 200 | #define AML_INT_BYTELIST_OP (u16) 0x0033 |
| 201 | #define AML_INT_STATICSTRING_OP (u16) 0x0034 |
| 202 | #define AML_INT_METHODCALL_OP (u16) 0x0035 |
| 203 | #define AML_INT_RETURN_VALUE_OP (u16) 0x0036 |
| 204 | #define AML_INT_EVAL_SUBTREE_OP (u16) 0x0037 |
| 205 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 206 | #define ARG_NONE 0x0 |
| 207 | |
| 208 | /* |
| 209 | * Argument types for the AML Parser |
| 210 | * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments. |
| 211 | * There can be up to 31 unique argument types |
| 212 | * Zero is reserved as end-of-list indicator |
| 213 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 214 | #define ARGP_BYTEDATA 0x01 |
| 215 | #define ARGP_BYTELIST 0x02 |
| 216 | #define ARGP_CHARLIST 0x03 |
| 217 | #define ARGP_DATAOBJ 0x04 |
| 218 | #define ARGP_DATAOBJLIST 0x05 |
| 219 | #define ARGP_DWORDDATA 0x06 |
| 220 | #define ARGP_FIELDLIST 0x07 |
| 221 | #define ARGP_NAME 0x08 |
| 222 | #define ARGP_NAMESTRING 0x09 |
| 223 | #define ARGP_OBJLIST 0x0A |
| 224 | #define ARGP_PKGLENGTH 0x0B |
| 225 | #define ARGP_SUPERNAME 0x0C |
| 226 | #define ARGP_TARGET 0x0D |
| 227 | #define ARGP_TERMARG 0x0E |
| 228 | #define ARGP_TERMLIST 0x0F |
| 229 | #define ARGP_WORDDATA 0x10 |
| 230 | #define ARGP_QWORDDATA 0x11 |
| 231 | #define ARGP_SIMPLENAME 0x12 |
| 232 | |
| 233 | /* |
| 234 | * Resolved argument types for the AML Interpreter |
| 235 | * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments. |
| 236 | * There can be up to 31 unique argument types (0 is end-of-arg-list indicator) |
| 237 | * |
| 238 | * Note1: These values are completely independent from the ACPI_TYPEs |
| 239 | * i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER |
| 240 | * |
| 241 | * Note2: If and when 5 bits becomes insufficient, it would probably be best |
| 242 | * to convert to a 6-byte array of argument types, allowing 8 bits per argument. |
| 243 | */ |
| 244 | |
| 245 | /* Single, simple types */ |
| 246 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 247 | #define ARGI_ANYTYPE 0x01 /* Don't care */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 248 | #define ARGI_PACKAGE 0x02 |
| 249 | #define ARGI_EVENT 0x03 |
| 250 | #define ARGI_MUTEX 0x04 |
| 251 | #define ARGI_DDBHANDLE 0x05 |
| 252 | |
| 253 | /* Interchangeable types (via implicit conversion) */ |
| 254 | |
| 255 | #define ARGI_INTEGER 0x06 |
| 256 | #define ARGI_STRING 0x07 |
| 257 | #define ARGI_BUFFER 0x08 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 258 | #define ARGI_BUFFER_OR_STRING 0x09 /* Used by MID op only */ |
| 259 | #define ARGI_COMPUTEDATA 0x0A /* Buffer, String, or Integer */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 260 | |
| 261 | /* Reference objects */ |
| 262 | |
| 263 | #define ARGI_INTEGER_REF 0x0B |
| 264 | #define ARGI_OBJECT_REF 0x0C |
| 265 | #define ARGI_DEVICE_REF 0x0D |
| 266 | #define ARGI_REFERENCE 0x0E |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 267 | #define ARGI_TARGETREF 0x0F /* Target, subject to implicit conversion */ |
| 268 | #define ARGI_FIXED_TARGET 0x10 /* Target, no implicit conversion */ |
| 269 | #define ARGI_SIMPLE_TARGET 0x11 /* Name, Local, Arg -- no implicit conversion */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 270 | |
| 271 | /* Multiple/complex types */ |
| 272 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 273 | #define ARGI_DATAOBJECT 0x12 /* Buffer, String, package or reference to a Node - Used only by size_of operator */ |
| 274 | #define ARGI_COMPLEXOBJ 0x13 /* Buffer, String, or package (Used by INDEX op only) */ |
| 275 | #define ARGI_REF_OR_STRING 0x14 /* Reference or String (Used by DEREFOF op only) */ |
Alexey Starikovskiy | a6823e1 | 2007-02-02 19:48:22 +0300 | [diff] [blame^] | 276 | #define ARGI_REGION_OR_BUFFER 0x15 /* Used by LOAD op only */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | #define ARGI_DATAREFOBJ 0x16 |
| 278 | |
| 279 | /* Note: types above can expand to 0x1F maximum */ |
| 280 | |
| 281 | #define ARGI_INVALID_OPCODE 0xFFFFFFFF |
| 282 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 283 | /* |
| 284 | * hash offsets |
| 285 | */ |
| 286 | #define AML_EXTOP_HASH_OFFSET 22 |
| 287 | #define AML_LNOT_HASH_OFFSET 19 |
| 288 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 289 | /* |
| 290 | * opcode groups and types |
| 291 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 292 | #define OPGRP_NAMED 0x01 |
| 293 | #define OPGRP_FIELD 0x02 |
| 294 | #define OPGRP_BYTELIST 0x04 |
| 295 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 296 | /* |
| 297 | * Opcode information |
| 298 | */ |
| 299 | |
| 300 | /* Opcode flags */ |
| 301 | |
| 302 | #define AML_LOGICAL 0x0001 |
| 303 | #define AML_LOGICAL_NUMERIC 0x0002 |
| 304 | #define AML_MATH 0x0004 |
| 305 | #define AML_CREATE 0x0008 |
| 306 | #define AML_FIELD 0x0010 |
| 307 | #define AML_DEFER 0x0020 |
| 308 | #define AML_NAMED 0x0040 |
| 309 | #define AML_NSNODE 0x0080 |
| 310 | #define AML_NSOPCODE 0x0100 |
| 311 | #define AML_NSOBJECT 0x0200 |
| 312 | #define AML_HAS_RETVAL 0x0400 |
| 313 | #define AML_HAS_TARGET 0x0800 |
| 314 | #define AML_HAS_ARGS 0x1000 |
| 315 | #define AML_CONSTANT 0x2000 |
| 316 | #define AML_NO_OPERAND_RESOLVE 0x4000 |
| 317 | |
| 318 | /* Convenient flag groupings */ |
| 319 | |
| 320 | #define AML_FLAGS_EXEC_0A_0T_1R AML_HAS_RETVAL |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 321 | #define AML_FLAGS_EXEC_1A_0T_0R AML_HAS_ARGS /* Monadic1 */ |
| 322 | #define AML_FLAGS_EXEC_1A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Monadic2 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 323 | #define AML_FLAGS_EXEC_1A_1T_0R AML_HAS_ARGS | AML_HAS_TARGET |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 324 | #define AML_FLAGS_EXEC_1A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* monadic2_r */ |
| 325 | #define AML_FLAGS_EXEC_2A_0T_0R AML_HAS_ARGS /* Dyadic1 */ |
| 326 | #define AML_FLAGS_EXEC_2A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Dyadic2 */ |
| 327 | #define AML_FLAGS_EXEC_2A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* dyadic2_r */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 328 | #define AML_FLAGS_EXEC_2A_2T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL |
| 329 | #define AML_FLAGS_EXEC_3A_0T_0R AML_HAS_ARGS |
| 330 | #define AML_FLAGS_EXEC_3A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL |
| 331 | #define AML_FLAGS_EXEC_6A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL |
| 332 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 333 | /* |
| 334 | * The opcode Type is used in a dispatch table, do not change |
| 335 | * without updating the table. |
| 336 | */ |
| 337 | #define AML_TYPE_EXEC_0A_0T_1R 0x00 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 338 | #define AML_TYPE_EXEC_1A_0T_0R 0x01 /* Monadic1 */ |
| 339 | #define AML_TYPE_EXEC_1A_0T_1R 0x02 /* Monadic2 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 340 | #define AML_TYPE_EXEC_1A_1T_0R 0x03 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 341 | #define AML_TYPE_EXEC_1A_1T_1R 0x04 /* monadic2_r */ |
| 342 | #define AML_TYPE_EXEC_2A_0T_0R 0x05 /* Dyadic1 */ |
| 343 | #define AML_TYPE_EXEC_2A_0T_1R 0x06 /* Dyadic2 */ |
| 344 | #define AML_TYPE_EXEC_2A_1T_1R 0x07 /* dyadic2_r */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 345 | #define AML_TYPE_EXEC_2A_2T_1R 0x08 |
| 346 | #define AML_TYPE_EXEC_3A_0T_0R 0x09 |
| 347 | #define AML_TYPE_EXEC_3A_1T_1R 0x0A |
| 348 | #define AML_TYPE_EXEC_6A_0T_1R 0x0B |
| 349 | /* End of types used in dispatch table */ |
| 350 | |
| 351 | #define AML_TYPE_LITERAL 0x0B |
| 352 | #define AML_TYPE_CONSTANT 0x0C |
| 353 | #define AML_TYPE_METHOD_ARGUMENT 0x0D |
| 354 | #define AML_TYPE_LOCAL_VARIABLE 0x0E |
| 355 | #define AML_TYPE_DATA_TERM 0x0F |
| 356 | |
| 357 | /* Generic for an op that returns a value */ |
| 358 | |
| 359 | #define AML_TYPE_METHOD_CALL 0x10 |
| 360 | |
| 361 | /* Misc */ |
| 362 | |
| 363 | #define AML_TYPE_CREATE_FIELD 0x11 |
| 364 | #define AML_TYPE_CREATE_OBJECT 0x12 |
| 365 | #define AML_TYPE_CONTROL 0x13 |
| 366 | #define AML_TYPE_NAMED_NO_OBJ 0x14 |
| 367 | #define AML_TYPE_NAMED_FIELD 0x15 |
| 368 | #define AML_TYPE_NAMED_SIMPLE 0x16 |
| 369 | #define AML_TYPE_NAMED_COMPLEX 0x17 |
| 370 | #define AML_TYPE_RETURN 0x18 |
| 371 | |
| 372 | #define AML_TYPE_UNDEFINED 0x19 |
| 373 | #define AML_TYPE_BOGUS 0x1A |
| 374 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 375 | /* AML Package Length encodings */ |
| 376 | |
| 377 | #define ACPI_AML_PACKAGE_TYPE1 0x40 |
| 378 | #define ACPI_AML_PACKAGE_TYPE2 0x4000 |
| 379 | #define ACPI_AML_PACKAGE_TYPE3 0x400000 |
| 380 | #define ACPI_AML_PACKAGE_TYPE4 0x40000000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 381 | |
| 382 | /* |
| 383 | * Opcode classes |
| 384 | */ |
| 385 | #define AML_CLASS_EXECUTE 0x00 |
| 386 | #define AML_CLASS_CREATE 0x01 |
| 387 | #define AML_CLASS_ARGUMENT 0x02 |
| 388 | #define AML_CLASS_NAMED_OBJECT 0x03 |
| 389 | #define AML_CLASS_CONTROL 0x04 |
| 390 | #define AML_CLASS_ASCII 0x05 |
| 391 | #define AML_CLASS_PREFIX 0x06 |
| 392 | #define AML_CLASS_INTERNAL 0x07 |
| 393 | #define AML_CLASS_RETURN_VALUE 0x08 |
| 394 | #define AML_CLASS_METHOD_CALL 0x09 |
| 395 | #define AML_CLASS_UNKNOWN 0x0A |
| 396 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 397 | /* Predefined Operation Region space_iDs */ |
| 398 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 399 | typedef enum { |
| 400 | REGION_MEMORY = 0, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 401 | REGION_IO, |
| 402 | REGION_PCI_CONFIG, |
| 403 | REGION_EC, |
| 404 | REGION_SMBUS, |
| 405 | REGION_CMOS, |
| 406 | REGION_PCI_BAR, |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 407 | REGION_DATA_TABLE, /* Internal use only */ |
| 408 | REGION_FIXED_HW = 0x7F |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 409 | } AML_REGION_TYPES; |
| 410 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 411 | /* Comparison operation codes for match_op operator */ |
| 412 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 413 | typedef enum { |
| 414 | MATCH_MTR = 0, |
| 415 | MATCH_MEQ = 1, |
| 416 | MATCH_MLE = 2, |
| 417 | MATCH_MLT = 3, |
| 418 | MATCH_MGE = 4, |
| 419 | MATCH_MGT = 5 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 420 | } AML_MATCH_OPERATOR; |
| 421 | |
| 422 | #define MAX_MATCH_OPERATOR 5 |
| 423 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 424 | /* |
| 425 | * field_flags |
| 426 | * |
| 427 | * This byte is extracted from the AML and includes three separate |
| 428 | * pieces of information about the field: |
| 429 | * 1) The field access type |
| 430 | * 2) The field update rule |
| 431 | * 3) The lock rule for the field |
| 432 | * |
| 433 | * Bits 00 - 03 : access_type (any_acc, byte_acc, etc.) |
| 434 | * 04 : lock_rule (1 == Lock) |
| 435 | * 05 - 06 : update_rule |
| 436 | */ |
| 437 | #define AML_FIELD_ACCESS_TYPE_MASK 0x0F |
| 438 | #define AML_FIELD_LOCK_RULE_MASK 0x10 |
| 439 | #define AML_FIELD_UPDATE_RULE_MASK 0x60 |
| 440 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 441 | /* 1) Field Access Types */ |
| 442 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 443 | typedef enum { |
| 444 | AML_FIELD_ACCESS_ANY = 0x00, |
| 445 | AML_FIELD_ACCESS_BYTE = 0x01, |
| 446 | AML_FIELD_ACCESS_WORD = 0x02, |
| 447 | AML_FIELD_ACCESS_DWORD = 0x03, |
| 448 | AML_FIELD_ACCESS_QWORD = 0x04, /* ACPI 2.0 */ |
| 449 | AML_FIELD_ACCESS_BUFFER = 0x05 /* ACPI 2.0 */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 450 | } AML_ACCESS_TYPE; |
| 451 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 452 | /* 2) Field Lock Rules */ |
| 453 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 454 | typedef enum { |
| 455 | AML_FIELD_LOCK_NEVER = 0x00, |
| 456 | AML_FIELD_LOCK_ALWAYS = 0x10 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 457 | } AML_LOCK_RULE; |
| 458 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 459 | /* 3) Field Update Rules */ |
| 460 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 461 | typedef enum { |
| 462 | AML_FIELD_UPDATE_PRESERVE = 0x00, |
| 463 | AML_FIELD_UPDATE_WRITE_AS_ONES = 0x20, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 464 | AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 465 | } AML_UPDATE_RULE; |
| 466 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 467 | /* |
| 468 | * Field Access Attributes. |
| 469 | * This byte is extracted from the AML via the |
| 470 | * access_as keyword |
| 471 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 472 | typedef enum { |
| 473 | AML_FIELD_ATTRIB_SMB_QUICK = 0x02, |
| 474 | AML_FIELD_ATTRIB_SMB_SEND_RCV = 0x04, |
| 475 | AML_FIELD_ATTRIB_SMB_BYTE = 0x06, |
| 476 | AML_FIELD_ATTRIB_SMB_WORD = 0x08, |
| 477 | AML_FIELD_ATTRIB_SMB_BLOCK = 0x0A, |
| 478 | AML_FIELD_ATTRIB_SMB_WORD_CALL = 0x0C, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 479 | AML_FIELD_ATTRIB_SMB_BLOCK_CALL = 0x0D |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 480 | } AML_ACCESS_ATTRIBUTE; |
| 481 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 482 | /* Bit fields in method_flags byte */ |
| 483 | |
| 484 | #define AML_METHOD_ARG_COUNT 0x07 |
| 485 | #define AML_METHOD_SERIALIZED 0x08 |
| 486 | #define AML_METHOD_SYNCH_LEVEL 0xF0 |
| 487 | |
| 488 | /* METHOD_FLAGS_ARG_COUNT is not used internally, define additional flags */ |
| 489 | |
| 490 | #define AML_METHOD_INTERNAL_ONLY 0x01 |
| 491 | #define AML_METHOD_RESERVED1 0x02 |
| 492 | #define AML_METHOD_RESERVED2 0x04 |
| 493 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 494 | #endif /* __AMLCODE_H__ */ |