jelly-mem_access 0.1.4

Memory Mapped I/O access library
Documentation

Memory Mapped I/O access library

Crates.io MIT licensed

Overview

This is a library for accessing memory-mapped I/O.

It assists register access using UIO(User space I/O) and bare-metal access with no_std.

It also assists access using u-dma-buf.

MMIO(Memory Mapped I/O)

mmio access in bare-metal programming can be written as follows.

    type RegisterWordSize = u64;
    let mmio_acc = MmioAccessor::<RegisterWordSize>::new(0xffff0000, 0x10000);
    mmio_acc.write_mem8 (0x00, 0x12);       // addr : 0xffff0000
    mmio_acc.write_mem16(0x02, 0x1234);     // addr : 0xffff0002
    mmio_acc.write_reg32(0x10, 0x12345678); // addr : 0xffff0080 <= 0x10 * size_of<RegisterWordSize>()
    mmio_acc.read_reg32(0x10);              // addr : 0xffff0080 <= 0x10 * size_of<RegisterWordSize>()

UIO(Userspace I/O)

UIO access in Linux programming can be written as follows.

    type RegisterWordSize = usize;
    let uio_num = 1;  // ex.) /dev/uio1
    let uio_acc = MmioAccessor::<RegisterWordSize>::new(uio_num);
    uio_acc.set_irq_enable(true);
    uio_acc.write_reg32(0x00, 0x1);
    uio_acc.wait_irq();

u-dma-buf

u-dma-buf access in Linux programming can be written as follows.

    let udmabuf_num = 4;  // ex.) /dev/udmabuf4
    let udmabuf_acc = UdmabufAccessor::<usize>::new(udmabuf_num, false).unwrap();
    println!("udmabuf4 phys addr : 0x{:x}", udmabuf_acc.phys_addr());
    println!("udmabuf4 size      : 0x{:x}", udmabuf_acc.size());
    udmabuf_acc.write_mem32(0x00, 0x1234);