opregion.h File Reference

#include <uacpi/internal/types.h>
#include <uacpi/opregion.h>

Include dependency graph for opregion.h:

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

Go to the source code of this file.

Classes
union	uacpi_opregion_io_data

Functions
uacpi_status	uacpi_initialize_opregion (void)
void	uacpi_deinitialize_opregion (void)
uacpi_status	uacpi_upgrade_to_opregion_lock (void)
void	uacpi_release_opregion_lock (void)
void	uacpi_trace_region_error (uacpi_namespace_node *node, uacpi_char *message, uacpi_status ret)
uacpi_status	uacpi_install_address_space_handler_with_flags (uacpi_namespace_node *device_node, enum uacpi_address_space space, uacpi_region_handler handler, uacpi_handle handler_context, uacpi_u16 flags)
void	uacpi_opregion_uninstall_handler (uacpi_namespace_node *node)
uacpi_bool	uacpi_address_space_handler_is_default (uacpi_address_space_handler *handler)
uacpi_address_space_handlers *	uacpi_node_get_address_space_handlers (uacpi_namespace_node *node)
uacpi_status	uacpi_initialize_opregion_node (uacpi_namespace_node *node)
uacpi_status	uacpi_opregion_attach (uacpi_namespace_node *node)
void	uacpi_install_default_address_space_handlers (void)
uacpi_bool	uacpi_is_buffer_access_address_space (uacpi_address_space space)
uacpi_status	uacpi_dispatch_opregion_io (uacpi_field_unit *field, uacpi_u32 offset, uacpi_region_op op, union uacpi_opregion_io_data data)

Function Documentation

uacpi_address_space_handler_is_default()

uacpi_bool uacpi_address_space_handler_is_default

(

uacpi_address_space_handler *

handler

)

Definition at line 502 of file opregion.c.

{
    return handler->flags & UACPI_ADDRESS_SPACE_HANDLER_DEFAULT;
}

Referenced by uacpi_namespace_initialize().

uacpi_deinitialize_opregion()

void uacpi_deinitialize_opregion

(

void

)

Definition at line 20 of file opregion.c.

{
    uacpi_recursive_lock_deinit(&g_opregion_lock);
}

Referenced by uacpi_state_reset().

uacpi_dispatch_opregion_io()

uacpi_status uacpi_dispatch_opregion_io	(	uacpi_field_unit *	field,
		uacpi_u32	offset,
		uacpi_region_op	op,
		union uacpi_opregion_io_data	data
	)

Definition at line 1162 of file opregion.c.

{
    uacpi_status ret;
    uacpi_object *obj;
    uacpi_operation_region *region;
    uacpi_address_space_handler *handler;
    uacpi_address_space space;
    uacpi_u64 abs_offset, offset_end = offset;
    uacpi_bool is_oob = UACPI_FALSE;
    uacpi_region_op orig_op = op;
 
    union {
        uacpi_region_rw_data rw;
        uacpi_region_pcc_send_data pcc;
        uacpi_region_gpio_rw_data gpio;
        uacpi_region_ipmi_rw_data ipmi;
        uacpi_region_ffixedhw_rw_data ffixedhw;
        uacpi_region_prm_rw_data prm;
        uacpi_region_serial_rw_data serial;
    } handler_data;
 
    ret = uacpi_opregion_attach(field->region);
    if (uacpi_unlikely_error(ret)) {
        uacpi_trace_region_error(
            field->region, "unable to attach", ret
        );
        return ret;
    }
 
    obj = uacpi_namespace_node_get_object_typed(
        field->region, UACPI_OBJECT_OPERATION_REGION_BIT
    );
    if (uacpi_unlikely(obj == UACPI_NULL))
        return UACPI_STATUS_INVALID_ARGUMENT;
 
    region = obj->op_region;
    space = region->space;
    handler = region->handler;
 
    abs_offset = region->offset + offset;
    offset_end += field->access_width_bytes;
 
    if (uacpi_likely(space_needs_bounds_checking(region->space)))
        is_oob = region->length < offset_end || abs_offset < offset;
    if (uacpi_unlikely(is_oob)) {
        const uacpi_char *path;
 
        path = uacpi_namespace_node_generate_absolute_path(field->region);
        uacpi_error(
            "out-of-bounds access to opregion %s[0x%"UACPI_PRIX64"->"
            "0x%"UACPI_PRIX64"] at 0x%"UACPI_PRIX64" (idx=%u, width=%d)",
            path, UACPI_FMT64(region->offset),
            UACPI_FMT64(region->offset + region->length),
            UACPI_FMT64(abs_offset), offset, field->access_width_bytes
        );
        uacpi_free_dynamic_string(path);
        return UACPI_STATUS_AML_OUT_OF_BOUNDS_INDEX;
    }
 
    handler_data.rw.region_context = region->user_context;
    handler_data.rw.handler_context = handler->user_context;
 
    switch (region->space) {
    case UACPI_ADDRESS_SPACE_PCC: {
        uacpi_u8 *cursor;
 
        cursor = region->internal_buffer + offset;
 
        /*
         * Reads from PCC just return the current contents of the internal
         * buffer.
         */
        if (op == UACPI_REGION_OP_READ) {
            uacpi_memcpy_zerout(
                data.integer, cursor, sizeof(*data.integer),
                field->access_width_bytes
            );
            goto io_done;
        }
 
        uacpi_memcpy(cursor, data.integer, field->access_width_bytes);
 
        /*
         * Dispatch a PCC send command if this was a write to the command field
         *
         * ACPI 6.5: 14.3. Extended PCC Subspace Shared Memory Region
         *
         * Note that a PCC region covers whatever follows the signature that
         * the shared memory region starts with, so the offset of every field
         * is 4 bytes less than what it is there.
         */
        if (pcc_write_completes_command(field, offset)) {
            uacpi_memzero(&handler_data.pcc.buffer, sizeof(handler_data.pcc.buffer));
            handler_data.pcc.buffer.bytes = region->internal_buffer;
            handler_data.pcc.buffer.length = region->length;
 
            op = UACPI_REGION_OP_PCC_SEND;
            break;
        }
 
        // No dispatch needed, IO is done
        goto io_done;
    }
    case UACPI_ADDRESS_SPACE_GENERAL_PURPOSE_IO:
        handler_data.gpio.pin_offset = field->pin_offset;
        handler_data.gpio.num_pins = field->bit_length;
        handler_data.gpio.value = *data.integer;
 
        ret = uacpi_object_get_string_or_buffer(
            field->connection, &handler_data.gpio.connection
        );
        if (uacpi_unlikely_error(ret))
            goto io_done;
 
        op = op == UACPI_REGION_OP_READ ?
            UACPI_REGION_OP_GPIO_READ : UACPI_REGION_OP_GPIO_WRITE;
        break;
    case UACPI_ADDRESS_SPACE_IPMI:
        handler_data.ipmi.in_out_message = data.buffer;
        handler_data.ipmi.command = abs_offset;
        op = UACPI_REGION_OP_IPMI_COMMAND;
        break;
    case UACPI_ADDRESS_SPACE_FFIXEDHW:
        handler_data.ffixedhw.in_out_message = data.buffer;
        handler_data.ffixedhw.command = abs_offset;
        op = UACPI_REGION_OP_FFIXEDHW_COMMAND;
        break;
    case UACPI_ADDRESS_SPACE_PRM:
        handler_data.prm.in_out_message = data.buffer;
        op = UACPI_REGION_OP_PRM_COMMAND;
        break;
    case UACPI_ADDRESS_SPACE_GENERIC_SERIAL_BUS:
    case UACPI_ADDRESS_SPACE_SMBUS:
        ret = uacpi_object_get_string_or_buffer(
            field->connection, &handler_data.serial.connection
        );
        if (uacpi_unlikely_error(ret))
            goto io_done;
 
        handler_data.serial.command = abs_offset;
        handler_data.serial.in_out_buffer = data.buffer;
        handler_data.serial.access_attribute = field->attributes;
 
        switch (field->attributes) {
        case UACPI_ACCESS_ATTRIBUTE_BYTES:
        case UACPI_ACCESS_ATTRIBUTE_RAW_BYTES:
        case UACPI_ACCESS_ATTRIBUTE_RAW_PROCESS_BYTES:
            handler_data.serial.access_length = field->access_length;
            break;
        default:
            handler_data.serial.access_length = 0;
        }
 
        op = op == UACPI_REGION_OP_READ ?
            UACPI_REGION_OP_SERIAL_READ : UACPI_REGION_OP_SERIAL_WRITE;
        break;
    default:
        handler_data.rw.byte_width = field->access_width_bytes;
        handler_data.rw.offset = abs_offset;
        handler_data.rw.value = *data.integer;
        break;
    }
 
    uacpi_object_ref(obj);
    uacpi_namespace_write_unlock();
 
    ret = handler->callback(op, &handler_data);
 
    uacpi_namespace_write_lock();
    uacpi_object_unref(obj);
 
io_done:
    if (uacpi_unlikely_error(ret)) {
        uacpi_trace_region_error(field->region, "unable to perform IO", ret);
        return ret;
    }
 
    if (orig_op == UACPI_REGION_OP_READ) {
        switch (space) {
        case UACPI_ADDRESS_SPACE_PCC:
        case UACPI_ADDRESS_SPACE_IPMI:
        case UACPI_ADDRESS_SPACE_FFIXEDHW:
        case UACPI_ADDRESS_SPACE_PRM:
        case UACPI_ADDRESS_SPACE_GENERIC_SERIAL_BUS:
        case UACPI_ADDRESS_SPACE_SMBUS:
            break;
        case UACPI_ADDRESS_SPACE_GENERAL_PURPOSE_IO:
            *data.integer = handler_data.gpio.value;
            break;
        default:
            *data.integer = handler_data.rw.value;
            break;
        }
    }
 
    trace_region_io(field, space, abs_offset, orig_op, data);
    return ret;
}

Referenced by access_field_unit().

uacpi_initialize_opregion()

uacpi_status uacpi_initialize_opregion

(

void

)

Definition at line 15 of file opregion.c.

{
    return uacpi_recursive_lock_init(&g_opregion_lock);
}

Referenced by uacpi_initialize().

uacpi_initialize_opregion_node()

uacpi_status uacpi_initialize_opregion_node

(

uacpi_namespace_node *

node

)

Definition at line 1065 of file opregion.c.

{
    uacpi_status ret;
    uacpi_namespace_node *parent = node->parent;
    uacpi_operation_region *region;
    uacpi_address_space_handlers *handlers;
    uacpi_address_space_handler *handler;
 
    ret = uacpi_upgrade_to_opregion_lock();
    if (uacpi_unlikely_error(ret))
        return ret;
 
    region = uacpi_namespace_node_get_object(node)->op_region;
    ret = UACPI_STATUS_NOT_FOUND;
 
    while (parent) {
        handlers = uacpi_node_get_address_space_handlers(parent);
        if (handlers != UACPI_NULL) {
            handler = find_handler(handlers, region->space);
 
            if (handler != UACPI_NULL) {
                region_install_handler(region, handler);
                ret = UACPI_STATUS_OK;
                break;
            }
        }
 
        parent = parent->parent;
    }
 
    if (ret != UACPI_STATUS_OK)
        goto out;
    if (!space_needs_reg(region->space))
        goto out;
    if (uacpi_get_current_init_level() < UACPI_INIT_LEVEL_NAMESPACE_LOADED)
        goto out;
 
    if (run_reg(node->parent, region->space, ACPI_REG_CONNECT) !=
        UACPI_STATUS_NOT_FOUND)
        region->state_flags |= UACPI_OP_REGION_STATE_REG_EXECUTED;
 
out:
    uacpi_recursive_lock_release(&g_opregion_lock);
    return ret;
}

Referenced by handle_create_data_region(), and handle_create_op_region().

uacpi_install_address_space_handler_with_flags()

uacpi_status uacpi_install_address_space_handler_with_flags	(	uacpi_namespace_node *	device_node,
		enum uacpi_address_space	space,
		uacpi_region_handler	handler,
		uacpi_handle	handler_context,
		uacpi_u16	flags
	)

Definition at line 882 of file opregion.c.

{
    uacpi_status ret;
    uacpi_address_space_handlers *handlers;
    uacpi_address_space_handler *this_handler, *new_handler;
    struct opregion_iter_ctx iter_ctx;
 
    ret = uacpi_recursive_lock_acquire(&g_opregion_lock);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    ret = uacpi_namespace_write_lock();
    if (uacpi_unlikely_error(ret)) {
        uacpi_recursive_lock_release(&g_opregion_lock);
        return ret;
    }
 
    handlers = extract_handlers(device_node);
    if (uacpi_unlikely(handlers == UACPI_NULL)) {
        ret = UACPI_STATUS_INVALID_ARGUMENT;
        goto out;
    }
 
    this_handler = find_handler(handlers, space);
    if (this_handler != UACPI_NULL) {
        ret = UACPI_STATUS_ALREADY_EXISTS;
        goto out;
    }
 
    new_handler = uacpi_kernel_alloc(sizeof(*new_handler));
    if (new_handler == UACPI_NULL) {
        ret = UACPI_STATUS_OUT_OF_MEMORY;
        goto out;
    }
    uacpi_shareable_init(new_handler);
 
    new_handler->next = handlers->head;
    new_handler->space = space;
    new_handler->user_context = handler_context;
    new_handler->callback = handler;
    new_handler->regions = UACPI_NULL;
    new_handler->flags = flags;
    handlers->head = new_handler;
 
    /*
     * The handlers that some of the regions already have are invoked as the
     * regions are taken away from them below, and are free to do whatever they
     * want in response, which includes uninstalling the handler that we have
     * just put on the list. Keep it alive until we're done.
     */
    uacpi_shareable_ref(new_handler);
 
    iter_ctx.handler = new_handler;
    iter_ctx.handlers = handlers;
    iter_ctx.action = OPREGION_ITER_ACTION_INSTALL;
 
    uacpi_namespace_do_for_each_child(
        device_node, do_install_or_uninstall_handler, UACPI_NULL,
        UACPI_OBJECT_ANY_BIT, UACPI_MAX_DEPTH_ANY, UACPI_SHOULD_LOCK_NO,
        UACPI_PERMANENT_ONLY_YES, &iter_ctx
    );
 
    if (uacpi_unlikely(!handler_is_installed(&iter_ctx))) {
        ret = UACPI_STATUS_NO_HANDLER;
        goto out_unref;
    }
 
    if (!space_needs_reg(space))
        goto out_unref;
 
     /*
      * Installing an early address space handler, obviously not possible to
      * execute any _REG methods here. Just return and hope that it is either
      * a global address space handler, or a handler installed by a user who
      * will run uacpi_reg_all_opregions manually after loading/initializing
      * the namespace.
      */
    if (g_uacpi_rt_ctx.init_level < UACPI_INIT_LEVEL_NAMESPACE_LOADED)
        goto out_unref;
 
    // Init level is NAMESPACE_INITIALIZED, so we can safely run _REG now
    ret = reg_all_opregions(device_node, space);
 
out_unref:
    uacpi_address_space_handler_unref(new_handler);
out:
    uacpi_namespace_write_unlock();
    uacpi_recursive_lock_release(&g_opregion_lock);
    return ret;
}

Referenced by uacpi_install_address_space_handler(), and uacpi_install_default_address_space_handlers().

uacpi_install_default_address_space_handlers()

void uacpi_install_default_address_space_handlers

(

void

)

Definition at line 778 of file default_handlers.c.

{
    uacpi_namespace_node *root;
 
    root = uacpi_namespace_root();
 
    uacpi_install_address_space_handler_with_flags(
        root, UACPI_ADDRESS_SPACE_SYSTEM_MEMORY,
        handle_memory_region, UACPI_NULL,
        UACPI_ADDRESS_SPACE_HANDLER_DEFAULT
    );
 
    uacpi_install_address_space_handler_with_flags(
        root, UACPI_ADDRESS_SPACE_SYSTEM_IO,
        handle_io_region, UACPI_NULL,
        UACPI_ADDRESS_SPACE_HANDLER_DEFAULT
    );
 
    uacpi_install_address_space_handler_with_flags(
        root, UACPI_ADDRESS_SPACE_PCI_CONFIG,
        handle_pci_region, UACPI_NULL,
        UACPI_ADDRESS_SPACE_HANDLER_DEFAULT
    );
 
    uacpi_install_address_space_handler_with_flags(
        root, UACPI_ADDRESS_SPACE_TABLE_DATA,
        handle_table_data_region, UACPI_NULL,
        UACPI_ADDRESS_SPACE_HANDLER_DEFAULT
    );
}

Referenced by uacpi_initialize().

uacpi_is_buffer_access_address_space()

uacpi_bool uacpi_is_buffer_access_address_space

(

uacpi_address_space

space

)

Definition at line 1111 of file opregion.c.

{
    switch (space) {
    case UACPI_ADDRESS_SPACE_SMBUS:
    case UACPI_ADDRESS_SPACE_IPMI:
    case UACPI_ADDRESS_SPACE_GENERIC_SERIAL_BUS:
    case UACPI_ADDRESS_SPACE_PRM:
    case UACPI_ADDRESS_SPACE_FFIXEDHW:
        return UACPI_TRUE;
    default:
        return UACPI_FALSE;
    }
}

Referenced by space_needs_bounds_checking(), uacpi_field_unit_get_bit_length(), and uacpi_field_unit_get_read_type().

uacpi_node_get_address_space_handlers()

uacpi_address_space_handlers * uacpi_node_get_address_space_handlers

(

uacpi_namespace_node *

node

)

Definition at line 179 of file opregion.c.

{
    uacpi_object *object;
 
    if (node == uacpi_namespace_root())
        return g_uacpi_rt_ctx.root_object->address_space_handlers;
 
    object = uacpi_namespace_node_get_object(node);
    if (uacpi_unlikely(object == UACPI_NULL))
        return UACPI_NULL;
 
    switch (object->type) {
    case UACPI_OBJECT_DEVICE:
    case UACPI_OBJECT_PROCESSOR:
    case UACPI_OBJECT_THERMAL_ZONE:
        return object->address_space_handlers;
    default:
        return UACPI_NULL;
    }
}

Referenced by do_install_or_uninstall_handler(), node_has_handler(), reg_all_opregions(), uacpi_initialize_opregion_node(), and uacpi_namespace_initialize().

uacpi_opregion_attach()

uacpi_status uacpi_opregion_attach

(

uacpi_namespace_node *

node

)

Definition at line 240 of file opregion.c.

{
    uacpi_object *obj;
    uacpi_operation_region *region;
    uacpi_address_space_handler *handler;
    uacpi_status ret;
    uacpi_region_attach_data attach_data = { 0 };
 
    if (uacpi_namespace_node_is_dangling(node))
        return UACPI_STATUS_NAMESPACE_NODE_DANGLING;
 
    obj = uacpi_namespace_node_get_object_typed(
        node, UACPI_OBJECT_OPERATION_REGION_BIT
    );
    if (uacpi_unlikely(obj == UACPI_NULL))
        return UACPI_STATUS_INVALID_ARGUMENT;
 
    region = obj->op_region;
 
    if (region->handler == UACPI_NULL)
        return UACPI_STATUS_NO_HANDLER;
    if (region->state_flags & UACPI_OP_REGION_STATE_ATTACHED)
        return UACPI_STATUS_OK;
 
    handler = region->handler;
    attach_data.region_node = node;
 
    switch (region->space) {
    case UACPI_ADDRESS_SPACE_PCC:
        if (region->length) {
            region->internal_buffer = uacpi_kernel_alloc_zeroed(region->length);
            if (uacpi_unlikely(region->internal_buffer == UACPI_NULL))
                return UACPI_STATUS_OUT_OF_MEMORY;
        }
 
        attach_data.pcc_info.buffer.bytes = region->internal_buffer;
        attach_data.pcc_info.buffer.length = region->length;
        attach_data.pcc_info.subspace_id = region->offset;
        break;
    case UACPI_ADDRESS_SPACE_GENERAL_PURPOSE_IO:
        attach_data.gpio_info.num_pins = region->length;
        break;
    default:
        attach_data.generic_info.base = region->offset;
        attach_data.generic_info.length = region->length;
        break;
    }
 
    attach_data.handler_context = handler->user_context;
 
    /*
     * The handler is invoked with the namespace unlocked, and is free to do
     * whatever it wants in the meantime, which includes evaluating a method
     * that gets rid of the region, as well as uninstalling itself. Keep both
     * of them alive until we're done.
     */
    uacpi_object_ref(obj);
    uacpi_shareable_ref(handler);
 
    uacpi_namespace_write_unlock();
    ret = handler->callback(UACPI_REGION_OP_ATTACH, &attach_data);
    uacpi_namespace_write_lock();
 
    if (uacpi_unlikely_error(ret))
        goto out;
 
    if (uacpi_unlikely(region->handler != handler)) {
        uacpi_region_detach_data detach_data = { 0 };
 
        /*
         * The region was taken away from the handler before it was done
         * attaching it. This is not something that the handler was told
         * about, as the region was not attached at the time, so do it now:
         * a region that was attached is always detached as well.
         */
        detach_data.region_node = node;
        detach_data.region_context = attach_data.out_region_context;
        detach_data.handler_context = handler->user_context;
 
        uacpi_namespace_write_unlock();
        handler->callback(UACPI_REGION_OP_DETACH, &detach_data);
        uacpi_namespace_write_lock();
 
        ret = UACPI_STATUS_NO_HANDLER;
        goto out;
    }
 
    if (uacpi_unlikely(region->state_flags & UACPI_OP_REGION_STATE_ATTACHED)) {
        uacpi_region_detach_data detach_data = { 0 };
 
        /*
         * The region was attached once more in the meantime, which is what
         * happens if the handler ends up accessing the region that it's still
         * in the middle of attaching. It only gets to be attached once, and
         * that one was there first, so this is the one to be undone.
         */
        detach_data.region_node = node;
        detach_data.region_context = attach_data.out_region_context;
        detach_data.handler_context = handler->user_context;
 
        uacpi_namespace_write_unlock();
        handler->callback(UACPI_REGION_OP_DETACH, &detach_data);
        uacpi_namespace_write_lock();
 
        goto out;
    }
 
    region->state_flags |= UACPI_OP_REGION_STATE_ATTACHED;
    region->user_context = attach_data.out_region_context;
 
out:
    uacpi_address_space_handler_unref(handler);
    uacpi_object_unref(obj);
    return ret;
}

Referenced by uacpi_dispatch_opregion_io().

uacpi_opregion_uninstall_handler()

void uacpi_opregion_uninstall_handler

(

uacpi_namespace_node *

node

)

Definition at line 492 of file opregion.c.

{
    if (uacpi_unlikely_error(uacpi_upgrade_to_opregion_lock()))
        return;
 
    region_uninstall_handler(node, UNREG_YES);
 
    uacpi_recursive_lock_release(&g_opregion_lock);
}

Referenced by namespace_node_detach_object(), and opregion_try_detach_from_parent().

uacpi_release_opregion_lock()

void uacpi_release_opregion_lock

(

void

)

Definition at line 487 of file opregion.c.

{
    uacpi_recursive_lock_release(&g_opregion_lock);
}

Referenced by unlock_field_unit_transaction().

uacpi_trace_region_error()

void uacpi_trace_region_error	(	uacpi_namespace_node *	node,
		uacpi_char *	message,
		uacpi_status	ret
	)

Definition at line 25 of file opregion.c.

{
    const uacpi_char *path, *space_string = "<unknown>";
    uacpi_object *obj;
 
    path = uacpi_namespace_node_generate_absolute_path(node);
 
    obj = uacpi_namespace_node_get_object_typed(
        node, UACPI_OBJECT_OPERATION_REGION_BIT
    );
    if (uacpi_likely(obj != UACPI_NULL))
        space_string = uacpi_address_space_to_string(obj->op_region->space);
 
    uacpi_error(
        "%s (%s) operation region %s: %s",
        message, space_string, path, uacpi_status_to_string(ret)
    );
    uacpi_free_dynamic_string(path);
}

Referenced by do_install_or_uninstall_handler(), find_pci_root(), handle_special_field(), io_region_attach(), memory_region_attach(), pci_region_attach(), region_uninstall_handler(), and uacpi_dispatch_opregion_io().

uacpi_upgrade_to_opregion_lock()

uacpi_status uacpi_upgrade_to_opregion_lock

(

void

)

Definition at line 472 of file opregion.c.

{
    uacpi_status ret;
 
    /*
     * Drop the namespace lock, and reacquire it after the opregion lock
     * so we keep the ordering with user API.
     */
    uacpi_namespace_write_unlock();
 
    ret = uacpi_recursive_lock_acquire(&g_opregion_lock);
    uacpi_namespace_write_lock();
    return ret;
}

Referenced by lock_field_unit_transaction(), uacpi_initialize_opregion_node(), and uacpi_opregion_uninstall_handler().