Skip to main content

CoherentHandle

Struct CoherentHandle 

Source
pub struct CoherentHandle { /* private fields */ }
Expand description

An opaque DMA allocation without a kernel virtual mapping.

Unlike Coherent, a CoherentHandle does not provide CPU access to the allocated memory. The allocation is always performed with DMA_ATTR_NO_KERNEL_MAPPING, meaning no kernel virtual mapping is created for the buffer. The value returned by the C API as the CPU address is an opaque handle used only to free the allocation.

This is useful for buffers that are only ever accessed by hardware.

§Invariants

  • cpu_handle holds the opaque handle returned by dma_alloc_attrs with DMA_ATTR_NO_KERNEL_MAPPING set, and is only valid for passing back to dma_free_attrs.
  • dma_handle is the corresponding bus address for device DMA.
  • size is the allocation size in bytes as passed to dma_alloc_attrs.
  • dma_attrs contains the attributes used for the allocation, always including DMA_ATTR_NO_KERNEL_MAPPING.

Implementations§

Source§

impl CoherentHandle

Source

pub fn alloc_with_attrs( dev: &Device<Bound>, size: usize, gfp_flags: Flags, dma_attrs: Attrs, ) -> Result<Self>

Allocates size bytes of coherent DMA memory without creating a kernel virtual mapping.

Additional DMA attributes may be passed via dma_attrs; DMA_ATTR_NO_KERNEL_MAPPING is always set implicitly.

Returns EINVAL if size is zero, ENOMEM if the allocation fails.

Source

pub fn alloc(dev: &Device<Bound>, size: usize, gfp_flags: Flags) -> Result<Self>

Allocates size bytes of coherent DMA memory without creating a kernel virtual mapping.

Source

pub fn dma_handle(&self) -> DmaAddress

Returns the DMA handle for this allocation.

This address can be programmed into device hardware for DMA access.

Source

pub fn size(&self) -> usize

Returns the size in bytes of this allocation.

Trait Implementations§

Source§

impl Drop for CoherentHandle

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for CoherentHandle

Source§

impl Sync for CoherentHandle

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Init<T> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more
Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> KnownSize for T

Source§

fn size(_: *const T) -> usize

Get the size of an object of this type in bytes, with the metadata of the given pointer.
Source§

impl<T> PinInit<T> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U, const N: u32> TryIntoBounded<T, N> for U
where T: Integer, U: TryInto<T>,

Source§

fn try_into_bounded(self) -> Option<Bounded<T, N>>

Attempts to convert self into a Bounded using N bits. Read more