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

#include "dt/dt_keymgr_dpe.h"

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

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

Typedefs
typedef struct dt_desc_keymgr_dpe	dt_desc_keymgr_dpe_t
	Description of instances.

Functions
dt_keymgr_dpe_t	dt_keymgr_dpe_from_instance_id (dt_instance_id_t inst_id)
	Get the keymgr_dpe instance from an instance ID.

dt_instance_id_t	dt_keymgr_dpe_instance_id (dt_keymgr_dpe_t dt)
	Get the instance ID of an instance.

uint32_t	dt_keymgr_dpe_reg_block (dt_keymgr_dpe_t dt, dt_keymgr_dpe_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_keymgr_dpe_irq_to_plic_id (dt_keymgr_dpe_t dt, dt_keymgr_dpe_irq_t irq)
	Get the PLIC ID of a keymgr_dpe IRQ for a given instance.

dt_keymgr_dpe_irq_t	dt_keymgr_dpe_irq_from_plic_id (dt_keymgr_dpe_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local keymgr_dpe IRQ type.

dt_alert_id_t	dt_keymgr_dpe_alert_to_alert_id (dt_keymgr_dpe_t dt, dt_keymgr_dpe_alert_t alert)
	Get the alert ID of a keymgr_dpe alert for a given instance.

dt_keymgr_dpe_alert_t	dt_keymgr_dpe_alert_from_alert_id (dt_keymgr_dpe_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local keymgr_dpe alert type.

dt_clock_t	dt_keymgr_dpe_clock (dt_keymgr_dpe_t dt, dt_keymgr_dpe_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_keymgr_dpe_reset (dt_keymgr_dpe_t dt, dt_keymgr_dpe_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_keymgr_dpe.c.

Data Structure Documentation

◆ dt_desc_keymgr_dpe

struct dt_desc_keymgr_dpe

Description of instances.

Definition at line 19 of file dt_keymgr_dpe.c.

Data Fields
uint32_t	base_addr[kDtKeymgrDpeRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtKeymgrDpeClockCount]	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_darjeeling_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[kDtKeymgrDpeResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_keymgr_dpe_t)0 || (dt) >= kDtKeymgrDpeCount) return (default); &keymgr_dpe_desc[dt]; })

Return a pointer to the dt_keymgr_dpe_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 65 of file dt_keymgr_dpe.c.

Function Documentation

◆ dt_keymgr_dpe_alert_from_alert_id()

dt_keymgr_dpe_alert_t dt_keymgr_dpe_alert_from_alert_id	(	dt_keymgr_dpe_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The keymgr_dpe alert, or kDtKeymgrDpeAlertCount.

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

Definition at line 117 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_alert_to_alert_id()

dt_alert_id_t dt_keymgr_dpe_alert_to_alert_id	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_alert_t	alert )

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

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

Definition at line 111 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_clock()

dt_clock_t dt_keymgr_dpe_clock	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_clock_t	clk )

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

Parameters

dt	Instance of keymgr_dpe.
clk	Clock port.

Returns: Clock signal.

Definition at line 129 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_from_instance_id()

dt_keymgr_dpe_t dt_keymgr_dpe_from_instance_id ( dt_instance_id_t inst_id )

Get the keymgr_dpe instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A keymgr_dpe instance.

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

Definition at line 67 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_instance_id()

dt_instance_id_t dt_keymgr_dpe_instance_id ( dt_keymgr_dpe_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of keymgr_dpe.

Returns: The instance ID of that instance.

Definition at line 74 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_irq_from_plic_id()

dt_keymgr_dpe_irq_t dt_keymgr_dpe_irq_from_plic_id	(	dt_keymgr_dpe_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns: The keymgr_dpe IRQ, or kDtKeymgrDpeIrqCount.

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

Definition at line 96 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_irq_to_plic_id()

dt_plic_irq_id_t dt_keymgr_dpe_irq_to_plic_id	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_irq_t	irq )

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

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

Parameters

dt	Instance of keymgr_dpe.
irq	A keymgr_dpe IRQ.

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

Definition at line 86 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_reg_block()

uint32_t dt_keymgr_dpe_reg_block	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of keymgr_dpe.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 79 of file dt_keymgr_dpe.c.

◆ dt_keymgr_dpe_reset()

dt_reset_t dt_keymgr_dpe_reset	(	dt_keymgr_dpe_t	dt,
		dt_keymgr_dpe_reset_t	rst )

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

Parameters

dt	Instance of keymgr_dpe.
rst	Reset port.

Returns: Reset signal.

Definition at line 136 of file dt_keymgr_dpe.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_keymgr_dpe

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_keymgr_dpe_alert_from_alert_id()

◆ dt_keymgr_dpe_alert_to_alert_id()

◆ dt_keymgr_dpe_clock()

◆ dt_keymgr_dpe_from_instance_id()

◆ dt_keymgr_dpe_instance_id()

◆ dt_keymgr_dpe_irq_from_plic_id()

◆ dt_keymgr_dpe_irq_to_plic_id()

◆ dt_keymgr_dpe_reg_block()

◆ dt_keymgr_dpe_reset()