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

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

Macros
#define	OPENTITAN_CSRNG_HAS_INTERFACE_SOFTWARE 1
	List of supported hardware features.

#define	OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE0 1

#define	OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE1 1

#define	OPENTITAN_CSRNG_HAS_MODE_DETERMINISTIC 1

#define	OPENTITAN_CSRNG_HAS_MODE_NONDETERMINISTIC 1

#define	OPENTITAN_CSRNG_HAS_READ_INT_STATE 1

#define	OPENTITAN_CSRNG_HAS_LIFECYCLE_DEBUGENABLE 1

Typedefs
typedef enum dt_csrng	dt_csrng_t
	List of instances.

typedef enum dt_csrng_reg_block	dt_csrng_reg_block_t
	List of register blocks.

typedef enum dt_csrng_irq	dt_csrng_irq_t
	List of IRQs.

typedef enum dt_csrng_alert	dt_csrng_alert_t
	List of Alerts.

typedef enum dt_csrng_clock	dt_csrng_clock_t
	List of clock ports.

typedef enum dt_csrng_reset	dt_csrng_reset_t
	List of reset ports.

Enumerations
enum	dt_csrng { kDtCsrng = 0 , kDtCsrngFirst = 0 , kDtCsrngCount = 1 }
	List of instances. More...

enum	dt_csrng_reg_block { kDtCsrngRegBlockCore = 0 , kDtCsrngRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_csrng_irq { kDtCsrngIrqCsCmdReqDone = 0 , kDtCsrngIrqCsEntropyReq = 1 , kDtCsrngIrqCsHwInstExc = 2 , kDtCsrngIrqCsFatalErr = 3 , kDtCsrngIrqCount = 4 }
	List of IRQs. More...

enum	dt_csrng_alert { kDtCsrngAlertRecovAlert = 0 , kDtCsrngAlertFatalAlert = 1 , kDtCsrngAlertCount = 2 }
	List of Alerts. More...

enum	dt_csrng_clock { kDtCsrngClockClk = 0 , kDtCsrngClockCount = 1 }
	List of clock ports. More...

enum	dt_csrng_reset { kDtCsrngResetRst = 0 , kDtCsrngResetCount = 1 }
	List of reset ports. More...

Functions
dt_csrng_t	dt_csrng_from_instance_id (dt_instance_id_t inst_id)
	Get the csrng instance from an instance ID.

dt_instance_id_t	dt_csrng_instance_id (dt_csrng_t dt)
	Get the instance ID of an instance.

uint32_t	dt_csrng_reg_block (dt_csrng_t dt, dt_csrng_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_csrng_irq_to_plic_id (dt_csrng_t dt, dt_csrng_irq_t irq)
	Get the PLIC ID of a csrng IRQ for a given instance.

dt_csrng_irq_t	dt_csrng_irq_from_plic_id (dt_csrng_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local csrng IRQ type.

dt_alert_id_t	dt_csrng_alert_to_alert_id (dt_csrng_t dt, dt_csrng_alert_t alert)
	Get the alert ID of a csrng alert for a given instance.

dt_csrng_alert_t	dt_csrng_alert_from_alert_id (dt_csrng_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local csrng alert type.

dt_clock_t	dt_csrng_clock (dt_csrng_t dt, dt_csrng_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_csrng_reset (dt_csrng_t dt, dt_csrng_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

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

Definition in file dt_csrng.h.

Macro Definition Documentation

◆ OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE0

#define OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE0 1

Definition at line 92 of file dt_csrng.h.

◆ OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE1

#define OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE1 1

Definition at line 93 of file dt_csrng.h.

◆ OPENTITAN_CSRNG_HAS_INTERFACE_SOFTWARE

#define OPENTITAN_CSRNG_HAS_INTERFACE_SOFTWARE 1

List of supported hardware features.

Definition at line 91 of file dt_csrng.h.

◆ OPENTITAN_CSRNG_HAS_LIFECYCLE_DEBUGENABLE

#define OPENTITAN_CSRNG_HAS_LIFECYCLE_DEBUGENABLE 1

Definition at line 97 of file dt_csrng.h.

◆ OPENTITAN_CSRNG_HAS_MODE_DETERMINISTIC

#define OPENTITAN_CSRNG_HAS_MODE_DETERMINISTIC 1

Definition at line 94 of file dt_csrng.h.

◆ OPENTITAN_CSRNG_HAS_MODE_NONDETERMINISTIC

#define OPENTITAN_CSRNG_HAS_MODE_NONDETERMINISTIC 1

Definition at line 95 of file dt_csrng.h.

◆ OPENTITAN_CSRNG_HAS_READ_INT_STATE

#define OPENTITAN_CSRNG_HAS_READ_INT_STATE 1

Definition at line 96 of file dt_csrng.h.

Typedef Documentation

◆ dt_csrng_alert_t

typedef enum dt_csrng_alert dt_csrng_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_csrng_clock_t

typedef enum dt_csrng_clock dt_csrng_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_csrng_irq_t

typedef enum dt_csrng_irq dt_csrng_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_csrng_reg_block_t

typedef enum dt_csrng_reg_block dt_csrng_reg_block_t

List of register blocks.

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

◆ dt_csrng_reset_t

typedef enum dt_csrng_reset dt_csrng_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_csrng

enum dt_csrng

List of instances.

Enumerator
kDtCsrng	csrng

Definition at line 23 of file dt_csrng.h.

◆ dt_csrng_alert

enum dt_csrng_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator

kDtCsrngAlertRecovAlert

This alert is triggered when a recoverable alert occurs.

Check the !!RECOV_ALERT_STS register to get more information.

kDtCsrngAlertFatalAlert

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

◆ dt_csrng_clock

enum dt_csrng_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtCsrngClockClk	Clock port clk_i.

Definition at line 73 of file dt_csrng.h.

◆ dt_csrng_irq

enum dt_csrng_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

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

Definition at line 47 of file dt_csrng.h.

◆ dt_csrng_reg_block

enum dt_csrng_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_csrng.h.

◆ dt_csrng_reset

enum dt_csrng_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtCsrngResetRst	Reset port rst_ni.

Definition at line 83 of file dt_csrng.h.

Function Documentation

◆ dt_csrng_alert_from_alert_id()

dt_csrng_alert_t dt_csrng_alert_from_alert_id	(	dt_csrng_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The csrng alert, or kDtCsrngAlertCount.

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

Definition at line 115 of file dt_csrng.c.

◆ dt_csrng_alert_to_alert_id()

dt_alert_id_t dt_csrng_alert_to_alert_id	(	dt_csrng_t	dt,
		dt_csrng_alert_t	alert )

Get the alert ID of a csrng 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 csrng.
alert	A csrng alert.

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

Definition at line 109 of file dt_csrng.c.

◆ dt_csrng_clock()

dt_clock_t dt_csrng_clock	(	dt_csrng_t	dt,
		dt_csrng_clock_t	clk )

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

Parameters

dt	Instance of csrng.
clk	Clock port.

Returns: Clock signal.

Definition at line 127 of file dt_csrng.c.

◆ dt_csrng_from_instance_id()

dt_csrng_t dt_csrng_from_instance_id ( dt_instance_id_t inst_id )

Get the csrng instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A csrng instance.

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

Definition at line 65 of file dt_csrng.c.

◆ dt_csrng_instance_id()

dt_instance_id_t dt_csrng_instance_id ( dt_csrng_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of csrng.

Returns: The instance ID of that instance.

Definition at line 72 of file dt_csrng.c.

◆ dt_csrng_irq_from_plic_id()

dt_csrng_irq_t dt_csrng_irq_from_plic_id	(	dt_csrng_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The csrng IRQ, or kDtCsrngIrqCount.

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

Definition at line 94 of file dt_csrng.c.

◆ dt_csrng_irq_to_plic_id()

dt_plic_irq_id_t dt_csrng_irq_to_plic_id	(	dt_csrng_t	dt,
		dt_csrng_irq_t	irq )

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

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

Parameters

dt	Instance of csrng.
irq	A csrng IRQ.

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

Definition at line 84 of file dt_csrng.c.

◆ dt_csrng_reg_block()

uint32_t dt_csrng_reg_block	(	dt_csrng_t	dt,
		dt_csrng_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of csrng.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 77 of file dt_csrng.c.

◆ dt_csrng_reset()

dt_reset_t dt_csrng_reset	(	dt_csrng_t	dt,
		dt_csrng_reset_t	rst )

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

Parameters

dt	Instance of csrng.
rst	Reset port.

Returns: Reset signal.

Definition at line 134 of file dt_csrng.c.

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE0

◆ OPENTITAN_CSRNG_HAS_INTERFACE_HARDWARE1

◆ OPENTITAN_CSRNG_HAS_INTERFACE_SOFTWARE

◆ OPENTITAN_CSRNG_HAS_LIFECYCLE_DEBUGENABLE

◆ OPENTITAN_CSRNG_HAS_MODE_DETERMINISTIC

◆ OPENTITAN_CSRNG_HAS_MODE_NONDETERMINISTIC

◆ OPENTITAN_CSRNG_HAS_READ_INT_STATE

Typedef Documentation

◆ dt_csrng_alert_t

◆ dt_csrng_clock_t

◆ dt_csrng_irq_t

◆ dt_csrng_reg_block_t

◆ dt_csrng_reset_t

Enumeration Type Documentation

◆ dt_csrng

◆ dt_csrng_alert

◆ dt_csrng_clock

◆ dt_csrng_irq

◆ dt_csrng_reg_block

◆ dt_csrng_reset

Function Documentation

◆ dt_csrng_alert_from_alert_id()

◆ dt_csrng_alert_to_alert_id()

◆ dt_csrng_clock()

◆ dt_csrng_from_instance_id()

◆ dt_csrng_instance_id()

◆ dt_csrng_irq_from_plic_id()

◆ dt_csrng_irq_to_plic_id()

◆ dt_csrng_reg_block()

◆ dt_csrng_reset()