Struct DmaRegion

pub struct DmaRegion<T: DeviceSync> { /* private fields */ }

A region of DMA memory, represented in virtual memory as type T, with a particular access mode and options.

Implementations

impl<'a, T: DeviceSync> DmaRegion<T>

pub fn nr_pages(&self) -> usize

Calculate the number of pages this region covers.

pub fn num_bytes(&self) -> usize

Return the number of bytes this region covers.

pub fn access(&self) -> Access

Return the access direction of this region.

pub fn pin(&mut self) -> Result<DmaPin<'_>, PinError>

pub fn sync(&self, sync: SyncMode)

pub fn with<F, R>(&self, f: F) -> R

where F: FnOnce(&T) -> R,

pub fn with_mut<F, R>(&mut self, f: F) -> R

where F: FnOnce(&mut T) -> R,

pub unsafe fn release_pin(&mut self)

Release any pin created for this region.

Safety

Caller must ensure that no device is using the information from any active pins for this region.

pub unsafe fn get(&self) -> &T

Get a reference to the DMA memory.

Safety

The caller must ensure coherence is applied.

pub unsafe fn get_mut(&mut self) -> &mut T

Get a mutable reference to the DMA memory.

Safety

The caller must ensure coherence is applied.

Trait Implementations

impl<T: DeviceSync> Debug for DmaRegion<T>

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

Formats the value using the given formatter.

impl<'a, T: DeviceSync> Drop for DmaRegion<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: DeviceSync> Send for DmaRegion<T>