uio 0.6.0

Helper library for writing linux user-space drivers with UIO.
Documentation

Linux UIO library for Rust

A thin abstraction library for writing user-space drivers in Linux by using the UIO facility (https://www.kernel.org/doc/html/latest/driver-api/uio-howto.html).

In order to use this library, you'll need to make sure your device uses the Linux UIO driver module. For example, the following sample commands unload the ahci driver in Linux and use the uio_pci_generic module for the SSD disk for the PCI device with vendor 0x8086 and device id 0x1d02. (Note: Dangerous, don't do this if you don't know what you're doing).

$ modprobe -r ahci
$ sudo modprobe uio
$ sudo modprobe uio_pci_generic
$ echo "0x8086 0x1d02" > /sys/bus/pci/drivers/uio_pci_generic/new_id
$ lspci -v -d :0x1d02 | grep "Kernel driver in use"

Afterwards you should have one or more uio devices available in /dev/uio* which you can use to instantiate the UioDevice struct:

use uio::UioDevice;

fn main() {
    let uio_num = 1; // /dev/uio1
    let dev = UioDevice::try_new(uio_num).unwrap();
    let mmap = dev.map_resource(5).unwrap();
}

For async projects, the async-tokio feature can be enabled, which allows async waiting for an IRQ:

async fn main() {
    let uio_num = 1; // /dev/uio1
    let dev = UioDevice::try_new(uio_num).unwrap();
    let mut async_uio: AsyncFd<UioDevice> = dev.try_into().unwrap();
    async_uio.get_mut().irq_enable().unwrap();
    async_uio.irq_wait().await.unwrap(); // Call irq_wait() directly on AsyncFd<UioDevice>
}

Development

This repository contains a Nix flake with a default development shell that can be used for Rust development. Some information to setup Nix can be found here.

To build this project:

nix develop
cargo build

Resources

For more information about UIO check the following links: