Struct NAPOTRegionSpec

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

A RISC-V PMP memory region specification, configured in NAPOT mode.

This type checks that the supplied start and size values meet the RISC-V NAPOT requirements, namely that

  • the region is a power of two bytes in size
  • the region’s start address is aligned to the region size
  • the region is at least 8 bytes long

By accepting this type, PMP implementations can rely on these requirements to be verified. Furthermore, they can use the NAPOTRegionSpec::napot_addr convenience method to retrieve an pmpaddrX CSR value encoding this region’s address and length.

Implementations§

Source§

impl NAPOTRegionSpec

Source

pub fn new(start: *const u8, size: usize) -> Option<Self>

Construct a new NAPOTRegionSpec

This method accepts a start address and a region length. It returns Some(region) when all constraints specified in the NAPOTRegionSpec’s documentation are satisfied, otherwise None.

Source

pub fn start(&self) -> *const u8

Retrieve the start address of this NAPOTRegionSpec.

Source

pub fn size(&self) -> usize

Retrieve the size of this NAPOTRegionSpec.

Source

pub fn end(&self) -> *const u8

Retrieve the end address of this NAPOTRegionSpec.

Source

pub fn napot_addr(&self) -> usize

Retrieve a pmpaddrX-CSR compatible representation of this NAPOTRegionSpec’s address and length. For this value to be valid in a CSR register, the pmpcfgX octet’s A (address mode) value belonging to this pmpaddrX-CSR must be set to NAPOT (0b11).

Trait Implementations§

Source§

impl Clone for NAPOTRegionSpec

Source§

fn clone(&self) -> NAPOTRegionSpec

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NAPOTRegionSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for NAPOTRegionSpec

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> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.