CSRNG Device Interface Functions More...

#include <stdbool.h>
#include <stdint.h>
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"
#include "dt/dt_csrng.h"

Go to the source code of this file.

Data Structures
struct	dif_csrng
	A handle to csrng. More...

Macros
#define	kDifCsrngIrqCsCmdReqDone kDtCsrngIrqCsCmdReqDone
	A csrng interrupt request type.

#define	kDifCsrngIrqCsEntropyReq kDtCsrngIrqCsEntropyReq
	Asserted when a request for entropy has been made.

#define	kDifCsrngIrqCsHwInstExc kDtCsrngIrqCsHwInstExc
	Asserted when a hardware-attached CSRNG instance encounters a command exception.

#define	kDifCsrngIrqCsFatalErr kDtCsrngIrqCsFatalErr
	Asserted when a FIFO error or a fatal alert occurs.

Typedefs
typedef struct dif_csrng	dif_csrng_t
	A handle to csrng.

typedef enum dif_csrng_alert	dif_csrng_alert_t
	A csrng alert type.

Enumerations
enum	dif_csrng_alert { kDifCsrngAlertRecovAlert = 0 , kDifCsrngAlertFatalAlert = 1 }
	A csrng alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_init (mmio_region_t base_addr, dif_csrng_t *csrng)
	Creates a new handle for a(n) csrng peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_init_from_dt (dt_csrng_t dt, dif_csrng_t *csrng)
	Creates a new handle for a(n) csrng peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_get_dt (const dif_csrng_t csrng, dt_csrng_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_alert_force (const dif_csrng_t *csrng, dif_csrng_alert_t alert)
	Forces a particular alert, causing it to be escalated as if the hardware had raised it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_get_type (const dif_csrng_t csrng, dif_csrng_irq_t, dif_irq_type_t type)
	Returns the type of a given interrupt (i.e., event or status) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_get_state (const dif_csrng_t csrng, dif_csrng_irq_state_snapshot_t snapshot)
	Returns the state of all interrupts (i.e., pending or not) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_is_pending (const dif_csrng_t csrng, dif_csrng_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_acknowledge_state (const dif_csrng_t *csrng, dif_csrng_irq_state_snapshot_t snapshot)
	Acknowledges all interrupts that were pending at the time of the state snapshot.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_acknowledge_all (const dif_csrng_t *csrng)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_acknowledge (const dif_csrng_t *csrng, dif_csrng_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_force (const dif_csrng_t *csrng, dif_csrng_irq_t, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_get_enabled (const dif_csrng_t csrng, dif_csrng_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_set_enabled (const dif_csrng_t *csrng, dif_csrng_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_disable_all (const dif_csrng_t csrng, dif_csrng_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_csrng_irq_restore_all (const dif_csrng_t csrng, const dif_csrng_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

CSRNG Device Interface Functions

Definition in file dif_csrng_autogen.h.

Data Structure Documentation

◆ dif_csrng

struct dif_csrng

A handle to csrng.

This type should be treated as opaque by users.

Definition at line 37 of file dif_csrng_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the csrng hardware registers.
dt_csrng_t	dt	The instance, set to `kDtCsrngCount` if not initialized through `dif_csrng_init_from_dt`.

Macro Definition Documentation

◆ kDifCsrngIrqCsCmdReqDone

#define kDifCsrngIrqCsCmdReqDone kDtCsrngIrqCsCmdReqDone

A csrng interrupt request type.

DEPRECATED Use dt_csrng_irq_t instead. This enumeration exists solely for the transition to dt-based interrupt numbers and will be removed in the future.

The following are defines to keep the types consistent with DT. Asserted when a command request is completed.

Definition at line 138 of file dif_csrng_autogen.h.

◆ kDifCsrngIrqCsEntropyReq

#define kDifCsrngIrqCsEntropyReq kDtCsrngIrqCsEntropyReq

Asserted when a request for entropy has been made.

Definition at line 142 of file dif_csrng_autogen.h.

◆ kDifCsrngIrqCsFatalErr

#define kDifCsrngIrqCsFatalErr kDtCsrngIrqCsFatalErr

Asserted when a FIFO error or a fatal alert occurs.

Check the !!ERR_CODE register to get more information.

Definition at line 150 of file dif_csrng_autogen.h.

◆ kDifCsrngIrqCsHwInstExc

#define kDifCsrngIrqCsHwInstExc kDtCsrngIrqCsHwInstExc

Asserted when a hardware-attached CSRNG instance encounters a command exception.

Definition at line 146 of file dif_csrng_autogen.h.

Typedef Documentation

◆ dif_csrng_t

typedef struct dif_csrng dif_csrng_t

A handle to csrng.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_csrng_alert

enum dif_csrng_alert

A csrng alert type.

Enumerator

kDifCsrngAlertRecovAlert

This alert is triggered when a recoverable alert occurs.

Check the !!RECOV_ALERT_STS register to get more information.

kDifCsrngAlertFatalAlert

This alert triggers (i) if an illegal state machine state is reached, or (ii) if an AES fatal alert condition occurs, or (iii) if a fatal integrity failure is detected on the TL-UL bus.

Definition at line 98 of file dif_csrng_autogen.h.

Function Documentation

◆ dif_csrng_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_alert_force	(	const dif_csrng_t *	csrng,
		dif_csrng_alert_t	alert )

Forces a particular alert, causing it to be escalated as if the hardware had raised it.

Parameters

csrng	A csrng handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_csrng_autogen.c.

◆ dif_csrng_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_get_dt	(	const dif_csrng_t *	csrng,
		dt_csrng_t *	dt )

Get the DT handle from this DIF.

If this DIF was initialized by dif_csrng_init_from_dt(dt, ..) then this function will return dt. Otherwise it will return an error.

Parameters

	csrng	A csrng handle.
[out]	dt	DT handle.

Returns: kDifBadArg if the DIF has no DT information, kDifOk otherwise.

Definition at line 52 of file dif_csrng_autogen.c.

◆ dif_csrng_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_init	(	mmio_region_t	base_addr,
		dif_csrng_t *	csrng )

Creates a new handle for a(n) csrng peripheral.

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the csrng peripheral.
[out]	csrng	Out param for the initialized handle.

Returns: The result of the operation.

DEPRECATED This function exists solely for the transition to dt-based DIFs and will be removed in the future.

Definition at line 25 of file dif_csrng_autogen.c.

◆ dif_csrng_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_init_from_dt	(	dt_csrng_t	dt,
		dif_csrng_t *	csrng )

Creates a new handle for a(n) csrng peripheral.

This function does not actuate the hardware.

Parameters

	dt	The devicetable description of the device.
[out]	csrng	Out param for the initialized handle.

Returns: The result of the operation.

Definition at line 39 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_acknowledge	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_t	irq )

Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

Parameters

csrng	A csrng handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 224 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_acknowledge_all ( const dif_csrng_t * csrng )

Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

Parameters

csrng A csrng handle.

Returns: The result of the operation.

Definition at line 205 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_acknowledge_state	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_state_snapshot_t	snapshot )

Acknowledges all interrupts that were pending at the time of the state snapshot.

Parameters

csrng	A csrng handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 163 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_disable_all	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_enable_snapshot_t *	snapshot )

Disables all interrupts, optionally snapshotting all enable states for later restoration.

Parameters

	csrng	A csrng handle.
[out]	snapshot	Out-param for the snapshot; may be `NULL`.

Returns: The result of the operation.

Definition at line 332 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_force	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_t	irq,
		const bool	val )

Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

Parameters

csrng	A csrng handle.
irq	An interrupt request.
val	Value to be set.

Returns: The result of the operation.

Definition at line 249 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_get_enabled	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

	csrng	A csrng handle.
	irq	An interrupt request.
[out]	state	Out-param toggle state of the interrupt.

Returns: The result of the operation.

Definition at line 274 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_get_state	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_state_snapshot_t *	snapshot )

Returns the state of all interrupts (i.e., pending or not) for this IP.

Parameters

	csrng	A csrng handle.
[out]	snapshot	Out-param for interrupt state snapshot.

Returns: The result of the operation.

Definition at line 146 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_get_type	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_t	irq,
		dif_irq_type_t *	type )

Returns the type of a given interrupt (i.e., event or status) for this IP.

Parameters

	csrng	A csrng handle.
	irq	An interrupt request.
[out]	type	Out-param for the interrupt type.

Returns: The result of the operation.

Definition at line 127 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_is_pending	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	csrng	A csrng handle.
	irq	An interrupt request.
[out]	is_pending	Out-param for whether the interrupt is pending.

Returns: The result of the operation.

Definition at line 180 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_restore_all	(	const dif_csrng_t *	csrng,
		const dif_csrng_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

csrng	A csrng handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 359 of file dif_csrng_autogen.c.

◆ dif_csrng_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_csrng_irq_set_enabled	(	const dif_csrng_t *	csrng,
		dif_csrng_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

csrng	A csrng handle.
irq	An interrupt request.
state	The new toggle state for the interrupt.

Returns: The result of the operation.

Definition at line 301 of file dif_csrng_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_csrng

Macro Definition Documentation

◆ kDifCsrngIrqCsCmdReqDone

◆ kDifCsrngIrqCsEntropyReq

◆ kDifCsrngIrqCsFatalErr

◆ kDifCsrngIrqCsHwInstExc

Typedef Documentation

◆ dif_csrng_t

Enumeration Type Documentation

◆ dif_csrng_alert

Function Documentation

◆ dif_csrng_alert_force()

◆ dif_csrng_get_dt()

◆ dif_csrng_init()

◆ dif_csrng_init_from_dt()

◆ dif_csrng_irq_acknowledge()

◆ dif_csrng_irq_acknowledge_all()

◆ dif_csrng_irq_acknowledge_state()

◆ dif_csrng_irq_disable_all()

◆ dif_csrng_irq_force()

◆ dif_csrng_irq_get_enabled()

◆ dif_csrng_irq_get_state()

◆ dif_csrng_irq_get_type()

◆ dif_csrng_irq_is_pending()

◆ dif_csrng_irq_restore_all()

◆ dif_csrng_irq_set_enabled()