Struct dma_boom::DmaBuf

pub struct DmaBuf(pub(crate) OwnedFd);

A DMA-Buf buffer

Tuple Fields

0: OwnedFd

Implementations

impl DmaBuf

pub(crate) fn memory_map(&self) -> Result<(usize, *mut u8), MapError>

pub fn memory_map_ro(&self) -> Result<MappedDmaBufRo<'_>, MapError>

Maps a DmaBuf for the CPU to access it read-

DMA-Buf requires the user-space to call the DMA_BUF_IOCTL_SYNC ioctl before and after any CPU access to a buffer in order to maintain the cache coherency.

Panics

If the buffer size reported by the kernel (i64) cannot fit into an usize.

Errors

Will return an error if either the Buffer’s length can’t be retrieved, or if the mmap call fails.

pub fn memory_map_rw(&mut self) -> Result<MappedDmaBufRw<'_>, MapError>

Maps a DmaBuf for the CPU to access it read-write

DMA-Buf requires the user-space to call the DMA_BUF_IOCTL_SYNC ioctl before and after any CPU access to a buffer in order to maintain the cache coherency.

Panics

If the buffer size reported by the kernel (i64) cannot fit into an usize.

Errors

Will return an error if either the Buffer’s length can’t be retrieved, or if the mmap call fails.

pub fn memory_map_wo(&mut self) -> Result<MappedDmaBufWo<'_>, MapError>

Maps a DmaBuf for the CPU to access it write-only

DMA-Buf requires the user-space to call the DMA_BUF_IOCTL_SYNC ioctl before and after any CPU access to a buffer in order to maintain the cache coherency.

Panics

If the buffer size reported by the kernel (i64) cannot fit into an usize.

Errors

Will return an error if either the Buffer’s length can’t be retrieved, or if the mmap call fails.

Trait Implementations

impl AsFd for DmaBuf

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for DmaBuf

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for DmaBuf

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<OwnedFd> for DmaBuf

fn from(owned: OwnedFd) -> Self

Converts to this type from the input type.

impl FromRawFd for DmaBuf

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.