Device Tables (DT) for IP aes and top darjeeling. More...

#include "hw/top/dt/dt_aes.h"

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

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

Typedefs
typedef struct dt_desc_aes	dt_desc_aes_t
	Description of instances.

Functions
dt_aes_t	dt_aes_from_instance_id (dt_instance_id_t inst_id)
	Get the aes instance from an instance ID.

dt_instance_id_t	dt_aes_instance_id (dt_aes_t dt)
	Get the instance ID of an instance.

uint32_t	dt_aes_reg_block (dt_aes_t dt, dt_aes_reg_block_t reg_block)
	Get the register base address of an instance.

dt_alert_id_t	dt_aes_alert_to_alert_id (dt_aes_t dt, dt_aes_alert_t alert)
	Get the alert ID of a aes alert for a given instance.

dt_aes_alert_t	dt_aes_alert_from_alert_id (dt_aes_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local aes alert type.

dt_clock_t	dt_aes_clock (dt_aes_t dt, dt_aes_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_aes_reset (dt_aes_t dt, dt_aes_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP aes and top darjeeling.

Definition in file dt_aes.c.

Data Structure Documentation

◆ dt_desc_aes

struct dt_desc_aes

Description of instances.

Definition at line 19 of file dt_aes.c.

Data Fields
uint32_t	base_addr[kDtAesRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtAesClockCount]	Clock signal connected to each clock port.
top_darjeeling_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_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.
dt_instance_id_t	inst_id	Instance ID.
dt_reset_t	reset[kDtAesResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_aes_t)0 || (dt) >= kDtAesCount) return (default); &aes_desc[dt]; })

Return a pointer to the dt_aes_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 58 of file dt_aes.c.

Function Documentation

◆ dt_aes_alert_from_alert_id()

dt_aes_alert_t dt_aes_alert_from_alert_id	(	dt_aes_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The aes alert, or kDtAesAlertCount.

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

Definition at line 86 of file dt_aes.c.

◆ dt_aes_alert_to_alert_id()

dt_alert_id_t dt_aes_alert_to_alert_id	(	dt_aes_t	dt,
		dt_aes_alert_t	alert )

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

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

Definition at line 80 of file dt_aes.c.

◆ dt_aes_clock()

dt_clock_t dt_aes_clock	(	dt_aes_t	dt,
		dt_aes_clock_t	clk )

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

Parameters

dt	Instance of aes.
clk	Clock port.

Returns: Clock signal.

Definition at line 98 of file dt_aes.c.

◆ dt_aes_from_instance_id()

dt_aes_t dt_aes_from_instance_id ( dt_instance_id_t inst_id )

Get the aes instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A aes instance.

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

Definition at line 60 of file dt_aes.c.

◆ dt_aes_instance_id()

dt_instance_id_t dt_aes_instance_id ( dt_aes_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of aes.

Returns: The instance ID of that instance.

Definition at line 67 of file dt_aes.c.

◆ dt_aes_reg_block()

uint32_t dt_aes_reg_block	(	dt_aes_t	dt,
		dt_aes_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of aes.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 72 of file dt_aes.c.

◆ dt_aes_reset()

dt_reset_t dt_aes_reset	(	dt_aes_t	dt,
		dt_aes_reset_t	rst )

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

Parameters

dt	Instance of aes.
rst	Reset port.

Returns: Reset signal.

Definition at line 105 of file dt_aes.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_aes

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_aes_alert_from_alert_id()

◆ dt_aes_alert_to_alert_id()

◆ dt_aes_clock()

◆ dt_aes_from_instance_id()

◆ dt_aes_instance_id()

◆ dt_aes_reg_block()

◆ dt_aes_reset()