amlcode.h revision 80062
196913Sgrog/******************************************************************************
296913Sgrog *
396913Sgrog * Name: amlcode.h - Definitions for AML, as included in "definition blocks"
496913Sgrog *                   Declarations and definitions contained herein are derived
596913Sgrog *                   directly from the ACPI specification.
696913Sgrog *       $Revision: 53 $
796913Sgrog *
896913Sgrog *****************************************************************************/
996913Sgrog
1096913Sgrog/******************************************************************************
1196913Sgrog *
1296913Sgrog * 1. Copyright Notice
1396913Sgrog *
1496913Sgrog * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp.
1596913Sgrog * All rights reserved.
1696913Sgrog *
1796913Sgrog * 2. License
1896913Sgrog *
1996913Sgrog * 2.1. This is your license from Intel Corp. under its intellectual property
2096913Sgrog * rights.  You may have additional license terms from the party that provided
2196913Sgrog * you this software, covering your right to use that party's intellectual
2296913Sgrog * property rights.
2396913Sgrog *
2496913Sgrog * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
2596913Sgrog * copy of the source code appearing in this file ("Covered Code") an
2696913Sgrog * irrevocable, perpetual, worldwide license under Intel's copyrights in the
2796913Sgrog * base code distributed originally by Intel ("Original Intel Code") to copy,
2896913Sgrog * make derivatives, distribute, use and display any portion of the Covered
2996913Sgrog * Code in any form, with the right to sublicense such rights; and
3096913Sgrog *
3196913Sgrog * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
3296913Sgrog * license (with the right to sublicense), under only those claims of Intel
3396913Sgrog * patents that are infringed by the Original Intel Code, to make, use, sell,
3496913Sgrog * offer to sell, and import the Covered Code and derivative works thereof
3596913Sgrog * solely to the minimum extent necessary to exercise the above copyright
3696911Sgrog * license, and in no event shall the patent license extend to any additions
3796911Sgrog * to or modifications of the Original Intel Code.  No other license or right
3896911Sgrog * is granted directly or by implication, estoppel or otherwise;
3996911Sgrog *
4096911Sgrog * The above copyright and patent license is granted only if the following
4196911Sgrog * conditions are met:
4296911Sgrog *
4396911Sgrog * 3. Conditions
4496911Sgrog *
4596911Sgrog * 3.1. Redistribution of Source with Rights to Further Distribute Source.
4696911Sgrog * Redistribution of source code of any substantial portion of the Covered
4796911Sgrog * Code or modification with rights to further distribute source must include
4896911Sgrog * the above Copyright Notice, the above License, this list of Conditions,
4996911Sgrog * and the following Disclaimer and Export Compliance provision.  In addition,
5096911Sgrog * Licensee must cause all Covered Code to which Licensee contributes to
5196911Sgrog * contain a file documenting the changes Licensee made to create that Covered
5296911Sgrog * Code and the date of any change.  Licensee must include in that file the
5396911Sgrog * documentation of any changes made by any predecessor Licensee.  Licensee
5496911Sgrog * must include a prominent statement that the modification is derived,
5596911Sgrog * directly or indirectly, from Original Intel Code.
5696911Sgrog *
5796911Sgrog * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
5896911Sgrog * Redistribution of source code of any substantial portion of the Covered
5996911Sgrog * Code or modification without rights to further distribute source must
6096911Sgrog * include the following Disclaimer and Export Compliance provision in the
6196911Sgrog * documentation and/or other materials provided with distribution.  In
6296911Sgrog * addition, Licensee may not authorize further sublicense of source of any
6396911Sgrog * portion of the Covered Code, and must include terms to the effect that the
6496911Sgrog * license from Licensee to its licensee is limited to the intellectual
6596911Sgrog * property embodied in the software Licensee provides to its licensee, and
6696911Sgrog * not to intellectual property embodied in modifications its licensee may
6796911Sgrog * make.
6896911Sgrog *
6996911Sgrog * 3.3. Redistribution of Executable. Redistribution in executable form of any
7096911Sgrog * substantial portion of the Covered Code or modification must reproduce the
7196911Sgrog * above Copyright Notice, and the following Disclaimer and Export Compliance
7296911Sgrog * provision in the documentation and/or other materials provided with the
7396911Sgrog * distribution.
7496911Sgrog *
7596911Sgrog * 3.4. Intel retains all right, title, and interest in and to the Original
7696911Sgrog * Intel Code.
7796911Sgrog *
7896911Sgrog * 3.5. Neither the name Intel nor any other trademark owned or controlled by
7996911Sgrog * Intel shall be used in advertising or otherwise to promote the sale, use or
8096911Sgrog * other dealings in products derived from or relating to the Covered Code
8196911Sgrog * without prior written authorization from Intel.
8296911Sgrog *
8396911Sgrog * 4. Disclaimer and Export Compliance
8496911Sgrog *
8596911Sgrog * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
8696911Sgrog * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
8796911Sgrog * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
8896911Sgrog * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
8996911Sgrog * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
9096911Sgrog * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
9196911Sgrog * PARTICULAR PURPOSE.
9296911Sgrog *
9396911Sgrog * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
9496911Sgrog * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
9596911Sgrog * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
9696911Sgrog * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
9796911Sgrog * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
9896911Sgrog * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
9996911Sgrog * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
10096911Sgrog * LIMITED REMEDY.
10196911Sgrog *
10296911Sgrog * 4.3. Licensee shall not export, either directly or indirectly, any of this
10396911Sgrog * software or system incorporating such software without first obtaining any
10496911Sgrog * required license or other approval from the U. S. Department of Commerce or
10596911Sgrog * any other agency or department of the United States Government.  In the
10696911Sgrog * event Licensee exports any such software from the United States or
10796911Sgrog * re-exports any such software from a foreign destination, Licensee shall
10896911Sgrog * ensure that the distribution and export/re-export of the software is in
10996911Sgrog * compliance with all laws, regulations, orders, or other restrictions of the
11096911Sgrog * U.S. Export Administration Regulations. Licensee agrees that neither it nor
11196911Sgrog * any of its subsidiaries will export/re-export any technical data, process,
11296911Sgrog * software, or service, directly or indirectly, to any country for which the
11396911Sgrog * United States government or any agency thereof requires an export license,
11496911Sgrog * other governmental approval, or letter of assurance, without first obtaining
11596911Sgrog * such license, approval or letter.
11696911Sgrog *
11796911Sgrog *****************************************************************************/
11896911Sgrog
11996911Sgrog#ifndef __AMLCODE_H__
12096911Sgrog#define __AMLCODE_H__
12196911Sgrog
12296911Sgrog
12396911Sgrog/* primary opcodes */
12496911Sgrog
12596911Sgrog#define AML_NULL_CHAR               (UINT16) 0x00
12696911Sgrog
12796911Sgrog#define AML_ZERO_OP                 (UINT16) 0x00
12896911Sgrog#define AML_ONE_OP                  (UINT16) 0x01
12996911Sgrog#define AML_UNASSIGNED              (UINT16) 0x02
13096911Sgrog#define AML_ALIAS_OP                (UINT16) 0x06
13196911Sgrog#define AML_NAME_OP                 (UINT16) 0x08
13296911Sgrog#define AML_BYTE_OP                 (UINT16) 0x0a
13396911Sgrog#define AML_WORD_OP                 (UINT16) 0x0b
13496911Sgrog#define AML_DWORD_OP                (UINT16) 0x0c
13596911Sgrog#define AML_STRING_OP               (UINT16) 0x0d
13696911Sgrog#define AML_QWORD_OP                (UINT16) 0x0e     /* ACPI 2.0 */
13796911Sgrog#define AML_SCOPE_OP                (UINT16) 0x10
13896911Sgrog#define AML_BUFFER_OP               (UINT16) 0x11
13996911Sgrog#define AML_PACKAGE_OP              (UINT16) 0x12
14096911Sgrog#define AML_VAR_PACKAGE_OP          (UINT16) 0x13     /* ACPI 2.0 */
14196911Sgrog#define AML_METHOD_OP               (UINT16) 0x14
14296911Sgrog#define AML_DUAL_NAME_PREFIX        (UINT16) 0x2e
14396911Sgrog#define AML_MULTI_NAME_PREFIX_OP    (UINT16) 0x2f
14496911Sgrog#define AML_NAME_CHAR_SUBSEQ        (UINT16) 0x30
14596911Sgrog#define AML_NAME_CHAR_FIRST         (UINT16) 0x41
14696911Sgrog#define AML_OP_PREFIX               (UINT16) 0x5b
14796911Sgrog#define AML_ROOT_PREFIX             (UINT16) 0x5c
14896911Sgrog#define AML_PARENT_PREFIX           (UINT16) 0x5e
14996911Sgrog#define AML_LOCAL_OP                (UINT16) 0x60
15096911Sgrog#define AML_LOCAL0                  (UINT16) 0x60
15196911Sgrog#define AML_LOCAL1                  (UINT16) 0x61
15296911Sgrog#define AML_LOCAL2                  (UINT16) 0x62
15396911Sgrog#define AML_LOCAL3                  (UINT16) 0x63
15496911Sgrog#define AML_LOCAL4                  (UINT16) 0x64
15596911Sgrog#define AML_LOCAL5                  (UINT16) 0x65
15696911Sgrog#define AML_LOCAL6                  (UINT16) 0x66
15796911Sgrog#define AML_LOCAL7                  (UINT16) 0x67
15896911Sgrog#define AML_ARG_OP                  (UINT16) 0x68
15996911Sgrog#define AML_ARG0                    (UINT16) 0x68
16096911Sgrog#define AML_ARG1                    (UINT16) 0x69
16196911Sgrog#define AML_ARG2                    (UINT16) 0x6a
16296911Sgrog#define AML_ARG3                    (UINT16) 0x6b
16396911Sgrog#define AML_ARG4                    (UINT16) 0x6c
16496911Sgrog#define AML_ARG5                    (UINT16) 0x6d
16596911Sgrog#define AML_ARG6                    (UINT16) 0x6e
16696911Sgrog#define AML_STORE_OP                (UINT16) 0x70
16796911Sgrog#define AML_REF_OF_OP               (UINT16) 0x71
16896911Sgrog#define AML_ADD_OP                  (UINT16) 0x72
16996911Sgrog#define AML_CONCAT_OP               (UINT16) 0x73
17096911Sgrog#define AML_SUBTRACT_OP             (UINT16) 0x74
17196911Sgrog#define AML_INCREMENT_OP            (UINT16) 0x75
17296911Sgrog#define AML_DECREMENT_OP            (UINT16) 0x76
17396911Sgrog#define AML_MULTIPLY_OP             (UINT16) 0x77
17496911Sgrog#define AML_DIVIDE_OP               (UINT16) 0x78
17596911Sgrog#define AML_SHIFT_LEFT_OP           (UINT16) 0x79
17696911Sgrog#define AML_SHIFT_RIGHT_OP          (UINT16) 0x7a
17796911Sgrog#define AML_BIT_AND_OP              (UINT16) 0x7b
17896911Sgrog#define AML_BIT_NAND_OP             (UINT16) 0x7c
17996911Sgrog#define AML_BIT_OR_OP               (UINT16) 0x7d
18096911Sgrog#define AML_BIT_NOR_OP              (UINT16) 0x7e
18196911Sgrog#define AML_BIT_XOR_OP              (UINT16) 0x7f
18296911Sgrog#define AML_BIT_NOT_OP              (UINT16) 0x80
18396911Sgrog#define AML_FIND_SET_LEFT_BIT_OP    (UINT16) 0x81
18496911Sgrog#define AML_FIND_SET_RIGHT_BIT_OP   (UINT16) 0x82
18596911Sgrog#define AML_DEREF_OF_OP             (UINT16) 0x83
18696911Sgrog#define AML_CONCAT_RES_OP           (UINT16) 0x84     /* ACPI 2.0 */
18796911Sgrog#define AML_MOD_OP                  (UINT16) 0x85     /* ACPI 2.0 */
18896911Sgrog#define AML_NOTIFY_OP               (UINT16) 0x86
18996911Sgrog#define AML_SIZE_OF_OP              (UINT16) 0x87
19096911Sgrog#define AML_INDEX_OP                (UINT16) 0x88
19196911Sgrog#define AML_MATCH_OP                (UINT16) 0x89
19296911Sgrog#define AML_CREATE_DWORD_FIELD_OP   (UINT16) 0x8a
19396911Sgrog#define AML_CREATE_WORD_FIELD_OP    (UINT16) 0x8b
19496911Sgrog#define AML_CREATE_BYTE_FIELD_OP    (UINT16) 0x8c
19596911Sgrog#define AML_CREATE_BIT_FIELD_OP     (UINT16) 0x8d
19696911Sgrog#define AML_TYPE_OP                 (UINT16) 0x8e
19796911Sgrog#define AML_CREATE_QWORD_FIELD_OP   (UINT16) 0x8f     /* ACPI 2.0 */
19896911Sgrog#define AML_LAND_OP                 (UINT16) 0x90
19996911Sgrog#define AML_LOR_OP                  (UINT16) 0x91
20096911Sgrog#define AML_LNOT_OP                 (UINT16) 0x92
20196911Sgrog#define AML_LEQUAL_OP               (UINT16) 0x93
20296911Sgrog#define AML_LGREATER_OP             (UINT16) 0x94
20396911Sgrog#define AML_LLESS_OP                (UINT16) 0x95
20496911Sgrog#define AML_TO_BUFFER_OP            (UINT16) 0x96     /* ACPI 2.0 */
20596911Sgrog#define AML_TO_DECSTRING_OP         (UINT16) 0x97     /* ACPI 2.0 */
20696911Sgrog#define AML_TO_HEXSTRING_OP         (UINT16) 0x98     /* ACPI 2.0 */
20796911Sgrog#define AML_TO_INTEGER_OP           (UINT16) 0x99     /* ACPI 2.0 */
20896911Sgrog#define AML_TO_STRING_OP            (UINT16) 0x9c     /* ACPI 2.0 */
20996911Sgrog#define AML_COPY_OP                 (UINT16) 0x9d     /* ACPI 2.0 */
21096911Sgrog#define AML_MID_OP                  (UINT16) 0x9e     /* ACPI 2.0 */
21196911Sgrog#define AML_CONTINUE_OP             (UINT16) 0x9f     /* ACPI 2.0 */
21296911Sgrog#define AML_IF_OP                   (UINT16) 0xa0
21396911Sgrog#define AML_ELSE_OP                 (UINT16) 0xa1
21496911Sgrog#define AML_WHILE_OP                (UINT16) 0xa2
21596911Sgrog#define AML_NOOP_OP                 (UINT16) 0xa3
21696911Sgrog#define AML_RETURN_OP               (UINT16) 0xa4
21796911Sgrog#define AML_BREAK_OP                (UINT16) 0xa5
21896911Sgrog#define AML_BREAK_POINT_OP          (UINT16) 0xcc
21996911Sgrog#define AML_ONES_OP                 (UINT16) 0xff
22096911Sgrog
22196911Sgrog/* prefixed opcodes */
222
223#define AML_EXTOP                   (UINT16) 0x005b
224
225
226#define AML_MUTEX_OP                (UINT16) 0x5b01
227#define AML_EVENT_OP                (UINT16) 0x5b02
228#define AML_SHIFT_RIGHT_BIT_OP      (UINT16) 0x5b10
229#define AML_SHIFT_LEFT_BIT_OP       (UINT16) 0x5b11
230#define AML_COND_REF_OF_OP          (UINT16) 0x5b12
231#define AML_CREATE_FIELD_OP         (UINT16) 0x5b13
232#define AML_LOAD_TABLE_OP           (UINT16) 0x5b1f     /* ACPI 2.0 */
233#define AML_LOAD_OP                 (UINT16) 0x5b20
234#define AML_STALL_OP                (UINT16) 0x5b21
235#define AML_SLEEP_OP                (UINT16) 0x5b22
236#define AML_ACQUIRE_OP              (UINT16) 0x5b23
237#define AML_SIGNAL_OP               (UINT16) 0x5b24
238#define AML_WAIT_OP                 (UINT16) 0x5b25
239#define AML_RESET_OP                (UINT16) 0x5b26
240#define AML_RELEASE_OP              (UINT16) 0x5b27
241#define AML_FROM_BCD_OP             (UINT16) 0x5b28
242#define AML_TO_BCD_OP               (UINT16) 0x5b29
243#define AML_UNLOAD_OP               (UINT16) 0x5b2a
244#define AML_REVISION_OP             (UINT16) 0x5b30
245#define AML_DEBUG_OP                (UINT16) 0x5b31
246#define AML_FATAL_OP                (UINT16) 0x5b32
247#define AML_REGION_OP               (UINT16) 0x5b80
248#define AML_FIELD_OP                (UINT16) 0x5b81
249#define AML_DEVICE_OP               (UINT16) 0x5b82
250#define AML_PROCESSOR_OP            (UINT16) 0x5b83
251#define AML_POWER_RES_OP            (UINT16) 0x5b84
252#define AML_THERMAL_ZONE_OP         (UINT16) 0x5b85
253#define AML_INDEX_FIELD_OP          (UINT16) 0x5b86
254#define AML_BANK_FIELD_OP           (UINT16) 0x5b87
255#define AML_DATA_REGION_OP          (UINT16) 0x5b88     /* ACPI 2.0 */
256
257
258/* Bogus opcodes (they are actually two separate opcodes) */
259
260#define AML_LGREATEREQUAL_OP        (UINT16) 0x9295
261#define AML_LLESSEQUAL_OP           (UINT16) 0x9294
262#define AML_LNOTEQUAL_OP            (UINT16) 0x9293
263
264
265/*
266 * Internal opcodes
267 * Use only "Unknown" AML opcodes, don't attempt to use
268 * any valid ACPI ASCII values (A-Z, 0-9, '-')
269 */
270
271#define AML_INT_NAMEPATH_OP         (UINT16) 0x002d
272#define AML_INT_NAMEDFIELD_OP       (UINT16) 0x0030
273#define AML_INT_RESERVEDFIELD_OP    (UINT16) 0x0031
274#define AML_INT_ACCESSFIELD_OP      (UINT16) 0x0032
275#define AML_INT_BYTELIST_OP         (UINT16) 0x0033
276#define AML_INT_STATICSTRING_OP     (UINT16) 0x0034
277#define AML_INT_METHODCALL_OP       (UINT16) 0x0035
278#define AML_INT_RETURN_VALUE_OP     (UINT16) 0x0036
279
280
281#define ARG_NONE                    0x0
282
283/*
284 * Argument types for the AML Parser
285 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
286 * There can be up to 31 unique argument types
287 */
288
289#define ARGP_BYTEDATA               0x01
290#define ARGP_BYTELIST               0x02
291#define ARGP_CHARLIST               0x03
292#define ARGP_DATAOBJ                0x04
293#define ARGP_DATAOBJLIST            0x05
294#define ARGP_DWORDDATA              0x06
295#define ARGP_FIELDLIST              0x07
296#define ARGP_NAME                   0x08
297#define ARGP_NAMESTRING             0x09
298#define ARGP_OBJLIST                0x0A
299#define ARGP_PKGLENGTH              0x0B
300#define ARGP_SUPERNAME              0x0C
301#define ARGP_TARGET                 0x0D
302#define ARGP_TERMARG                0x0E
303#define ARGP_TERMLIST               0x0F
304#define ARGP_WORDDATA               0x10
305#define ARGP_QWORDDATA              0x11
306#define ARGP_SIMPLENAME             0x12
307
308/*
309 * Resolved argument types for the AML Interpreter
310 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
311 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
312 */
313
314/* "Standard" ACPI types are 1-15 (0x0F) */
315
316#define ARGI_INTEGER                ACPI_TYPE_INTEGER       /* 1 */
317#define ARGI_STRING                 ACPI_TYPE_STRING        /* 2 */
318#define ARGI_BUFFER                 ACPI_TYPE_BUFFER        /* 3 */
319#define ARGI_PACKAGE                ACPI_TYPE_PACKAGE       /* 4 */
320#define ARGI_EVENT                  ACPI_TYPE_EVENT
321#define ARGI_MUTEX                  ACPI_TYPE_MUTEX
322#define ARGI_REGION                 ACPI_TYPE_REGION
323#define ARGI_DDBHANDLE              ACPI_TYPE_DDB_HANDLE
324
325/* Custom types are 0x10 through 0x1F */
326
327#define ARGI_IF                     0x10
328#define ARGI_ANYOBJECT              0x11
329#define ARGI_ANYTYPE                0x12
330#define ARGI_COMPUTEDATA            0x13     /* Buffer, String, or Integer */
331#define ARGI_DATAOBJECT             0x14     /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/
332#define ARGI_COMPLEXOBJ             0x15     /* Buffer, String, or package (Used by INDEX op only) */
333#define ARGI_INTEGER_REF            0x16
334#define ARGI_OBJECT_REF             0x17
335#define ARGI_DEVICE_REF             0x18
336#define ARGI_REFERENCE              0x19
337#define ARGI_TARGETREF              0x1A     /* Target, subject to implicit conversion */
338#define ARGI_FIXED_TARGET           0x1B     /* Target, no implicit conversion */
339#define ARGI_SIMPLE_TARGET          0x1C     /* Name, Local, Arg -- no implicit conversion */
340#define ARGI_BUFFERSTRING           0x1D
341
342#define ARGI_INVALID_OPCODE         0xFFFFFFFF
343
344
345/*
346 * hash offsets
347 */
348#define AML_EXTOP_HASH_OFFSET       22
349#define AML_LNOT_HASH_OFFSET        19
350
351
352/*
353 * opcode groups and types
354 */
355
356#define OPGRP_NAMED                 0x01
357#define OPGRP_FIELD                 0x02
358#define OPGRP_BYTELIST              0x04
359
360#define OPTYPE_UNDEFINED            0
361
362
363#define OPTYPE_LITERAL              1
364#define OPTYPE_CONSTANT             2
365#define OPTYPE_METHOD_ARGUMENT      3
366#define OPTYPE_LOCAL_VARIABLE       4
367#define OPTYPE_DATA_TERM            5
368
369/* Type 1 opcodes */
370
371#define OPTYPE_MONADIC1             6
372#define OPTYPE_DYADIC1              7
373
374/* Type 2 opcodes */
375
376#define OPTYPE_MONADIC2             8
377#define OPTYPE_MONADIC2R            9
378#define OPTYPE_DYADIC2              10
379#define OPTYPE_DYADIC2R             11
380#define OPTYPE_DYADIC2S             12
381
382/* Multi-operand (>=3) opcodes */
383
384#define OPTYPE_TRIADIC              13
385#define OPTYPE_QUADRADIC            14
386#define OPTYPE_HEXADIC              15
387
388/* Generic for an op that returns a value */
389
390#define OPTYPE_METHOD_CALL          16
391
392/* Misc */
393
394#define OPTYPE_CREATE_FIELD         17
395#define OPTYPE_CONTROL              18
396#define OPTYPE_RECONFIGURATION      19
397#define OPTYPE_NAMED_OBJECT         20
398#define OPTYPE_RETURN               21
399
400#define OPTYPE_BOGUS                22
401
402
403/* Predefined Operation Region SpaceIDs */
404
405typedef enum
406{
407    REGION_MEMORY                   = 0,
408    REGION_IO,
409    REGION_PCI_CONFIG,
410    REGION_EC,
411    REGION_SMBUS,
412    REGION_CMOS,
413    REGION_PCI_BAR,
414    REGION_FIXED_HW                 = 0x7F,
415
416} AML_REGION_TYPES;
417
418
419/* Comparison operation codes for MatchOp operator */
420
421typedef enum
422{
423    MATCH_MTR                       = 0,
424    MATCH_MEQ                       = 1,
425    MATCH_MLE                       = 2,
426    MATCH_MLT                       = 3,
427    MATCH_MGE                       = 4,
428    MATCH_MGT                       = 5
429
430} AML_MATCH_OPERATOR;
431
432#define MAX_MATCH_OPERATOR          5
433
434
435/* Field Access Types */
436
437#define ACCESS_TYPE_MASK            0x0f
438#define ACCESS_TYPE_SHIFT           0
439
440typedef enum
441{
442    ACCESS_ANY_ACC                  = 0,
443    ACCESS_BYTE_ACC                 = 1,
444    ACCESS_WORD_ACC                 = 2,
445    ACCESS_DWORD_ACC                = 3,
446    ACCESS_QWORD_ACC                = 4,    /* ACPI 2.0 */
447    ACCESS_BLOCK_ACC                = 4,
448    ACCESS_SMBSEND_RECV_ACC         = 5,
449    ACCESS_SMBQUICK_ACC             = 6
450
451} AML_ACCESS_TYPE;
452
453
454/* Field Lock Rules */
455
456#define LOCK_RULE_MASK              0x10
457#define LOCK_RULE_SHIFT             4
458
459typedef enum
460{
461    GLOCK_NEVER_LOCK                = 0,
462    GLOCK_ALWAYS_LOCK               = 1
463
464} AML_LOCK_RULE;
465
466
467/* Field Update Rules */
468
469#define UPDATE_RULE_MASK            0x060
470#define UPDATE_RULE_SHIFT           5
471
472typedef enum
473{
474    UPDATE_PRESERVE                 = 0,
475    UPDATE_WRITE_AS_ONES            = 1,
476    UPDATE_WRITE_AS_ZEROS           = 2
477
478} AML_UPDATE_RULE;
479
480
481/* bit fields in MethodFlags byte */
482
483#define METHOD_FLAGS_ARG_COUNT      0x07
484#define METHOD_FLAGS_SERIALIZED     0x08
485#define METHOD_FLAGS_SYNCH_LEVEL    0xF0
486
487
488/* Array sizes.  Used for range checking also */
489
490#define NUM_REGION_TYPES            7
491#define NUM_ACCESS_TYPES            7
492#define NUM_UPDATE_RULES            3
493#define NUM_MATCH_OPS               7
494#define NUM_OPCODES                 256
495#define NUM_FIELD_NAMES             2
496
497
498#define USER_REGION_BEGIN           0x80
499
500/*
501 * AML tables
502 */
503
504#ifdef DEFINE_AML_GLOBALS
505
506/* External declarations for the AML tables */
507
508extern UINT8                    AcpiGbl_Aml             [NUM_OPCODES];
509extern UINT16                   AcpiGbl_Pfx             [NUM_OPCODES];
510
511
512#endif /* DEFINE_AML_GLOBALS */
513
514#endif /* __AMLCODE_H__ */
515