Device Tables (DT) for IP entropy_src and top earlgrey. More...

#include "dt_api.h"
#include <stdint.h>

Macros
#define	OPENTITAN_ENTROPY_SRC_HAS_MODE_BYPASS 1
	List of supported hardware features.

#define	OPENTITAN_ENTROPY_SRC_HAS_MODE_FIPS 1

#define	OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS 1

#define	OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS_EXT 1

#define	OPENTITAN_ENTROPY_SRC_HAS_RNG_BIT_ENABLE 1

#define	OPENTITAN_ENTROPY_SRC_HAS_ROUTE_TO_FIRMWARE 1

#define	OPENTITAN_ENTROPY_SRC_HAS_FW_OV_OBSERVE 1

#define	OPENTITAN_ENTROPY_SRC_HAS_FW_OV_EXTRACT_AND_INSERT 1

Typedefs
typedef enum dt_entropy_src	dt_entropy_src_t
	List of instances.

typedef enum dt_entropy_src_reg_block	dt_entropy_src_reg_block_t
	List of register blocks.

typedef enum dt_entropy_src_irq	dt_entropy_src_irq_t
	List of IRQs.

typedef enum dt_entropy_src_alert	dt_entropy_src_alert_t
	List of Alerts.

typedef enum dt_entropy_src_clock	dt_entropy_src_clock_t
	List of clock ports.

typedef enum dt_entropy_src_reset	dt_entropy_src_reset_t
	List of reset ports.

Enumerations
enum	dt_entropy_src { kDtEntropySrc = 0 , kDtEntropySrcFirst = 0 , kDtEntropySrcCount = 1 }
	List of instances. More...

enum	dt_entropy_src_reg_block { kDtEntropySrcRegBlockCore = 0 , kDtEntropySrcRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_entropy_src_irq { kDtEntropySrcIrqEsEntropyValid = 0 , kDtEntropySrcIrqEsHealthTestFailed = 1 , kDtEntropySrcIrqEsObserveFifoReady = 2 , kDtEntropySrcIrqEsFatalErr = 3 , kDtEntropySrcIrqCount = 4 }
	List of IRQs. More...

enum	dt_entropy_src_alert { kDtEntropySrcAlertRecovAlert = 0 , kDtEntropySrcAlertFatalAlert = 1 , kDtEntropySrcAlertCount = 2 }
	List of Alerts. More...

enum	dt_entropy_src_clock { kDtEntropySrcClockClk = 0 , kDtEntropySrcClockCount = 1 }
	List of clock ports. More...

enum	dt_entropy_src_reset { kDtEntropySrcResetRst = 0 , kDtEntropySrcResetCount = 1 }
	List of reset ports. More...

Functions
dt_entropy_src_t	dt_entropy_src_from_instance_id (dt_instance_id_t inst_id)
	Get the entropy_src instance from an instance ID.

dt_instance_id_t	dt_entropy_src_instance_id (dt_entropy_src_t dt)
	Get the instance ID of an instance.

uint32_t	dt_entropy_src_reg_block (dt_entropy_src_t dt, dt_entropy_src_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_entropy_src_irq_to_plic_id (dt_entropy_src_t dt, dt_entropy_src_irq_t irq)
	Get the PLIC ID of a entropy_src IRQ for a given instance.

dt_entropy_src_irq_t	dt_entropy_src_irq_from_plic_id (dt_entropy_src_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local entropy_src IRQ type.

dt_alert_id_t	dt_entropy_src_alert_to_alert_id (dt_entropy_src_t dt, dt_entropy_src_alert_t alert)
	Get the alert ID of a entropy_src alert for a given instance.

dt_entropy_src_alert_t	dt_entropy_src_alert_from_alert_id (dt_entropy_src_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local entropy_src alert type.

dt_clock_t	dt_entropy_src_clock (dt_entropy_src_t dt, dt_entropy_src_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_entropy_src_reset (dt_entropy_src_t dt, dt_entropy_src_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP entropy_src and top earlgrey.

This file contains the type definitions and global functions of the entropy_src.

Definition in file dt_entropy_src.h.

Macro Definition Documentation

◆ OPENTITAN_ENTROPY_SRC_HAS_FW_OV_EXTRACT_AND_INSERT

#define OPENTITAN_ENTROPY_SRC_HAS_FW_OV_EXTRACT_AND_INSERT 1

Definition at line 98 of file dt_entropy_src.h.

◆ OPENTITAN_ENTROPY_SRC_HAS_FW_OV_OBSERVE

#define OPENTITAN_ENTROPY_SRC_HAS_FW_OV_OBSERVE 1

Definition at line 97 of file dt_entropy_src.h.

◆ OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS

#define OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS 1

Definition at line 93 of file dt_entropy_src.h.

◆ OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS_EXT

#define OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS_EXT 1

Definition at line 94 of file dt_entropy_src.h.

◆ OPENTITAN_ENTROPY_SRC_HAS_MODE_BYPASS

#define OPENTITAN_ENTROPY_SRC_HAS_MODE_BYPASS 1

List of supported hardware features.

Definition at line 91 of file dt_entropy_src.h.

◆ OPENTITAN_ENTROPY_SRC_HAS_MODE_FIPS

#define OPENTITAN_ENTROPY_SRC_HAS_MODE_FIPS 1

Definition at line 92 of file dt_entropy_src.h.

◆ OPENTITAN_ENTROPY_SRC_HAS_RNG_BIT_ENABLE

#define OPENTITAN_ENTROPY_SRC_HAS_RNG_BIT_ENABLE 1

Definition at line 95 of file dt_entropy_src.h.

◆ OPENTITAN_ENTROPY_SRC_HAS_ROUTE_TO_FIRMWARE

#define OPENTITAN_ENTROPY_SRC_HAS_ROUTE_TO_FIRMWARE 1

Definition at line 96 of file dt_entropy_src.h.

Typedef Documentation

◆ dt_entropy_src_alert_t

typedef enum dt_entropy_src_alert dt_entropy_src_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_entropy_src_clock_t

typedef enum dt_entropy_src_clock dt_entropy_src_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_entropy_src_irq_t

typedef enum dt_entropy_src_irq dt_entropy_src_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_entropy_src_reg_block_t

typedef enum dt_entropy_src_reg_block dt_entropy_src_reg_block_t

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

◆ dt_entropy_src_reset_t

typedef enum dt_entropy_src_reset dt_entropy_src_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_entropy_src

enum dt_entropy_src

List of instances.

Enumerator
kDtEntropySrc	entropy_src

Definition at line 23 of file dt_entropy_src.h.

◆ dt_entropy_src_alert

enum dt_entropy_src_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator

kDtEntropySrcAlertRecovAlert

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

kDtEntropySrcAlertFatalAlert

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 60 of file dt_entropy_src.h.

◆ dt_entropy_src_clock

enum dt_entropy_src_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtEntropySrcClockClk	Clock port clk_i.

Definition at line 73 of file dt_entropy_src.h.

◆ dt_entropy_src_irq

enum dt_entropy_src_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtEntropySrcIrqEsEntropyValid	Asserted when entropy source bits are available for firmware for consumption via ! !ENTROPY_DATA register.
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.
kDtEntropySrcIrqEsObserveFifoReady	Asserted when the observe FIFO has filled to the configured threshold level (see ! !OBSERVE_FIFO_THRESH).
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 47 of file dt_entropy_src.h.

◆ dt_entropy_src_reg_block

enum dt_entropy_src_reg_block

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 34 of file dt_entropy_src.h.

◆ dt_entropy_src_reset

enum dt_entropy_src_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtEntropySrcResetRst	Reset port rst_ni.

Definition at line 83 of file dt_entropy_src.h.

Function Documentation

◆ dt_entropy_src_alert_from_alert_id()

dt_entropy_src_alert_t dt_entropy_src_alert_from_alert_id	(	dt_entropy_src_t	dt,
		dt_alert_id_t	alert )

Convert a global alert ID to a local entropy_src alert type.

Parameters

dt	Instance of entropy_src.
alert	A global alert ID that belongs to this instance.

Returns: The entropy_src alert, or kDtEntropySrcAlertCount.

Note: This function assumes that the global alert ID belongs to the instance of entropy_src passed in parameter. In other words, it must be the case that dt_entropy_src_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtEntropySrcAlertCount.

Definition at line 115 of file dt_entropy_src.c.

◆ dt_entropy_src_alert_to_alert_id()

dt_alert_id_t dt_entropy_src_alert_to_alert_id	(	dt_entropy_src_t	dt,
		dt_entropy_src_alert_t	alert )

Get the alert ID of a entropy_src alert for a given instance.

Note: This function only makes sense if the instance is connected to the Alert Handler. For any instances where the instance is not connected, the return value is unspecified.

Parameters

dt	Instance of entropy_src.
alert	A entropy_src alert.

Returns: The Alert Handler alert ID of the alert of this instance.

Definition at line 109 of file dt_entropy_src.c.

◆ dt_entropy_src_clock()

dt_clock_t dt_entropy_src_clock	(	dt_entropy_src_t	dt,
		dt_entropy_src_clock_t	clk )

Get the clock signal connected to a clock port of an instance.

Parameters

dt	Instance of entropy_src.
clk	Clock port.

Returns: Clock signal.

Definition at line 127 of file dt_entropy_src.c.

◆ dt_entropy_src_from_instance_id()

dt_entropy_src_t dt_entropy_src_from_instance_id ( dt_instance_id_t inst_id )

Get the entropy_src instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A entropy_src instance.

Note: This function only makes sense if the instance ID has device type entropy_src, otherwise the returned value is unspecified.

Definition at line 65 of file dt_entropy_src.c.

◆ dt_entropy_src_instance_id()

dt_instance_id_t dt_entropy_src_instance_id ( dt_entropy_src_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of entropy_src.

Returns: The instance ID of that instance.

Definition at line 72 of file dt_entropy_src.c.

◆ dt_entropy_src_irq_from_plic_id()

dt_entropy_src_irq_t dt_entropy_src_irq_from_plic_id	(	dt_entropy_src_t	dt,
		dt_plic_irq_id_t	irq )

Convert a global IRQ ID to a local entropy_src IRQ type.

Parameters

dt	Instance of entropy_src.
irq	A PLIC ID that belongs to this instance.

Returns: The entropy_src IRQ, or kDtEntropySrcIrqCount.

Note: This function assumes that the PLIC ID belongs to the instance of entropy_src passed in parameter. In other words, it must be the case that dt_entropy_src_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtEntropySrcIrqCount.

Definition at line 94 of file dt_entropy_src.c.

◆ dt_entropy_src_irq_to_plic_id()

dt_plic_irq_id_t dt_entropy_src_irq_to_plic_id	(	dt_entropy_src_t	dt,
		dt_entropy_src_irq_t	irq )

Get the PLIC ID of a entropy_src IRQ for a given instance.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters

dt	Instance of entropy_src.
irq	A entropy_src IRQ.

Returns: The PLIC ID of the IRQ of this instance.

Definition at line 84 of file dt_entropy_src.c.

◆ dt_entropy_src_reg_block()

uint32_t dt_entropy_src_reg_block	(	dt_entropy_src_t	dt,
		dt_entropy_src_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of entropy_src.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 77 of file dt_entropy_src.c.

◆ dt_entropy_src_reset()

dt_reset_t dt_entropy_src_reset	(	dt_entropy_src_t	dt,
		dt_entropy_src_reset_t	rst )

Get the reset signal connected to a reset port of an instance.

Parameters

dt	Instance of entropy_src.
rst	Reset port.

Returns: Reset signal.

Definition at line 134 of file dt_entropy_src.c.

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ OPENTITAN_ENTROPY_SRC_HAS_FW_OV_EXTRACT_AND_INSERT

◆ OPENTITAN_ENTROPY_SRC_HAS_FW_OV_OBSERVE

◆ OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS

◆ OPENTITAN_ENTROPY_SRC_HAS_HEALTH_TESTS_EXT

◆ OPENTITAN_ENTROPY_SRC_HAS_MODE_BYPASS

◆ OPENTITAN_ENTROPY_SRC_HAS_MODE_FIPS

◆ OPENTITAN_ENTROPY_SRC_HAS_RNG_BIT_ENABLE

◆ OPENTITAN_ENTROPY_SRC_HAS_ROUTE_TO_FIRMWARE

Typedef Documentation

◆ dt_entropy_src_alert_t

◆ dt_entropy_src_clock_t

◆ dt_entropy_src_irq_t

◆ dt_entropy_src_reg_block_t

◆ dt_entropy_src_reset_t

Enumeration Type Documentation

◆ dt_entropy_src

◆ dt_entropy_src_alert

◆ dt_entropy_src_clock

◆ dt_entropy_src_irq

◆ dt_entropy_src_reg_block

◆ dt_entropy_src_reset

Function Documentation

◆ dt_entropy_src_alert_from_alert_id()

◆ dt_entropy_src_alert_to_alert_id()

◆ dt_entropy_src_clock()

◆ dt_entropy_src_from_instance_id()

◆ dt_entropy_src_instance_id()

◆ dt_entropy_src_irq_from_plic_id()

◆ dt_entropy_src_irq_to_plic_id()

◆ dt_entropy_src_reg_block()

◆ dt_entropy_src_reset()