EDN 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 "hw/top/dt/dt_edn.h"

Go to the source code of this file.

Data Structures
struct	dif_edn
	A handle to edn. More...

Macros
#define	kDifEdnIrqEdnCmdReqDone kDtEdnIrqEdnCmdReqDone
	A edn interrupt request type.

#define	kDifEdnIrqEdnFatalErr kDtEdnIrqEdnFatalErr
	Asserted when a FIFO error occurs.

Typedefs
typedef struct dif_edn	dif_edn_t
	A handle to edn.

typedef enum dif_edn_alert	dif_edn_alert_t
	A edn alert type.

typedef dt_edn_irq_t	dif_edn_irq_t

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

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

Enumerations
enum	dif_edn_alert { kDifEdnAlertRecovAlert = 0 , kDifEdnAlertFatalAlert = 1 }
	A edn alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_init (mmio_region_t base_addr, dif_edn_t *edn)
	Creates a new handle for a(n) edn peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_init_from_dt (dt_edn_t dt, dif_edn_t *edn)
	Creates a new handle for a(n) edn peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_get_dt (const dif_edn_t edn, dt_edn_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_alert_force (const dif_edn_t *edn, dif_edn_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_edn_irq_get_type (const dif_edn_t edn, dif_edn_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_edn_irq_get_state (const dif_edn_t edn, dif_edn_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_edn_irq_is_pending (const dif_edn_t edn, dif_edn_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_irq_acknowledge_state (const dif_edn_t *edn, dif_edn_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_edn_irq_acknowledge_all (const dif_edn_t *edn)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_irq_acknowledge (const dif_edn_t *edn, dif_edn_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_irq_force (const dif_edn_t *edn, dif_edn_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_edn_irq_get_enabled (const dif_edn_t edn, dif_edn_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_irq_set_enabled (const dif_edn_t *edn, dif_edn_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_irq_disable_all (const dif_edn_t edn, dif_edn_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_edn_irq_restore_all (const dif_edn_t edn, const dif_edn_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

EDN Device Interface Functions

Definition in file dif_edn_autogen.h.

Data Structure Documentation

◆ dif_edn

struct dif_edn

A handle to edn.

This type should be treated as opaque by users.

Definition at line 37 of file dif_edn_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the edn hardware registers.
dt_edn_t	dt	The instance, set to `kDtEdnCount` if not initialized through `dif_edn_init_from_dt`.

Macro Definition Documentation

◆ kDifEdnIrqEdnCmdReqDone

#define kDifEdnIrqEdnCmdReqDone kDtEdnIrqEdnCmdReqDone

A edn interrupt request type.

DEPRECATED Use dt_edn_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 software CSRNG request has completed.

Definition at line 138 of file dif_edn_autogen.h.

◆ kDifEdnIrqEdnFatalErr

#define kDifEdnIrqEdnFatalErr kDtEdnIrqEdnFatalErr

Asserted when a FIFO error occurs.

Definition at line 142 of file dif_edn_autogen.h.

Typedef Documentation

◆ dif_edn_irq_enable_snapshot_t

typedef uint32_t dif_edn_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_edn_irq_disable_all() and dif_edn_irq_restore_all() functions.

Definition at line 252 of file dif_edn_autogen.h.

◆ dif_edn_irq_state_snapshot_t

typedef uint32_t dif_edn_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_edn_irq_get_state() and dif_edn_irq_acknowledge_state() functions.

Definition at line 150 of file dif_edn_autogen.h.

◆ dif_edn_irq_t

typedef dt_edn_irq_t dif_edn_irq_t

Definition at line 124 of file dif_edn_autogen.h.

◆ dif_edn_t

typedef struct dif_edn dif_edn_t

A handle to edn.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_edn_alert

enum dif_edn_alert

A edn alert type.

Enumerator
kDifEdnAlertRecovAlert	This alert is triggered when entropy bus data matches on consecutive clock cycles.
kDifEdnAlertFatalAlert	This alert triggers (i) if an illegal state machine state is reached, or (ii) if a fatal integrity failure is detected on the TL-UL bus.

Definition at line 98 of file dif_edn_autogen.h.

Function Documentation

◆ dif_edn_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_alert_force	(	const dif_edn_t *	edn,
		dif_edn_alert_t	alert )

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

Parameters

edn	A edn handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_edn_autogen.c.

◆ dif_edn_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_get_dt	(	const dif_edn_t *	edn,
		dt_edn_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 52 of file dif_edn_autogen.c.

◆ dif_edn_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_init	(	mmio_region_t	base_addr,
		dif_edn_t *	edn )

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

This function does not actuate the hardware.

Parameters

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

◆ dif_edn_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_init_from_dt	(	dt_edn_t	dt,
		dif_edn_t *	edn )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 39 of file dif_edn_autogen.c.

◆ dif_edn_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge	(	const dif_edn_t *	edn,
		dif_edn_irq_t	irq )

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

Parameters

edn	A edn handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 216 of file dif_edn_autogen.c.

◆ dif_edn_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge_all ( const dif_edn_t * edn )

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

Parameters

edn	A edn handle.

Returns: The result of the operation.

Definition at line 197 of file dif_edn_autogen.c.

◆ dif_edn_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_acknowledge_state	(	const dif_edn_t *	edn,
		dif_edn_irq_state_snapshot_t	snapshot )

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

Parameters

edn	A edn handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 155 of file dif_edn_autogen.c.

◆ dif_edn_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_disable_all	(	const dif_edn_t *	edn,
		dif_edn_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 324 of file dif_edn_autogen.c.

◆ dif_edn_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_force	(	const dif_edn_t *	edn,
		dif_edn_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 241 of file dif_edn_autogen.c.

◆ dif_edn_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_get_enabled	(	const dif_edn_t *	edn,
		dif_edn_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 266 of file dif_edn_autogen.c.

◆ dif_edn_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_get_state	(	const dif_edn_t *	edn,
		dif_edn_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 138 of file dif_edn_autogen.c.

◆ dif_edn_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_get_type	(	const dif_edn_t *	edn,
		dif_edn_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 119 of file dif_edn_autogen.c.

◆ dif_edn_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_is_pending	(	const dif_edn_t *	edn,
		dif_edn_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	edn	A edn 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 172 of file dif_edn_autogen.c.

◆ dif_edn_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_restore_all	(	const dif_edn_t *	edn,
		const dif_edn_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

edn	A edn handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 351 of file dif_edn_autogen.c.

◆ dif_edn_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_edn_irq_set_enabled	(	const dif_edn_t *	edn,
		dif_edn_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 293 of file dif_edn_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_edn

Macro Definition Documentation

◆ kDifEdnIrqEdnCmdReqDone

◆ kDifEdnIrqEdnFatalErr

Typedef Documentation

◆ dif_edn_irq_enable_snapshot_t

◆ dif_edn_irq_state_snapshot_t

◆ dif_edn_irq_t

◆ dif_edn_t

Enumeration Type Documentation

◆ dif_edn_alert

Function Documentation

◆ dif_edn_alert_force()

◆ dif_edn_get_dt()

◆ dif_edn_init()

◆ dif_edn_init_from_dt()

◆ dif_edn_irq_acknowledge()

◆ dif_edn_irq_acknowledge_all()

◆ dif_edn_irq_acknowledge_state()

◆ dif_edn_irq_disable_all()

◆ dif_edn_irq_force()

◆ dif_edn_irq_get_enabled()

◆ dif_edn_irq_get_state()

◆ dif_edn_irq_get_type()

◆ dif_edn_irq_is_pending()

◆ dif_edn_irq_restore_all()

◆ dif_edn_irq_set_enabled()