dt_sram_ctrl.c File Reference

Device Tables (DT) for IP sram_ctrl and top englishbreakfast. More...

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

Go to the source code of this file.

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

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

Typedefs
typedef struct dt_desc_sram_ctrl	dt_desc_sram_ctrl_t
	Description of instances.

Functions
dt_sram_ctrl_t	dt_sram_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the sram_ctrl instance from an instance ID.
dt_instance_id_t	dt_sram_ctrl_instance_id (dt_sram_ctrl_t dt)
	Get the instance ID of an instance.
uint32_t	dt_sram_ctrl_reg_block (dt_sram_ctrl_t dt, dt_sram_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.
uint32_t	dt_sram_ctrl_memory_base (dt_sram_ctrl_t dt, dt_sram_ctrl_memory_t mem)
	Get the base address of a memory.
uint32_t	dt_sram_ctrl_memory_size (dt_sram_ctrl_t dt, dt_sram_ctrl_memory_t mem)
	Get the size of a memory.
dt_clock_t	dt_sram_ctrl_clock (dt_sram_ctrl_t dt, dt_sram_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_sram_ctrl_reset (dt_sram_ctrl_t dt, dt_sram_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP sram_ctrl and top englishbreakfast.

Definition in file dt_sram_ctrl.c.

---

Data Structure Documentation

dt_desc_sram_ctrl

struct dt_desc_sram_ctrl

Description of instances.

Definition at line 19 of file dt_sram_ctrl.c.

Data Fields
dt_clock_t	clock[kDtSramCtrlClockCount]	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.
uint32_t	mem_addr[kDtSramCtrlMemoryCount]	Base address of each memory.
uint32_t	mem_size[kDtSramCtrlMemoryCount]	Size in bytes of each memory.
uint32_t	reg_addr[kDtSramCtrlRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtSramCtrlResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({     if ((dt) < (dt_sram_ctrl_t)0 || (dt) >= kDtSramCtrlCount)       return (default);     &sram_ctrl_desc[dt];   })

Return a pointer to the dt_sram_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 59 of file dt_sram_ctrl.c.

Function Documentation

dt_sram_ctrl_clock()

dt_clock_t dt_sram_ctrl_clock	(	dt_sram_ctrl_t	dt,
		dt_sram_ctrl_clock_t	clk )

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

Parameters

dt	Instance of sram_ctrl.
clk	Clock port.

Returns

Clock signal.

Definition at line 97 of file dt_sram_ctrl.c.

dt_sram_ctrl_from_instance_id()

dt_sram_ctrl_t dt_sram_ctrl_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the sram_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A sram_ctrl instance.

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

Definition at line 61 of file dt_sram_ctrl.c.

dt_sram_ctrl_instance_id()

dt_instance_id_t dt_sram_ctrl_instance_id

(

dt_sram_ctrl_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of sram_ctrl.

Returns

The instance ID of that instance.

Definition at line 68 of file dt_sram_ctrl.c.

dt_sram_ctrl_memory_base()

uint32_t dt_sram_ctrl_memory_base	(	dt_sram_ctrl_t	dt,
		dt_sram_ctrl_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of sram_ctrl.
mem	The memory requested.

Returns

The base address of the requested memory.

Definition at line 80 of file dt_sram_ctrl.c.

dt_sram_ctrl_memory_size()

uint32_t dt_sram_ctrl_memory_size	(	dt_sram_ctrl_t	dt,
		dt_sram_ctrl_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of sram_ctrl.
mem	The memory requested.

Returns

The size of the requested memory.

Definition at line 87 of file dt_sram_ctrl.c.

dt_sram_ctrl_reg_block()

uint32_t dt_sram_ctrl_reg_block	(	dt_sram_ctrl_t	dt,
		dt_sram_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of sram_ctrl.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 73 of file dt_sram_ctrl.c.

dt_sram_ctrl_reset()

dt_reset_t dt_sram_ctrl_reset	(	dt_sram_ctrl_t	dt,
		dt_sram_ctrl_reset_t	rst )

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

Parameters

dt	Instance of sram_ctrl.
rst	Reset port.

Returns

Reset signal.

Definition at line 104 of file dt_sram_ctrl.c.