types.h File Reference

#include <uacpi/status.h>
#include <uacpi/types.h>
#include <uacpi/internal/shareable.h>

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	uacpi_buffer
struct	uacpi_package
struct	uacpi_buffer_field
struct	uacpi_buffer_index
struct	uacpi_mutex
struct	uacpi_event
struct	uacpi_address_space_handler
struct	uacpi_address_space_handlers
struct	uacpi_device_notify_handler
struct	uacpi_handlers
struct	uacpi_operation_region
struct	uacpi_device
struct	uacpi_processor
struct	uacpi_thermal_zone
struct	uacpi_power_resource
struct	uacpi_control_method
struct	uacpi_field_unit
struct	uacpi_object

Macros
#define	UACPI_ADDRESS_SPACE_HANDLER_DEFAULT   (1 << 0)
#define	UACPI_OP_REGION_STATE_REG_EXECUTED   (1 << 0)
#define	UACPI_OP_REGION_STATE_ATTACHED   (1 << 1)

Typedefs
typedef struct uacpi_buffer	uacpi_buffer
typedef struct uacpi_package	uacpi_package
typedef struct uacpi_buffer_field	uacpi_buffer_field
typedef struct uacpi_buffer_index	uacpi_buffer_index
typedef struct uacpi_mutex	uacpi_mutex
typedef struct uacpi_event	uacpi_event
typedef struct uacpi_address_space_handler	uacpi_address_space_handler
typedef struct uacpi_address_space_handlers	uacpi_address_space_handlers
typedef struct uacpi_device_notify_handler	uacpi_device_notify_handler
typedef struct uacpi_handlers	uacpi_handlers
typedef struct uacpi_operation_region	uacpi_operation_region
typedef struct uacpi_device	uacpi_device
typedef struct uacpi_processor	uacpi_processor
typedef struct uacpi_thermal_zone	uacpi_thermal_zone
typedef struct uacpi_power_resource	uacpi_power_resource
typedef uacpi_status(*	uacpi_native_call_handler) (uacpi_handle ctx, uacpi_object *retval)
typedef struct uacpi_control_method	uacpi_control_method
typedef enum uacpi_access_type	uacpi_access_type
typedef enum uacpi_lock_rule	uacpi_lock_rule
typedef enum uacpi_update_rule	uacpi_update_rule
typedef enum uacpi_field_unit_kind	uacpi_field_unit_kind
typedef struct uacpi_field_unit	uacpi_field_unit
typedef struct uacpi_object	uacpi_object

Enumerations
enum	uacpi_reference_kind {   UACPI_REFERENCE_KIND_REFOF = 0 , UACPI_REFERENCE_KIND_LOCAL = 1 , UACPI_REFERENCE_KIND_ARG = 2 , UACPI_REFERENCE_KIND_NAMED = 3 ,   UACPI_REFERENCE_KIND_PKG_INDEX = 4 }
enum	uacpi_string_kind { UACPI_STRING_KIND_NORMAL = 0 , UACPI_STRING_KIND_PATH }
enum	uacpi_access_type {   UACPI_ACCESS_TYPE_ANY = 0 , UACPI_ACCESS_TYPE_BYTE = 1 , UACPI_ACCESS_TYPE_WORD = 2 , UACPI_ACCESS_TYPE_DWORD = 3 ,   UACPI_ACCESS_TYPE_QWORD = 4 , UACPI_ACCESS_TYPE_BUFFER = 5 }
enum	uacpi_lock_rule { UACPI_LOCK_RULE_NO_LOCK = 0 , UACPI_LOCK_RULE_LOCK = 1 }
enum	uacpi_update_rule { UACPI_UPDATE_RULE_PRESERVE = 0 , UACPI_UPDATE_RULE_WRITE_AS_ONES = 1 , UACPI_UPDATE_RULE_WRITE_AS_ZEROES = 2 }
enum	uacpi_field_unit_kind { UACPI_FIELD_UNIT_KIND_NORMAL = 0 , UACPI_FIELD_UNIT_KIND_INDEX = 1 , UACPI_FIELD_UNIT_KIND_BANK = 2 }
enum	uacpi_assign_behavior { UACPI_ASSIGN_BEHAVIOR_DEEP_COPY , UACPI_ASSIGN_BEHAVIOR_SHALLOW_COPY }
enum	uacpi_prealloc_objects { UACPI_PREALLOC_OBJECTS_NO , UACPI_PREALLOC_OBJECTS_YES }

Functions
uacpi_object *	uacpi_create_object (uacpi_object_type type)
uacpi_status	uacpi_object_assign (uacpi_object *dst, uacpi_object *src, enum uacpi_assign_behavior)
void	uacpi_object_attach_child (uacpi_object *parent, uacpi_object *child)
void	uacpi_object_detach_child (uacpi_object *parent)
struct uacpi_object *	uacpi_create_internal_reference (enum uacpi_reference_kind kind, uacpi_object *child)
uacpi_object *	uacpi_unwrap_internal_reference (uacpi_object *object)
uacpi_bool	uacpi_package_fill (uacpi_package *pkg, uacpi_size num_elements, enum uacpi_prealloc_objects prealloc_objects)
uacpi_mutex *	uacpi_create_mutex (void)
void	uacpi_mutex_unref (uacpi_mutex *)
void	uacpi_method_unref (uacpi_control_method *)
void	uacpi_address_space_handler_unref (uacpi_address_space_handler *handler)
void	uacpi_buffer_to_view (uacpi_buffer *, uacpi_data_view *)

Macro Definition Documentation

UACPI_ADDRESS_SPACE_HANDLER_DEFAULT

#define UACPI_ADDRESS_SPACE_HANDLER_DEFAULT   (1 << 0)

Definition at line 73 of file types.h.

UACPI_OP_REGION_STATE_ATTACHED

#define UACPI_OP_REGION_STATE_ATTACHED   (1 << 1)

Definition at line 114 of file types.h.

UACPI_OP_REGION_STATE_REG_EXECUTED

#define UACPI_OP_REGION_STATE_REG_EXECUTED   (1 << 0)

Definition at line 111 of file types.h.

Typedef Documentation

uacpi_access_type

typedef enum uacpi_access_type uacpi_access_type

uacpi_address_space_handler

typedef struct uacpi_address_space_handler uacpi_address_space_handler

uacpi_address_space_handlers

typedef struct uacpi_address_space_handlers uacpi_address_space_handlers

uacpi_buffer

typedef struct uacpi_buffer uacpi_buffer

uacpi_buffer_field

typedef struct uacpi_buffer_field uacpi_buffer_field

uacpi_buffer_index

typedef struct uacpi_buffer_index uacpi_buffer_index

uacpi_control_method

typedef struct uacpi_control_method uacpi_control_method

uacpi_device

typedef struct uacpi_device uacpi_device

uacpi_device_notify_handler

typedef struct uacpi_device_notify_handler uacpi_device_notify_handler

uacpi_event

typedef struct uacpi_event uacpi_event

uacpi_field_unit

typedef struct uacpi_field_unit uacpi_field_unit

uacpi_field_unit_kind

typedef enum uacpi_field_unit_kind uacpi_field_unit_kind

uacpi_handlers

typedef struct uacpi_handlers uacpi_handlers

uacpi_lock_rule

typedef enum uacpi_lock_rule uacpi_lock_rule

uacpi_mutex

typedef struct uacpi_mutex uacpi_mutex

uacpi_native_call_handler

typedef uacpi_status(* uacpi_native_call_handler) (uacpi_handle ctx, uacpi_object *retval)

Definition at line 163 of file types.h.

uacpi_object

typedef struct uacpi_object uacpi_object

uacpi_operation_region

typedef struct uacpi_operation_region uacpi_operation_region

uacpi_package

typedef struct uacpi_package uacpi_package

uacpi_power_resource

typedef struct uacpi_power_resource uacpi_power_resource

uacpi_processor

typedef struct uacpi_processor uacpi_processor

uacpi_thermal_zone

typedef struct uacpi_thermal_zone uacpi_thermal_zone

uacpi_update_rule

typedef enum uacpi_update_rule uacpi_update_rule

Enumeration Type Documentation

uacpi_access_type

enum uacpi_access_type

Enumerator
UACPI_ACCESS_TYPE_ANY
UACPI_ACCESS_TYPE_BYTE
UACPI_ACCESS_TYPE_WORD
UACPI_ACCESS_TYPE_DWORD
UACPI_ACCESS_TYPE_QWORD
UACPI_ACCESS_TYPE_BUFFER

Definition at line 183 of file types.h.

                               {
    UACPI_ACCESS_TYPE_ANY = 0,
    UACPI_ACCESS_TYPE_BYTE = 1,
    UACPI_ACCESS_TYPE_WORD = 2,
    UACPI_ACCESS_TYPE_DWORD = 3,
    UACPI_ACCESS_TYPE_QWORD = 4,
    UACPI_ACCESS_TYPE_BUFFER = 5,
} uacpi_access_type;

uacpi_assign_behavior

enum uacpi_assign_behavior

Enumerator
UACPI_ASSIGN_BEHAVIOR_DEEP_COPY
UACPI_ASSIGN_BEHAVIOR_SHALLOW_COPY

Definition at line 275 of file types.h.

                           {
    UACPI_ASSIGN_BEHAVIOR_DEEP_COPY,
    UACPI_ASSIGN_BEHAVIOR_SHALLOW_COPY,
};

uacpi_field_unit_kind

enum uacpi_field_unit_kind

Enumerator
UACPI_FIELD_UNIT_KIND_NORMAL
UACPI_FIELD_UNIT_KIND_INDEX
UACPI_FIELD_UNIT_KIND_BANK

Definition at line 203 of file types.h.

                                   {
    UACPI_FIELD_UNIT_KIND_NORMAL = 0,
    UACPI_FIELD_UNIT_KIND_INDEX = 1,
    UACPI_FIELD_UNIT_KIND_BANK = 2,
} uacpi_field_unit_kind;

uacpi_lock_rule

enum uacpi_lock_rule

Enumerator
UACPI_LOCK_RULE_NO_LOCK
UACPI_LOCK_RULE_LOCK

Definition at line 192 of file types.h.

                             {
    UACPI_LOCK_RULE_NO_LOCK = 0,
    UACPI_LOCK_RULE_LOCK = 1,
} uacpi_lock_rule;

uacpi_prealloc_objects

enum uacpi_prealloc_objects

Enumerator
UACPI_PREALLOC_OBJECTS_NO
UACPI_PREALLOC_OBJECTS_YES

Definition at line 291 of file types.h.

                            {
    UACPI_PREALLOC_OBJECTS_NO,
    UACPI_PREALLOC_OBJECTS_YES,
};

uacpi_reference_kind

enum uacpi_reference_kind

Enumerator
UACPI_REFERENCE_KIND_REFOF
UACPI_REFERENCE_KIND_LOCAL
UACPI_REFERENCE_KIND_ARG
UACPI_REFERENCE_KIND_NAMED
UACPI_REFERENCE_KIND_PKG_INDEX

Definition at line 10 of file types.h.

                          {
    UACPI_REFERENCE_KIND_REFOF = 0,
    UACPI_REFERENCE_KIND_LOCAL = 1,
    UACPI_REFERENCE_KIND_ARG = 2,
    UACPI_REFERENCE_KIND_NAMED = 3,
    UACPI_REFERENCE_KIND_PKG_INDEX = 4,
};

uacpi_string_kind

enum uacpi_string_kind

Enumerator
UACPI_STRING_KIND_NORMAL
UACPI_STRING_KIND_PATH

Definition at line 19 of file types.h.

                       {
    UACPI_STRING_KIND_NORMAL = 0,
    UACPI_STRING_KIND_PATH,
};

uacpi_update_rule

enum uacpi_update_rule

Enumerator
UACPI_UPDATE_RULE_PRESERVE
UACPI_UPDATE_RULE_WRITE_AS_ONES
UACPI_UPDATE_RULE_WRITE_AS_ZEROES

Definition at line 197 of file types.h.

                               {
    UACPI_UPDATE_RULE_PRESERVE = 0,
    UACPI_UPDATE_RULE_WRITE_AS_ONES = 1,
    UACPI_UPDATE_RULE_WRITE_AS_ZEROES = 2,
} uacpi_update_rule;

Function Documentation

uacpi_address_space_handler_unref()

void uacpi_address_space_handler_unref

(

uacpi_address_space_handler *

handler

)

Definition at line 548 of file types.c.

{
    uacpi_shareable_unref_and_delete_if_last(
        handler, free_address_space_handler
    );
}

Referenced by region_uninstall_handler(), and uacpi_uninstall_address_space_handler().

uacpi_buffer_to_view()

void uacpi_buffer_to_view	(	uacpi_buffer *	buf,
		uacpi_data_view *	out_view
	)

Definition at line 1034 of file types.c.

{
    out_view->bytes = buf->byte_data;
    out_view->length = buf->size;
}

Referenced by extract_native_resources_from_method(), handle_concatenate_res(), and uacpi_object_do_get_string_or_buffer().

uacpi_create_internal_reference()

struct uacpi_object * uacpi_create_internal_reference	(	enum uacpi_reference_kind	kind,
		uacpi_object *	child
	)

Definition at line 1453 of file types.c.

{
    uacpi_object *ret;
 
    ret = uacpi_create_object(UACPI_OBJECT_REFERENCE);
    if (uacpi_unlikely(ret == UACPI_NULL))
        return ret;
 
    ret->flags = kind;
    uacpi_object_attach_child(ret, child);
    return ret;
}

Referenced by create_named_scope(), frame_push_args(), handle_arg_or_local(), handle_create_buffer_field(), handle_create_data_region(), handle_create_field(), handle_create_method(), handle_create_mutex_or_event(), handle_create_named(), handle_create_op_region(), handle_index(), and uacpi_initialize_namespace().

uacpi_create_mutex()

uacpi_mutex * uacpi_create_mutex

(

void

)

Definition at line 181 of file types.c.

{
    uacpi_mutex *mutex;
 
    mutex = uacpi_kernel_alloc_zeroed(sizeof(uacpi_mutex));
    if (uacpi_unlikely(mutex == UACPI_NULL))
        return UACPI_NULL;
 
    mutex->owner = UACPI_THREAD_ID_NONE;
 
    mutex->handle = uacpi_kernel_create_mutex();
    if (mutex->handle == UACPI_NULL) {
        uacpi_free(mutex, sizeof(*mutex));
        return UACPI_NULL;
    }
 
    uacpi_shareable_init(mutex);
    return mutex;
}

Referenced by enter_method(), and mutex_alloc().

uacpi_create_object()

uacpi_object * uacpi_create_object

(

uacpi_object_type

type

)

Definition at line 327 of file types.c.

{
    uacpi_object *ret;
    object_ctor ctor;
 
    ret = uacpi_kernel_alloc_zeroed(sizeof(*ret));
    if (uacpi_unlikely(ret == UACPI_NULL))
        return ret;
 
    uacpi_shareable_init(ret);
    ret->type = type;
 
    ctor = object_constructor_table[type];
    if (ctor == UACPI_NULL)
        return ret;
 
    if (uacpi_unlikely(!ctor(ret))) {
        uacpi_free(ret, sizeof(*ret));
        return UACPI_NULL;
    }
 
    return ret;
}

Referenced by copy_object_to_reference(), eval_sleep_helper(), exec_op(), handle_arg_or_local(), handle_copy_object_or_store(), handle_index(), handle_package(), make_object_for_predefined(), region_run_reg(), store_to_reference(), uacpi_create_internal_reference(), uacpi_eval(), uacpi_execute_control_method(), uacpi_native_resources_to_aml(), uacpi_object_create_integer(), uacpi_object_create_reference(), uacpi_object_create_uninitialized(), uacpi_object_do_create_string_or_buffer(), uacpi_package_fill(), and uacpi_set_interrupt_model().

uacpi_method_unref()

void uacpi_method_unref

(

uacpi_control_method *

method

)

Definition at line 648 of file types.c.

{
    uacpi_shareable_unref_and_delete_if_last(method, free_method);
}

Referenced by call_frame_clear(), free_object_storage(), and uacpi_eval().

uacpi_mutex_unref()

void uacpi_mutex_unref

(

uacpi_mutex *

mutex

)

Definition at line 492 of file types.c.

{
    if (mutex == UACPI_NULL)
        return;
 
    uacpi_shareable_unref_and_delete_if_last(mutex, free_mutex);
}

Referenced by free_object_storage(), held_mutexes_array_remove_and_release(), and uacpi_deinitialize_namespace().

uacpi_object_assign()

uacpi_status uacpi_object_assign	(	uacpi_object *	dst,
		uacpi_object *	src,
		enum	uacpi_assign_behavior
	)

Definition at line 1360 of file types.c.

{
    uacpi_status ret = UACPI_STATUS_OK;
 
    if (src == dst)
        return ret;
 
    switch (dst->type) {
    case UACPI_OBJECT_REFERENCE:
        uacpi_object_detach_child(dst);
        break;
    case UACPI_OBJECT_STRING:
    case UACPI_OBJECT_BUFFER:
    case UACPI_OBJECT_METHOD:
    case UACPI_OBJECT_PACKAGE:
    case UACPI_OBJECT_MUTEX:
    case UACPI_OBJECT_EVENT:
    case UACPI_OBJECT_PROCESSOR:
    case UACPI_OBJECT_DEVICE:
    case UACPI_OBJECT_THERMAL_ZONE:
        free_object_storage(dst);
        break;
    default:
        break;
    }
 
    switch (src->type) {
    case UACPI_OBJECT_UNINITIALIZED:
    case UACPI_OBJECT_DEBUG:
        break;
    case UACPI_OBJECT_BUFFER:
    case UACPI_OBJECT_STRING:
        dst->flags = src->flags;
        ret = assign_buffer(dst, src, behavior);
        break;
    case UACPI_OBJECT_BUFFER_FIELD:
        dst->buffer_field = src->buffer_field;
        uacpi_shareable_ref(dst->buffer_field.backing);
        break;
    case UACPI_OBJECT_BUFFER_INDEX:
        dst->buffer_index = src->buffer_index;
        uacpi_shareable_ref(dst->buffer_index.buffer);
        break;
    case UACPI_OBJECT_INTEGER:
        dst->integer = src->integer;
        break;
    case UACPI_OBJECT_METHOD:
        dst->method = src->method;
        uacpi_shareable_ref(dst->method);
        break;
    case UACPI_OBJECT_MUTEX:
        ret = assign_mutex(dst, src, behavior);
        break;
    case UACPI_OBJECT_EVENT:
        ret = assign_event(dst, src, behavior);
        break;
    case UACPI_OBJECT_OPERATION_REGION:
        dst->op_region = src->op_region;
        uacpi_shareable_ref(dst->op_region);
        break;
    case UACPI_OBJECT_PACKAGE:
        ret = assign_package(dst, src, behavior);
        break;
    case UACPI_OBJECT_FIELD_UNIT:
        dst->field_unit = src->field_unit;
        uacpi_shareable_ref(dst->field_unit);
        break;
    case UACPI_OBJECT_REFERENCE:
        uacpi_object_attach_child(dst, src->inner_object);
        break;
    case UACPI_OBJECT_PROCESSOR:
        dst->processor = src->processor;
        uacpi_shareable_ref(dst->processor);
        break;
    case UACPI_OBJECT_DEVICE:
        dst->device = src->device;
        uacpi_shareable_ref(dst->device);
        break;
    case UACPI_OBJECT_THERMAL_ZONE:
        dst->thermal_zone = src->thermal_zone;
        uacpi_shareable_ref(dst->thermal_zone);
        break;
    default:
        ret = UACPI_STATUS_UNIMPLEMENTED;
    }
 
    if (ret == UACPI_STATUS_OK)
        dst->type = src->type;
 
    return ret;
}

Referenced by copy_object_to_reference(), deep_copy_package_no_recurse(), exec_op(), handle_package(), handle_ref_or_deref_of(), handle_return(), store_to_reference(), uacpi_eval(), uacpi_object_assign_integer(), uacpi_object_assign_package(), uacpi_object_assign_reference(), and uacpi_object_do_assign_buffer().

uacpi_object_attach_child()

void uacpi_object_attach_child	(	uacpi_object *	parent,
		uacpi_object *	child
	)

Definition at line 943 of file types.c.

{
    uacpi_u32 refs_to_add;
 
    parent->inner_object = child;
 
    if (uacpi_unlikely(uacpi_bugged_shareable(parent))) {
        make_chain_bugged(child);
        return;
    }
 
    refs_to_add = uacpi_shareable_refcount(parent);
    while (refs_to_add--)
        uacpi_object_ref(child);
}

Referenced by object_replace_child(), uacpi_create_internal_reference(), uacpi_object_assign(), uacpi_object_assign_reference(), and uacpi_object_create_reference().

uacpi_object_detach_child()

void uacpi_object_detach_child

(

uacpi_object *

parent

)

Definition at line 959 of file types.c.

{
    uacpi_u32 refs_to_remove;
    uacpi_object *child;
 
    child = parent->inner_object;
    parent->inner_object = UACPI_NULL;
 
    if (uacpi_unlikely(uacpi_bugged_shareable(parent)))
        return;
 
    refs_to_remove = uacpi_shareable_refcount(parent);
    while (refs_to_remove--)
        uacpi_object_unref(child);
}

Referenced by object_replace_child(), and uacpi_object_assign().

uacpi_package_fill()

uacpi_bool uacpi_package_fill	(	uacpi_package *	pkg,
		uacpi_size	num_elements,
		enum uacpi_prealloc_objects	prealloc_objects
	)

Definition at line 124 of file types.c.

{
    uacpi_size i;
 
    if (uacpi_unlikely(num_elements == 0))
        return UACPI_TRUE;
 
    pkg->objects = uacpi_kernel_alloc_zeroed(
        num_elements * sizeof(uacpi_handle)
    );
    if (uacpi_unlikely(pkg->objects == UACPI_NULL))
        return UACPI_FALSE;
 
    pkg->count = num_elements;
 
    if (prealloc_objects == UACPI_PREALLOC_OBJECTS_YES) {
        for (i = 0; i < num_elements; ++i) {
            pkg->objects[i] = uacpi_create_object(UACPI_OBJECT_UNINITIALIZED);
 
            if (uacpi_unlikely(pkg->objects[i] == UACPI_NULL))
                return UACPI_FALSE;
        }
    }
 
    return UACPI_TRUE;
}

Referenced by handle_package(), and package_alloc().

uacpi_unwrap_internal_reference()

uacpi_object * uacpi_unwrap_internal_reference

(

uacpi_object *

object

)

Definition at line 1468 of file types.c.

{
    for (;;) {
        if (object->type != UACPI_OBJECT_REFERENCE ||
            (object->flags == UACPI_REFERENCE_KIND_REFOF ||
             object->flags == UACPI_REFERENCE_KIND_PKG_INDEX))
            return object;
 
        object = object->inner_object;
    }
}

Referenced by copy_object_to_reference(), debug_store(), exec_op(), handle_event_ctl(), handle_mutex_ctl(), handle_package(), method_get_ret_object(), store_to_reference(), store_to_target(), uacpi_namespace_node_get_object(), and uacpi_osi().