io.h File Reference

#include <uacpi/internal/types.h>
#include <uacpi/acpi.h>
#include <uacpi/io.h>

Include dependency graph for io.h:

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

Go to the source code of this file.

Classes
struct	uacpi_mapped_gas

Macros
#define	uacpi_mmio_read8   uacpi_builtin_mmio_read8
#define	uacpi_mmio_read16   uacpi_builtin_mmio_read16
#define	uacpi_mmio_read32   uacpi_builtin_mmio_read32
#define	uacpi_mmio_read64   uacpi_builtin_mmio_read64
#define	uacpi_mmio_write8   uacpi_builtin_mmio_write8
#define	uacpi_mmio_write16   uacpi_builtin_mmio_write16
#define	uacpi_mmio_write32   uacpi_builtin_mmio_write32
#define	uacpi_mmio_write64   uacpi_builtin_mmio_write64

Typedefs
typedef struct uacpi_mapped_gas	uacpi_mapped_gas

Functions
uacpi_status	uacpi_map_gas_noalloc (const struct acpi_gas *gas, uacpi_mapped_gas *out_mapped)
void	uacpi_unmap_gas_nofree (uacpi_mapped_gas *gas)
uacpi_size	uacpi_round_up_bits_to_bytes (uacpi_size bit_length)
void	uacpi_read_buffer_field (const uacpi_buffer_field *field, void *dst)
void	uacpi_write_buffer_field (uacpi_buffer_field *field, const void *src, uacpi_size size)
uacpi_status	uacpi_field_unit_get_read_type (struct uacpi_field_unit *field, uacpi_object_type *out_type)
uacpi_status	uacpi_field_unit_get_bit_length (struct uacpi_field_unit *field, uacpi_size *out_length)
uacpi_status	uacpi_read_field_unit (uacpi_field_unit *field, void *dst, uacpi_size size, uacpi_data_view *wtr_response)
uacpi_status	uacpi_write_field_unit (uacpi_field_unit *field, const void *src, uacpi_size size, uacpi_data_view *wtr_response)
uacpi_status	uacpi_write_field_unit_in_chunks (uacpi_field_unit *field, const void *src, uacpi_size size, uacpi_data_view *wtr_response)
uacpi_u8	uacpi_builtin_mmio_read8 (void *ptr)
uacpi_u16	uacpi_builtin_mmio_read16 (void *ptr)
uacpi_u32	uacpi_builtin_mmio_read32 (void *ptr)
uacpi_u64	uacpi_builtin_mmio_read64 (void *ptr)
void	uacpi_builtin_mmio_write8 (void *ptr, uacpi_u8 data)
void	uacpi_builtin_mmio_write16 (void *ptr, uacpi_u16 data)
void	uacpi_builtin_mmio_write32 (void *ptr, uacpi_u32 data)
void	uacpi_builtin_mmio_write64 (void *ptr, uacpi_u64 data)
uacpi_status	uacpi_system_memory_read (void *ptr, uacpi_size offset, uacpi_u8 width, uacpi_u64 *out)
uacpi_status	uacpi_system_memory_write (void *ptr, uacpi_size offset, uacpi_u8 width, uacpi_u64 in)
uacpi_status	uacpi_system_io_read (uacpi_handle handle, uacpi_size offset, uacpi_u8 width, uacpi_u64 *out)
uacpi_status	uacpi_system_io_write (uacpi_handle handle, uacpi_size offset, uacpi_u8 width, uacpi_u64 in)
uacpi_status	uacpi_pci_read (uacpi_handle handle, uacpi_size offset, uacpi_u8 width, uacpi_u64 *out)
uacpi_status	uacpi_pci_write (uacpi_handle handle, uacpi_size offset, uacpi_u8 width, uacpi_u64 in)

Macro Definition Documentation

uacpi_mmio_read16

#define uacpi_mmio_read16   uacpi_builtin_mmio_read16

Definition at line 89 of file io.h.

uacpi_mmio_read32

#define uacpi_mmio_read32   uacpi_builtin_mmio_read32

Definition at line 90 of file io.h.

uacpi_mmio_read64

#define uacpi_mmio_read64   uacpi_builtin_mmio_read64

Definition at line 91 of file io.h.

uacpi_mmio_read8

#define uacpi_mmio_read8   uacpi_builtin_mmio_read8

Definition at line 88 of file io.h.

uacpi_mmio_write16

#define uacpi_mmio_write16   uacpi_builtin_mmio_write16

Definition at line 94 of file io.h.

uacpi_mmio_write32

#define uacpi_mmio_write32   uacpi_builtin_mmio_write32

Definition at line 95 of file io.h.

uacpi_mmio_write64

#define uacpi_mmio_write64   uacpi_builtin_mmio_write64

Definition at line 96 of file io.h.

uacpi_mmio_write8

#define uacpi_mmio_write8   uacpi_builtin_mmio_write8

Definition at line 93 of file io.h.

Typedef Documentation

uacpi_mapped_gas

typedef struct uacpi_mapped_gas uacpi_mapped_gas

Function Documentation

uacpi_builtin_mmio_read16()

uacpi_u16 uacpi_builtin_mmio_read16

(

void *

ptr

)

Definition at line 1096 of file io.c.

{
    return *(volatile uacpi_u16*)ptr;
}

uacpi_builtin_mmio_read32()

uacpi_u32 uacpi_builtin_mmio_read32

(

void *

ptr

)

Definition at line 1101 of file io.c.

{
    return *(volatile uacpi_u32*)ptr;
}

uacpi_builtin_mmio_read64()

uacpi_u64 uacpi_builtin_mmio_read64

(

void *

ptr

)

Definition at line 1106 of file io.c.

{
    return *(volatile uacpi_u64*)ptr;
}

uacpi_builtin_mmio_read8()

uacpi_u8 uacpi_builtin_mmio_read8

(

void *

ptr

)

Definition at line 1091 of file io.c.

{
    return *(volatile uacpi_u8*)ptr;
}

uacpi_builtin_mmio_write16()

void uacpi_builtin_mmio_write16	(	void *	ptr,
		uacpi_u16	data
	)

Definition at line 1116 of file io.c.

{
    *(volatile uacpi_u16*)ptr = data;
}

uacpi_builtin_mmio_write32()

void uacpi_builtin_mmio_write32	(	void *	ptr,
		uacpi_u32	data
	)

Definition at line 1121 of file io.c.

{
    *(volatile uacpi_u32*)ptr = data;
}

uacpi_builtin_mmio_write64()

void uacpi_builtin_mmio_write64	(	void *	ptr,
		uacpi_u64	data
	)

Definition at line 1126 of file io.c.

{
    *(volatile uacpi_u64*)ptr = data;
}

uacpi_builtin_mmio_write8()

void uacpi_builtin_mmio_write8	(	void *	ptr,
		uacpi_u8	data
	)

Definition at line 1111 of file io.c.

{
    *(volatile uacpi_u8*)ptr = data;
}

uacpi_field_unit_get_bit_length()

uacpi_status uacpi_field_unit_get_bit_length	(	struct uacpi_field_unit *	field,
		uacpi_size *	out_length
	)

Definition at line 786 of file io.c.

{
    uacpi_object *obj;
 
    if (field->kind == UACPI_FIELD_UNIT_KIND_INDEX)
        goto out_basic_field;
 
    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;
 
    if (uacpi_is_buffer_access_address_space(obj->op_region->space)) {
        /*
         * Bit length is protocol specific, the data will be returned
         * via the write-then-read response buffer.
         */
        *out_length = 0;
        return UACPI_STATUS_OK;
    }
 
out_basic_field:
    *out_length = field->bit_length;
    return UACPI_STATUS_OK;
}

Referenced by field_byte_size().

uacpi_field_unit_get_read_type()

uacpi_status uacpi_field_unit_get_read_type	(	struct uacpi_field_unit *	field,
		uacpi_object_type *	out_type
	)

Definition at line 757 of file io.c.

{
    uacpi_object *obj;
 
    if (field->kind == UACPI_FIELD_UNIT_KIND_INDEX)
        goto out_basic_field;
 
    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;
 
    if (uacpi_is_buffer_access_address_space(obj->op_region->space)) {
        *out_type = UACPI_OBJECT_BUFFER;
        return UACPI_STATUS_OK;
    }
 
out_basic_field:
    if (field->bit_length > (g_uacpi_rt_ctx.is_rev1 ? 32u : 64u))
        *out_type = UACPI_OBJECT_BUFFER;
    else
        *out_type = UACPI_OBJECT_INTEGER;
 
    return UACPI_STATUS_OK;
}

Referenced by field_get_read_type().

uacpi_map_gas_noalloc()

uacpi_status uacpi_map_gas_noalloc	(	const struct acpi_gas *	gas,
		uacpi_mapped_gas *	out_mapped
	)

Definition at line 992 of file io.c.

{
    uacpi_status ret;
    uacpi_u8 access_bit_width, total_width;
 
    ret = gas_validate(gas, &access_bit_width, &total_width);
    if (ret != UACPI_STATUS_OK)
        return ret;
 
    if (gas->address_space_id == UACPI_ADDRESS_SPACE_SYSTEM_MEMORY) {
        out_mapped->mapping = uacpi_kernel_map(gas->address, total_width / 8);
        if (uacpi_unlikely(out_mapped->mapping == UACPI_MAP_FAILED))
            return UACPI_STATUS_MAPPING_FAILED;
 
        out_mapped->read = uacpi_system_memory_read;
        out_mapped->write = uacpi_system_memory_write;
        out_mapped->unmap = uacpi_kernel_unmap;
    } else { // IO, validated by gas_validate above
        ret = uacpi_kernel_io_map(gas->address, total_width / 8, &out_mapped->mapping);
        if (uacpi_unlikely_error(ret))
            return ret;
 
        out_mapped->read = uacpi_system_io_read;
        out_mapped->write = uacpi_system_io_write;
        out_mapped->unmap = unmap_gas_io;
    }
 
    out_mapped->access_bit_width = access_bit_width;
    out_mapped->total_bit_width = total_width;
    out_mapped->bit_offset = gas->register_bit_offset;
 
    return UACPI_STATUS_OK;
}

Referenced by create_gpe_block(), map_one(), uacpi_gas_read(), uacpi_gas_write(), and uacpi_map_gas().

uacpi_pci_read()

uacpi_status uacpi_pci_read	(	uacpi_handle	handle,
		uacpi_size	offset,
		uacpi_u8	width,
		uacpi_u64 *	out
	)

Definition at line 1250 of file io.c.

{
    uacpi_status ret;
    union integer_data data = {
        .qword = 0,
    };
 
    switch (width) {
    case 1:
        ret = uacpi_kernel_pci_read8(handle, offset, &data.byte);
        break;
    case 2:
        ret = uacpi_kernel_pci_read16(handle, offset, &data.word);
        break;
    case 4:
        ret = uacpi_kernel_pci_read32(handle, offset, &data.dword);
        break;
    default:
        uacpi_error(
            "invalid PCI_Config read %p@%zu width=%d",
            handle, offset, width
        );
        return UACPI_STATUS_INVALID_ARGUMENT;
    }
 
    if (uacpi_likely_success(ret))
        *out = data.qword;
    return ret;
}

Referenced by pci_region_do_rw().

uacpi_pci_write()

uacpi_status uacpi_pci_write	(	uacpi_handle	handle,
		uacpi_size	offset,
		uacpi_u8	width,
		uacpi_u64	in
	)

Definition at line 1282 of file io.c.

{
    uacpi_status ret;
 
    switch (width) {
    case 1:
        ret = uacpi_kernel_pci_write8(handle, offset, in);
        break;
    case 2:
        ret = uacpi_kernel_pci_write16(handle, offset, in);
        break;
    case 4:
        ret = uacpi_kernel_pci_write32(handle, offset, in);
        break;
    default:
        uacpi_error(
            "invalid PCI_Config write %p@%zu width=%d",
            handle, offset, width
        );
        return UACPI_STATUS_INVALID_ARGUMENT;
    }
 
    return ret;
}

Referenced by pci_region_do_rw().

uacpi_read_buffer_field()

void uacpi_read_buffer_field	(	const uacpi_buffer_field *	field,
		void *	dst
	)

Definition at line 113 of file io.c.

{
    // There's nothing to read from a buffer field that's empty
    if (uacpi_unlikely(field->bit_length == 0))
        return;
 
    if (!(field->bit_index & 7)) {
        uacpi_u8 *src = field->backing->data;
        uacpi_size count;
 
        count = uacpi_round_up_bits_to_bytes(field->bit_length);
        uacpi_memcpy(dst, src + (field->bit_index / 8), count);
        cut_misaligned_tail(dst, count - 1, field->bit_length);
        return;
    }
 
    do_misaligned_buffer_read(field, dst);
}

Referenced by handle_field_read(), and handle_inc_dec().

uacpi_read_field_unit()

uacpi_status uacpi_read_field_unit	(	uacpi_field_unit *	field,
		void *	dst,
		uacpi_size	size,
		uacpi_data_view *	wtr_response
	)

Definition at line 558 of file io.c.

{
    uacpi_status ret;
    uacpi_u32 field_byte_length;
    uacpi_bool did_handle;
    uacpi_data_view data_view = { 0 };
 
    data_view.data = dst;
    data_view.length = size;
 
    ret = lock_field_unit_transaction(field);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    ret = handle_special_field(
        field, data_view, UACPI_REGION_OP_READ,
        wtr_response, &did_handle
    );
    if (did_handle)
        goto out;
 
    // There's nothing to read from a field that the AML declared as empty
    if (uacpi_unlikely(field->bit_length == 0)) {
        uacpi_memzero(dst, size);
        goto out;
    }
 
    field_byte_length = uacpi_round_up_bits_to_bytes(field->bit_length);
 
    /*
     * Very simple fast case:
     * - Bit offset within first byte is 0
     * AND
     * - Field size is <= access width
     */
    if (field->bit_offset_within_first_byte == 0 &&
        field_byte_length <= field->access_width_bytes)
    {
        uacpi_u64 out;
        union uacpi_opregion_io_data data;
 
        data.integer = &out;
        ret = access_field_unit(
            field, field->byte_offset, UACPI_REGION_OP_READ,
            data
        );
        if (uacpi_unlikely_error(ret))
            goto out;
 
        uacpi_memcpy_zerout(dst, &out, size, field_byte_length);
        if (size >= field_byte_length)
            cut_misaligned_tail(dst, field_byte_length - 1, field->bit_length);
 
        goto out;
    }
 
    // Slow case
    ret = do_read_misaligned_field_unit(field, dst, size);
 
out:
    unlock_field_unit_transaction(field);
    return ret;
}

Referenced by access_field_unit(), handle_field_read(), and handle_inc_dec().

uacpi_round_up_bits_to_bytes()

uacpi_size uacpi_round_up_bits_to_bytes

(

uacpi_size

bit_length

)

Definition at line 11 of file io.c.

{
    return UACPI_ALIGN_UP(bit_length, 8, uacpi_size) / 8;
}

Referenced by do_misaligned_buffer_read(), field_byte_size(), object_assign_with_implicit_cast(), uacpi_read_buffer_field(), uacpi_read_field_unit(), uacpi_write_buffer_field(), and uacpi_write_field_unit_in_chunks().

uacpi_system_io_read()

uacpi_status uacpi_system_io_read	(	uacpi_handle	handle,
		uacpi_size	offset,
		uacpi_u8	width,
		uacpi_u64 *	out
	)

Definition at line 1191 of file io.c.

{
    uacpi_status ret;
    union integer_data data = {
        .qword = 0,
    };
 
    switch (width) {
    case 1:
        ret = uacpi_kernel_io_read8(handle, offset, &data.byte);
        break;
    case 2:
        ret = uacpi_kernel_io_read16(handle, offset, &data.word);
        break;
    case 4:
        ret = uacpi_kernel_io_read32(handle, offset, &data.dword);
        break;
    default:
        uacpi_error(
            "invalid SystemIO read %p@%zu width=%d",
            handle, offset, width
        );
        return UACPI_STATUS_INVALID_ARGUMENT;
    }
 
    if (uacpi_likely_success(ret))
        *out = data.qword;
    return ret;
}

Referenced by io_region_do_rw(), and uacpi_map_gas_noalloc().

uacpi_system_io_write()

uacpi_status uacpi_system_io_write	(	uacpi_handle	handle,
		uacpi_size	offset,
		uacpi_u8	width,
		uacpi_u64	in
	)

Definition at line 1223 of file io.c.

{
    uacpi_status ret;
 
    switch (width) {
    case 1:
        ret = uacpi_kernel_io_write8(handle, offset, in);
        break;
    case 2:
        ret = uacpi_kernel_io_write16(handle, offset, in);
        break;
    case 4:
        ret = uacpi_kernel_io_write32(handle, offset, in);
        break;
    default:
        uacpi_error(
            "invalid SystemIO write %p@%zu width=%d",
            handle, offset, width
        );
        return UACPI_STATUS_INVALID_ARGUMENT;
    }
 
    return ret;
}

Referenced by io_region_do_rw(), and uacpi_map_gas_noalloc().

uacpi_system_memory_read()

uacpi_status uacpi_system_memory_read	(	void *	ptr,
		uacpi_size	offset,
		uacpi_u8	width,
		uacpi_u64 *	out
	)

Definition at line 1132 of file io.c.

{
    ptr = UACPI_PTR_ADD(ptr, offset);
 
    switch (width) {
    case 1:
        *out = uacpi_mmio_read8(ptr);
        break;
    case 2:
        *out = uacpi_mmio_read16(ptr);
        break;
    case 4:
        *out = uacpi_mmio_read32(ptr);
        break;
    case 8:
        *out = uacpi_mmio_read64(ptr);
        break;
    default:
        return UACPI_STATUS_INVALID_ARGUMENT;
    }
 
    return UACPI_STATUS_OK;
}

Referenced by memory_region_do_rw(), table_data_region_do_rw(), and uacpi_map_gas_noalloc().

uacpi_system_memory_write()

uacpi_status uacpi_system_memory_write	(	void *	ptr,
		uacpi_size	offset,
		uacpi_u8	width,
		uacpi_u64	in
	)

Definition at line 1158 of file io.c.

{
    ptr = UACPI_PTR_ADD(ptr, offset);
 
    switch (width) {
    case 1:
        uacpi_mmio_write8(ptr, in);
        break;
    case 2:
        uacpi_mmio_write16(ptr, in);
        break;
    case 4:
        uacpi_mmio_write32(ptr, in);
        break;
    case 8:
        uacpi_mmio_write64(ptr, in);
        break;
    default:
        return UACPI_STATUS_INVALID_ARGUMENT;
    }
 
    return UACPI_STATUS_OK;
}

Referenced by memory_region_do_rw(), table_data_region_do_rw(), and uacpi_map_gas_noalloc().

uacpi_unmap_gas_nofree()

void uacpi_unmap_gas_nofree

(

uacpi_mapped_gas *

gas

)

Definition at line 1049 of file io.c.

{
    gas->unmap(gas->mapping, gas->access_bit_width / 8);
}

Referenced by free_gpe_block(), uacpi_deinitialize_registers(), uacpi_gas_read(), uacpi_gas_write(), and uacpi_unmap_gas().

uacpi_write_buffer_field()

void uacpi_write_buffer_field	(	uacpi_buffer_field *	field,
		const void *	src,
		uacpi_size	size
	)

Definition at line 152 of file io.c.

{
    // There's nothing to write to a buffer field that's empty
    if (uacpi_unlikely(field->bit_length == 0))
        return;
 
    if (!(field->bit_index & 7)) {
        uacpi_u8 *dst, last_byte, tail_shift;
        uacpi_size count;
 
        dst = field->backing->data;
        dst += field->bit_index / 8;
        count = uacpi_round_up_bits_to_bytes(field->bit_length);
 
        last_byte = dst[count - 1];
        tail_shift = field->bit_length & 7;
 
        uacpi_memcpy_zerout(dst, src, count, size);
        if (tail_shift) {
            uacpi_u8 last_shift = 8 - tail_shift;
            dst[count - 1] = dst[count - 1] << last_shift;
            dst[count - 1] >>= last_shift;
            dst[count - 1] |= (last_byte >> tail_shift) << tail_shift;
        }
 
        return;
    }
 
    do_write_misaligned_buffer_field(field, src, size);
}

Referenced by object_assign_with_implicit_cast().

uacpi_write_field_unit()

uacpi_status uacpi_write_field_unit	(	uacpi_field_unit *	field,
		const void *	src,
		uacpi_size	size,
		uacpi_data_view *	wtr_response
	)

Definition at line 738 of file io.c.

{
    return write_field_unit(field, src, size, size, wtr_response);
}

Referenced by access_field_unit(), and store_to_field_unit().

uacpi_write_field_unit_in_chunks()

uacpi_status uacpi_write_field_unit_in_chunks	(	uacpi_field_unit *	field,
		const void *	src,
		uacpi_size	size,
		uacpi_data_view *	wtr_response
	)

Definition at line 746 of file io.c.

{
    return write_field_unit(
        field, src, size, uacpi_round_up_bits_to_bytes(field->bit_length),
        wtr_response
    );
}

Referenced by store_to_field_unit().