Merge with Linux 2.5.48.
[linux-2.6/linux-mips.git] / drivers / acpi / include / amlcode.h
blob341108a44fb8fb14caf1fb46264d9f55d6819b28
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.
6 * $Revision: 71 $
8 *****************************************************************************/
11 * Copyright (C) 2000 - 2002, R. Byron Moore
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #ifndef __AMLCODE_H__
29 #define __AMLCODE_H__
31 /* primary opcodes */
33 #define AML_NULL_CHAR (u16) 0x00
35 #define AML_ZERO_OP (u16) 0x00
36 #define AML_ONE_OP (u16) 0x01
37 #define AML_UNASSIGNED (u16) 0x02
38 #define AML_ALIAS_OP (u16) 0x06
39 #define AML_NAME_OP (u16) 0x08
40 #define AML_BYTE_OP (u16) 0x0a
41 #define AML_WORD_OP (u16) 0x0b
42 #define AML_DWORD_OP (u16) 0x0c
43 #define AML_STRING_OP (u16) 0x0d
44 #define AML_QWORD_OP (u16) 0x0e /* ACPI 2.0 */
45 #define AML_SCOPE_OP (u16) 0x10
46 #define AML_BUFFER_OP (u16) 0x11
47 #define AML_PACKAGE_OP (u16) 0x12
48 #define AML_VAR_PACKAGE_OP (u16) 0x13 /* ACPI 2.0 */
49 #define AML_METHOD_OP (u16) 0x14
50 #define AML_DUAL_NAME_PREFIX (u16) 0x2e
51 #define AML_MULTI_NAME_PREFIX_OP (u16) 0x2f
52 #define AML_NAME_CHAR_SUBSEQ (u16) 0x30
53 #define AML_NAME_CHAR_FIRST (u16) 0x41
54 #define AML_OP_PREFIX (u16) 0x5b
55 #define AML_ROOT_PREFIX (u16) 0x5c
56 #define AML_PARENT_PREFIX (u16) 0x5e
57 #define AML_LOCAL_OP (u16) 0x60
58 #define AML_LOCAL0 (u16) 0x60
59 #define AML_LOCAL1 (u16) 0x61
60 #define AML_LOCAL2 (u16) 0x62
61 #define AML_LOCAL3 (u16) 0x63
62 #define AML_LOCAL4 (u16) 0x64
63 #define AML_LOCAL5 (u16) 0x65
64 #define AML_LOCAL6 (u16) 0x66
65 #define AML_LOCAL7 (u16) 0x67
66 #define AML_ARG_OP (u16) 0x68
67 #define AML_ARG0 (u16) 0x68
68 #define AML_ARG1 (u16) 0x69
69 #define AML_ARG2 (u16) 0x6a
70 #define AML_ARG3 (u16) 0x6b
71 #define AML_ARG4 (u16) 0x6c
72 #define AML_ARG5 (u16) 0x6d
73 #define AML_ARG6 (u16) 0x6e
74 #define AML_STORE_OP (u16) 0x70
75 #define AML_REF_OF_OP (u16) 0x71
76 #define AML_ADD_OP (u16) 0x72
77 #define AML_CONCAT_OP (u16) 0x73
78 #define AML_SUBTRACT_OP (u16) 0x74
79 #define AML_INCREMENT_OP (u16) 0x75
80 #define AML_DECREMENT_OP (u16) 0x76
81 #define AML_MULTIPLY_OP (u16) 0x77
82 #define AML_DIVIDE_OP (u16) 0x78
83 #define AML_SHIFT_LEFT_OP (u16) 0x79
84 #define AML_SHIFT_RIGHT_OP (u16) 0x7a
85 #define AML_BIT_AND_OP (u16) 0x7b
86 #define AML_BIT_NAND_OP (u16) 0x7c
87 #define AML_BIT_OR_OP (u16) 0x7d
88 #define AML_BIT_NOR_OP (u16) 0x7e
89 #define AML_BIT_XOR_OP (u16) 0x7f
90 #define AML_BIT_NOT_OP (u16) 0x80
91 #define AML_FIND_SET_LEFT_BIT_OP (u16) 0x81
92 #define AML_FIND_SET_RIGHT_BIT_OP (u16) 0x82
93 #define AML_DEREF_OF_OP (u16) 0x83
94 #define AML_CONCAT_RES_OP (u16) 0x84 /* ACPI 2.0 */
95 #define AML_MOD_OP (u16) 0x85 /* ACPI 2.0 */
96 #define AML_NOTIFY_OP (u16) 0x86
97 #define AML_SIZE_OF_OP (u16) 0x87
98 #define AML_INDEX_OP (u16) 0x88
99 #define AML_MATCH_OP (u16) 0x89
100 #define AML_CREATE_DWORD_FIELD_OP (u16) 0x8a
101 #define AML_CREATE_WORD_FIELD_OP (u16) 0x8b
102 #define AML_CREATE_BYTE_FIELD_OP (u16) 0x8c
103 #define AML_CREATE_BIT_FIELD_OP (u16) 0x8d
104 #define AML_TYPE_OP (u16) 0x8e
105 #define AML_CREATE_QWORD_FIELD_OP (u16) 0x8f /* ACPI 2.0 */
106 #define AML_LAND_OP (u16) 0x90
107 #define AML_LOR_OP (u16) 0x91
108 #define AML_LNOT_OP (u16) 0x92
109 #define AML_LEQUAL_OP (u16) 0x93
110 #define AML_LGREATER_OP (u16) 0x94
111 #define AML_LLESS_OP (u16) 0x95
112 #define AML_TO_BUFFER_OP (u16) 0x96 /* ACPI 2.0 */
113 #define AML_TO_DECSTRING_OP (u16) 0x97 /* ACPI 2.0 */
114 #define AML_TO_HEXSTRING_OP (u16) 0x98 /* ACPI 2.0 */
115 #define AML_TO_INTEGER_OP (u16) 0x99 /* ACPI 2.0 */
116 #define AML_TO_STRING_OP (u16) 0x9c /* ACPI 2.0 */
117 #define AML_COPY_OP (u16) 0x9d /* ACPI 2.0 */
118 #define AML_MID_OP (u16) 0x9e /* ACPI 2.0 */
119 #define AML_CONTINUE_OP (u16) 0x9f /* ACPI 2.0 */
120 #define AML_IF_OP (u16) 0xa0
121 #define AML_ELSE_OP (u16) 0xa1
122 #define AML_WHILE_OP (u16) 0xa2
123 #define AML_NOOP_OP (u16) 0xa3
124 #define AML_RETURN_OP (u16) 0xa4
125 #define AML_BREAK_OP (u16) 0xa5
126 #define AML_BREAK_POINT_OP (u16) 0xcc
127 #define AML_ONES_OP (u16) 0xff
129 /* prefixed opcodes */
131 #define AML_EXTOP (u16) 0x005b
134 #define AML_MUTEX_OP (u16) 0x5b01
135 #define AML_EVENT_OP (u16) 0x5b02
136 #define AML_SHIFT_RIGHT_BIT_OP (u16) 0x5b10
137 #define AML_SHIFT_LEFT_BIT_OP (u16) 0x5b11
138 #define AML_COND_REF_OF_OP (u16) 0x5b12
139 #define AML_CREATE_FIELD_OP (u16) 0x5b13
140 #define AML_LOAD_TABLE_OP (u16) 0x5b1f /* ACPI 2.0 */
141 #define AML_LOAD_OP (u16) 0x5b20
142 #define AML_STALL_OP (u16) 0x5b21
143 #define AML_SLEEP_OP (u16) 0x5b22
144 #define AML_ACQUIRE_OP (u16) 0x5b23
145 #define AML_SIGNAL_OP (u16) 0x5b24
146 #define AML_WAIT_OP (u16) 0x5b25
147 #define AML_RESET_OP (u16) 0x5b26
148 #define AML_RELEASE_OP (u16) 0x5b27
149 #define AML_FROM_BCD_OP (u16) 0x5b28
150 #define AML_TO_BCD_OP (u16) 0x5b29
151 #define AML_UNLOAD_OP (u16) 0x5b2a
152 #define AML_REVISION_OP (u16) 0x5b30
153 #define AML_DEBUG_OP (u16) 0x5b31
154 #define AML_FATAL_OP (u16) 0x5b32
155 #define AML_REGION_OP (u16) 0x5b80
156 #define AML_FIELD_OP (u16) 0x5b81
157 #define AML_DEVICE_OP (u16) 0x5b82
158 #define AML_PROCESSOR_OP (u16) 0x5b83
159 #define AML_POWER_RES_OP (u16) 0x5b84
160 #define AML_THERMAL_ZONE_OP (u16) 0x5b85
161 #define AML_INDEX_FIELD_OP (u16) 0x5b86
162 #define AML_BANK_FIELD_OP (u16) 0x5b87
163 #define AML_DATA_REGION_OP (u16) 0x5b88 /* ACPI 2.0 */
166 /* Bogus opcodes (they are actually two separate opcodes) */
168 #define AML_LGREATEREQUAL_OP (u16) 0x9295
169 #define AML_LLESSEQUAL_OP (u16) 0x9294
170 #define AML_LNOTEQUAL_OP (u16) 0x9293
174 * Internal opcodes
175 * Use only "Unknown" AML opcodes, don't attempt to use
176 * any valid ACPI ASCII values (A-Z, 0-9, '-')
179 #define AML_INT_NAMEPATH_OP (u16) 0x002d
180 #define AML_INT_NAMEDFIELD_OP (u16) 0x0030
181 #define AML_INT_RESERVEDFIELD_OP (u16) 0x0031
182 #define AML_INT_ACCESSFIELD_OP (u16) 0x0032
183 #define AML_INT_BYTELIST_OP (u16) 0x0033
184 #define AML_INT_STATICSTRING_OP (u16) 0x0034
185 #define AML_INT_METHODCALL_OP (u16) 0x0035
186 #define AML_INT_RETURN_VALUE_OP (u16) 0x0036
187 #define AML_INT_EVAL_SUBTREE_OP (u16) 0x0037
190 #define ARG_NONE 0x0
193 * Argument types for the AML Parser
194 * Each field in the Arg_types u32 is 5 bits, allowing for a maximum of 6 arguments.
195 * There can be up to 31 unique argument types
198 #define ARGP_BYTEDATA 0x01
199 #define ARGP_BYTELIST 0x02
200 #define ARGP_CHARLIST 0x03
201 #define ARGP_DATAOBJ 0x04
202 #define ARGP_DATAOBJLIST 0x05
203 #define ARGP_DWORDDATA 0x06
204 #define ARGP_FIELDLIST 0x07
205 #define ARGP_NAME 0x08
206 #define ARGP_NAMESTRING 0x09
207 #define ARGP_OBJLIST 0x0A
208 #define ARGP_PKGLENGTH 0x0B
209 #define ARGP_SUPERNAME 0x0C
210 #define ARGP_TARGET 0x0D
211 #define ARGP_TERMARG 0x0E
212 #define ARGP_TERMLIST 0x0F
213 #define ARGP_WORDDATA 0x10
214 #define ARGP_QWORDDATA 0x11
215 #define ARGP_SIMPLENAME 0x12
218 * Resolved argument types for the AML Interpreter
219 * Each field in the Arg_types u32 is 5 bits, allowing for a maximum of 6 arguments.
220 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
222 * Note: If and when 5 bits becomes insufficient, it would probably be best
223 * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
226 /* "Standard" ACPI types are 1-15 (0x0F) */
228 #define ARGI_INTEGER ACPI_TYPE_INTEGER /* 1 */
229 #define ARGI_STRING ACPI_TYPE_STRING /* 2 */
230 #define ARGI_BUFFER ACPI_TYPE_BUFFER /* 3 */
231 #define ARGI_PACKAGE ACPI_TYPE_PACKAGE /* 4 */
232 #define ARGI_EVENT ACPI_TYPE_EVENT
233 #define ARGI_MUTEX ACPI_TYPE_MUTEX
234 #define ARGI_REGION ACPI_TYPE_REGION
235 #define ARGI_DDBHANDLE ACPI_TYPE_DDB_HANDLE
237 /* Custom types are 0x10 through 0x1F */
239 #define ARGI_IF 0x10
240 #define ARGI_ANYOBJECT 0x11
241 #define ARGI_ANYTYPE 0x12
242 #define ARGI_COMPUTEDATA 0x13 /* Buffer, String, or Integer */
243 #define ARGI_DATAOBJECT 0x14 /* Buffer, String, package or reference to a Node - Used only by Size_of operator*/
244 #define ARGI_COMPLEXOBJ 0x15 /* Buffer, String, or package (Used by INDEX op only) */
245 #define ARGI_INTEGER_REF 0x16
246 #define ARGI_OBJECT_REF 0x17
247 #define ARGI_DEVICE_REF 0x18
248 #define ARGI_REFERENCE 0x19
249 #define ARGI_TARGETREF 0x1A /* Target, subject to implicit conversion */
250 #define ARGI_FIXED_TARGET 0x1B /* Target, no implicit conversion */
251 #define ARGI_SIMPLE_TARGET 0x1C /* Name, Local, Arg -- no implicit conversion */
252 #define ARGI_BUFFERSTRING 0x1D
253 #define ARGI_REF_OR_STRING 0x1E /* Reference or String (Used by DEREFOF op only) */
255 #define ARGI_INVALID_OPCODE 0xFFFFFFFF
259 * hash offsets
261 #define AML_EXTOP_HASH_OFFSET 22
262 #define AML_LNOT_HASH_OFFSET 19
266 * opcode groups and types
269 #define OPGRP_NAMED 0x01
270 #define OPGRP_FIELD 0x02
271 #define OPGRP_BYTELIST 0x04
275 * Opcode information
278 /* Opcode flags */
280 #define AML_HAS_ARGS 0x0800
281 #define AML_HAS_TARGET 0x0400
282 #define AML_HAS_RETVAL 0x0200
283 #define AML_NSOBJECT 0x0100
284 #define AML_NSOPCODE 0x0080
285 #define AML_NSNODE 0x0040
286 #define AML_NAMED 0x0020
287 #define AML_DEFER 0x0010
288 #define AML_FIELD 0x0008
289 #define AML_CREATE 0x0004
290 #define AML_MATH 0x0002
291 #define AML_LOGICAL 0x0001
292 #define AML_CONSTANT 0x1000
294 /* Convenient flag groupings */
296 #define AML_FLAGS_EXEC_1A_0T_0R AML_HAS_ARGS /* Monadic1 */
297 #define AML_FLAGS_EXEC_1A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Monadic2 */
298 #define AML_FLAGS_EXEC_1A_1T_0R AML_HAS_ARGS | AML_HAS_TARGET
299 #define AML_FLAGS_EXEC_1A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2_r */
300 #define AML_FLAGS_EXEC_2A_0T_0R AML_HAS_ARGS /* Dyadic1 */
301 #define AML_FLAGS_EXEC_2A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL /* Dyadic2 */
302 #define AML_FLAGS_EXEC_2A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2_r */
303 #define AML_FLAGS_EXEC_2A_2T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
304 #define AML_FLAGS_EXEC_3A_0T_0R AML_HAS_ARGS
305 #define AML_FLAGS_EXEC_3A_1T_1R AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
306 #define AML_FLAGS_EXEC_6A_0T_1R AML_HAS_ARGS | AML_HAS_RETVAL
310 * The opcode Type is used in a dispatch table, do not change
311 * without updating the table.
313 #define AML_TYPE_EXEC_1A_0T_0R 0x00 /* Monadic1 */
314 #define AML_TYPE_EXEC_1A_0T_1R 0x01 /* Monadic2 */
315 #define AML_TYPE_EXEC_1A_1T_0R 0x02
316 #define AML_TYPE_EXEC_1A_1T_1R 0x03 /* Monadic2_r */
317 #define AML_TYPE_EXEC_2A_0T_0R 0x04 /* Dyadic1 */
318 #define AML_TYPE_EXEC_2A_0T_1R 0x05 /* Dyadic2 */
319 #define AML_TYPE_EXEC_2A_1T_1R 0x06 /* Dyadic2_r */
320 #define AML_TYPE_EXEC_2A_2T_1R 0x07
321 #define AML_TYPE_EXEC_3A_0T_0R 0x08
322 #define AML_TYPE_EXEC_3A_1T_1R 0x09
323 #define AML_TYPE_EXEC_6A_0T_1R 0x0A
324 /* End of types used in dispatch table */
326 #define AML_TYPE_LITERAL 0x0B
327 #define AML_TYPE_CONSTANT 0x0C
328 #define AML_TYPE_METHOD_ARGUMENT 0x0D
329 #define AML_TYPE_LOCAL_VARIABLE 0x0E
330 #define AML_TYPE_DATA_TERM 0x0F
332 /* Generic for an op that returns a value */
334 #define AML_TYPE_METHOD_CALL 0x10
336 /* Misc */
338 #define AML_TYPE_CREATE_FIELD 0x11
339 #define AML_TYPE_CREATE_OBJECT 0x12
340 #define AML_TYPE_CONTROL 0x13
341 #define AML_TYPE_NAMED_NO_OBJ 0x14
342 #define AML_TYPE_NAMED_FIELD 0x15
343 #define AML_TYPE_NAMED_SIMPLE 0x16
344 #define AML_TYPE_NAMED_COMPLEX 0x17
345 #define AML_TYPE_RETURN 0x18
347 #define AML_TYPE_UNDEFINED 0x19
348 #define AML_TYPE_BOGUS 0x1A
352 * Opcode classes
354 #define AML_CLASS_EXECUTE 0x00
355 #define AML_CLASS_CREATE 0x01
356 #define AML_CLASS_ARGUMENT 0x02
357 #define AML_CLASS_NAMED_OBJECT 0x03
358 #define AML_CLASS_CONTROL 0x04
359 #define AML_CLASS_ASCII 0x05
360 #define AML_CLASS_PREFIX 0x06
361 #define AML_CLASS_INTERNAL 0x07
362 #define AML_CLASS_RETURN_VALUE 0x08
363 #define AML_CLASS_METHOD_CALL 0x09
364 #define AML_CLASS_UNKNOWN 0x0A
367 /* Predefined Operation Region Space_iDs */
369 typedef enum
371 REGION_MEMORY = 0,
372 REGION_IO,
373 REGION_PCI_CONFIG,
374 REGION_EC,
375 REGION_SMBUS,
376 REGION_CMOS,
377 REGION_PCI_BAR,
378 REGION_DATA_TABLE, /* Internal use only */
379 REGION_FIXED_HW = 0x7F
381 } AML_REGION_TYPES;
384 /* Comparison operation codes for Match_op operator */
386 typedef enum
388 MATCH_MTR = 0,
389 MATCH_MEQ = 1,
390 MATCH_MLE = 2,
391 MATCH_MLT = 3,
392 MATCH_MGE = 4,
393 MATCH_MGT = 5
395 } AML_MATCH_OPERATOR;
397 #define MAX_MATCH_OPERATOR 5
401 * Field_flags
403 * This byte is extracted from the AML and includes three separate
404 * pieces of information about the field:
405 * 1) The field access type
406 * 2) The field update rule
407 * 3) The lock rule for the field
409 * Bits 00 - 03 : Access_type (Any_acc, Byte_acc, etc.)
410 * 04 : Lock_rule (1 == Lock)
411 * 05 - 06 : Update_rule
413 #define AML_FIELD_ACCESS_TYPE_MASK 0x0F
414 #define AML_FIELD_LOCK_RULE_MASK 0x10
415 #define AML_FIELD_UPDATE_RULE_MASK 0x60
418 /* 1) Field Access Types */
420 typedef enum
422 AML_FIELD_ACCESS_ANY = 0x00,
423 AML_FIELD_ACCESS_BYTE = 0x01,
424 AML_FIELD_ACCESS_WORD = 0x02,
425 AML_FIELD_ACCESS_DWORD = 0x03,
426 AML_FIELD_ACCESS_QWORD = 0x04, /* ACPI 2.0 */
427 AML_FIELD_ACCESS_BUFFER = 0x05 /* ACPI 2.0 */
429 } AML_ACCESS_TYPE;
432 /* 2) Field Lock Rules */
434 typedef enum
436 AML_FIELD_LOCK_NEVER = 0x00,
437 AML_FIELD_LOCK_ALWAYS = 0x10
439 } AML_LOCK_RULE;
442 /* 3) Field Update Rules */
444 typedef enum
446 AML_FIELD_UPDATE_PRESERVE = 0x00,
447 AML_FIELD_UPDATE_WRITE_AS_ONES = 0x20,
448 AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
450 } AML_UPDATE_RULE;
454 * Field Access Attributes.
455 * This byte is extracted from the AML via the
456 * Access_as keyword
458 typedef enum
460 AML_FIELD_ATTRIB_SMB_QUICK = 0x02,
461 AML_FIELD_ATTRIB_SMB_SEND_RCV = 0x04,
462 AML_FIELD_ATTRIB_SMB_BYTE = 0x06,
463 AML_FIELD_ATTRIB_SMB_WORD = 0x08,
464 AML_FIELD_ATTRIB_SMB_BLOCK = 0x0A,
465 AML_FIELD_ATTRIB_SMB_WORD_CALL = 0x0C,
466 AML_FIELD_ATTRIB_SMB_BLOCK_CALL = 0x0D
468 } AML_ACCESS_ATTRIBUTE;
471 /* bit fields in Method_flags byte */
473 #define METHOD_FLAGS_ARG_COUNT 0x07
474 #define METHOD_FLAGS_SERIALIZED 0x08
475 #define METHOD_FLAGS_SYNCH_LEVEL 0xF0
478 #endif /* __AMLCODE_H__ */