embassy-mspm0

Crates

git

Versions

mspm0g3519pt

Flavors

Trng

Struct Trng 

Source
pub struct Trng<'d, L: SecurityMarker> { /* private fields */ }
Expand description

True Random Number Generator (TRNG) Driver for MSPM0 series.

The driver provides blocking random numbers with TryRngCore methods and asynchronous counterparts in Trng::async_read_u32, Trng::async_read_u64, and Trng::async_read_bytes.

The TRNG can be configured with different decimation rates. See DecimRate, FastDecimRate, and CryptoDecimRate. The TRNG can be instantiated with Trng::new, Trng::new_fast, or Trng::new_secure.

Usage example:

#![no_std]
#![no_main]

use embassy_executor::Spawner;
use embassy_mspm0::Config;
use embassy_mspm0::trng::Trng;
use rand_core::TryRngCore;
use {defmt_rtt as _, panic_halt as _};

#[embassy_executor::main]
async fn main(_spawner: Spawner) -> ! {
    let p = embassy_mspm0::init(Config::default());
    let mut trng = Trng::new(p.TRNG).expect("Failed to initialize TRNG");
    let mut randomness = [0u8; 16];

    loop {
        trng.fill_bytes(&mut randomness).unwrap();
        assert_ne!(randomness, [0u8; 16]);
    }
}

Implementations§

Source§

impl<'d> Trng<'d, Crypto>

Source

pub fn new(peripheral: Peri<'d, TRNG>) -> Result<Self, Error>

Setup a TRNG driver with the default safe decimation rate (Decim4).

Source§

impl<'d> Trng<'d, Fast>

Source

pub fn new_fast( peripheral: Peri<'d, TRNG>, rate: FastDecimRate, ) -> Result<Self, Error>

Setup a TRNG driver with a specific fast decimation rate.

The created TRNG is not suitable for cryptography. Use Trng::new_secure instead.
Source§

impl<'d> Trng<'d, Crypto>

Source

pub fn new_secure( peripheral: Peri<'d, TRNG>, rate: CryptoDecimRate, ) -> Result<Self, Error>

Setup a TRNG driver with a specific cryptographic decimation rate.

Source§

impl<'d, D: SecurityMarker> Trng<'d, D>

Source

pub fn fail_reset(&mut self) -> Result<(), Error>

L-series TRM 13.2.5.2(10): procedure for recovering from a failed read.

This method reinitializes the TRNG which may take some time to complete.

Source

pub async fn async_read_u32(&mut self) -> Result<u32, Error>

Asynchronously read a 32-bit random value from the TRNG.

The synchronous counterpart is given by TryRngCore::try_next_u32.

As with the synchronous methods, an Err may be retried up to two times after calling Trng::fail_reset.

Source

pub async fn async_read_u64(&mut self) -> Result<u64, Error>

Asynchronously read a 64-bit random value from the TRNG.

The synchronous counterpart is given by TryRngCore::try_next_u64.

As with the synchronous methods, an Err may be retried up to two times after calling Trng::fail_reset.

Source

pub async fn async_read_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Asynchronously fill dest with random bytes from the TRNG.

The synchronous counterpart is given by TryRngCore::try_fill_bytes.

As with the synchronous methods, an Err may be retried up to two times after calling Trng::fail_reset.

Note When an error condition occurs, the buffer may be partially filled.

Trait Implementations§

Source§

impl<D: SecurityMarker> TryRngCore for Trng<'_, D>

Implements the fallible TryRngCore.

If any of the methods give an Err, the operation may be retried up to two times after calling Trng::fail_reset.

Source§

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Note When an error condition occurs, the buffer may be partially filled.

Source§

type Error = Error

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

fn try_next_u32(&mut self) -> Result<u32, Error>

Return the next random u32.
Source§

fn try_next_u64(&mut self) -> Result<u64, Error>

Return the next random u64.
Source§

fn unwrap_err(self) -> UnwrapErr<Self>
where Self: Sized,

Wrap RNG with the UnwrapErr wrapper.
Source§

fn unwrap_mut(&mut self) -> UnwrapMut<'_, Self>

Wrap RNG with the UnwrapMut wrapper.
Source§

impl TryCryptoRng for Trng<'_, Crypto>

Auto Trait Implementations§

§

impl<'d, L> Freeze for Trng<'d, L>

§

impl<'d, L> RefUnwindSafe for Trng<'d, L>
where L: RefUnwindSafe,

§

impl<'d, L> Send for Trng<'d, L>
where L: Send,

§

impl<'d, L> Sync for Trng<'d, L>
where L: Sync,

§

impl<'d, L> Unpin for Trng<'d, L>
where L: Unpin,

§

impl<'d, L> UnwindSafe for Trng<'d, L>
where L: UnwindSafe,

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
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> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.