named.h

Go to the documentation of this file.

#pragma once
 
#include <modules/acpi/aml/encoding/data_integers.h>
#include <modules/acpi/aml/integer.h>
 
#include <stdbool.h>
 
typedef struct aml_object aml_object_t;
typedef struct aml_opregion aml_opregion_t;
typedef struct aml_field_unit aml_field_unit_t;
typedef struct aml_term_list_ctx aml_term_list_ctx_t;
 
/**
 * @brief Named Objects Encoding
 * @defgroup modules_acpi_aml_encoding_name Named Objects
 * @ingroup modules_acpi_aml
 *
 * Not to be confused with "ACPI AML Name Objects Encoding".
 *
 * @see Section 20.2.5.2 of the ACPI specification for more details.
 *
 * @{
 */
 
/**
 * @brief Region Space Encoding
 * @enum aml_region_space_t
 */
typedef enum
{
    AML_REGION_SYSTEM_MEMORY = 0x00,
    AML_REGION_SYSTEM_IO = 0x01,
    AML_REGION_PCI_CONFIG = 0x02,
    AML_REGION_EMBEDDED_CONTROL = 0x03,
    AML_REGION_SM_BUS = 0x04,
    AML_REGION_SYSTEM_CMOS = 0x05,
    AML_REGION_PCI_BAR_TARGET = 0x06,
    AML_REGION_IPMI = 0x07,
    AML_REGION_GENERAL_PURPOSE_IO = 0x08,
    AML_REGION_GENERIC_SERIAL_BUS = 0x09,
    AML_REGION_PCC = 0x0A,
    AML_REGION_OEM_MIN = 0x80,
    AML_REGION_OEM_MAX = 0xFF,
} aml_region_space_t;
 
/**
 * @brief Enum for all field access types, bits 0-3 of FieldFlags.
 * @enum aml_access_type_t
 */
typedef enum
{
    AML_ACCESS_TYPE_ANY = 0,
    AML_ACCESS_TYPE_BYTE = 1,
    AML_ACCESS_TYPE_WORD = 2,
    AML_ACCESS_TYPE_DWORD = 3,
    AML_ACCESS_TYPE_QWORD = 4,
    AML_ACCESS_TYPE_BUFFER = 5,
} aml_access_type_t;
 
/**
 * @brief Enum for all field lock rules, bit 4 of FieldFlags.
 * @enum aml_lock_rule_t
 */
typedef enum
{
    AML_LOCK_RULE_NO_LOCK = 0,
    AML_LOCK_RULE_LOCK = 1,
} aml_lock_rule_t;
 
/**
 * @brief Enum for all field update rules, bits 5-6 of FieldFlags.
 * @enum aml_update_rule_t
 */
typedef enum
{
    AML_UPDATE_RULE_PRESERVE = 0,
    AML_UPDATE_RULE_WRITE_AS_ONES = 1,
    AML_UPDATE_RULE_WRITE_AS_ZEROS = 2,
} aml_update_rule_t;
 
/**
 * @brief FieldFlags structure.
 * @struct aml_field_flags_t
 */
typedef struct
{
    aml_access_type_t accessType;
    aml_lock_rule_t lockRule;
    aml_update_rule_t updateRule;
} aml_field_flags_t;
 
/**
 * @brief Enum for all FieldList types.
 * @enum aml_field_list_type_t
 */
typedef enum
{
    AML_FIELD_LIST_TYPE_FIELD,       ///< FieldList is part of a DefField.
    AML_FIELD_LIST_TYPE_INDEX_FIELD, ///< FieldList is part of an IndexField.
    AML_FIELD_LIST_TYPE_BANK_FIELD,  ///< FieldList is part of a BankField.
} aml_field_list_type_t;
 
/**
 * @brief Context passed to lower functions by `aml_field_list_read()`.
 * @struct aml_field_list_ctx_t
 */
typedef struct
{
    aml_field_list_type_t type;   ///< The type of FieldList.
    aml_field_flags_t flags;      ///< The flags of the FieldList.
    aml_bit_size_t currentOffset; ///< The current offset within the opregion.
    union {
        struct
        {
            aml_opregion_t* opregion;
        } field;
        struct
        {
            aml_field_unit_t* index;
            aml_field_unit_t* data;
        } index;
        struct
        {
            aml_opregion_t* opregion;
            aml_field_unit_t* bank;
            aml_uint_t bankValue;
        } bank;
    };
} aml_field_list_ctx_t;
 
/**
 * @brief SyncLevel Encoding
 * @enum aml_sync_level_t
 */
typedef uint8_t aml_sync_level_t;
 
/**
 * @brief MethodFlags structure.
 * @struct aml_method_flags_t
 */
typedef struct
{
    uint8_t argCount;           ///< Amount of arguments (0-7)
    bool isSerialized;          ///< true if method is serialized, false if not
    aml_sync_level_t syncLevel; ///< Synchronization level (0-15)
} aml_method_flags_t;
 
/**
 * @brief ProcID structure, deprecated in version 6.4 of the ACPI specification.
 */
typedef uint8_t aml_proc_id_t;
 
/**
 * @brief PblkAddr structure, deprecated in version 6.4 of the ACPI specification.
 */
typedef uint32_t aml_pblk_addr_t;
 
/**
 * @brief PblkLen structure, deprecated in version 6.4 of the ACPI specification.
 */
typedef uint8_t aml_pblk_len_t;
 
/**
 * @brief SystemLevel structure.
 */
typedef uint8_t aml_system_level_t;
 
/**
 * @brief ResourceOrder structure.
 */
typedef uint16_t aml_resource_order_t;
 
/**
 * @brief Reads a BankValue structure from the AML byte stream.
 *
 * A BankValue structure is defined as `BankValue := TermArg => Integer`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the bank value.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_bank_value_read(aml_term_list_ctx_t* ctx, aml_uint_t* out);
 
/**
 * @brief Reads a RegionSpace structure from the AML byte stream.
 *
 * A RegionSpace structure is defined as `RegionSpace := ByteData`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the region space.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_region_space_read(aml_term_list_ctx_t* ctx, aml_region_space_t* out);
 
/**
 * @brief Reads a RegionOffset structure from the AML byte stream.
 *
 * A RegionOffset structure is defined as `RegionOffset := TermArg => Integer`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the RegionOffset.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_region_offset_read(aml_term_list_ctx_t* ctx, aml_uint_t* out);
 
/**
 * @brief Reads a RegionLen structure from the AML byte stream.
 *
 * A RegionLen structure is defined as `RegionLen := TermArg => Integer`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the region length.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_region_len_read(aml_term_list_ctx_t* ctx, aml_uint_t* out);
 
/**
 * @brief Reads a DefOpRegion structure from the AML byte stream.
 *
 * A DefOpRegion structure is defined as `DefOpRegion := OpRegionOp NameString RegionSpace RegionOffset RegionLen`.
 *
 * @see Section 19.6.100 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_opregion_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a FieldFlags structure from the AML byte stream.
 *
 * Clean up definition.
 *
 * A FieldFlags structure is defined as `FieldFlags := ByteData`, where
 * - bit 0-3: AccessType
 *   - 0 AnyAcc
 *   - 1 ByteAcc
 *   - 2 WordAcc
 *   - 3 DWordAcc
 *   - 4 QWordAcc
 *   - 5 BufferAcc
 *   - 6 Reserved
 *
 * - bits 7-15 Reserved
 *
 * - bit 4: LockRule
 *   - 0 NoLock
 *   - 1 Lock
 *
 * - bit 5-6: UpdateRule
 *   - 0 Preserve
 *   - 1 WriteAsOnes
 *   - 2 WriteAsZeros
 *
 * - bit 7: Reserved (must be 0)
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The buffer to store the FieldFlags structure.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_field_flags_read(aml_term_list_ctx_t* ctx, aml_field_flags_t* out);
 
/**
 * @brief Reads a NamedField structure from the AML byte stream.
 *
 * A NamedField structure is defined as `NamedField := NameSeg PkgLength`
 *
 * @see Section 19.6.48 of the ACPI specification for more details about the Field Operation.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param fieldCtx The AML field list context.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_name_field_read(aml_term_list_ctx_t* ctx, aml_field_list_ctx_t* fieldCtx);
 
/**
 * @brief Reads a ReservedField structure from the AML byte stream.
 *
 * A ReservedField structure is defined as `ReservedField := 0x00 PkgLength`.
 *
 * @see Section 19.6.48 of the ACPI specification for more details about the Field Operation.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param fieldCtx The AML field list context.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_reserved_field_read(aml_term_list_ctx_t* ctx, aml_field_list_ctx_t* fieldCtx);
 
/**
 * @brief Reads a FieldElement structure from the AML byte stream.
 *
 * The FieldElement structure is defined as `FieldElement := NamedField | ReservedField | AccessField |
 * ExtendedAccessField | ConnectField`.
 *
 * @see Section 19.6.48 of the ACPI specification for more details about the Field Operation.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param fieldCtx The AML field list context.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_field_element_read(aml_term_list_ctx_t* ctx, aml_field_list_ctx_t* fieldCtx);
 
/**
 * @brief Reads a FieldList structure from the AML byte stream.
 *
 * The FieldList structure is defined as `FieldList := Nothing | <fieldelement fieldlist>`.
 *
 * @see Section 19.6.48 of the ACPI specification for more details about the Field Operation.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param fieldCtx The AML field list context.
 * @param end The index at which the FieldList ends.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_field_list_read(aml_term_list_ctx_t* ctx, aml_field_list_ctx_t* fieldCtx, const uint8_t* end);
 
/**
 * @brief Reads a DefField structure from the AML byte stream.
 *
 * The DefField structure is defined as `DefField := FieldOp PkgLength NameString FieldFlags FieldList`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefIndexField structure from the AML byte stream.
 *
 * The DefIndexField structure is defined as `DefIndexField := IndexFieldOp PkgLength NameString NameString FieldFlags
 * FieldList`.
 *
 * IndexFields can be a bit confusing, but the basic idea is that you have two fields, one for the index and one for the
 * data. The index field in this case can be thought of as a "selector", and the data field is where we find the actual
 * data we "selected". For example, to perform a read, we first write an index to the index field, and then read the
 * data from the data field. The index is typically an offset into an array or table, and the data is the value at that
 * offset.
 *
 * @see Section 19.6.64 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_index_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefBankField structure from the AML byte stream.
 *
 * The DefBankField structure is defined as `DefBankField := BankFieldOp PkgLength NameString NameString BankValue
 * FieldFlags FieldList`.
 *
 * BankFields can be even more confusing then IndexFields. A BankField allows for the same opregion to be accessed using
 * different field configurations, by switching between different banks. Each BankField as an ID, the BankValue, and you
 * have some object, pointed to by the second NameString, such that when you read from a BankField, the BankValue is
 * first written to the object to select the bank structure associated with that BankField.
 *
 * Basically you can change the structure of an opregion by selecting different banks.
 *
 * @see Section 19.6.7 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_bank_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a MethodFlags structure from the AML byte stream.
 *
 * A MethodFlags structure is defined as `MethodFlags := ByteData`, where
 * - bit 0-2: ArgCount (0-7)
 * - bit 3:
 *  - 0: NotSerialized
 *  - 1: Serialized
 * - bit 4-7: SyncLevel (0x00-0x0F)
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the MethodFlags structure.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_method_flags_read(aml_term_list_ctx_t* ctx, aml_method_flags_t* out);
 
/**
 * @brief Reads a DefMethod structure from the AML byte stream.
 *
 * The DefField structure is defined as `DefMethod := MethodOp PkgLength NameString MethodFlags TermList`.
 *
 * @see Section 19.6.85 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_method_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefDevice structure from the AML byte stream.
 *
 * The DefDevice structure is defined as `DefDevice := DeviceOp PkgLength NameString TermList`.
 *
 * @see Section 19.6.31 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_device_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a SyncFlags structure from the AML byte stream.
 *
 * A SyncFlags structure is defined as `SyncFlags := ByteData`, where
 * - bit 0-3: SyncLevel (0x00-0x0F)
 * - bit 4-7: Reserved (must be 0)
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the SyncFlags structure.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_sync_flags_read(aml_term_list_ctx_t* ctx, aml_sync_level_t* out);
 
/**
 * @brief Reads a DefMutex structure from the AML byte stream.
 *
 * The DefMutex structure is defined as `DefMutex := MutexOp NameString SyncFlags`.
 *
 * @see Section 19.6.89 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_mutex_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a ProcID structure from the AML byte stream. Deprecated in ACPI 6.4 but still supported.
 *
 * A ProcID structure is defined as `ProcID := ByteData`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the processor ID.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_proc_id_read(aml_term_list_ctx_t* ctx, aml_proc_id_t* out);
 
/**
 * @brief Reads a PblkAddr structure from the AML byte stream. Deprecated in ACPI 6.4 but still supported.
 *
 * A PblkAddr structure is defined as `PblkAddr := DWordData`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the Pblk address.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_pblk_addr_read(aml_term_list_ctx_t* ctx, aml_pblk_addr_t* out);
 
/**
 * @brief Reads a PblkLen structure from the AML byte stream. Deprecated in ACPI 6.4 but still supported.
 *
 * A PblkLen structure is defined as `PblkLen := ByteData`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the Pblk length.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_pblk_len_read(aml_term_list_ctx_t* ctx, aml_pblk_len_t* out);
 
/**
 * @brief Reads a DefProcessor structure from the AML byte stream. Deprecated in ACPI 6.4 but still supported.
 *
 * The DefProcessor structure is defined as `DefProcessor := ProcessorOp PkgLength NameString ProcID PblkAddr PblkLen
 * TermList`.
 *
 * @see Section 20.2.7 of version 6.3 Errata A of the ACPI specification for more details on the grammar and
 * section 19.6.108 of the same for more details about its behavior.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_processor_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a SourceBuff structure from the AML byte stream.
 *
 * A SourceBuff structure is defined as `SourceBuff := TermArg => Buffer`.
 *
 * SourceBuff must evaluate to a ObjectReference that refers to a Buffer object.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, the buffer object. On failure, `NULL` and `errno` is set.
 */
aml_object_t* aml_source_buff_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a BitIndex structure from the AML byte stream.
 *
 * A BitIndex structure is defined as `BitIndex := TermArg => Integer`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The destination buffer to store the BitIndex.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_bit_index_read(aml_term_list_ctx_t* ctx, aml_uint_t* out);
 
/**
 * @brief Reads a ByteIndex structure from the AML byte stream.
 *
 * A ByteIndex structure is defined as `ByteIndex := TermArg => Integer`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The destination buffer to store the ByteIndex.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_byte_index_read(aml_term_list_ctx_t* ctx, aml_uint_t* out);
 
/**
 * @brief Reads a DefCreateBitField structure from the AML byte stream.
 *
 * The DefCreateBitField structure is defined as `DefCreateBitField := CreateBitFieldOp SourceBuff BitIndex NameString`.
 *
 * A CreateBitField operation creates a field, with the name stored in the NameString, that accesses the single bit with
 * the index BitIndex within the SourceBuff.
 *
 * So if BitIndex is 6 and SourceBuff is a buffer with the value 0b10101010, then reading the created bit field will
 * return 1, and writing 0 to it will change SourceBuff to 0b10101000.
 *
 * The other CreateXField operations work similarly, but for different sizes of fields and use byte indices instead of
 * bit indices.
 *
 * @see Section 19.6.18 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_create_bit_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefCreateByteField structure from the AML byte stream.
 *
 * The DefCreateByteField structure is defined as `DefCreateByteField := CreateByteFieldOp SourceBuff ByteIndex
 * NameString`.
 *
 * A CreateByteField operation creates a field, with the name stored in the NameString, that accesses the byte (8 bits)
 * starting at the index ByteIndex within the SourceBuff.
 *
 * @see Section 19.6.19 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_create_byte_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefCreateWordField structure from the AML byte stream.
 *
 * The DefCreateWordField structure is defined as `DefCreateWordField := CreateWordFieldOp SourceBuff ByteIndex
 * NameString`.
 *
 * A CreateWordField operation creates a field, with the name stored in the NameString, that accesses the word (16 bits)
 * starting at the index ByteIndex within the SourceBuff.
 *
 * @see Section 19.6.23 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_create_word_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefCreateDWordField structure from the AML byte stream.
 *
 * The DefCreateDWordField structure is defined as `DefCreateDWordField := CreateDWordFieldOp SourceBuff ByteIndex
 * NameString`.
 *
 * A CreateDWordField operation creates a field, with the name stored in the NameString, that accesses the double word
 * (32 bits) starting at the index ByteIndex within the SourceBuff.
 *
 * @see Section 19.6.20 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_create_dword_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefCreateQWordField structure from the AML byte stream.
 *
 * The DefCreateQWordField structure is defined as `DefCreateQWordField := CreateQWordFieldOp SourceBuff ByteIndex
 * NameString`.
 *
 * A CreateQWordField operation creates a field, with the name stored in the NameString, that accesses the quad word (64
 * bits) starting at the index ByteIndex within the SourceBuff.
 *
 * @see Section 19.6.22 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_create_qword_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefEvent structure from the AML byte stream.
 *
 * The DefEvent structure is defined as `DefEvent := EventOp NameString`.
 *
 * @see Section 19.6.42 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_event_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefThermalZone structure from the AML byte stream.
 *
 * The DefThermalZone structure is defined as `DefThermalZone := ThermalZoneOp PkgLength NameString TermList`.
 *
 * @see Section 19.6.135 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_thermal_zone_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a SystemLevel structure from the AML byte stream.
 *
 * A SystemLevel structure is defined as `SystemLevel := ByteData`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the system level.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_system_level_read(aml_term_list_ctx_t* ctx, aml_system_level_t* out);
 
/**
 * @brief Reads a ResourceOrder structure from the AML byte stream.
 *
 * A ResourceOrder structure is defined as `ResourceOrder := WordData`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the resource order.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_resource_order_read(aml_term_list_ctx_t* ctx, aml_resource_order_t* out);
 
/**
 * @brief Reads a DefPowerRes structure from the AML byte stream.
 *
 * The DefPowerRes structure is defined as `DefPowerRes := PowerResOp PkgLength NameString SystemLevel ResourceOrder
 * TermList`.
 *
 * @see Section 19.6.108 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_power_res_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a NumBits structure from the AML byte stream.
 *
 * A NumBits structure is defined as `NumBits := TermArg => Integer`.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @param out The output buffer to store the number of bits.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_num_bits_read(aml_term_list_ctx_t* ctx, aml_uint_t* out);
 
/**
 * @brief Reads a DefCreateField structure from the AML byte stream.
 *
 * The DefCreateField structure is defined as `DefDataRegion := CreateFieldOp SourceBuff BitIndex NumBits NameString`.
 *
 * @see Section 19.6.21 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_create_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefCreateField structure from the AML byte stream.
 *
 * The DefCreateField structure is defined as `DefCreateField := CreateFieldOp SourceBuff BitIndex FieldFlags
 * NameString`.
 *
 * A CreateField operation creates a field, with the name stored in the NameString, that accesses a field of arbitrary
 * size and alignment within the SourceBuff, starting at the bit index BitIndex, and with the access properties defined
 * by FieldFlags.
 *
 * @see Section 19.6.21 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_create_field_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a DefDataRegion structure from the AML byte stream.
 *
 * The DefDataRegion structure is defined as `DefDataRegion := DataRegionOp NameString TermArg TermArg TermArg`.
 *
 * Despite the name the DefDataRegion structure is used to implement the DataTableRegion ASL operation.
 *
 * All it does is that it allows a System Descriptor Table to be accessed as an opregion.
 *
 * @see Section 19.6.25 of the ACPI specification for more details.
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_def_data_region_read(aml_term_list_ctx_t* ctx);
 
/**
 * @brief Reads a NamedObj structure from the AML byte stream.
 *
 * Version 6.6 of the ACPI specification has a few mistakes in the definition of the NamedObj structure,
 * its supposed to contain several stuctures that it does not. If you check version 4.0 of the specification
 * section 19.2.5.2 you can confirm that that these structures are supposed to be there but have, somehow, been
 * forgotten.
 *
 * The forgotten structures are:
 * - `DefField`
 * - `DefMethod`
 * - `DefMutex`
 * - `DefIndexField`
 * - `DefDevice`
 * - `DefEvent`
 * - `Maybe even more?`
 *
 * We add all missing structures to our definition of NamedObj. I have no idea how there are this many
 * mistakes in the latest version of the ACPI specification.
 *
 * The DefProcessor structure was deprecated in version 6.4 of the ACPI specification, but we still support it.
 *
 * The NamedObj structure is defined as `NamedObj := DefBankField | DefCreateBitField | DefCreateByteField |
 * DefCreateDWordField | DefCreateField | DefCreateQWordField | DefCreateWordField | DefDataRegion | DefExternal |
 * DefOpRegion | DefPowerRes | DefThermalZone | DefField | DefMethod | DefDevice | DefMutex | DefProcessor |
 * DefIndexField | DefEvent`.
 *
 * Currently unimplemented Opcodes are:
 * - `DefExternal`
 *
 * @param ctx The context of the TermList that this structure is part of.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_named_obj_read(aml_term_list_ctx_t* ctx);
 
/** @} */