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

#include "dt/dt_entropy_src.h"

Data Structures
struct	dt_desc_entropy_src
	Description of instances. More...

Macros
#define	TRY_GET_DT(dt, default)
	Return a pointer to the `dt_entropy_src_desc_t` structure of the requested `dt` if it's a valid index.

Typedefs
typedef struct dt_desc_entropy_src	dt_desc_entropy_src_t
	Description of instances.

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.

Definition in file dt_entropy_src.c.

Data Structure Documentation

◆ dt_desc_entropy_src

struct dt_desc_entropy_src

Description of instances.

Definition at line 19 of file dt_entropy_src.c.

Data Fields
uint32_t	base_addr[kDtEntropySrcRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtEntropySrcClockCount]	Clock signal connected to each clock port.
top_earlgrey_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
top_earlgrey_plic_irq_id_t	first_irq	PLIC ID of the first IRQ of this instance. This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
dt_instance_id_t	inst_id	Instance ID.
dt_reset_t	reset[kDtEntropySrcResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_entropy_src_t)0 || (dt) >= kDtEntropySrcCount) return (default); &entropy_src_desc[dt]; })

Return a pointer to the dt_entropy_src_desc_t structure of the requested dt if it's a valid index.

Otherwise, this macro will return (i.e. exit the function) with the provided default value.

Definition at line 63 of file dt_entropy_src.c.

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.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_entropy_src

Macro Definition Documentation

◆ TRY_GET_DT

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