ENTROPY_SRC 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_entropy_src.h"

Go to the source code of this file.

Data Structures
struct	dif_entropy_src
	A handle to entropy_src. More...

Macros
#define	kDifEntropySrcIrqEsEntropyValid kDtEntropySrcIrqEsEntropyValid
	A entropy_src interrupt request type.

#define	kDifEntropySrcIrqEsHealthTestFailed kDtEntropySrcIrqEsHealthTestFailed
	Asserted whenever the main state machine is in the alert state, e.g., due to health tests failing and reaching the threshold value configured in !

#define	kDifEntropySrcIrqEsObserveFifoReady kDtEntropySrcIrqEsObserveFifoReady
	Asserted when the observe FIFO has filled to the configured threshold level (see !

#define	kDifEntropySrcIrqEsFatalErr kDtEntropySrcIrqEsFatalErr
	Asserted when an fatal error condition is met, e.g., upon FIFO errors, or if an illegal state machine state is reached.

Typedefs
typedef struct dif_entropy_src	dif_entropy_src_t
	A handle to entropy_src.

typedef enum dif_entropy_src_alert	dif_entropy_src_alert_t
	A entropy_src alert type.

typedef dt_entropy_src_irq_t	dif_entropy_src_irq_t

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

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

Enumerations
enum	dif_entropy_src_alert { kDifEntropySrcAlertRecovAlert = 0 , kDifEntropySrcAlertFatalAlert = 1 }
	A entropy_src alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_init (mmio_region_t base_addr, dif_entropy_src_t *entropy_src)
	Creates a new handle for a(n) entropy_src peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_init_from_dt (dt_entropy_src_t dt, dif_entropy_src_t *entropy_src)
	Creates a new handle for a(n) entropy_src peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_get_dt (const dif_entropy_src_t entropy_src, dt_entropy_src_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_alert_force (const dif_entropy_src_t *entropy_src, dif_entropy_src_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_entropy_src_irq_get_type (const dif_entropy_src_t entropy_src, dif_entropy_src_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_entropy_src_irq_get_state (const dif_entropy_src_t entropy_src, dif_entropy_src_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_entropy_src_irq_is_pending (const dif_entropy_src_t entropy_src, dif_entropy_src_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_irq_acknowledge_state (const dif_entropy_src_t *entropy_src, dif_entropy_src_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_entropy_src_irq_acknowledge_all (const dif_entropy_src_t *entropy_src)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_irq_acknowledge (const dif_entropy_src_t *entropy_src, dif_entropy_src_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_irq_force (const dif_entropy_src_t *entropy_src, dif_entropy_src_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_entropy_src_irq_get_enabled (const dif_entropy_src_t entropy_src, dif_entropy_src_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_irq_set_enabled (const dif_entropy_src_t *entropy_src, dif_entropy_src_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_irq_disable_all (const dif_entropy_src_t entropy_src, dif_entropy_src_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_entropy_src_irq_restore_all (const dif_entropy_src_t entropy_src, const dif_entropy_src_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

ENTROPY_SRC Device Interface Functions

Definition in file dif_entropy_src_autogen.h.

Data Structure Documentation

◆ dif_entropy_src

struct dif_entropy_src

A handle to entropy_src.

This type should be treated as opaque by users.

Definition at line 37 of file dif_entropy_src_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the entropy_src hardware registers.
dt_entropy_src_t	dt	The instance, set to `kDtEntropySrcCount` if not initialized through `dif_entropy_src_init_from_dt`.

Macro Definition Documentation

◆ kDifEntropySrcIrqEsEntropyValid

#define kDifEntropySrcIrqEsEntropyValid kDtEntropySrcIrqEsEntropyValid

A entropy_src interrupt request type.

DEPRECATED Use dt_entropy_src_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 entropy source bits are available for firmware for consumption via !!ENTROPY_DATA register.

Definition at line 138 of file dif_entropy_src_autogen.h.

◆ kDifEntropySrcIrqEsFatalErr

#define kDifEntropySrcIrqEsFatalErr kDtEntropySrcIrqEsFatalErr

Asserted when an fatal error condition is met, e.g., upon FIFO errors, or if an illegal state machine state is reached.

Definition at line 150 of file dif_entropy_src_autogen.h.

◆ kDifEntropySrcIrqEsHealthTestFailed

#define kDifEntropySrcIrqEsHealthTestFailed kDtEntropySrcIrqEsHealthTestFailed

Asserted whenever the main state machine is in the alert state, e.g., due to health tests failing and reaching the threshold value configured in !

!ALERT_THRESHOLD.

Definition at line 142 of file dif_entropy_src_autogen.h.

◆ kDifEntropySrcIrqEsObserveFifoReady

#define kDifEntropySrcIrqEsObserveFifoReady kDtEntropySrcIrqEsObserveFifoReady

Asserted when the observe FIFO has filled to the configured threshold level (see !

!OBSERVE_FIFO_THRESH).

Definition at line 146 of file dif_entropy_src_autogen.h.

Typedef Documentation

◆ dif_entropy_src_irq_enable_snapshot_t

typedef uint32_t dif_entropy_src_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_entropy_src_irq_disable_all() and dif_entropy_src_irq_restore_all() functions.

Definition at line 260 of file dif_entropy_src_autogen.h.

◆ dif_entropy_src_irq_state_snapshot_t

typedef uint32_t dif_entropy_src_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_entropy_src_irq_get_state() and dif_entropy_src_irq_acknowledge_state() functions.

Definition at line 158 of file dif_entropy_src_autogen.h.

◆ dif_entropy_src_irq_t

typedef dt_entropy_src_irq_t dif_entropy_src_irq_t

Definition at line 124 of file dif_entropy_src_autogen.h.

◆ dif_entropy_src_t

typedef struct dif_entropy_src dif_entropy_src_t

A handle to entropy_src.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_entropy_src_alert

enum dif_entropy_src_alert

A entropy_src alert type.

Enumerator

kDifEntropySrcAlertRecovAlert

This alert is triggered upon the alert health test threshold criteria not met.

kDifEntropySrcAlertFatalAlert

This alert triggers for any condition detected in the !

!ERR_CODE register, which includes FIFO errors, COUNTER errors, FSM state errors, and also when integrity failures are detected on the TL-UL bus.

Definition at line 98 of file dif_entropy_src_autogen.h.

Function Documentation

◆ dif_entropy_src_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_alert_force	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_alert_t	alert )

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

Parameters

entropy_src	A entropy_src handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_get_dt	(	const dif_entropy_src_t *	entropy_src,
		dt_entropy_src_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 52 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_init	(	mmio_region_t	base_addr,
		dif_entropy_src_t *	entropy_src )

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

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the entropy_src peripheral.
[out]	entropy_src	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_entropy_src_autogen.c.

◆ dif_entropy_src_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_init_from_dt	(	dt_entropy_src_t	dt,
		dif_entropy_src_t *	entropy_src )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 39 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_acknowledge	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_t	irq )

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

Parameters

entropy_src	A entropy_src handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 224 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_acknowledge_all ( const dif_entropy_src_t * entropy_src )

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

Parameters

entropy_src A entropy_src handle.

Returns: The result of the operation.

Definition at line 205 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_acknowledge_state	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_state_snapshot_t	snapshot )

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

Parameters

entropy_src	A entropy_src handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 163 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_disable_all	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 332 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_force	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 249 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_get_enabled	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

	entropy_src	A entropy_src 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_entropy_src_autogen.c.

◆ dif_entropy_src_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_get_state	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 146 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_get_type	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

	entropy_src	A entropy_src 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_entropy_src_autogen.c.

◆ dif_entropy_src_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_is_pending	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	entropy_src	A entropy_src 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_entropy_src_autogen.c.

◆ dif_entropy_src_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_restore_all	(	const dif_entropy_src_t *	entropy_src,
		const dif_entropy_src_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

entropy_src	A entropy_src handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 359 of file dif_entropy_src_autogen.c.

◆ dif_entropy_src_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_entropy_src_irq_set_enabled	(	const dif_entropy_src_t *	entropy_src,
		dif_entropy_src_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

entropy_src	A entropy_src 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_entropy_src_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_entropy_src

Macro Definition Documentation

◆ kDifEntropySrcIrqEsEntropyValid

◆ kDifEntropySrcIrqEsFatalErr

◆ kDifEntropySrcIrqEsHealthTestFailed

◆ kDifEntropySrcIrqEsObserveFifoReady

Typedef Documentation

◆ dif_entropy_src_irq_enable_snapshot_t

◆ dif_entropy_src_irq_state_snapshot_t

◆ dif_entropy_src_irq_t

◆ dif_entropy_src_t

Enumeration Type Documentation

◆ dif_entropy_src_alert

Function Documentation

◆ dif_entropy_src_alert_force()

◆ dif_entropy_src_get_dt()

◆ dif_entropy_src_init()

◆ dif_entropy_src_init_from_dt()

◆ dif_entropy_src_irq_acknowledge()

◆ dif_entropy_src_irq_acknowledge_all()

◆ dif_entropy_src_irq_acknowledge_state()

◆ dif_entropy_src_irq_disable_all()

◆ dif_entropy_src_irq_force()

◆ dif_entropy_src_irq_get_enabled()

◆ dif_entropy_src_irq_get_state()

◆ dif_entropy_src_irq_get_type()

◆ dif_entropy_src_irq_is_pending()

◆ dif_entropy_src_irq_restore_all()

◆ dif_entropy_src_irq_set_enabled()