True Random Number Generator (TRNG) HW driver header file. More...

#include <stdint.h>

Data Structures
struct	neorv32_trng_t

Functions
Prototypes
int	neorv32_trng_available (void)

void	neorv32_trng_enable (void)

void	neorv32_trng_disable (void)

void	neorv32_trng_fifo_clear (void)

int	neorv32_trng_get_fifo_depth (void)

int	neorv32_trng_get (uint8_t *data)

int	neorv32_trng_check_sim_mode (void)

IO Device: True Random Number Generator (TRNG)
#define	NEORV32_TRNG ((neorv32_trng_t*) (NEORV32_TRNG_BASE))

enum	NEORV32_TRNG_CTRL_enum { TRNG_CTRL_EN = 0 , TRNG_CTRL_FIFO_CLR = 1 , TRNG_CTRL_FIFO_LSB = 2 , TRNG_CTRL_FIFO_MSB = 5 , TRNG_CTRL_SIM_MODE = 6 , TRNG_CTRL_AVAIL = 7 }

enum	NEORV32_TRNG_DATA_enum { TRNG_DATA_LSB = 0 , TRNG_DATA_MSB = 7 }

Detailed Description

True Random Number Generator (TRNG) HW driver header file.

Note: These functions should only be used if the TRNG unit was synthesized (IO_TRNG_EN = true).

See also: https://stnolting.github.io/neorv32/sw/files.html

Macro Definition Documentation

◆ NEORV32_TRNG

#define NEORV32_TRNG ((neorv32_trng_t*) (NEORV32_TRNG_BASE))

TRNG module hardware access (neorv32_trng_t)

Enumeration Type Documentation

◆ NEORV32_TRNG_CTRL_enum

enum NEORV32_TRNG_CTRL_enum

TRNG control register bits

Enumerator
TRNG_CTRL_EN	TRNG data register(0) (r/w): TRNG enable
TRNG_CTRL_FIFO_CLR	TRNG data register(1) (-/w): Clear data FIFO (auto clears)
TRNG_CTRL_FIFO_LSB	TRNG data register(2) (r/-): log2(FIFO size), LSB
TRNG_CTRL_FIFO_MSB	TRNG data register(5) (r/-): log2(FIFO size), MSB
TRNG_CTRL_SIM_MODE	TRNG data register(6) (r/-): PRNG mode (simulation mode)
TRNG_CTRL_AVAIL	TRNG data register(7) (r/-): Random data available

◆ NEORV32_TRNG_DATA_enum

enum NEORV32_TRNG_DATA_enum

TRNG data register bits

Enumerator
TRNG_DATA_LSB	TRNG control register(0) (r/-): Random data byte, bit 0
TRNG_DATA_MSB	TRNG control register(7) (r/-): Random data byte, bit 7

Function Documentation

◆ neorv32_trng_available()

int neorv32_trng_available ( void )

Check if TRNG unit was synthesized.

Returns: 0 if TRNG was not synthesized, 1 if TRNG is available.

◆ neorv32_trng_check_sim_mode()

int neorv32_trng_check_sim_mode ( void )

Check if TRNG is implemented using SIMULATION mode.

Warning: In simulation mode the physical entropy source is replaced by a PRNG (LFSR) with very bad random quality.

Returns: Simulation mode active when not zero.

◆ neorv32_trng_disable()

void neorv32_trng_disable ( void )

Reset and disable TRNG.

◆ neorv32_trng_enable()

void neorv32_trng_enable ( void )

Reset, configure and enable TRNG.

◆ neorv32_trng_fifo_clear()

void neorv32_trng_fifo_clear ( void )

Flush TRNG random data FIFO.

◆ neorv32_trng_get()

int neorv32_trng_get ( uint8_t * data )

Get random data byte from TRNG.

Parameters

[in,out] data uint8_t pointer for storing random data byte. Will be set to zero if no valid data available.

Returns: Data is valid when 0 and invalid otherwise.

◆ neorv32_trng_get_fifo_depth()

int neorv32_trng_get_fifo_depth ( void )

Get TRNG FIFO depth.

Returns: TRNG FIFO size (number of entries).

Data Structures

Functions

IO Device: True Random Number Generator (TRNG)