Blame source/include/amlcode.h

Packit Service 1fb00e
/******************************************************************************
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * Name: amlcode.h - Definitions for AML, as included in "definition blocks"
Packit Service 1fb00e
 *                   Declarations and definitions contained herein are derived
Packit Service 1fb00e
 *                   directly from the ACPI specification.
Packit Service 1fb00e
 *
Packit Service 1fb00e
 *****************************************************************************/
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Copyright (C) 2000 - 2018, Intel Corp.
Packit Service 1fb00e
 * All rights reserved.
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * Redistribution and use in source and binary forms, with or without
Packit Service 1fb00e
 * modification, are permitted provided that the following conditions
Packit Service 1fb00e
 * are met:
Packit Service 1fb00e
 * 1. Redistributions of source code must retain the above copyright
Packit Service 1fb00e
 *    notice, this list of conditions, and the following disclaimer,
Packit Service 1fb00e
 *    without modification.
Packit Service 1fb00e
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
Packit Service 1fb00e
 *    substantially similar to the "NO WARRANTY" disclaimer below
Packit Service 1fb00e
 *    ("Disclaimer") and any redistribution must be conditioned upon
Packit Service 1fb00e
 *    including a substantially similar Disclaimer requirement for further
Packit Service 1fb00e
 *    binary redistribution.
Packit Service 1fb00e
 * 3. Neither the names of the above-listed copyright holders nor the names
Packit Service 1fb00e
 *    of any contributors may be used to endorse or promote products derived
Packit Service 1fb00e
 *    from this software without specific prior written permission.
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * Alternatively, this software may be distributed under the terms of the
Packit Service 1fb00e
 * GNU General Public License ("GPL") version 2 as published by the Free
Packit Service 1fb00e
 * Software Foundation.
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * NO WARRANTY
Packit Service 1fb00e
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Packit Service 1fb00e
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Packit Service 1fb00e
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
Packit Service 1fb00e
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Packit Service 1fb00e
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Packit Service 1fb00e
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
Packit Service 1fb00e
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
Packit Service 1fb00e
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
Packit Service 1fb00e
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
Packit Service 1fb00e
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Packit Service 1fb00e
 * POSSIBILITY OF SUCH DAMAGES.
Packit Service 1fb00e
 */
Packit Service 1fb00e
Packit Service 1fb00e
#ifndef __AMLCODE_H__
Packit Service 1fb00e
#define __AMLCODE_H__
Packit Service 1fb00e
Packit Service 1fb00e
/* primary opcodes */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_ZERO_OP                 (UINT16) 0x00
Packit Service 1fb00e
#define AML_ONE_OP                  (UINT16) 0x01
Packit Service 1fb00e
#define AML_ALIAS_OP                (UINT16) 0x06
Packit Service 1fb00e
#define AML_NAME_OP                 (UINT16) 0x08
Packit Service 1fb00e
#define AML_BYTE_OP                 (UINT16) 0x0a
Packit Service 1fb00e
#define AML_WORD_OP                 (UINT16) 0x0b
Packit Service 1fb00e
#define AML_DWORD_OP                (UINT16) 0x0c
Packit Service 1fb00e
#define AML_STRING_OP               (UINT16) 0x0d
Packit Service 1fb00e
#define AML_QWORD_OP                (UINT16) 0x0e     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_SCOPE_OP                (UINT16) 0x10
Packit Service 1fb00e
#define AML_BUFFER_OP               (UINT16) 0x11
Packit Service 1fb00e
#define AML_PACKAGE_OP              (UINT16) 0x12
Packit Service 1fb00e
#define AML_VARIABLE_PACKAGE_OP     (UINT16) 0x13     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_METHOD_OP               (UINT16) 0x14
Packit Service 1fb00e
#define AML_EXTERNAL_OP             (UINT16) 0x15     /* ACPI 6.0 */
Packit Service 1fb00e
#define AML_DUAL_NAME_PREFIX        (UINT16) 0x2e
Packit Service 1fb00e
#define AML_MULTI_NAME_PREFIX       (UINT16) 0x2f
Packit Service 1fb00e
#define AML_EXTENDED_PREFIX         (UINT16) 0x5b
Packit Service 1fb00e
#define AML_ROOT_PREFIX             (UINT16) 0x5c
Packit Service 1fb00e
#define AML_PARENT_PREFIX           (UINT16) 0x5e
Packit Service 1fb00e
#define AML_FIRST_LOCAL_OP          (UINT16) 0x60     /* Used for Local op # calculations */
Packit Service 1fb00e
#define AML_LOCAL0                  (UINT16) 0x60
Packit Service 1fb00e
#define AML_LOCAL1                  (UINT16) 0x61
Packit Service 1fb00e
#define AML_LOCAL2                  (UINT16) 0x62
Packit Service 1fb00e
#define AML_LOCAL3                  (UINT16) 0x63
Packit Service 1fb00e
#define AML_LOCAL4                  (UINT16) 0x64
Packit Service 1fb00e
#define AML_LOCAL5                  (UINT16) 0x65
Packit Service 1fb00e
#define AML_LOCAL6                  (UINT16) 0x66
Packit Service 1fb00e
#define AML_LOCAL7                  (UINT16) 0x67
Packit Service 1fb00e
#define AML_FIRST_ARG_OP            (UINT16) 0x68     /* Used for Arg op # calculations */
Packit Service 1fb00e
#define AML_ARG0                    (UINT16) 0x68
Packit Service 1fb00e
#define AML_ARG1                    (UINT16) 0x69
Packit Service 1fb00e
#define AML_ARG2                    (UINT16) 0x6a
Packit Service 1fb00e
#define AML_ARG3                    (UINT16) 0x6b
Packit Service 1fb00e
#define AML_ARG4                    (UINT16) 0x6c
Packit Service 1fb00e
#define AML_ARG5                    (UINT16) 0x6d
Packit Service 1fb00e
#define AML_ARG6                    (UINT16) 0x6e
Packit Service 1fb00e
#define AML_STORE_OP                (UINT16) 0x70
Packit Service 1fb00e
#define AML_REF_OF_OP               (UINT16) 0x71
Packit Service 1fb00e
#define AML_ADD_OP                  (UINT16) 0x72
Packit Service 1fb00e
#define AML_CONCATENATE_OP          (UINT16) 0x73
Packit Service 1fb00e
#define AML_SUBTRACT_OP             (UINT16) 0x74
Packit Service 1fb00e
#define AML_INCREMENT_OP            (UINT16) 0x75
Packit Service 1fb00e
#define AML_DECREMENT_OP            (UINT16) 0x76
Packit Service 1fb00e
#define AML_MULTIPLY_OP             (UINT16) 0x77
Packit Service 1fb00e
#define AML_DIVIDE_OP               (UINT16) 0x78
Packit Service 1fb00e
#define AML_SHIFT_LEFT_OP           (UINT16) 0x79
Packit Service 1fb00e
#define AML_SHIFT_RIGHT_OP          (UINT16) 0x7a
Packit Service 1fb00e
#define AML_BIT_AND_OP              (UINT16) 0x7b
Packit Service 1fb00e
#define AML_BIT_NAND_OP             (UINT16) 0x7c
Packit Service 1fb00e
#define AML_BIT_OR_OP               (UINT16) 0x7d
Packit Service 1fb00e
#define AML_BIT_NOR_OP              (UINT16) 0x7e
Packit Service 1fb00e
#define AML_BIT_XOR_OP              (UINT16) 0x7f
Packit Service 1fb00e
#define AML_BIT_NOT_OP              (UINT16) 0x80
Packit Service 1fb00e
#define AML_FIND_SET_LEFT_BIT_OP    (UINT16) 0x81
Packit Service 1fb00e
#define AML_FIND_SET_RIGHT_BIT_OP   (UINT16) 0x82
Packit Service 1fb00e
#define AML_DEREF_OF_OP             (UINT16) 0x83
Packit Service 1fb00e
#define AML_CONCATENATE_TEMPLATE_OP (UINT16) 0x84     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_MOD_OP                  (UINT16) 0x85     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_NOTIFY_OP               (UINT16) 0x86
Packit Service 1fb00e
#define AML_SIZE_OF_OP              (UINT16) 0x87
Packit Service 1fb00e
#define AML_INDEX_OP                (UINT16) 0x88
Packit Service 1fb00e
#define AML_MATCH_OP                (UINT16) 0x89
Packit Service 1fb00e
#define AML_CREATE_DWORD_FIELD_OP   (UINT16) 0x8a
Packit Service 1fb00e
#define AML_CREATE_WORD_FIELD_OP    (UINT16) 0x8b
Packit Service 1fb00e
#define AML_CREATE_BYTE_FIELD_OP    (UINT16) 0x8c
Packit Service 1fb00e
#define AML_CREATE_BIT_FIELD_OP     (UINT16) 0x8d
Packit Service 1fb00e
#define AML_OBJECT_TYPE_OP          (UINT16) 0x8e
Packit Service 1fb00e
#define AML_CREATE_QWORD_FIELD_OP   (UINT16) 0x8f     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_LOGICAL_AND_OP          (UINT16) 0x90
Packit Service 1fb00e
#define AML_LOGICAL_OR_OP           (UINT16) 0x91
Packit Service 1fb00e
#define AML_LOGICAL_NOT_OP          (UINT16) 0x92
Packit Service 1fb00e
#define AML_LOGICAL_EQUAL_OP        (UINT16) 0x93
Packit Service 1fb00e
#define AML_LOGICAL_GREATER_OP      (UINT16) 0x94
Packit Service 1fb00e
#define AML_LOGICAL_LESS_OP         (UINT16) 0x95
Packit Service 1fb00e
#define AML_TO_BUFFER_OP            (UINT16) 0x96     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_TO_DECIMAL_STRING_OP    (UINT16) 0x97     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_TO_HEX_STRING_OP        (UINT16) 0x98     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_TO_INTEGER_OP           (UINT16) 0x99     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_TO_STRING_OP            (UINT16) 0x9c     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_COPY_OBJECT_OP          (UINT16) 0x9d     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_MID_OP                  (UINT16) 0x9e     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_CONTINUE_OP             (UINT16) 0x9f     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_IF_OP                   (UINT16) 0xa0
Packit Service 1fb00e
#define AML_ELSE_OP                 (UINT16) 0xa1
Packit Service 1fb00e
#define AML_WHILE_OP                (UINT16) 0xa2
Packit Service 1fb00e
#define AML_NOOP_OP                 (UINT16) 0xa3
Packit Service 1fb00e
#define AML_RETURN_OP               (UINT16) 0xa4
Packit Service 1fb00e
#define AML_BREAK_OP                (UINT16) 0xa5
Packit Service 1fb00e
#define AML_COMMENT_OP              (UINT16) 0xa9
Packit Service 1fb00e
#define AML_BREAKPOINT_OP          (UINT16) 0xcc
Packit Service 1fb00e
#define AML_ONES_OP                 (UINT16) 0xff
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Combination opcodes (actually two one-byte opcodes)
Packit Service 1fb00e
 * Used by the disassembler and iASL compiler
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define AML_LOGICAL_GREATER_EQUAL_OP (UINT16) 0x9295    /* LNot (LLess) */
Packit Service 1fb00e
#define AML_LOGICAL_LESS_EQUAL_OP    (UINT16) 0x9294    /* LNot (LGreater) */
Packit Service 1fb00e
#define AML_LOGICAL_NOT_EQUAL_OP     (UINT16) 0x9293    /* LNot (LEqual) */
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/* Prefixed (2-byte) opcodes (with AML_EXTENDED_PREFIX) */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_EXTENDED_OPCODE         (UINT16) 0x5b00     /* Prefix for 2-byte opcodes */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_MUTEX_OP                (UINT16) 0x5b01
Packit Service 1fb00e
#define AML_EVENT_OP                (UINT16) 0x5b02
Packit Service 1fb00e
#define AML_SHIFT_RIGHT_BIT_OP      (UINT16) 0x5b10     /* Obsolete, not in ACPI spec */
Packit Service 1fb00e
#define AML_SHIFT_LEFT_BIT_OP       (UINT16) 0x5b11     /* Obsolete, not in ACPI spec */
Packit Service 1fb00e
#define AML_CONDITIONAL_REF_OF_OP   (UINT16) 0x5b12
Packit Service 1fb00e
#define AML_CREATE_FIELD_OP         (UINT16) 0x5b13
Packit Service 1fb00e
#define AML_LOAD_TABLE_OP           (UINT16) 0x5b1f     /* ACPI 2.0 */
Packit Service 1fb00e
#define AML_LOAD_OP                 (UINT16) 0x5b20
Packit Service 1fb00e
#define AML_STALL_OP                (UINT16) 0x5b21
Packit Service 1fb00e
#define AML_SLEEP_OP                (UINT16) 0x5b22
Packit Service 1fb00e
#define AML_ACQUIRE_OP              (UINT16) 0x5b23
Packit Service 1fb00e
#define AML_SIGNAL_OP               (UINT16) 0x5b24
Packit Service 1fb00e
#define AML_WAIT_OP                 (UINT16) 0x5b25
Packit Service 1fb00e
#define AML_RESET_OP                (UINT16) 0x5b26
Packit Service 1fb00e
#define AML_RELEASE_OP              (UINT16) 0x5b27
Packit Service 1fb00e
#define AML_FROM_BCD_OP             (UINT16) 0x5b28
Packit Service 1fb00e
#define AML_TO_BCD_OP               (UINT16) 0x5b29
Packit Service 1fb00e
#define AML_UNLOAD_OP               (UINT16) 0x5b2a
Packit Service 1fb00e
#define AML_REVISION_OP             (UINT16) 0x5b30
Packit Service 1fb00e
#define AML_DEBUG_OP                (UINT16) 0x5b31
Packit Service 1fb00e
#define AML_FATAL_OP                (UINT16) 0x5b32
Packit Service 1fb00e
#define AML_TIMER_OP                (UINT16) 0x5b33     /* ACPI 3.0 */
Packit Service 1fb00e
#define AML_REGION_OP               (UINT16) 0x5b80
Packit Service 1fb00e
#define AML_FIELD_OP                (UINT16) 0x5b81
Packit Service 1fb00e
#define AML_DEVICE_OP               (UINT16) 0x5b82
Packit Service 1fb00e
#define AML_PROCESSOR_OP            (UINT16) 0x5b83
Packit Service 1fb00e
#define AML_POWER_RESOURCE_OP       (UINT16) 0x5b84
Packit Service 1fb00e
#define AML_THERMAL_ZONE_OP         (UINT16) 0x5b85
Packit Service 1fb00e
#define AML_INDEX_FIELD_OP          (UINT16) 0x5b86
Packit Service 1fb00e
#define AML_BANK_FIELD_OP           (UINT16) 0x5b87
Packit Service 1fb00e
#define AML_DATA_REGION_OP          (UINT16) 0x5b88     /* ACPI 2.0 */
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Opcodes for "Field" operators
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define AML_FIELD_OFFSET_OP         (UINT8) 0x00
Packit Service 1fb00e
#define AML_FIELD_ACCESS_OP         (UINT8) 0x01
Packit Service 1fb00e
#define AML_FIELD_CONNECTION_OP     (UINT8) 0x02        /* ACPI 5.0 */
Packit Service 1fb00e
#define AML_FIELD_EXT_ACCESS_OP     (UINT8) 0x03        /* ACPI 5.0 */
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Internal opcodes
Packit Service 1fb00e
 * Use only "Unknown" AML opcodes, don't attempt to use
Packit Service 1fb00e
 * any valid ACPI ASCII values (A-Z, 0-9, '-')
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define AML_INT_NAMEPATH_OP         (UINT16) 0x002d
Packit Service 1fb00e
#define AML_INT_NAMEDFIELD_OP       (UINT16) 0x0030
Packit Service 1fb00e
#define AML_INT_RESERVEDFIELD_OP    (UINT16) 0x0031
Packit Service 1fb00e
#define AML_INT_ACCESSFIELD_OP      (UINT16) 0x0032
Packit Service 1fb00e
#define AML_INT_BYTELIST_OP         (UINT16) 0x0033
Packit Service 1fb00e
#define AML_INT_METHODCALL_OP       (UINT16) 0x0035
Packit Service 1fb00e
#define AML_INT_RETURN_VALUE_OP     (UINT16) 0x0036
Packit Service 1fb00e
#define AML_INT_EVAL_SUBTREE_OP     (UINT16) 0x0037
Packit Service 1fb00e
#define AML_INT_CONNECTION_OP       (UINT16) 0x0038
Packit Service 1fb00e
#define AML_INT_EXTACCESSFIELD_OP   (UINT16) 0x0039
Packit Service 1fb00e
Packit Service 1fb00e
#define ARG_NONE                    0x0
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Argument types for the AML Parser
Packit Service 1fb00e
 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
Packit Service 1fb00e
 * There can be up to 31 unique argument types
Packit Service 1fb00e
 * Zero is reserved as end-of-list indicator
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define ARGP_BYTEDATA               0x01
Packit Service 1fb00e
#define ARGP_BYTELIST               0x02
Packit Service 1fb00e
#define ARGP_CHARLIST               0x03
Packit Service 1fb00e
#define ARGP_DATAOBJ                0x04
Packit Service 1fb00e
#define ARGP_DATAOBJLIST            0x05
Packit Service 1fb00e
#define ARGP_DWORDDATA              0x06
Packit Service 1fb00e
#define ARGP_FIELDLIST              0x07
Packit Service 1fb00e
#define ARGP_NAME                   0x08
Packit Service 1fb00e
#define ARGP_NAMESTRING             0x09
Packit Service 1fb00e
#define ARGP_OBJLIST                0x0A
Packit Service 1fb00e
#define ARGP_PKGLENGTH              0x0B
Packit Service 1fb00e
#define ARGP_SUPERNAME              0x0C
Packit Service 1fb00e
#define ARGP_TARGET                 0x0D
Packit Service 1fb00e
#define ARGP_TERMARG                0x0E
Packit Service 1fb00e
#define ARGP_TERMLIST               0x0F
Packit Service 1fb00e
#define ARGP_WORDDATA               0x10
Packit Service 1fb00e
#define ARGP_QWORDDATA              0x11
Packit Service 1fb00e
#define ARGP_SIMPLENAME             0x12 /* NameString | LocalTerm | ArgTerm */
Packit Service 1fb00e
#define ARGP_NAME_OR_REF            0x13 /* For ObjectType only */
Packit Service 1fb00e
#define ARGP_MAX                    0x13
Packit Service 1fb00e
#define ARGP_COMMENT                0x14
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Resolved argument types for the AML Interpreter
Packit Service 1fb00e
 * Each field in the ArgTypes UINT32 is 5 bits, allowing for a maximum of 6 arguments.
Packit Service 1fb00e
 * There can be up to 31 unique argument types (0 is end-of-arg-list indicator)
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * Note1: These values are completely independent from the ACPI_TYPEs
Packit Service 1fb00e
 *        i.e., ARGI_INTEGER != ACPI_TYPE_INTEGER
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * Note2: If and when 5 bits becomes insufficient, it would probably be best
Packit Service 1fb00e
 * to convert to a 6-byte array of argument types, allowing 8 bits per argument.
Packit Service 1fb00e
 */
Packit Service 1fb00e
Packit Service 1fb00e
/* Single, simple types */
Packit Service 1fb00e
Packit Service 1fb00e
#define ARGI_ANYTYPE                0x01    /* Don't care */
Packit Service 1fb00e
#define ARGI_PACKAGE                0x02
Packit Service 1fb00e
#define ARGI_EVENT                  0x03
Packit Service 1fb00e
#define ARGI_MUTEX                  0x04
Packit Service 1fb00e
#define ARGI_DDBHANDLE              0x05
Packit Service 1fb00e
Packit Service 1fb00e
/* Interchangeable types (via implicit conversion) */
Packit Service 1fb00e
Packit Service 1fb00e
#define ARGI_INTEGER                0x06
Packit Service 1fb00e
#define ARGI_STRING                 0x07
Packit Service 1fb00e
#define ARGI_BUFFER                 0x08
Packit Service 1fb00e
#define ARGI_BUFFER_OR_STRING       0x09    /* Used by MID op only */
Packit Service 1fb00e
#define ARGI_COMPUTEDATA            0x0A    /* Buffer, String, or Integer */
Packit Service 1fb00e
Packit Service 1fb00e
/* Reference objects */
Packit Service 1fb00e
Packit Service 1fb00e
#define ARGI_INTEGER_REF            0x0B
Packit Service 1fb00e
#define ARGI_OBJECT_REF             0x0C
Packit Service 1fb00e
#define ARGI_DEVICE_REF             0x0D
Packit Service 1fb00e
#define ARGI_REFERENCE              0x0E
Packit Service 1fb00e
#define ARGI_TARGETREF              0x0F    /* Target, subject to implicit conversion */
Packit Service 1fb00e
#define ARGI_FIXED_TARGET           0x10    /* Target, no implicit conversion */
Packit Service 1fb00e
#define ARGI_SIMPLE_TARGET          0x11    /* Name, Local, Arg -- no implicit conversion */
Packit Service 1fb00e
#define ARGI_STORE_TARGET           0x12    /* Target for store is TARGETREF + package objects */
Packit Service 1fb00e
Packit Service 1fb00e
/* Multiple/complex types */
Packit Service 1fb00e
Packit Service 1fb00e
#define ARGI_DATAOBJECT             0x13    /* Buffer, String, package or reference to a Node - Used only by SizeOf operator*/
Packit Service 1fb00e
#define ARGI_COMPLEXOBJ             0x14    /* Buffer, String, or package (Used by INDEX op only) */
Packit Service 1fb00e
#define ARGI_REF_OR_STRING          0x15    /* Reference or String (Used by DEREFOF op only) */
Packit Service 1fb00e
#define ARGI_REGION_OR_BUFFER       0x16    /* Used by LOAD op only */
Packit Service 1fb00e
#define ARGI_DATAREFOBJ             0x17
Packit Service 1fb00e
Packit Service 1fb00e
/* Note: types above can expand to 0x1F maximum */
Packit Service 1fb00e
Packit Service 1fb00e
#define ARGI_INVALID_OPCODE         0xFFFFFFFF
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Some of the flags and types below are of the form:
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * AML_FLAGS_EXEC_#A_#T,#R, or
Packit Service 1fb00e
 * AML_TYPE_EXEC_#A_#T,#R where:
Packit Service 1fb00e
 *
Packit Service 1fb00e
 *      #A is the number of required arguments
Packit Service 1fb00e
 *      #T is the number of target operands
Packit Service 1fb00e
 *      #R indicates whether there is a return value
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * These types are used for the top-level dispatch of the AML
Packit Service 1fb00e
 * opcode. They group similar operators that can share common
Packit Service 1fb00e
 * front-end code before dispatch to the final code that implements
Packit Service 1fb00e
 * the operator.
Packit Service 1fb00e
 */
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Opcode information flags
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define AML_LOGICAL                 0x0001
Packit Service 1fb00e
#define AML_LOGICAL_NUMERIC         0x0002
Packit Service 1fb00e
#define AML_MATH                    0x0004
Packit Service 1fb00e
#define AML_CREATE                  0x0008
Packit Service 1fb00e
#define AML_FIELD                   0x0010
Packit Service 1fb00e
#define AML_DEFER                   0x0020
Packit Service 1fb00e
#define AML_NAMED                   0x0040
Packit Service 1fb00e
#define AML_NSNODE                  0x0080
Packit Service 1fb00e
#define AML_NSOPCODE                0x0100
Packit Service 1fb00e
#define AML_NSOBJECT                0x0200
Packit Service 1fb00e
#define AML_HAS_RETVAL              0x0400
Packit Service 1fb00e
#define AML_HAS_TARGET              0x0800
Packit Service 1fb00e
#define AML_HAS_ARGS                0x1000
Packit Service 1fb00e
#define AML_CONSTANT                0x2000
Packit Service 1fb00e
#define AML_NO_OPERAND_RESOLVE      0x4000
Packit Service 1fb00e
Packit Service 1fb00e
/* Convenient flag groupings of the flags above */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_FLAGS_EXEC_0A_0T_1R                                     AML_HAS_RETVAL
Packit Service 1fb00e
#define AML_FLAGS_EXEC_1A_0T_0R     AML_HAS_ARGS                                   /* Monadic1  */
Packit Service 1fb00e
#define AML_FLAGS_EXEC_1A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Monadic2  */
Packit Service 1fb00e
#define AML_FLAGS_EXEC_1A_1T_0R     AML_HAS_ARGS | AML_HAS_TARGET
Packit Service 1fb00e
#define AML_FLAGS_EXEC_1A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Monadic2R */
Packit Service 1fb00e
#define AML_FLAGS_EXEC_2A_0T_0R     AML_HAS_ARGS                                   /* Dyadic1   */
Packit Service 1fb00e
#define AML_FLAGS_EXEC_2A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL /* Dyadic2   */
Packit Service 1fb00e
#define AML_FLAGS_EXEC_2A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL /* Dyadic2R  */
Packit Service 1fb00e
#define AML_FLAGS_EXEC_2A_2T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
Packit Service 1fb00e
#define AML_FLAGS_EXEC_3A_0T_0R     AML_HAS_ARGS
Packit Service 1fb00e
#define AML_FLAGS_EXEC_3A_1T_1R     AML_HAS_ARGS | AML_HAS_TARGET | AML_HAS_RETVAL
Packit Service 1fb00e
#define AML_FLAGS_EXEC_6A_0T_1R     AML_HAS_ARGS |                  AML_HAS_RETVAL
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * The opcode Type is used in a dispatch table, do not change
Packit Service 1fb00e
 * or add anything new without updating the table.
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define AML_TYPE_EXEC_0A_0T_1R      0x00 /* 0 Args, 0 Target, 1 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_1A_0T_0R      0x01 /* 1 Args, 0 Target, 0 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_1A_0T_1R      0x02 /* 1 Args, 0 Target, 1 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_1A_1T_0R      0x03 /* 1 Args, 1 Target, 0 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_1A_1T_1R      0x04 /* 1 Args, 1 Target, 1 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_2A_0T_0R      0x05 /* 2 Args, 0 Target, 0 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_2A_0T_1R      0x06 /* 2 Args, 0 Target, 1 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_2A_1T_1R      0x07 /* 2 Args, 1 Target, 1 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_2A_2T_1R      0x08 /* 2 Args, 2 Target, 1 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_3A_0T_0R      0x09 /* 3 Args, 0 Target, 0 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_3A_1T_1R      0x0A /* 3 Args, 1 Target, 1 RetVal */
Packit Service 1fb00e
#define AML_TYPE_EXEC_6A_0T_1R      0x0B /* 6 Args, 0 Target, 1 RetVal */
Packit Service 1fb00e
/* End of types used in dispatch table */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_TYPE_LITERAL            0x0C
Packit Service 1fb00e
#define AML_TYPE_CONSTANT           0x0D
Packit Service 1fb00e
#define AML_TYPE_METHOD_ARGUMENT    0x0E
Packit Service 1fb00e
#define AML_TYPE_LOCAL_VARIABLE     0x0F
Packit Service 1fb00e
#define AML_TYPE_DATA_TERM          0x10
Packit Service 1fb00e
Packit Service 1fb00e
/* Generic for an op that returns a value */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_TYPE_METHOD_CALL        0x11
Packit Service 1fb00e
Packit Service 1fb00e
/* Miscellaneous types */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_TYPE_CREATE_FIELD       0x12
Packit Service 1fb00e
#define AML_TYPE_CREATE_OBJECT      0x13
Packit Service 1fb00e
#define AML_TYPE_CONTROL            0x14
Packit Service 1fb00e
#define AML_TYPE_NAMED_NO_OBJ       0x15
Packit Service 1fb00e
#define AML_TYPE_NAMED_FIELD        0x16
Packit Service 1fb00e
#define AML_TYPE_NAMED_SIMPLE       0x17
Packit Service 1fb00e
#define AML_TYPE_NAMED_COMPLEX      0x18
Packit Service 1fb00e
#define AML_TYPE_RETURN             0x19
Packit Service 1fb00e
#define AML_TYPE_UNDEFINED          0x1A
Packit Service 1fb00e
#define AML_TYPE_BOGUS              0x1B
Packit Service 1fb00e
Packit Service 1fb00e
/* AML Package Length encodings */
Packit Service 1fb00e
Packit Service 1fb00e
#define ACPI_AML_PACKAGE_TYPE1      0x40
Packit Service 1fb00e
#define ACPI_AML_PACKAGE_TYPE2      0x4000
Packit Service 1fb00e
#define ACPI_AML_PACKAGE_TYPE3      0x400000
Packit Service 1fb00e
#define ACPI_AML_PACKAGE_TYPE4      0x40000000
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Opcode classes
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define AML_CLASS_EXECUTE           0x00
Packit Service 1fb00e
#define AML_CLASS_CREATE            0x01
Packit Service 1fb00e
#define AML_CLASS_ARGUMENT          0x02
Packit Service 1fb00e
#define AML_CLASS_NAMED_OBJECT      0x03
Packit Service 1fb00e
#define AML_CLASS_CONTROL           0x04
Packit Service 1fb00e
#define AML_CLASS_ASCII             0x05
Packit Service 1fb00e
#define AML_CLASS_PREFIX            0x06
Packit Service 1fb00e
#define AML_CLASS_INTERNAL          0x07
Packit Service 1fb00e
#define AML_CLASS_RETURN_VALUE      0x08
Packit Service 1fb00e
#define AML_CLASS_METHOD_CALL       0x09
Packit Service 1fb00e
#define AML_CLASS_UNKNOWN           0x0A
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/* Comparison operation codes for MatchOp operator */
Packit Service 1fb00e
Packit Service 1fb00e
typedef enum
Packit Service 1fb00e
{
Packit Service 1fb00e
    MATCH_MTR                       = 0,
Packit Service 1fb00e
    MATCH_MEQ                       = 1,
Packit Service 1fb00e
    MATCH_MLE                       = 2,
Packit Service 1fb00e
    MATCH_MLT                       = 3,
Packit Service 1fb00e
    MATCH_MGE                       = 4,
Packit Service 1fb00e
    MATCH_MGT                       = 5
Packit Service 1fb00e
Packit Service 1fb00e
} AML_MATCH_OPERATOR;
Packit Service 1fb00e
Packit Service 1fb00e
#define MAX_MATCH_OPERATOR          5
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * FieldFlags
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * This byte is extracted from the AML and includes three separate
Packit Service 1fb00e
 * pieces of information about the field:
Packit Service 1fb00e
 * 1) The field access type
Packit Service 1fb00e
 * 2) The field update rule
Packit Service 1fb00e
 * 3) The lock rule for the field
Packit Service 1fb00e
 *
Packit Service 1fb00e
 * Bits 00 - 03 : AccessType (AnyAcc, ByteAcc, etc.)
Packit Service 1fb00e
 *      04      : LockRule (1 == Lock)
Packit Service 1fb00e
 *      05 - 06 : UpdateRule
Packit Service 1fb00e
 */
Packit Service 1fb00e
#define AML_FIELD_ACCESS_TYPE_MASK  0x0F
Packit Service 1fb00e
#define AML_FIELD_LOCK_RULE_MASK    0x10
Packit Service 1fb00e
#define AML_FIELD_UPDATE_RULE_MASK  0x60
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/* 1) Field Access Types */
Packit Service 1fb00e
Packit Service 1fb00e
typedef enum
Packit Service 1fb00e
{
Packit Service 1fb00e
    AML_FIELD_ACCESS_ANY            = 0x00,
Packit Service 1fb00e
    AML_FIELD_ACCESS_BYTE           = 0x01,
Packit Service 1fb00e
    AML_FIELD_ACCESS_WORD           = 0x02,
Packit Service 1fb00e
    AML_FIELD_ACCESS_DWORD          = 0x03,
Packit Service 1fb00e
    AML_FIELD_ACCESS_QWORD          = 0x04,    /* ACPI 2.0 */
Packit Service 1fb00e
    AML_FIELD_ACCESS_BUFFER         = 0x05     /* ACPI 2.0 */
Packit Service 1fb00e
Packit Service 1fb00e
} AML_ACCESS_TYPE;
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/* 2) Field Lock Rules */
Packit Service 1fb00e
Packit Service 1fb00e
typedef enum
Packit Service 1fb00e
{
Packit Service 1fb00e
    AML_FIELD_LOCK_NEVER            = 0x00,
Packit Service 1fb00e
    AML_FIELD_LOCK_ALWAYS           = 0x10
Packit Service 1fb00e
Packit Service 1fb00e
} AML_LOCK_RULE;
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/* 3) Field Update Rules */
Packit Service 1fb00e
Packit Service 1fb00e
typedef enum
Packit Service 1fb00e
{
Packit Service 1fb00e
    AML_FIELD_UPDATE_PRESERVE       = 0x00,
Packit Service 1fb00e
    AML_FIELD_UPDATE_WRITE_AS_ONES  = 0x20,
Packit Service 1fb00e
    AML_FIELD_UPDATE_WRITE_AS_ZEROS = 0x40
Packit Service 1fb00e
Packit Service 1fb00e
} AML_UPDATE_RULE;
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/*
Packit Service 1fb00e
 * Field Access Attributes.
Packit Service 1fb00e
 * This byte is extracted from the AML via the
Packit Service 1fb00e
 * AccessAs keyword
Packit Service 1fb00e
 */
Packit Service 1fb00e
typedef enum
Packit Service 1fb00e
{
Packit Service 1fb00e
    AML_FIELD_ATTRIB_QUICK          = 0x02,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_SEND_RCV       = 0x04,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_BYTE           = 0x06,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_WORD           = 0x08,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_BLOCK          = 0x0A,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_MULTIBYTE      = 0x0B,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_WORD_CALL      = 0x0C,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_BLOCK_CALL     = 0x0D,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_RAW_BYTES      = 0x0E,
Packit Service 1fb00e
    AML_FIELD_ATTRIB_RAW_PROCESS    = 0x0F
Packit Service 1fb00e
Packit Service 1fb00e
} AML_ACCESS_ATTRIBUTE;
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
/* Bit fields in the AML MethodFlags byte */
Packit Service 1fb00e
Packit Service 1fb00e
#define AML_METHOD_ARG_COUNT        0x07
Packit Service 1fb00e
#define AML_METHOD_SERIALIZED       0x08
Packit Service 1fb00e
#define AML_METHOD_SYNC_LEVEL       0xF0
Packit Service 1fb00e
Packit Service 1fb00e
Packit Service 1fb00e
#endif /* __AMLCODE_H__ */