(aaec0de)

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"

Go to the source code of this file.

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

Typedefs
typedef struct dif_csrng	dif_csrng_t
	A handle to csrng. More...

typedef enum dif_csrng_alert	dif_csrng_alert_t
	A csrng alert type.

typedef enum dif_csrng_irq	dif_csrng_irq_t
	A csrng interrupt request type.

typedef uint32_t	dif_csrng_irq_state_snapshot_t
	A snapshot of the state of the interrupts for this IP. More...

typedef uint32_t	dif_csrng_irq_enable_snapshot_t
	A snapshot of the enablement state of the interrupts for this IP. More...

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

enum	dif_csrng_irq { kDifCsrngIrqCsCmdReqDone = 0, kDifCsrngIrqCsEntropyReq = 1, kDifCsrngIrqCsHwInstExc = 2, kDifCsrngIrqCsFatalErr = 3 }
	A csrng interrupt request 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. More...

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

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

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

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

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

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

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

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

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

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

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

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

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 32 of file dif_csrng_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the csrng hardware registers.

Typedef Documentation

◆ dif_csrng_irq_enable_snapshot_t

typedef uint32_t dif_csrng_irq_enable_snapshot_t

A snapshot of the enablement state of the interrupts for this IP.

This is an opaque type, to be used with the dif_csrng_irq_disable_all() and dif_csrng_irq_restore_all() functions.

Definition at line 201 of file dif_csrng_autogen.h.

◆ dif_csrng_irq_state_snapshot_t

typedef uint32_t dif_csrng_irq_state_snapshot_t

A snapshot of the state of the interrupts for this IP.

This is an opaque type, to be used with the dif_csrng_irq_get_state() and dif_csrng_irq_acknowledge_state() functions.

Definition at line 110 of file dif_csrng_autogen.h.

◆ 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 54 of file dif_csrng_autogen.h.

◆ dif_csrng_irq

enum dif_csrng_irq

A csrng interrupt request type.

Enumerator
kDifCsrngIrqCsCmdReqDone	Asserted when a command request is completed.
kDifCsrngIrqCsEntropyReq	Asserted when a request for entropy has been made.
kDifCsrngIrqCsHwInstExc	Asserted when a hardware-attached CSRNG instance encounters a command exception.
kDifCsrngIrqCsFatalErr	Asserted when a FIFO error or a fatal alert occurs. Check the !!ERR_CODE register to get more information.

Definition at line 83 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 27 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.

Definition at line 17 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 156 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 143 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 110 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 241 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 176 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 195 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 97 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 85 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 123 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 261 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 217 of file dif_csrng_autogen.c.

(aaec0de)

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_csrng

Typedef Documentation

◆ dif_csrng_irq_enable_snapshot_t

◆ dif_csrng_irq_state_snapshot_t

◆ dif_csrng_t

Enumeration Type Documentation

◆ dif_csrng_alert

◆ dif_csrng_irq

Function Documentation

◆ dif_csrng_alert_force()

◆ dif_csrng_init()

◆ 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()