amlcode.h 20 KB

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