Tokens

Tokens. More...

Collaboration diagram for Tokens:

Detailed Description

Tokens.

This module handles descriptions of all tokens that can be found in an AML byte stream, storing them and their properties.

The token type ends up, in most cases, being the smallest most fundamental type used in the parser (as in the type at the bottom of the recursive tree), but there are some exceptions, for example a ByteData object is not a token type simply because it can have any value (0x00 to 0xFF).

See also

Section 20.3 of the ACPI specification for more details.

Data Structures
struct	aml_token_props_t
	Token Properties. More...
struct	aml_token_t
	Token. More...

Enumerations
enum	aml_token_num_t {   AML_NULL_NAME = 0x00 , AML_ZERO_OP = 0x00 , AML_ONE_OP = 0x01 , AML_ALIAS_OP = 0x06 ,   AML_NAME_OP = 0x08 , AML_BYTE_PREFIX = 0x0A , AML_WORD_PREFIX = 0x0B , AML_DWORD_PREFIX = 0x0C ,   AML_STRING_PREFIX = 0x0D , AML_QWORD_PREFIX = 0x0E , AML_SCOPE_OP = 0x10 , AML_BUFFER_OP = 0x11 ,   AML_PACKAGE_OP = 0x12 , AML_VAR_PACKAGE_OP = 0x13 , AML_METHOD_OP = 0x14 , AML_EXTERNAL_OP = 0x15 ,   AML_DUAL_NAME_PREFIX = 0x2E , AML_MULTI_NAME_PREFIX = 0x2F , AML_DIGIT_CHAR_0 = 0x30 , AML_DIGIT_CHAR_1 = 0x31 ,   AML_DIGIT_CHAR_2 = 0x32 , AML_DIGIT_CHAR_3 = 0x33 , AML_DIGIT_CHAR_4 = 0x34 , AML_DIGIT_CHAR_5 = 0x35 ,   AML_DIGIT_CHAR_6 = 0x36 , AML_DIGIT_CHAR_7 = 0x37 , AML_DIGIT_CHAR_8 = 0x38 , AML_DIGIT_CHAR_9 = 0x39 ,   AML_NAME_CHAR_A = 0x41 , AML_NAME_CHAR_B = 0x42 , AML_NAME_CHAR_C = 0x43 , AML_NAME_CHAR_D = 0x44 ,   AML_NAME_CHAR_E = 0x45 , AML_NAME_CHAR_F = 0x46 , AML_NAME_CHAR_G = 0x47 , AML_NAME_CHAR_H = 0x48 ,   AML_NAME_CHAR_I = 0x49 , AML_NAME_CHAR_J = 0x4A , AML_NAME_CHAR_K = 0x4B , AML_NAME_CHAR_L = 0x4C ,   AML_NAME_CHAR_M = 0x4D , AML_NAME_CHAR_N = 0x4E , AML_NAME_CHAR_O = 0x4F , AML_NAME_CHAR_P = 0x50 ,   AML_NAME_CHAR_Q = 0x51 , AML_NAME_CHAR_R = 0x52 , AML_NAME_CHAR_S = 0x53 , AML_NAME_CHAR_T = 0x54 ,   AML_NAME_CHAR_U = 0x55 , AML_NAME_CHAR_V = 0x56 , AML_NAME_CHAR_W = 0x57 , AML_NAME_CHAR_X = 0x58 ,   AML_NAME_CHAR_Y = 0x59 , AML_NAME_CHAR_Z = 0x5A , AML_EXT_OP_PREFIX = 0x5B , AML_ROOT_CHAR = 0x5C ,   AML_PARENT_PREFIX_CHAR = 0x5E , AML_NAME_CHAR = 0x5F , AML_LOCAL0_OP = 0x60 , AML_LOCAL1_OP = 0x61 ,   AML_LOCAL2_OP = 0x62 , AML_LOCAL3_OP = 0x63 , AML_LOCAL4_OP = 0x64 , AML_LOCAL5_OP = 0x65 ,   AML_LOCAL6_OP = 0x66 , AML_LOCAL7_OP = 0x67 , AML_ARG0_OP = 0x68 , AML_ARG1_OP = 0x69 ,   AML_ARG2_OP = 0x6A , AML_ARG3_OP = 0x6B , AML_ARG4_OP = 0x6C , AML_ARG5_OP = 0x6D ,   AML_ARG6_OP = 0x6E , AML_STORE_OP = 0x70 , AML_REF_OF_OP = 0x71 , AML_ADD_OP = 0x72 ,   AML_CONCAT_OP = 0x73 , AML_SUBTRACT_OP = 0x74 , AML_INCREMENT_OP = 0x75 , AML_DECREMENT_OP = 0x76 ,   AML_MULTIPLY_OP = 0x77 , AML_DIVIDE_OP = 0x78 , AML_SHIFT_LEFT_OP = 0x79 , AML_SHIFT_RIGHT_OP = 0x7A ,   AML_AND_OP = 0x7B , AML_NAND_OP = 0x7C , AML_OR_OP = 0x7D , AML_NOR_OP = 0x7E ,   AML_XOR_OP = 0x7F , AML_NOT_OP = 0x80 , AML_FIND_SET_LEFT_BIT_OP = 0x81 , AML_FIND_SET_RIGHT_BIT_OP = 0x82 ,   AML_DEREF_OF_OP = 0x83 , AML_CONCAT_RES_OP = 0x84 , AML_MOD_OP = 0x85 , AML_NOTIFY_OP = 0x86 ,   AML_SIZE_OF_OP = 0x87 , AML_INDEX_OP = 0x88 , AML_MATCH_OP = 0x89 , AML_CREATE_DWORD_FIELD_OP = 0x8A ,   AML_CREATE_WORD_FIELD_OP = 0x8B , AML_CREATE_BYTE_FIELD_OP = 0x8C , AML_CREATE_BIT_FIELD_OP = 0x8D , AML_OBJECT_TYPE_OP = 0x8E ,   AML_CREATE_QWORD_FIELD_OP = 0x8F , AML_LAND_OP = 0x90 , AML_LOR_OP = 0x91 , AML_LNOT_OP = 0x92 ,   AML_LEQUAL_OP = 0x93 , AML_LGREATER_OP = 0x94 , AML_LLESS_OP = 0x95 , AML_TO_BUFFER_OP = 0x96 ,   AML_TO_DECIMAL_STRING_OP = 0x97 , AML_TO_HEX_STRING_OP = 0x98 , AML_TO_INTEGER_OP = 0x99 , AML_TO_STRING_OP = 0x9C ,   AML_COPY_OBJECT_OP = 0x9D , AML_MID_OP = 0x9E , AML_CONTINUE_OP = 0x9F , AML_IF_OP = 0xA0 ,   AML_ELSE_OP = 0xA1 , AML_WHILE_OP = 0xA2 , AML_NOOP_OP = 0xA3 , AML_RETURN_OP = 0xA4 ,   AML_BREAK_OP = 0xA5 , AML_BREAK_POINT_OP = 0xCC , AML_ONES_OP = 0xFF , AML_EXT_OP_PREFIX_BASE = 0x100 ,   AML_MUTEX_OP = AML_EXT_OP_PREFIX_BASE + 0x01 , AML_EVENT_OP = AML_EXT_OP_PREFIX_BASE + 0x02 , AML_COND_REF_OF_OP = AML_EXT_OP_PREFIX_BASE + 0x12 , AML_CREATE_FIELD_OP = AML_EXT_OP_PREFIX_BASE + 0x13 ,   AML_LOAD_TABLE_OP = AML_EXT_OP_PREFIX_BASE + 0x1F , AML_LOAD_OP = AML_EXT_OP_PREFIX_BASE + 0x20 , AML_STALL_OP = AML_EXT_OP_PREFIX_BASE + 0x21 , AML_SLEEP_OP = AML_EXT_OP_PREFIX_BASE + 0x22 ,   AML_ACQUIRE_OP = AML_EXT_OP_PREFIX_BASE + 0x23 , AML_SIGNAL_OP = AML_EXT_OP_PREFIX_BASE + 0x24 , AML_WAIT_OP = AML_EXT_OP_PREFIX_BASE + 0x25 , AML_RESET_OP = AML_EXT_OP_PREFIX_BASE + 0x26 ,   AML_RELEASE_OP = AML_EXT_OP_PREFIX_BASE + 0x27 , AML_FROM_BCD_OP = AML_EXT_OP_PREFIX_BASE + 0x28 , AML_TO_BCD_OP = AML_EXT_OP_PREFIX_BASE + 0x29 , AML_RESERVED_OP = AML_EXT_OP_PREFIX_BASE + 0x2A ,   AML_REVISION_OP = AML_EXT_OP_PREFIX_BASE + 0x30 , AML_DEBUG_OP = AML_EXT_OP_PREFIX_BASE + 0x31 , AML_FATAL_OP = AML_EXT_OP_PREFIX_BASE + 0x32 , AML_TIMER_OP = AML_EXT_OP_PREFIX_BASE + 0x33 ,   AML_OPREGION_OP = AML_EXT_OP_PREFIX_BASE + 0x80 , AML_FIELD_OP = AML_EXT_OP_PREFIX_BASE + 0x81 , AML_DEVICE_OP = AML_EXT_OP_PREFIX_BASE + 0x82 , AML_DEPRECATED_PROCESSOR_OP = AML_EXT_OP_PREFIX_BASE + 0x83 ,   AML_POWER_RES_OP = AML_EXT_OP_PREFIX_BASE + 0x84 , AML_THERMAL_ZONE_OP = AML_EXT_OP_PREFIX_BASE + 0x85 , AML_INDEX_FIELD_OP = AML_EXT_OP_PREFIX_BASE + 0x86 , AML_BANK_FIELD_OP = AML_EXT_OP_PREFIX_BASE + 0x87 ,   AML_DATA_REGION_OP = AML_EXT_OP_PREFIX_BASE + 0x88 , AML_LNOT_OP_BASE = 0x200 , AML_LNOT_EQUAL_OP = AML_LNOT_OP_BASE + 0x93 , AML_LLESS_EQUAL_OP = AML_LNOT_OP_BASE + 0x94 ,   AML_LGREATER_EQUAL_OP = AML_LNOT_OP_BASE + 0x95 , AML_UNKNOWN_TOKEN = 0x2FE , AML_MAX_TOKEN = 0x2FF }
	Token numbers. More...
enum	aml_encoding_group_t {   AML_ENCODING_GROUP_NONE , AML_ENCODING_GROUP_DATA , AML_ENCODING_GROUP_TERM , AML_ENCODING_GROUP_NAME ,   AML_ENCODING_GROUP_LOCAL , AML_ENCODING_GROUP_ARG , AML_ENCODING_GROUP_DEBUG }
enum	aml_token_type_t {   AML_TOKEN_TYPE_NONE = 0 , AML_TOKEN_TYPE_NAME , AML_TOKEN_TYPE_NAMESPACE_MODIFIER , AML_TOKEN_TYPE_NAMED ,   AML_TOKEN_TYPE_STATEMENT , AML_TOKEN_TYPE_EXPRESSION , AML_TOKEN_TYPE_ARG , AML_TOKEN_TYPE_LOCAL ,   AML_TOKEN_TYPE_COMPUTATIONAL , AML_TOKEN_TYPE_DEBUG }
	Token Type. More...

Functions
const char *	aml_token_type_to_string (aml_token_type_t type)
	Convert a token type to a string.
static const aml_token_props_t *	aml_token_lookup (aml_token_num_t num)
	Lookup token properties.
static void	aml_token_peek (aml_term_list_ctx_t *ctx, aml_token_t *out)
	Attempt to read a token from the AML stream, without advancing the instruction pointer.
static void	aml_token_read (aml_term_list_ctx_t *ctx, aml_token_t *out)
	Attempt to read a token from the AML stream.
static uint64_t	aml_token_expect (aml_term_list_ctx_t *ctx, aml_token_num_t expected)
	Reads a token from the AML stream and verifies it matches the expected token.

Variables
const aml_token_props_t	amlTokenProps [AML_MAX_TOKEN]
	Token properties array indexed by aml_token_num_t.

Enumeration Type Documentation

aml_token_num_t

enum aml_token_num_t

Token numbers.

All tokens stored an an enum, we also encode the extended tokens (those that make up two bytes) by assigning them certain token ranges.

Enumerator
AML_NULL_NAME
AML_ZERO_OP
AML_ONE_OP
AML_ALIAS_OP
AML_NAME_OP
AML_BYTE_PREFIX
AML_WORD_PREFIX
AML_DWORD_PREFIX
AML_STRING_PREFIX
AML_QWORD_PREFIX
AML_SCOPE_OP
AML_BUFFER_OP
AML_PACKAGE_OP
AML_VAR_PACKAGE_OP
AML_METHOD_OP
AML_EXTERNAL_OP
AML_DUAL_NAME_PREFIX
AML_MULTI_NAME_PREFIX
AML_DIGIT_CHAR_0
AML_DIGIT_CHAR_1
AML_DIGIT_CHAR_2
AML_DIGIT_CHAR_3
AML_DIGIT_CHAR_4
AML_DIGIT_CHAR_5
AML_DIGIT_CHAR_6
AML_DIGIT_CHAR_7
AML_DIGIT_CHAR_8
AML_DIGIT_CHAR_9
AML_NAME_CHAR_A
AML_NAME_CHAR_B
AML_NAME_CHAR_C
AML_NAME_CHAR_D
AML_NAME_CHAR_E
AML_NAME_CHAR_F
AML_NAME_CHAR_G
AML_NAME_CHAR_H
AML_NAME_CHAR_I
AML_NAME_CHAR_J
AML_NAME_CHAR_K
AML_NAME_CHAR_L
AML_NAME_CHAR_M
AML_NAME_CHAR_N
AML_NAME_CHAR_O
AML_NAME_CHAR_P
AML_NAME_CHAR_Q
AML_NAME_CHAR_R
AML_NAME_CHAR_S
AML_NAME_CHAR_T
AML_NAME_CHAR_U
AML_NAME_CHAR_V
AML_NAME_CHAR_W
AML_NAME_CHAR_X
AML_NAME_CHAR_Y
AML_NAME_CHAR_Z
AML_EXT_OP_PREFIX
AML_ROOT_CHAR
AML_PARENT_PREFIX_CHAR
AML_NAME_CHAR
AML_LOCAL0_OP
AML_LOCAL1_OP
AML_LOCAL2_OP
AML_LOCAL3_OP
AML_LOCAL4_OP
AML_LOCAL5_OP
AML_LOCAL6_OP
AML_LOCAL7_OP
AML_ARG0_OP
AML_ARG1_OP
AML_ARG2_OP
AML_ARG3_OP
AML_ARG4_OP
AML_ARG5_OP
AML_ARG6_OP
AML_STORE_OP
AML_REF_OF_OP
AML_ADD_OP
AML_CONCAT_OP
AML_SUBTRACT_OP
AML_INCREMENT_OP
AML_DECREMENT_OP
AML_MULTIPLY_OP
AML_DIVIDE_OP
AML_SHIFT_LEFT_OP
AML_SHIFT_RIGHT_OP
AML_AND_OP
AML_NAND_OP
AML_OR_OP
AML_NOR_OP
AML_XOR_OP
AML_NOT_OP
AML_FIND_SET_LEFT_BIT_OP
AML_FIND_SET_RIGHT_BIT_OP
AML_DEREF_OF_OP
AML_CONCAT_RES_OP
AML_MOD_OP
AML_NOTIFY_OP
AML_SIZE_OF_OP
AML_INDEX_OP
AML_MATCH_OP
AML_CREATE_DWORD_FIELD_OP
AML_CREATE_WORD_FIELD_OP
AML_CREATE_BYTE_FIELD_OP
AML_CREATE_BIT_FIELD_OP
AML_OBJECT_TYPE_OP
AML_CREATE_QWORD_FIELD_OP
AML_LAND_OP
AML_LOR_OP
AML_LNOT_OP
AML_LEQUAL_OP
AML_LGREATER_OP
AML_LLESS_OP
AML_TO_BUFFER_OP
AML_TO_DECIMAL_STRING_OP
AML_TO_HEX_STRING_OP
AML_TO_INTEGER_OP
AML_TO_STRING_OP
AML_COPY_OBJECT_OP
AML_MID_OP
AML_CONTINUE_OP
AML_IF_OP
AML_ELSE_OP
AML_WHILE_OP
AML_NOOP_OP
AML_RETURN_OP
AML_BREAK_OP
AML_BREAK_POINT_OP
AML_ONES_OP
AML_EXT_OP_PREFIX_BASE
AML_MUTEX_OP
AML_EVENT_OP
AML_COND_REF_OF_OP
AML_CREATE_FIELD_OP
AML_LOAD_TABLE_OP
AML_LOAD_OP
AML_STALL_OP
AML_SLEEP_OP
AML_ACQUIRE_OP
AML_SIGNAL_OP
AML_WAIT_OP
AML_RESET_OP
AML_RELEASE_OP
AML_FROM_BCD_OP
AML_TO_BCD_OP
AML_RESERVED_OP
AML_REVISION_OP
AML_DEBUG_OP
AML_FATAL_OP
AML_TIMER_OP
AML_OPREGION_OP
AML_FIELD_OP
AML_DEVICE_OP
AML_DEPRECATED_PROCESSOR_OP
AML_POWER_RES_OP
AML_THERMAL_ZONE_OP
AML_INDEX_FIELD_OP
AML_BANK_FIELD_OP
AML_DATA_REGION_OP
AML_LNOT_OP_BASE
AML_LNOT_EQUAL_OP
AML_LLESS_EQUAL_OP
AML_LGREATER_EQUAL_OP
AML_UNKNOWN_TOKEN
AML_MAX_TOKEN

Definition at line 34 of file token.h.

aml_encoding_group_t

enum aml_encoding_group_t

Enumerator
AML_ENCODING_GROUP_NONE
AML_ENCODING_GROUP_DATA
AML_ENCODING_GROUP_TERM
AML_ENCODING_GROUP_NAME
AML_ENCODING_GROUP_LOCAL
AML_ENCODING_GROUP_ARG
AML_ENCODING_GROUP_DEBUG

Definition at line 208 of file token.h.

aml_token_type_t

enum aml_token_type_t

Token Type.

Enumerator
AML_TOKEN_TYPE_NONE
AML_TOKEN_TYPE_NAME	Is a Name Object (section 20.2.2).
AML_TOKEN_TYPE_NAMESPACE_MODIFIER	Is a Namespace Modifier Object (section 20.2.5.1).
AML_TOKEN_TYPE_NAMED	Is a NamedObj (section 20.2.5.2).
AML_TOKEN_TYPE_STATEMENT	Is a Statement Opcode (section 20.2.5.3).
AML_TOKEN_TYPE_EXPRESSION	Is an Expression Opcode (section 20.2.5.4).
AML_TOKEN_TYPE_ARG	Is an Arg Object (section 20.2.6.1).
AML_TOKEN_TYPE_LOCAL	Is a Local Object (section 20.2.6.2).
AML_TOKEN_TYPE_COMPUTATIONAL	Is part of a ComputationalData Object (section 20.2.3).
AML_TOKEN_TYPE_DEBUG	Is a Debug Object (section 20.2.6.3).

Definition at line 223 of file token.h.

Function Documentation

aml_token_type_to_string()

const char * aml_token_type_to_string

(

aml_token_type_t

type

)

Convert a token type to a string.

Parameters

type	The token type to convert.

Returns

On success, the string representation of the token type. On failure, "UnknownToken".

Definition at line 139 of file token.c.

Here is the caller graph for this function:

aml_token_lookup()

static const aml_token_props_t * aml_token_lookup ( aml_token_num_t  num )

inlinestatic

Lookup token properties.

Parameters

num	The token number to lookup.

Returns

On success, a pointer to the token properties. On failure, the properties of AML_UNKNOWN_TOKEN.

Definition at line 278 of file token.h.

Here is the caller graph for this function:

aml_token_peek()

static void aml_token_peek ( aml_term_list_ctx_t *  ctx, aml_token_t *  out  )

inlinestatic

Attempt to read a token from the AML stream, without advancing the instruction pointer.

If the stream is empty, the token will be set to AML_UNKNOWN_TOKEN and length 0.

Parameters

ctx	The AML term list context to parse from.

Definition at line 301 of file token.h.

Here is the caller graph for this function:

aml_token_read()

static void aml_token_read ( aml_term_list_ctx_t *  ctx, aml_token_t *  out  )

inlinestatic

Attempt to read a token from the AML stream.

Parameters

ctx	The AML term list context to parse from.
out	The token to read into.

Definition at line 340 of file token.h.

Here is the call graph for this function:

Here is the caller graph for this function:

aml_token_expect()

static uint64_t aml_token_expect ( aml_term_list_ctx_t *  ctx, aml_token_num_t  expected  )

inlinestatic

Reads a token from the AML stream and verifies it matches the expected token.

Parameters

ctx	The AML term list context to parse from.
expected	The expected token number.

Returns

On success, 0. On failure, ERR and errno is set.

Definition at line 353 of file token.h.

Here is the call graph for this function:

Variable Documentation

amlTokenProps

const aml_token_props_t amlTokenProps[AML_MAX_TOKEN]

extern

Token properties array indexed by aml_token_num_t.

Definition at line 5 of file token.c.