Struct uio::UioDevice

pub struct UioDevice { /* private fields */ }

Implementations

impl UioDevice

pub fn new(uio_num: usize) -> Result<UioDevice>

Creates a new UIO device for Linux.

Arguments

• uio_num - UIO index of device (i.e., 1 for /dev/uio1)

pub fn get_resource_info(&mut self) -> Result<Vec<(String, u64)>, UioError>

Return a vector of mappable resources (i.e., PCI bars) including their size.

pub fn map_resource(&self, bar_nr: usize) -> Result<*mut c_void, UioError>

Maps a given resource into the virtual address space of the process.

Arguments

• bar_nr: The index to the given resource (i.e., 1 for /sys/class/uio/uioX/device/resource1)

pub fn get_event_count(&self) -> Result<u32, UioError>

The amount of events.

pub fn get_name(&self) -> Result<String, UioError>

The name of the UIO device.

pub fn get_version(&self) -> Result<String, UioError>

The version of the UIO driver.

pub fn map_size(&self, mapping: usize) -> Result<usize, UioError>

The size of a given mapping.

Arguments

• mapping: The given index of the mapping (i.e., 1 for /sys/class/uio/uioX/maps/map1)

pub fn map_addr(&self, mapping: usize) -> Result<usize, UioError>

The address of a given mapping.

Arguments

• mapping: The given index of the mapping (i.e., 1 for /sys/class/uio/uioX/maps/map1)

pub fn get_map_info(&mut self) -> Result<Vec<String>, UioError>

Return a list of all possible memory mappings.

pub fn map_mapping(&self, mapping: usize) -> Result<*mut c_void, UioError>

Map an available memory mapping.

Arguments

• mapping: The given index of the mapping (i.e., 1 for /sys/class/uio/uioX/maps/map1)

pub fn irq_enable(&mut self) -> Result<()>

Enable interrupt

pub fn irq_disable(&mut self) -> Result<()>

Disable interrupt

pub fn irq_wait(&mut self) -> Result<u32>

Wait for interrupt