initial commit with v2.6.9
[linux-2.6.9-moxart.git] / include / acpi / amlcode.h
blob0344b94c863d65f287360f1816c48e1c7f373e4a
1 /******************************************************************************
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.
7 *****************************************************************************/
9 /*
10 * Copyright (C) 2000 - 2004, R. Byron Moore
11 * All rights reserved.
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.
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.
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.
46 #ifndef __AMLCODE_H__
47 #define __AMLCODE_H__
49 /* primary opcodes */
51 #define AML_NULL_CHAR (u16) 0x00
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
62 #define AML_QWORD_OP (u16) 0x0e /* ACPI 2.0 */
63 #define AML_SCOPE_OP (u16) 0x10
64 #define AML_BUFFER_OP (u16) 0x11
65 #define AML_PACKAGE_OP (u16) 0x12
66 #define AML_VAR_PACKAGE_OP (u16) 0x13 /* ACPI 2.0 */
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
72 #define AML_OP_PREFIX (u16) 0x5b
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
112 #define AML_CONCAT_RES_OP (u16) 0x84 /* ACPI 2.0 */
113 #define AML_MOD_OP (u16) 0x85 /* ACPI 2.0 */
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
123 #define AML_CREATE_QWORD_FIELD_OP (u16) 0x8f /* ACPI 2.0 */
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
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 */
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
147 /* prefixed opcodes */
149 #define AML_EXTOP (u16) 0x005b
152 #define AML_MUTEX_OP (u16) 0x5b01
153 #define AML_EVENT_OP (u16) 0x5b02
154 #define AML_SHIFT_RIGHT_BIT_OP (u16) 0x5b10
155 #define AML_SHIFT_LEFT_BIT_OP (u16) 0x5b11
156 #define AML_COND_REF_OF_OP (u16) 0x5b12
157 #define AML_CREATE_FIELD_OP (u16) 0x5b13
158 #define AML_LOAD_TABLE_OP (u16) 0x5b1f /* ACPI 2.0 */
159 #define AML_LOAD_OP (u16) 0x5b20
160 #define AML_STALL_OP (u16) 0x5b21
161 #define AML_SLEEP_OP (u16) 0x5b22
162 #define AML_ACQUIRE_OP (u16) 0x5b23
163 #define AML_SIGNAL_OP (u16) 0x5b24
164 #define AML_WAIT_OP (u16) 0x5b25
165 #define AML_RESET_OP (u16) 0x5b26
166 #define AML_RELEASE_OP (u16) 0x5b27
167 #define AML_FROM_BCD_OP (u16) 0x5b28
168 #define AML_TO_BCD_OP (u16) 0x5b29
169 #define AML_UNLOAD_OP (u16) 0x5b2a
170 #define AML_REVISION_OP (u16) 0x5b30
171 #define AML_DEBUG_OP (u16) 0x5b31
172 #define AML_FATAL_OP (u16) 0x5b32
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
181 #define AML_DATA_REGION_OP (u16) 0x5b88 /* ACPI 2.0 */
184 /* Bogus opcodes (they are actually two separate opcodes) */
186 #define AML_LGREATEREQUAL_OP (u16) 0x9295
187 #define AML_LLESSEQUAL_OP (u16) 0x9294
188 #define AML_LNOTEQUAL_OP (u16) 0x9293
192 * Internal opcodes
193 * Use only "Unknown" AML opcodes, don't attempt to use
194 * any valid ACPI ASCII values (A-Z, 0-9, '-')
197 #define AML_INT_NAMEPATH_OP (u16) 0x002d
198 #define AML_INT_NAMEDFIELD_OP (u16) 0x0030
199 #define AML_INT_RESERVEDFIELD_OP (u16) 0x0031
200 #define AML_INT_ACCESSFIELD_OP (u16) 0x0032
201 #define AML_INT_BYTELIST_OP (u16) 0x0033
202 #define AML_INT_STATICSTRING_OP (u16) 0x0034
203 #define AML_INT_METHODCALL_OP (u16) 0x0035
204 #define AML_INT_RETURN_VALUE_OP (u16) 0x0036
205 #define AML_INT_EVAL_SUBTREE_OP (u16) 0x0037
208 #define ARG_NONE 0x0
211 * Argument types for the AML Parser
212 * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments.
213 * There can be up to 31 unique argument types
214 * Zero is reserved as end-of-list indicator
217 #define ARGP_BYTEDATA 0x01
218 #define ARGP_BYTELIST 0x02
219 #define ARGP_CHARLIST 0x03
220 #define ARGP_DATAOBJ 0x04
221 #define ARGP_DATAOBJLIST 0x05
222 #define ARGP_DWORDDATA 0x06
223 #define ARGP_FIELDLIST 0x07
224 #define ARGP_NAME 0x08
225 #define ARGP_NAMESTRING 0x09
226 #define ARGP_OBJLIST 0x0A
227 #define ARGP_PKGLENGTH 0x0B
228 #define ARGP_SUPERNAME 0x0C
229 #define ARGP_TARGET 0x0D
230 #define ARGP_TERMARG 0x0E
231 #define ARGP_TERMLIST 0x0F
232 #define ARGP_WORDDATA 0x10
233 #define ARGP_QWORDDATA 0x11
234 #define ARGP_SIMPLENAME 0x12
237 * Resolved argument types for the AML Interpreter
238 * Each field in the arg_types u32 is 5 bits, allowing for a maximum of 6 arguments.
239 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
241 * Note1: These values are completely independent from the ACPI_TYPEs
242 * i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
244 * Note2: If and when 5 bits becomes insufficient, it would probably be best
245 * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
248 /* Single, simple types */
250 #define ARGI_ANYTYPE 0x01 /* Don't care */
251 #define ARGI_PACKAGE 0x02
252 #define ARGI_EVENT 0x03
253 #define ARGI_MUTEX 0x04
254 #define ARGI_DDBHANDLE 0x05
256 /* Interchangeable types (via implicit conversion) */
258 #define ARGI_INTEGER 0x06
259 #define ARGI_STRING 0x07
260 #define ARGI_BUFFER 0x08
261 #define ARGI_BUFFER_OR_STRING 0x09 /* Used by MID op only */
262 #define ARGI_COMPUTEDATA 0x0A /* Buffer, String, or Integer */
264 /* Reference objects */
266 #define ARGI_INTEGER_REF 0x0B
267 #define ARGI_OBJECT_REF 0x0C
268 #define ARGI_DEVICE_REF 0x0D
269 #define ARGI_REFERENCE 0x0E
270 #define ARGI_TARGETREF 0x0F /* Target, subject to implicit conversion */
271 #define ARGI_FIXED_TARGET 0x10 /* Target, no implicit conversion */
272 #define ARGI_SIMPLE_TARGET 0x11 /* Name, Local, Arg -- no implicit conversion */
274 /* Multiple/complex types */
276 #define ARGI_DATAOBJECT 0x12 /* Buffer, String, package or reference to a Node - Used only by size_of operator*/
277 #define ARGI_COMPLEXOBJ 0x13 /* Buffer, String, or package (Used by INDEX op only) */
278 #define ARGI_REF_OR_STRING 0x14 /* Reference or String (Used by DEREFOF op only) */
279 #define ARGI_REGION_OR_FIELD 0x15 /* Used by LOAD op only */
281 /* Note: types above can expand to 0x1F maximum */
283 #define ARGI_INVALID_OPCODE 0xFFFFFFFF
287 * hash offsets
289 #define AML_EXTOP_HASH_OFFSET 22
290 #define AML_LNOT_HASH_OFFSET 19
294 * opcode groups and types
297 #define OPGRP_NAMED 0x01
298 #define OPGRP_FIELD 0x02
299 #define OPGRP_BYTELIST 0x04
303 * Opcode information
306 /* Opcode flags */
308 #define AML_HAS_ARGS 0x0800
309 #define AML_HAS_TARGET 0x0400
310 #define AML_HAS_RETVAL 0x0200
311 #define AML_NSOBJECT 0x0100
312 #define AML_NSOPCODE 0x0080
313 #define AML_NSNODE 0x0040
314 #define AML_NAMED 0x0020
315 #define AML_DEFER 0x0010
316 #define AML_FIELD 0x0008
317 #define AML_CREATE 0x0004
318 #define AML_MATH 0x0002
319 #define AML_LOGICAL 0x0001
320 #define AML_CONSTANT 0x1000
322 /* Convenient flag groupings */
324 #define AML_FLAGS_EXEC_1A_0T_0R AML_HAS_ARGS /* Monadic1 */
325 #define AML_FLAGS_EXEC_1A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Monadic2 */
326 #define AML_FLAGS_EXEC_1A_1T_0R AML_HAS_ARGS | AML_HAS_TARGET
327 #define AML_FLAGS_EXEC_1A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* monadic2_r */
328 #define AML_FLAGS_EXEC_2A_0T_0R AML_HAS_ARGS /* Dyadic1 */
329 #define AML_FLAGS_EXEC_2A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Dyadic2 */
330 #define AML_FLAGS_EXEC_2A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* dyadic2_r */
331 #define AML_FLAGS_EXEC_2A_2T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
332 #define AML_FLAGS_EXEC_3A_0T_0R AML_HAS_ARGS
333 #define AML_FLAGS_EXEC_3A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
334 #define AML_FLAGS_EXEC_6A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL
338 * The opcode Type is used in a dispatch table, do not change
339 * without updating the table.
341 #define AML_TYPE_EXEC_1A_0T_0R 0x00 /* Monadic1 */
342 #define AML_TYPE_EXEC_1A_0T_1R 0x01 /* Monadic2 */
343 #define AML_TYPE_EXEC_1A_1T_0R 0x02
344 #define AML_TYPE_EXEC_1A_1T_1R 0x03 /* monadic2_r */
345 #define AML_TYPE_EXEC_2A_0T_0R 0x04 /* Dyadic1 */
346 #define AML_TYPE_EXEC_2A_0T_1R 0x05 /* Dyadic2 */
347 #define AML_TYPE_EXEC_2A_1T_1R 0x06 /* dyadic2_r */
348 #define AML_TYPE_EXEC_2A_2T_1R 0x07
349 #define AML_TYPE_EXEC_3A_0T_0R 0x08
350 #define AML_TYPE_EXEC_3A_1T_1R 0x09
351 #define AML_TYPE_EXEC_6A_0T_1R 0x0A
352 /* End of types used in dispatch table */
354 #define AML_TYPE_LITERAL 0x0B
355 #define AML_TYPE_CONSTANT 0x0C
356 #define AML_TYPE_METHOD_ARGUMENT 0x0D
357 #define AML_TYPE_LOCAL_VARIABLE 0x0E
358 #define AML_TYPE_DATA_TERM 0x0F
360 /* Generic for an op that returns a value */
362 #define AML_TYPE_METHOD_CALL 0x10
364 /* Misc */
366 #define AML_TYPE_CREATE_FIELD 0x11
367 #define AML_TYPE_CREATE_OBJECT 0x12
368 #define AML_TYPE_CONTROL 0x13
369 #define AML_TYPE_NAMED_NO_OBJ 0x14
370 #define AML_TYPE_NAMED_FIELD 0x15
371 #define AML_TYPE_NAMED_SIMPLE 0x16
372 #define AML_TYPE_NAMED_COMPLEX 0x17
373 #define AML_TYPE_RETURN 0x18
375 #define AML_TYPE_UNDEFINED 0x19
376 #define AML_TYPE_BOGUS 0x1A
380 * Opcode classes
382 #define AML_CLASS_EXECUTE 0x00
383 #define AML_CLASS_CREATE 0x01
384 #define AML_CLASS_ARGUMENT 0x02
385 #define AML_CLASS_NAMED_OBJECT 0x03
386 #define AML_CLASS_CONTROL 0x04
387 #define AML_CLASS_ASCII 0x05
388 #define AML_CLASS_PREFIX 0x06
389 #define AML_CLASS_INTERNAL 0x07
390 #define AML_CLASS_RETURN_VALUE 0x08
391 #define AML_CLASS_METHOD_CALL 0x09
392 #define AML_CLASS_UNKNOWN 0x0A
395 /* Predefined Operation Region space_iDs */
397 typedef enum
399 REGION_MEMORY = 0,
400 REGION_IO,
401 REGION_PCI_CONFIG,
402 REGION_EC,
403 REGION_SMBUS,
404 REGION_CMOS,
405 REGION_PCI_BAR,
406 REGION_DATA_TABLE, /* Internal use only */
407 REGION_FIXED_HW = 0x7F
409 } AML_REGION_TYPES;
412 /* Comparison operation codes for match_op operator */
414 typedef enum
416 MATCH_MTR = 0,
417 MATCH_MEQ = 1,
418 MATCH_MLE = 2,
419 MATCH_MLT = 3,
420 MATCH_MGE = 4,
421 MATCH_MGT = 5
423 } AML_MATCH_OPERATOR;
425 #define MAX_MATCH_OPERATOR 5
429 * field_flags
431 * This byte is extracted from the AML and includes three separate
432 * pieces of information about the field:
433 * 1) The field access type
434 * 2) The field update rule
435 * 3) The lock rule for the field
437 * Bits 00 - 03 : access_type (any_acc, byte_acc, etc.)
438 * 04 : lock_rule (1 == Lock)
439 * 05 - 06 : update_rule
441 #define AML_FIELD_ACCESS_TYPE_MASK 0x0F
442 #define AML_FIELD_LOCK_RULE_MASK 0x10
443 #define AML_FIELD_UPDATE_RULE_MASK 0x60
446 /* 1) Field Access Types */
448 typedef enum
450 AML_FIELD_ACCESS_ANY = 0x00,
451 AML_FIELD_ACCESS_BYTE = 0x01,
452 AML_FIELD_ACCESS_WORD = 0x02,
453 AML_FIELD_ACCESS_DWORD = 0x03,
454 AML_FIELD_ACCESS_QWORD = 0x04, /* ACPI 2.0 */
455 AML_FIELD_ACCESS_BUFFER = 0x05 /* ACPI 2.0 */
457 } AML_ACCESS_TYPE;
460 /* 2) Field Lock Rules */
462 typedef enum
464 AML_FIELD_LOCK_NEVER = 0x00,
465 AML_FIELD_LOCK_ALWAYS = 0x10
467 } AML_LOCK_RULE;
470 /* 3) Field Update Rules */
472 typedef enum
474 AML_FIELD_UPDATE_PRESERVE = 0x00,
475 AML_FIELD_UPDATE_WRITE_AS_ONES = 0x20,
476 AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
478 } AML_UPDATE_RULE;
482 * Field Access Attributes.
483 * This byte is extracted from the AML via the
484 * access_as keyword
486 typedef enum
488 AML_FIELD_ATTRIB_SMB_QUICK = 0x02,
489 AML_FIELD_ATTRIB_SMB_SEND_RCV = 0x04,
490 AML_FIELD_ATTRIB_SMB_BYTE = 0x06,
491 AML_FIELD_ATTRIB_SMB_WORD = 0x08,
492 AML_FIELD_ATTRIB_SMB_BLOCK = 0x0A,
493 AML_FIELD_ATTRIB_SMB_WORD_CALL = 0x0C,
494 AML_FIELD_ATTRIB_SMB_BLOCK_CALL = 0x0D
496 } AML_ACCESS_ATTRIBUTE;
499 /* Bit fields in method_flags byte */
501 #define AML_METHOD_ARG_COUNT 0x07
502 #define AML_METHOD_SERIALIZED 0x08
503 #define AML_METHOD_SYNCH_LEVEL 0xF0
505 /* METHOD_FLAGS_ARG_COUNT is not used internally, define additional flags */
507 #define AML_METHOD_INTERNAL_ONLY 0x01
508 #define AML_METHOD_RESERVED1 0x02
509 #define AML_METHOD_RESERVED2 0x04
512 #endif /* __AMLCODE_H__ */