1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
//! True random number generator.
//!
//! Provides basic support for the True Random Number Generator. The TRNG generates truly random
//! data and is intended for use as a generator of entropy.
//!
//! The TRNG is fairly slow - 15 minutes to an hour to generate 1 megabyte - so it probably
//! should only be used to generate a relatively small amount of entropy for a cryptographic
//! algorithm. Occasionally retrieving entropy from it won't necessarily need to block, as
//! this driver retrieves 512 bits at a time.
//!
//! ## RngCore Support
//!
//! When the crate feature `rand_core` is enabled, the TRNG can be wrapped in a struct that
//! implements [`rand_core`][rand_core]'s `RngCore` trait (via `into_rng()`). The [`rand`][rand]
//! crate's `Rng` trait automatically implements high-level functions on top of `RngCore`.
//!
//! Note that only the `try_fill_bytes` function of `RngCore` allows reporting an error. The others
//! will panic if the TRNG reports an error. Errors appear to be extremely rare in the default
//! configuration (none were seen over 3GB of data), but it's possible they will be more common in
//! certain situations, such as extreme temperatures or an inconsistent power supply. The non-public
//! Security Reference Manual may have more information.
//!
//! If you intend to use the `RngCore` wrapper, you should set a larger retry count. The default
//! retry count should be sufficient.
//!
//! [rand_core]: https://crates.io/crates/rand_core
//! [rand]: https://crates.io/crates/rand
//!
//! # Example
//!
//! Enable the TRNG clock gate, wait to generate random data.
//!
//! ```no_run
//! use imxrt_hal as hal;
//! use imxrt_ral as ral;
//!
//! # || -> Option<()> {
//! let mut ccm = unsafe { ral::ccm::CCM::instance() };
//! hal::ccm::clock_gate::trng().set(&mut ccm, hal::ccm::clock_gate::ON);
//!
//! let mut trng = hal::trng::Trng::new(
//! unsafe { ral::trng::TRNG::instance() },
//! hal::trng::SampleMode::default(),
//! hal::trng::RetryCount::default(),
//! );
//!
//! let random_data = nb::block!(trng.next_u32()).ok()?;
//! # Some(()) }();
//! ```
use core::fmt;
use crate::ral::trng;
use crate::ral::{modify_reg, read_reg, write_reg};
/// TRNG sampling mode
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum SampleMode {
/// von Neumann data in both entropy shifter and statistical checks. Approximately 4x slower
/// than the other modes.
VonNeumann = trng::MCTL::SAMP_MODE::RW::SAMP_MODE_0,
/// Raw data in both entropy shifter and statistical checks. Likely lower quality than the
/// other two modes.
Raw = trng::MCTL::SAMP_MODE::RW::SAMP_MODE_1,
/// von Neumann data in entropy shifter, raw data in statistical checks
VonNeumannRaw = trng::MCTL::SAMP_MODE::RW::SAMP_MODE_2,
}
impl Default for SampleMode {
/// Returns `VonNeumannRaw`.
fn default() -> Self {
// "Set sample mode of the TRNG ring oscillator to Von Neumann, for better random data.
// It is optional." <- SDK, explaining why they set sample mode to 0 (VN)
// Teensyduino uses VNRaw, the reason appears to be this post:
// https://forum.pjrc.com/threads/54711-Teensy-4-0-First-Beta-Test?p=195000&viewfull=1#post195000
// VNRaw appears to produce equivalent quality output and is ~4x faster than VN.
// As such, VonNeumannRaw is the default SampleMode here.
Self::VonNeumannRaw
}
}
/// The true random number generator.
pub struct Trng {
reg: trng::TRNG,
block: [u32; 16],
index: usize,
}
impl fmt::Debug for Trng {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("TRNG")
.field("block", &self.block)
.field("index", &self.index)
.finish()
}
}
/// The number of retry attempts.
///
/// Describes the number of times to retry
/// after a test failure before an error is declared. Valid
/// range `1..=15`. The default retry count is the largest
/// possible value.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct RetryCount(u32);
impl RetryCount {
/// The default reset count.
pub const DEFAULT: u32 = 15;
/// Create a new retry count.
///
/// Returns `None` if `retry_count` is not in the half-closed range
/// `1..=15`.
pub fn new(retry_count: u32) -> Option<Self> {
(1..=15)
.contains(&retry_count)
.then_some(RetryCount(retry_count))
}
}
impl Default for RetryCount {
fn default() -> Self {
RetryCount(Self::DEFAULT)
}
}
impl Trng {
/// Create a TRNG given a sampling mode and retry count.
///
/// To select the default sampling mode and retry counts, use `Default::default()`.
pub fn new(reg: trng::TRNG, sample_mode: SampleMode, retry_count: RetryCount) -> Self {
// Not supported: locking TRNG to prevent programmability.
// A number of things here are likely configurable if you have access to the SRM.
// Without it only limited configuration is safe. Garbage configs lead to endless errors.
modify_reg!(trng, reg, MCTL, PRGM: 1);
modify_reg!(trng, reg, MCTL, RST_DEF: 1);
// enter program mode and reset to defaults
// it isn't clear what defaults it actually sets, so let's set the tests manually
// All these values are sourced only from the #defines in the MCUXpresso TRNG driver for the
// IMXRT1062. The doc comments contain both typos and completely wrong values.
write_reg!(trng, reg, SCMISC, RTY_CT: retry_count.0, LRUN_MAX: 34); // _RUN_MAX_LIMIT
// Note: The SDK uses _MAX and _MIN for values, but the registers use the max value and a
// range. The SDK _MIN values are expressed as (max - range), making it easy to ensure
// that these values are correct.
write_reg!(trng, reg, SCML, MONO_MAX: 1384, MONO_RNG: 268); // _MONOBIT_
write_reg!(trng, reg, SCR1L, RUN1_MAX: 405, RUN1_RNG: 178); // _RUNBIT1_
write_reg!(trng, reg, SCR2L, RUN2_MAX: 220, RUN2_RNG: 122); // _RUNBIT2_
write_reg!(trng, reg, SCR3L, RUN3_MAX: 125, RUN3_RNG: 88); // _RUNBIT3_
write_reg!(trng, reg, SCR4L, RUN4_MAX: 75, RUN4_RNG: 64); // _RUNBIT4_
write_reg!(trng, reg, SCR5L, RUN5_MAX: 47, RUN5_RNG: 46); // _RUNBIT5_
write_reg!(trng, reg, SCR6PL, RUN6P_MAX: 47, RUN6P_RNG: 46); // _RUNBIT6PLUS_
write_reg!(trng, reg, PKRMAX, PKR_MAX: 26912); // _POKER_MAXIMUM
write_reg!(trng, reg, PKRRNG, PKR_RNG: 2467);
write_reg!(trng, reg, FRQMAX, FRQ_MAX: 25600); // _FREQUENCY_MAXIMUM
write_reg!(trng, reg, FRQMIN, FRQ_MIN: 1600); // _FREQUENCY_MINIMUM
write_reg!(trng, reg, SDCTL, SAMP_SIZE: 2500, ENT_DLY: 3200); // _SAMPLE_SIZE, _ENTROPY_DELAY
write_reg!(trng, reg, SBLIM, SB_LIM: 63); // _SPARSE_BIT_LIMIT
// set sample mode, exit program mode
modify_reg!(trng, reg, MCTL, SAMP_MODE: sample_mode as u32);
modify_reg!(trng, reg, MCTL, PRGM: 0);
// for 1015, 1021, maybe other non i.MX chips: set TRNG_ACC to 1 here
read_reg!(trng, reg, ENT[15]);
// reading ENT15 triggers new entropy generation
Self {
reg,
block: [0; 16],
index: 16, // equal to len, to trigger immediate retrieval
}
}
/// Return the next randomly-generated `u32`. May need to retrieve another block of random numbers.
///
/// Returns "would block" if we're not ready to read entropy; try again. See the module-level
/// example for how to block.
pub fn next_u32(&mut self) -> nb::Result<u32, Error> {
self.retrieve_if_needed()?;
let data = nb::Result::Ok(self.block[self.index]);
self.index += 1;
data
}
/// Retrieve another block of random numbers if we've used them all up.
fn retrieve_if_needed(&mut self) -> nb::Result<(), Error> {
if self.index >= self.block.len() {
self.retrieve()?;
self.index = 0;
}
Ok(())
}
/// Retrieve another block of random numbers.
fn retrieve(&mut self) -> nb::Result<(), Error> {
let mctl = read_reg!(trng, self.reg, MCTL);
if (mctl & trng::MCTL::ERR::mask) != 0 {
let flags = self.get_error_flags();
write_reg!(trng, self.reg, MCTL, mctl); // write reg back to clear error
return Err(nb::Error::Other(Error(flags)));
}
if (mctl & trng::MCTL::ENT_VAL::mask) == 0 {
return Err(nb::Error::WouldBlock); // not ready to read entropy
}
for idx in 0..self.reg.ENT.len() {
self.block[idx] = read_reg!(trng, self.reg, ENT[idx]);
}
read_reg!(trng, self.reg, ENT[0]);
// SDK (fsl_trng.c):
// Dummy read. Defect workaround.
// TRNG could not clear ENT_VAL flag automatically, application
// had to do a dummy reading operation for anyone TRNG register
// to clear it firstly, then to read the RTENT0 to RTENT15 again
// This appears unnecessary on the 1062? done anyway in case it's necessary for another chip
Ok(())
}
/// Retrieve all known error flags.
fn get_error_flags(&self) -> ErrorFlags {
let status = read_reg!(trng, self.reg, STATUS) & 0xFFFF;
// all the error flags in STATUS are in the low 16 bits
let mut flags = ErrorFlags::from_bits_truncate(status);
flags.set(
ErrorFlags::FCT_FAIL,
read_reg!(trng, self.reg, MCTL, FCT_FAIL) == 1,
);
flags
}
/// Release the TRNG in a disabled state.
///
/// This preserves any previously set retry count, sample mode,
/// and peripheral settings. However, the register block is returned
/// in a disabled state.
pub fn release_disabled(self) -> trng::TRNG {
modify_reg!(trng, self.reg, MCTL, PRGM: 1);
while read_reg!(trng, self.reg, MCTL, TSTOP_OK) == 0 {
core::hint::spin_loop();
}
self.reg
}
/// Wrap the TRNG in a struct that implements `rand_core`'s `RngCore` trait.
#[cfg(feature = "rand_core")]
pub fn into_rng(self) -> RngCoreWrapper {
RngCoreWrapper(self)
}
#[cfg(feature = "rand_core")]
fn read(&mut self, buffer: &mut [u8]) -> Result<(), Error> {
let mut data = [0; 4];
let mut index = 4;
for b in buffer.iter_mut() {
if index == 4 {
data = nb::block!(self.next_u32())?.to_be_bytes();
index = 0;
}
*b = data[index];
index += 1;
}
Ok(())
}
}
/// Wrapper struct around [`TRNG`] that implements `RngCore`.
#[cfg(feature = "rand_core")]
pub struct RngCoreWrapper(Trng);
#[cfg(feature = "rand_core")]
impl RngCoreWrapper {
/// Deconstruct this wrapper and return the TRNG struct.
pub fn into_inner(self) -> Trng {
self.0
}
}
#[cfg(feature = "rand_core")]
impl rand_core::RngCore for RngCoreWrapper {
/// Return the next random `u32`.
///
/// # Panics
///
/// Panics if the TRNG returns an error.
fn next_u32(&mut self) -> u32 {
let mut bytes = [0; 4];
self.fill_bytes(&mut bytes);
u32::from_be_bytes(bytes)
}
/// Return the next random `u64`.
///
/// # Panics
///
/// Panics if the TRNG returns an error.
fn next_u64(&mut self) -> u64 {
let mut bytes = [0; 8];
self.fill_bytes(&mut bytes);
u64::from_be_bytes(bytes)
}
/// Fill `dest` with random data.
///
/// # Panics
///
/// Panics if the TRNG returns an error.
fn fill_bytes(&mut self, dest: &mut [u8]) {
self.try_fill_bytes(dest).expect("TRNG returned an error")
}
/// Fill `dest` with random data.
///
/// If an error occurs, the error's `code` is the bits of the [`ErrorFlags`] that this driver
/// would have reported, ORed with [`rand_core::Error::CUSTOM_START`]. Use
/// [`ErrorFlags::from_bits_truncate`] to convert the `code` to the struct.
fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), rand_core::Error> {
// defer to Read implementation, converting error to rand_core's Error
self.0.read(dest).map_err(|e| {
let code = e.0.bits | rand_core::Error::CUSTOM_START;
// Safety: Two highest bits always set.
unsafe { core::num::NonZeroU32::new_unchecked(code).into() }
})
}
}
/// A TRNG error occurred, such as a statistical test failing.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct Error(pub ErrorFlags);
bitflags::bitflags! {
/// Specific errors that may occur during entropy generation
pub struct ErrorFlags : u32 {
// STATUS register starts here (automatically set from bits)
/// 1-bit run sampling 0s test failed
const TF1BR0 = 1 << 0;
/// 1-bit run sampling 1s test failed
const TF1BR1 = 1 << 1;
/// 2-bit run sampling 0s test failed
const TF2BR0 = 1 << 2;
/// 2-bit run sampling 1s test failed
const TF2BR1 = 1 << 3;
/// 3-bit run sampling 0s test failed
const TF3BR0 = 1 << 4;
/// 3-bit run sampling 1s test failed
const TF3BR1 = 1 << 5;
/// 4-bit run sampling 0s test failed
const TF4BR0 = 1 << 6;
/// 4-bit run sampling 1s test failed
const TF4BR1 = 1 << 7;
/// 5-bit run sampling 0s test failed
const TF5BR0 = 1 << 8;
/// 5-bit run sampling 1s test failed
const TF5BR1 = 1 << 9;
/// 6-plus-bit run sampling 0s test failed
const TF6PBR0 = 1 << 10;
/// 6-plus-bit run sampling 1s test failed
const TF6PBR1 = 1 << 11;
/// Sparse bit test failed
const TFSB = 1 << 12;
/// Long run test failed
const TFLR = 1 << 13;
/// Poker test failed
const TFP = 1 << 14;
/// Mono bit test failed
const TFMB = 1 << 15;
// MCTL register starts here (set manually)
/// Count taken during entropy generation was outside the defined range of FRQ_MIN to FRQ_MAX
const FCT_FAIL = 1 << 16;
}
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "An error occurred in the TRNG module")
}
}
#[cfg(feature = "eh02-unproven")]
impl eh02::blocking::rng::Read for Trng {
type Error = Error;
// e-h RNG Read is a *blocking* trait, so no WouldBlock here
// Read is part of the unproven API and will be removed in version 1.0
fn read(&mut self, buffer: &mut [u8]) -> Result<(), Self::Error> {
let mut data = [0; 4];
let mut index = 4;
for b in buffer.iter_mut() {
if index == 4 {
data = nb::block!(self.next_u32())?.to_be_bytes();
index = 0;
}
*b = data[index];
index += 1;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::RetryCount;
#[test]
fn retry_count() {
assert!(RetryCount::new(0).is_none());
for count in 1..16 {
assert!(RetryCount::new(count).is_some());
}
assert!(RetryCount::new(16).is_none());
}
}