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

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

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

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

Typedefs
typedef struct dt_desc_soc_dbg_ctrl	dt_desc_soc_dbg_ctrl_t
	Description of instances.

Functions
dt_soc_dbg_ctrl_t	dt_soc_dbg_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the soc_dbg_ctrl instance from an instance ID.

dt_instance_id_t	dt_soc_dbg_ctrl_instance_id (dt_soc_dbg_ctrl_t dt)
	Get the instance ID of an instance.

uint32_t	dt_soc_dbg_ctrl_reg_block (dt_soc_dbg_ctrl_t dt, dt_soc_dbg_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.

uint32_t	dt_soc_dbg_ctrl_memory_base (dt_soc_dbg_ctrl_t dt, dt_soc_dbg_ctrl_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_soc_dbg_ctrl_memory_size (dt_soc_dbg_ctrl_t dt, dt_soc_dbg_ctrl_memory_t mem)
	Get the size of a memory.

dt_alert_id_t	dt_soc_dbg_ctrl_alert_to_alert_id (dt_soc_dbg_ctrl_t dt, dt_soc_dbg_ctrl_alert_t alert)
	Get the alert ID of a soc_dbg_ctrl alert for a given instance.

dt_soc_dbg_ctrl_alert_t	dt_soc_dbg_ctrl_alert_from_alert_id (dt_soc_dbg_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local soc_dbg_ctrl alert type.

dt_clock_t	dt_soc_dbg_ctrl_clock (dt_soc_dbg_ctrl_t dt, dt_soc_dbg_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_soc_dbg_ctrl_reset (dt_soc_dbg_ctrl_t dt, dt_soc_dbg_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_soc_dbg_ctrl.c.

Data Structure Documentation

◆ dt_desc_soc_dbg_ctrl

struct dt_desc_soc_dbg_ctrl

Description of instances.

Definition at line 19 of file dt_soc_dbg_ctrl.c.

Data Fields
dt_clock_t	clock[kDtSocDbgCtrlClockCount]	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.
dt_instance_id_t	inst_id	Instance ID.
uint32_t	mem_addr[kDtSocDbgCtrlMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtSocDbgCtrlMemoryCount]	Size in bytes of each memory.
uint32_t	reg_addr[kDtSocDbgCtrlRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtSocDbgCtrlResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_soc_dbg_ctrl_t)0 || (dt) >= kDtSocDbgCtrlCount) return (default); &soc_dbg_ctrl_desc[dt]; })

Return a pointer to the dt_soc_dbg_ctrl_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_soc_dbg_ctrl.c.

Function Documentation

◆ dt_soc_dbg_ctrl_alert_from_alert_id()

dt_soc_dbg_ctrl_alert_t dt_soc_dbg_ctrl_alert_from_alert_id	(	dt_soc_dbg_ctrl_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The soc_dbg_ctrl alert, or kDtSocDbgCtrlAlertCount.

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

Definition at line 105 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_alert_to_alert_id()

dt_alert_id_t dt_soc_dbg_ctrl_alert_to_alert_id	(	dt_soc_dbg_ctrl_t	dt,
		dt_soc_dbg_ctrl_alert_t	alert )

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

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

Definition at line 99 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_clock()

dt_clock_t dt_soc_dbg_ctrl_clock	(	dt_soc_dbg_ctrl_t	dt,
		dt_soc_dbg_ctrl_clock_t	clk )

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

Parameters

dt	Instance of soc_dbg_ctrl.
clk	Clock port.

Returns: Clock signal.

Definition at line 117 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_from_instance_id()

dt_soc_dbg_ctrl_t dt_soc_dbg_ctrl_from_instance_id ( dt_instance_id_t inst_id )

Get the soc_dbg_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A soc_dbg_ctrl instance.

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

Definition at line 65 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_instance_id()

dt_instance_id_t dt_soc_dbg_ctrl_instance_id ( dt_soc_dbg_ctrl_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of soc_dbg_ctrl.

Returns: The instance ID of that instance.

Definition at line 72 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_memory_base()

uint32_t dt_soc_dbg_ctrl_memory_base	(	dt_soc_dbg_ctrl_t	dt,
		dt_soc_dbg_ctrl_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of soc_dbg_ctrl.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 84 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_memory_size()

uint32_t dt_soc_dbg_ctrl_memory_size	(	dt_soc_dbg_ctrl_t	dt,
		dt_soc_dbg_ctrl_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of soc_dbg_ctrl.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 91 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_reg_block()

uint32_t dt_soc_dbg_ctrl_reg_block	(	dt_soc_dbg_ctrl_t	dt,
		dt_soc_dbg_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of soc_dbg_ctrl.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 77 of file dt_soc_dbg_ctrl.c.

◆ dt_soc_dbg_ctrl_reset()

dt_reset_t dt_soc_dbg_ctrl_reset	(	dt_soc_dbg_ctrl_t	dt,
		dt_soc_dbg_ctrl_reset_t	rst )

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

Parameters

dt	Instance of soc_dbg_ctrl.
rst	Reset port.

Returns: Reset signal.

Definition at line 124 of file dt_soc_dbg_ctrl.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_soc_dbg_ctrl

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_soc_dbg_ctrl_alert_from_alert_id()

◆ dt_soc_dbg_ctrl_alert_to_alert_id()

◆ dt_soc_dbg_ctrl_clock()

◆ dt_soc_dbg_ctrl_from_instance_id()

◆ dt_soc_dbg_ctrl_instance_id()

◆ dt_soc_dbg_ctrl_memory_base()

◆ dt_soc_dbg_ctrl_memory_size()

◆ dt_soc_dbg_ctrl_reg_block()

◆ dt_soc_dbg_ctrl_reset()