object.h

Go to the documentation of this file.

#pragma once
 
#include <kernel/acpi/aml/encoding/name.h>
#include <kernel/acpi/aml/integer.h>
#include <kernel/acpi/aml/namespace.h>
#include <kernel/acpi/aml/patch_up.h>
#include <kernel/acpi/aml/runtime/mutex.h>
#include <kernel/fs/sysfs.h>
#include <kernel/utils/ref.h>
 
#include <stdint.h>
 
typedef struct aml_state aml_state_t;
typedef struct aml_object aml_object_t;
typedef struct aml_opregion_obj aml_opregion_obj_t;
typedef struct aml_string_obj aml_string_obj_t;
typedef struct aml_method_obj aml_method_obj_t;
 
#define AML_SMALL_BUFFER_SIZE 32
 
#define AML_SMALL_STRING_SIZE AML_SMALL_BUFFER_SIZE
 
#define AML_SMALL_PACKAGE_SIZE 4
 
#define AML_OBJECT_CACHE_SIZE 64
 
typedef enum
{
    AML_UNINITIALIZED = 0,
    AML_BUFFER = 1 << 0,
    AML_BUFFER_FIELD = 1 << 1,
    AML_DEBUG_OBJECT = 1 << 2,
    AML_DEVICE = 1 << 3,
    AML_EVENT = 1 << 4,
    AML_FIELD_UNIT = 1 << 5,
    AML_INTEGER = 1 << 6,
    // AML_INTEGER_CONSTANT = 1 << 7,
    AML_METHOD = 1 << 8,
    AML_MUTEX = 1 << 9,
    AML_OBJECT_REFERENCE = 1 << 10,
    AML_OPERATION_REGION = 1 << 11,
    AML_PACKAGE = 1 << 12,
    AML_POWER_RESOURCE = 1 << 13,
    AML_PROCESSOR = 1 << 14,
    AML_RAW_DATA_BUFFER = 1 << 15,
    AML_STRING = 1 << 16,
    AML_THERMAL_ZONE = 1 << 17,
    AML_ALIAS = 1 << 18,            
    AML_UNRESOLVED = 1 << 19,       
    AML_PREDEFINED_SCOPE = 1 << 20, 
    AML_ARG = 1 << 21,              
    AML_LOCAL = 1 << 22,            
    AML_COMPUTATIONAL_DATA_OBJECTS = AML_INTEGER | AML_STRING | AML_BUFFER,
    AML_DATA_OBJECTS = AML_COMPUTATIONAL_DATA_OBJECTS | AML_PACKAGE,
    AML_DATA_REF_OBJECTS = AML_DATA_OBJECTS | AML_OBJECT_REFERENCE,
    AML_NAMESPACES =
        AML_DEVICE | AML_PROCESSOR | AML_METHOD | AML_THERMAL_ZONE | AML_POWER_RESOURCE | AML_PREDEFINED_SCOPE,
    AML_ALL_TYPES = AML_BUFFER | AML_BUFFER_FIELD | AML_DEBUG_OBJECT | AML_DEVICE | AML_EVENT | AML_FIELD_UNIT |
        AML_INTEGER | AML_METHOD | AML_MUTEX | AML_OBJECT_REFERENCE | AML_OPERATION_REGION | AML_PACKAGE |
        AML_POWER_RESOURCE | AML_PROCESSOR | AML_RAW_DATA_BUFFER | AML_STRING | AML_THERMAL_ZONE,
    AML_TYPE_AMOUNT = 20, 
} aml_type_t;
 
typedef enum
{
    AML_OBJECT_NONE = 0,       
    AML_OBJECT_ROOT = 1 << 0,  
    AML_OBJECT_NAMED = 1 << 1, 
    AML_OBJECT_EXCEPTION_ON_USE = 1 << 2,
    AML_OBJECT_EXPOSED_IN_SYSFS = 1 << 3,
} aml_object_flags_t;
 
typedef uint64_t aml_object_id_t;
 
#define AML_OBJECT_ID_NONE 0
 
typedef enum
{
    AML_FIELD_UNIT_NONE,
    AML_FIELD_UNIT_FIELD,
    AML_FIELD_UNIT_INDEX_FIELD,
    AML_FIELD_UNIT_BANK_FIELD,
} aml_field_unit_obj_type_t;
 
typedef aml_object_t* (*aml_method_implementation_t)(aml_method_obj_t* method, aml_object_t** args, uint64_t argCount);
 
#define AML_OBJECT_COMMON_HEADER \
    ref_t ref; \
    aml_object_id_t id; \
    aml_name_t name; \
    map_entry_t mapEntry; \
    list_entry_t listEntry; \
    aml_namespace_overlay_t* overlay; \
    list_t children; \
    list_entry_t siblingsEntry; \
    aml_object_t* parent; \
    aml_object_flags_t flags; \
    aml_type_t type; \
    dentry_t* dir
 
typedef struct aml_buffer_obj
{
    AML_OBJECT_COMMON_HEADER;
    uint8_t* content;
    uint64_t length;
    uint8_t smallBuffer[AML_SMALL_BUFFER_SIZE]; 
} aml_buffer_obj_t;
 
typedef struct aml_buffer_field_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_object_t* target;
    aml_bit_size_t bitOffset;
    aml_bit_size_t bitSize;
} aml_buffer_field_obj_t;
 
typedef struct aml_event_obj
{
    AML_OBJECT_COMMON_HEADER;
} aml_event_obj_t;
 
typedef struct aml_field_unit_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_field_unit_obj_type_t fieldType; 
    aml_field_unit_obj_t* index;         
    aml_field_unit_obj_t* data;          
    aml_object_t* bankValue;             
    aml_field_unit_obj_t* bank;          
    aml_opregion_obj_t* opregion;        
    aml_field_flags_t fieldFlags;        
    aml_bit_size_t bitOffset;            
    aml_bit_size_t bitSize;              
} aml_field_unit_obj_t;
 
typedef struct aml_integer_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_integer_t value;
} aml_integer_obj_t;
 
typedef struct aml_integer_constant_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_integer_t value;
} aml_integer_constant_obj_t;
 
typedef struct aml_method_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_method_implementation_t implementation;
    aml_method_flags_t methodFlags;
    const uint8_t* start;
    const uint8_t* end;
    aml_mutex_id_t mutex;
} aml_method_obj_t;
 
typedef struct aml_mutex_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_sync_level_t syncLevel;
    aml_mutex_id_t mutex;
} aml_mutex_obj_t;
 
typedef struct aml_object_referencev
{
    AML_OBJECT_COMMON_HEADER;
    aml_object_t* target;
} aml_object_reference_obj_t;
 
typedef struct aml_opregion_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_region_space_t space;
    uintptr_t offset;
    uint32_t length;
} aml_opregion_obj_t;
 
typedef struct aml_package_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_object_t** elements;
    uint64_t length;
    aml_object_t* smallElements[AML_SMALL_PACKAGE_SIZE]; 
} aml_package_obj_t;
 
typedef struct aml_power_resource_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_system_level_t systemLevel;
    aml_resource_order_t resourceOrder;
} aml_power_resource_obj_t;
 
typedef struct aml_processor_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_proc_id_t procId;
    aml_pblk_addr_t pblkAddr;
    aml_pblk_len_t pblkLen;
} aml_processor_obj_t;
 
typedef struct aml_string_obj
{
    AML_OBJECT_COMMON_HEADER;
    char* content;
    uint64_t length;
    char smallString[AML_SMALL_STRING_SIZE + 1]; 
} aml_string_obj_t;
 
typedef struct aml_alias_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_object_t* target;
} aml_alias_obj_t;
 
typedef struct aml_unresolved_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_name_string_t nameString;             
    aml_object_t* from;                       
    aml_patch_up_resolve_callback_t callback; 
} aml_unresolved_obj_t;
 
typedef struct aml_arg_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_object_t* value; 
} aml_arg_obj_t;
 
typedef struct aml_local_obj
{
    AML_OBJECT_COMMON_HEADER;
    aml_object_t* value; 
} aml_local_obj_t;
 
typedef struct aml_object
{
    union {
        struct
        {
            AML_OBJECT_COMMON_HEADER;
        };
        aml_buffer_obj_t buffer;
        aml_buffer_field_obj_t bufferField;
        aml_event_obj_t event;
        aml_field_unit_obj_t fieldUnit;
        aml_integer_obj_t integer;
        aml_integer_constant_obj_t integerConstant;
        aml_method_obj_t method;
        aml_mutex_obj_t mutex;
        aml_object_reference_obj_t objectReference;
        aml_opregion_obj_t opregion;
        aml_package_obj_t package;
        aml_power_resource_obj_t powerResource;
        aml_processor_obj_t processor;
        aml_string_obj_t string;
 
        aml_alias_obj_t alias;
        aml_unresolved_obj_t unresolved;
        aml_arg_obj_t arg;
        aml_local_obj_t local;
    };
} aml_object_t;
 
uint64_t aml_object_get_total_count(void);
 
aml_object_t* aml_object_new(void);
 
void aml_object_clear(aml_object_t* object);
 
uint64_t aml_object_count_children(aml_object_t* parent);
 
uint64_t aml_object_set_bits_at(aml_object_t* object, aml_bit_size_t bitOffset, aml_bit_size_t bitSize, uint8_t* in);
 
uint64_t aml_object_get_bits_at(aml_object_t* object, aml_bit_size_t bitOffset, aml_bit_size_t bitSize, uint8_t* out);
 
void aml_object_exception_check(aml_object_t* object, aml_state_t* state);
 
uint64_t aml_buffer_set(aml_object_t* object, const uint8_t* buffer, uint64_t bytesToCopy, uint64_t length);
 
uint64_t aml_buffer_set_empty(aml_object_t* object, uint64_t length);
 
uint64_t aml_buffer_field_set(aml_object_t* object, aml_object_t* target, aml_bit_size_t bitOffset,
    aml_bit_size_t bitSize);
 
uint64_t aml_debug_object_set(aml_object_t* object);
 
uint64_t aml_device_set(aml_object_t* object);
 
uint64_t aml_event_set(aml_object_t* object);
 
uint64_t aml_field_unit_field_set(aml_object_t* object, aml_opregion_obj_t* opregion, aml_field_flags_t flags,
    aml_bit_size_t bitOffset, aml_bit_size_t bitSize);
 
uint64_t aml_field_unit_index_field_set(aml_object_t* object, aml_field_unit_obj_t* index, aml_field_unit_obj_t* data,
    aml_field_flags_t flags, aml_bit_size_t bitOffset, aml_bit_size_t bitSize);
 
uint64_t aml_field_unit_bank_field_set(aml_object_t* object, aml_opregion_obj_t* opregion, aml_field_unit_obj_t* bank,
    uint64_t bankValue, aml_field_flags_t flags, aml_bit_size_t bitOffset, aml_bit_size_t bitSize);
 
uint64_t aml_integer_set(aml_object_t* object, aml_integer_t value);
 
uint64_t aml_method_set(aml_object_t* object, aml_method_flags_t flags, const uint8_t* start, const uint8_t* end,
    aml_method_implementation_t implementation);
 
aml_method_obj_t* aml_method_find(const uint8_t* addr);
 
uint64_t aml_mutex_set(aml_object_t* object, aml_sync_level_t syncLevel);
 
uint64_t aml_object_reference_set(aml_object_t* object, aml_object_t* target);
 
uint64_t aml_operation_region_set(aml_object_t* object, aml_region_space_t space, uintptr_t offset, uint32_t length);
 
uint64_t aml_package_set(aml_object_t* object, uint64_t length);
 
uint64_t aml_power_resource_set(aml_object_t* object, aml_system_level_t systemLevel,
    aml_resource_order_t resourceOrder);
 
uint64_t aml_processor_set(aml_object_t* object, aml_proc_id_t procId, aml_pblk_addr_t pblkAddr,
    aml_pblk_len_t pblkLen);
 
uint64_t aml_string_set_empty(aml_object_t* object, uint64_t length);
 
uint64_t aml_string_set(aml_object_t* object, const char* str);
 
uint64_t aml_string_resize(aml_string_obj_t* string, uint64_t newLength);
 
uint64_t aml_thermal_zone_set(aml_object_t* object);
 
uint64_t aml_alias_set(aml_object_t* object, aml_object_t* target);
 
aml_object_t* aml_alias_obj_traverse(aml_alias_obj_t* alias);
 
uint64_t aml_unresolved_set(aml_object_t* object, const aml_name_string_t* nameString, aml_object_t* from,
    aml_patch_up_resolve_callback_t callback);
 
uint64_t aml_predefined_scope_set(aml_object_t* object);
 
uint64_t aml_arg_set(aml_object_t* object, aml_object_t* value);
 
uint64_t aml_local_set(aml_object_t* object);