Macros
#define	MAX_AML_NAMESTRING_SIZE 1277U

#define	MAX_ASL_NAMESTRING_SIZE 1529U

#define	AML_METHOD_INVOC_OP 0xD0

#define	AML_FIELD_NAMED_OP 0x04

Typedefs
typedef enum EAmlNodeDataType	EAML_NODE_DATA_TYPE

typedef enum EAmlParseIndex	EAML_PARSE_INDEX

typedef enum EAmlObjType	EAML_OBJ_TYPE

typedef enum EAmlNodeType	EAML_NODE_TYPE

Enumerations
enum	EAmlNodeDataType { EAmlNodeDataTypeNone = 0 , EAmlNodeDataTypeReserved1 , EAmlNodeDataTypeReserved2 , EAmlNodeDataTypeReserved3 , EAmlNodeDataTypeReserved4 , EAmlNodeDataTypeReserved5 , EAmlNodeDataTypeNameString , EAmlNodeDataTypeString , EAmlNodeDataTypeUInt , EAmlNodeDataTypeRaw , EAmlNodeDataTypeResourceData , EAmlNodeDataTypeFieldPkgLen , EAmlNodeDataTypeMax }

enum	EAmlParseIndex { EAmlParseIndexTerm0 = 0 , EAmlParseIndexTerm1 , EAmlParseIndexTerm2 , EAmlParseIndexTerm3 , EAmlParseIndexTerm4 , EAmlParseIndexTerm5 , EAmlParseIndexMax }

enum	EAmlObjType { EAmlObjTypeUnknown = 0x0 , EAmlObjTypeInt , EAmlObjTypeStrObj , EAmlObjTypeBuffObj , EAmlObjTypePkgObj , EAmlObjTypeFieldUnitObj , EAmlObjTypeDeviceObj , EAmlObjTypeEventObj , EAmlObjTypeMethodObj , EAmlObjTypeMutexObj , EAmlObjTypeOpRegionObj , EAmlObjTypePowerResObj , EAmlObjTypeProcessorObj , EAmlObjTypeThermalZoneObj , EAmlObjTypeBuffFieldObj , EAmlObjTypeDDBHandleObj }

enum	EAmlNodeType { EAmlNodeUnknown , EAmlNodeRoot , EAmlNodeObject , EAmlNodeData , EAmlNodeMax }

Detailed Description

The AML tree created by the AMLLib relies on enum/define values and structures defined here.

Macro Definition Documentation

◆ AML_FIELD_NAMED_OP

#define AML_FIELD_NAMED_OP 0x04

Pseudo OpCode for NamedField field elements.

The AML grammar does not attribute an OpCode/SubOpCode couple for the NamedField field element. This library is representing NamedField field elements as if they had one.

The AML encoding for NamedField field elements in the ACPI specification 6.3 is: NamedField := NameSeg PkgLength In this library, it is: NamedField := NamedFieldOp NameSeg PkgLength

When computing the size of a tree or serializing it, the additional data is not taken into account (i.e. the NamedFieldOp).

Definition at line 139 of file AmlDefines.h.

◆ AML_METHOD_INVOC_OP

#define AML_METHOD_INVOC_OP 0xD0

Pseudo OpCode for method invocations.

The AML grammar does not attribute an OpCode/SubOpCode couple for method invocations. This library is representing method invocations as if they had one.

The AML encoding for method invocations in the ACPI specification 6.3 is: MethodInvocation := NameString TermArgList In this library, it is: MethodInvocation := MethodInvocationOp NameString ArgumentCount TermArgList ArgumentCount := ByteData

When computing the size of a tree or serializing it, the additional data is not taken into account (i.e. the MethodInvocationOp and the ArgumentCount).

Definition at line 120 of file AmlDefines.h.

◆ MAX_AML_NAMESTRING_SIZE

#define MAX_AML_NAMESTRING_SIZE 1277U

Maximum size of an AML NameString.

An AML NameString can be at most (255 * 4) + 255 + 2 = 1277 bytes long. Indeed, according to ACPI 6.3 specification, s20.2.2, an AML NameString can be resolved as a MultiNamePath.

The encoding of this MultiNamePath can be made of at most:

255 carets ('^'), one for each level in the namespace;
255 NameSeg of 4 bytes;
2 bytes for the MultiNamePrefix and SegCount.

Definition at line 87 of file AmlDefines.h.

◆ MAX_ASL_NAMESTRING_SIZE

#define MAX_ASL_NAMESTRING_SIZE 1529U

Maximum size of an ASL NameString.

An ASL NameString can be at most (255 * 4) + 255 + 254 = 1529 bytes long. Cf the ASL grammar available in ACPI 6.3 specification, 19.2.2.

The encoding of an ASL NameString can be made of at most:

255 carets ('^'), one for each level in the namespace;
255 NameSeg of 4 bytes;
254 NameSeg separators ('.').

Definition at line 101 of file AmlDefines.h.

Typedef Documentation

◆ EAML_NODE_DATA_TYPE

typedef enum EAmlNodeDataType EAML_NODE_DATA_TYPE

AML tree node types.

Data nodes are tagged with the data type they contain. Some data types cannot be used for data nodes (None, Object). EAmlUIntX types are converted to the EAML_NODE_DATA_TYPE enum type. These types are accessible externally.

◆ EAML_NODE_TYPE

typedef enum EAmlNodeType EAML_NODE_TYPE

Node types.

◆ EAML_OBJ_TYPE

typedef enum EAmlObjType EAML_OBJ_TYPE

AML object types.

The ACPI specification defines several object types. They are listed with the definition of ObjectTypeKeyword.

◆ EAML_PARSE_INDEX

typedef enum EAmlParseIndex EAML_PARSE_INDEX

Indexes of fixed arguments.

AML objects defined the ACPI 6.3 specification, s20.3 "AML Byte Stream Byte Values" can have at most 6 fixed arguments.

Method and functions can have at most 7 arguments, cf s19.6.83 "Method (Declare Control Method)". The enum goes to 8 to store the name of the method invocation.

Enumeration Type Documentation

◆ EAmlNodeDataType

enum EAmlNodeDataType

AML tree node types.

Data nodes are tagged with the data type they contain. Some data types cannot be used for data nodes (None, Object). EAmlUIntX types are converted to the EAML_NODE_DATA_TYPE enum type. These types are accessible externally.

Enumerator
EAmlNodeDataTypeNone	EAmlNone, not accessible.
EAmlNodeDataTypeReserved1	EAmlUInt8, converted to the UInt type.
EAmlNodeDataTypeReserved2	EAmlUInt16, converted to the UInt type.
EAmlNodeDataTypeReserved3	EAmlUInt32, converted to the UInt type.
EAmlNodeDataTypeReserved4	EAmlUInt64, converted to the UInt type.
EAmlNodeDataTypeReserved5	EAmlObject, not accessible.
EAmlNodeDataTypeNameString	EAmlName, name corresponding to the NameString keyword in the ACPI specification. E.g.: "\_SB_.DEV0"
EAmlNodeDataTypeString	EAmlString, NULL terminated string.
EAmlNodeDataTypeUInt	Integer data of any length, EAmlUIntX are converted to this type.
EAmlNodeDataTypeRaw	Raw bytes contained in a buffer.
EAmlNodeDataTypeResourceData	Resource data element.
EAmlNodeDataTypeFieldPkgLen	FieldPkgLen data element. PkgLen are usually stored as part of object node structures. However, they can be found standalone in a FieldList.
EAmlNodeDataTypeMax	Max enum.

Definition at line 30 of file AmlDefines.h.

◆ EAmlNodeType

enum EAmlNodeType

Node types.

Enumerator
EAmlNodeUnknown	Unknown/Invalid AML Node Type.
EAmlNodeRoot	AML Root Node, typically represents a DefinitionBlock.
EAmlNodeObject	AML Object Node, typically represents an ASL statement or its arguments.
EAmlNodeData	AML Data Node, typically represents arguments for an ASL statement.
EAmlNodeMax	Max enum.

Definition at line 171 of file AmlDefines.h.

◆ EAmlObjType

enum EAmlObjType