Skip to main content

CoherentView

kernel::dma

Struct CoherentView 

Source 
pub struct CoherentView<'a, T: ?Sized> { /* private fields */ }
Expand description

View type for Coherent.

This is same as SysMem but with additional information that allows handing out a DMA handle.

Implementations§

Source§

impl<'a, T: ?Sized> CoherentView<'a, T>

Source

pub fn as_sys_mem(self) -> SysMem<'a, T>

Erase the DMA handle information and obtain a SysMem view of the same memory region.

Source

pub fn dma_handle(self) -> DmaAddress

Returns a DMA handle which may be given to the device as the DMA address base of the region.

Source

pub unsafe fn as_ref(self) -> &'a T

Returns a reference to the data in the region.

§Safety
  • Callers must ensure that the device does not read/write to/from memory while the returned reference is live.
  • Callers must ensure that this call does not race with a write (including call to as_mut) to the same region while the returned reference is live.
Source

pub unsafe fn as_mut(self) -> &'a mut T

Returns a mutable reference to the data in the region.

§Safety
  • Callers must ensure that the device does not read/write to/from memory while the returned reference is live.
  • Callers must ensure that this call does not race with a read (including call to as_ref) or write (including call to as_mut) to the same region while the returned reference is live.

Trait Implementations§

Source§

impl<T: ?Sized> Clone for CoherentView<'_, T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: ?Sized> Copy for CoherentView<'_, T>

Source§

impl<'a, T: ?Sized + KnownSize> IoBase<'a> for CoherentView<'a, T>

Source§

type Backend = CoherentIoBackend

Type that defines all I/O operations.
Source§

type Target = T

Type of this I/O region. For untyped regions, Region can be used.
Source§

fn as_view(self) -> CoherentView<'a, Self::Target>

Return a view that covers the full region.

Auto Trait Implementations§

§

impl<'a, T> Freeze for CoherentView<'a, T>
where T: ?Sized,

§

impl<'a, T> RefUnwindSafe for CoherentView<'a, T>
where T: RefUnwindSafe + ?Sized,

§

impl<'a, T> Send for CoherentView<'a, T>
where T: Sync + ?Sized,

§

impl<'a, T> Sync for CoherentView<'a, T>
where T: Sync + ?Sized,

§

impl<'a, T> Unpin for CoherentView<'a, T>
where T: ?Sized,

§

impl<'a, T> UnsafeUnpin for CoherentView<'a, T>
where T: ?Sized,

§

impl<'a, T> UnwindSafe for CoherentView<'a, T>
where T: RefUnwindSafe + ?Sized,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<'a, T> Io<'a> for T
where T: IoBase<'a>,

Source§

fn size(self) -> usize

Returns the size of this I/O region.
Source§

fn len<T>(self) -> usize
where Self: Io<'a, Target = [T]>,

Returns the length of the slice in number of elements.
Source§

fn is_empty<T>(self) -> bool
where Self: Io<'a, Target = [T]>,

Returns true if the slice has a length of 0.
Source§

fn try_cast<U>(self) -> Result<<Self::Backend as IoBackend>::View<'a, U>>
where Self::Target: FromBytes + IntoBytes, U: FromBytes + IntoBytes,

Try to convert into a different typed I/O view. Read more
Source§

fn read_val(self) -> Self::Target
where Self::Backend: IoCapable<Self::Target>, Self::Target: Sized,

Read a value from I/O. Read more
Source§

fn write_val(self, value: Self::Target)
where Self::Backend: IoCapable<Self::Target>, Self::Target: Sized,

Write a value to I/O. Read more
Source§

fn copy_read(self) -> Self::Target
where Self::Backend: IoCopyable, Self::Target: Sized + FromBytes,

Copy-read from I/O memory. Read more
Source§

fn copy_write(self, value: Self::Target)
where Self::Backend: IoCopyable, Self::Target: Sized + IntoBytes,

Copy-write to I/O memory. Read more
Source§

fn copy_from_slice(self, data: &[u8])
where Self::Backend: IoCopyable, Self: Io<'a, Target = [u8]>,

Copy bytes from data to I/O memory. Read more
Source§

fn copy_to_slice(self, data: &mut [u8])
where Self::Backend: IoCopyable, Self: Io<'a, Target = [u8]>,

Copy bytes from I/O memory to data. Read more
Source§

fn try_read8(self, offset: usize) -> Result<u8>
where usize: IoLoc<Self::Target, u8, IoType = u8>, Self::Backend: IoCapable<u8>,

Fallible 8-bit read with runtime bounds check.
Source§

fn try_read16(self, offset: usize) -> Result<u16>
where usize: IoLoc<Self::Target, u16, IoType = u16>, Self::Backend: IoCapable<u16>,

Fallible 16-bit read with runtime bounds check.
Source§

fn try_read32(self, offset: usize) -> Result<u32>
where usize: IoLoc<Self::Target, u32, IoType = u32>, Self::Backend: IoCapable<u32>,

Fallible 32-bit read with runtime bounds check.
Source§

fn try_read64(self, offset: usize) -> Result<u64>
where usize: IoLoc<Self::Target, u64, IoType = u64>, Self::Backend: IoCapable<u64>,

Fallible 64-bit read with runtime bounds check.
Source§

fn try_write8(self, value: u8, offset: usize) -> Result
where usize: IoLoc<Self::Target, u8, IoType = u8>, Self::Backend: IoCapable<u8>,

Fallible 8-bit write with runtime bounds check.
Source§

fn try_write16(self, value: u16, offset: usize) -> Result
where usize: IoLoc<Self::Target, u16, IoType = u16>, Self::Backend: IoCapable<u16>,

Fallible 16-bit write with runtime bounds check.
Source§

fn try_write32(self, value: u32, offset: usize) -> Result
where usize: IoLoc<Self::Target, u32, IoType = u32>, Self::Backend: IoCapable<u32>,

Fallible 32-bit write with runtime bounds check.
Source§

fn try_write64(self, value: u64, offset: usize) -> Result
where usize: IoLoc<Self::Target, u64, IoType = u64>, Self::Backend: IoCapable<u64>,

Fallible 64-bit write with runtime bounds check.
Source§

fn read8(self, offset: usize) -> u8
where usize: IoLoc<Self::Target, u8, IoType = u8>, Self::Backend: IoCapable<u8>,

Infallible 8-bit read with compile-time bounds check.
Source§

fn read16(self, offset: usize) -> u16
where usize: IoLoc<Self::Target, u16, IoType = u16>, Self::Backend: IoCapable<u16>,

Infallible 16-bit read with compile-time bounds check.
Source§

fn read32(self, offset: usize) -> u32
where usize: IoLoc<Self::Target, u32, IoType = u32>, Self::Backend: IoCapable<u32>,

Infallible 32-bit read with compile-time bounds check.
Source§

fn read64(self, offset: usize) -> u64
where usize: IoLoc<Self::Target, u64, IoType = u64>, Self::Backend: IoCapable<u64>,

Infallible 64-bit read with compile-time bounds check.
Source§

fn write8(self, value: u8, offset: usize)
where usize: IoLoc<Self::Target, u8, IoType = u8>, Self::Backend: IoCapable<u8>,

Infallible 8-bit write with compile-time bounds check.
Source§

fn write16(self, value: u16, offset: usize)
where usize: IoLoc<Self::Target, u16, IoType = u16>, Self::Backend: IoCapable<u16>,

Infallible 16-bit write with compile-time bounds check.
Source§

fn write32(self, value: u32, offset: usize)
where usize: IoLoc<Self::Target, u32, IoType = u32>, Self::Backend: IoCapable<u32>,

Infallible 32-bit write with compile-time bounds check.
Source§

fn write64(self, value: u64, offset: usize)
where usize: IoLoc<Self::Target, u64, IoType = u64>, Self::Backend: IoCapable<u64>,

Infallible 64-bit write with compile-time bounds check.
Source§

fn try_read<T, L>(self, location: L) -> Result<T>
where L: IoLoc<Self::Target, T>, Self::Backend: IoCapable<L::IoType>,

Generic fallible read with runtime bounds check. Read more
Source§

fn try_write<T, L>(self, location: L, value: T) -> Result
where L: IoLoc<Self::Target, T>, Self::Backend: IoCapable<L::IoType>,

Generic fallible write with runtime bounds check. Read more
Source§

fn try_write_reg<T, L, V>(self, value: V) -> Result
where L: IoLoc<Self::Target, T>, V: LocatedRegister<Self::Target, Location = L, Value = T>, Self::Backend: IoCapable<L::IoType>,

Generic fallible write of a fully-located register value. Read more
Source§

fn try_update<T, L, F>(self, location: L, f: F) -> Result
where L: IoLoc<Self::Target, T>, Self::Backend: IoCapable<L::IoType>, F: FnOnce(T) -> T,

Generic fallible update with runtime bounds check. Read more
Source§

fn read<T, L>(self, location: L) -> T
where L: IoLoc<Self::Target, T>, Self::Backend: IoCapable<L::IoType>,

Generic infallible read with compile-time bounds check. Read more
Source§

fn write<T, L>(self, location: L, value: T)
where L: IoLoc<Self::Target, T>, Self::Backend: IoCapable<L::IoType>,

Generic infallible write with compile-time bounds check. Read more
Source§

fn write_reg<T, L, V>(self, value: V)
where L: IoLoc<Self::Target, T>, V: LocatedRegister<Self::Target, Location = L, Value = T>, Self::Backend: IoCapable<L::IoType>,

Generic infallible write of a fully-located register value. Read more
Source§

fn update<T, L, F>(self, location: L, f: F)
where L: IoLoc<Self::Target, T>, Self::Backend: IoCapable<L::IoType>, F: FnOnce(T) -> T,

Generic infallible update with compile-time bounds check. Read more
Source§

impl<T> KnownSize for T

Source§

const MIN_SIZE: usize = const MIN_SIZE: usize = size_of::<T>();

Minimum size of this type known at compile-time.
Source§

const MIN_ALIGN: Alignment = const MIN_ALIGN: Alignment = Alignment::of::<T>();

Minimum alignment of this type known at compile-time.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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