rram_macro.c File Reference

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

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

Go to the source code of this file.

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

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

Typedefs
typedef struct dt_desc_rram_macro	dt_desc_rram_macro_t
	Description of instances.

Functions
dt_rram_macro_t	dt_rram_macro_from_instance_id (dt_instance_id_t inst_id)
	Get the rram_macro instance from an instance ID.
dt_instance_id_t	dt_rram_macro_instance_id (dt_rram_macro_t dt)
	Get the instance ID of an instance.
uint32_t	dt_rram_macro_reg_block (dt_rram_macro_t dt, dt_rram_macro_reg_block_t reg_block)
	Get the register base address of an instance.
dt_periph_io_t	dt_rram_macro_periph_io (dt_rram_macro_t dt, dt_rram_macro_periph_io_t sig)
	Get the peripheral I/O description of an instance.
dt_clock_t	dt_rram_macro_clock (dt_rram_macro_t dt, dt_rram_macro_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_rram_macro_reset (dt_rram_macro_t dt, dt_rram_macro_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP rram_macro and top earlgrey.

Definition in file rram_macro.c.

---

Data Structure Documentation

dt_desc_rram_macro

struct dt_desc_rram_macro

Description of instances.

Definition at line 19 of file rram_macro.c.

Data Fields
dt_clock_t	clock[kDtRramMacroClockCount]	Clock signal connected to each clock port.
dt_instance_id_t	inst_id	Instance ID.
dt_periph_io_t	periph_io[kDtRramMacroPeriphIoCount]	Description of each peripheral I/O.
uint32_t	reg_addr[kDtRramMacroRegBlockCount]	Base address of each register block.
dt_reset_t	reset[kDtRramMacroResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({     if ((dt) < (dt_rram_macro_t)0 || (int)(dt) >= kDtRramMacroCount)       return (default);     &rram_macro_desc[dt];   })

Return a pointer to the dt_rram_macro_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 84 of file rram_macro.c.

Function Documentation

dt_rram_macro_clock()

dt_clock_t dt_rram_macro_clock	(	dt_rram_macro_t	dt,
		dt_rram_macro_clock_t	clk )

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

Parameters

dt	Instance of rram_macro.
clk	Clock port.

Returns

Clock signal.

Definition at line 114 of file rram_macro.c.

dt_rram_macro_from_instance_id()

dt_rram_macro_t dt_rram_macro_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the rram_macro instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A rram_macro instance.

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

Definition at line 86 of file rram_macro.c.

dt_rram_macro_instance_id()

dt_instance_id_t dt_rram_macro_instance_id

(

dt_rram_macro_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of rram_macro.

Returns

The instance ID of that instance.

Definition at line 93 of file rram_macro.c.

dt_rram_macro_periph_io()

dt_periph_io_t dt_rram_macro_periph_io	(	dt_rram_macro_t	dt,
		dt_rram_macro_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

dt	Instance of rram_macro.
sig	Requested peripheral I/O.

Returns

Description of the requested peripheral I/O for this instance.

Definition at line 107 of file rram_macro.c.

dt_rram_macro_reg_block()

uint32_t dt_rram_macro_reg_block	(	dt_rram_macro_t	dt,
		dt_rram_macro_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of rram_macro.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 98 of file rram_macro.c.

dt_rram_macro_reset()

dt_reset_t dt_rram_macro_reset	(	dt_rram_macro_t	dt,
		dt_rram_macro_reset_t	rst )

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

Parameters

dt	Instance of rram_macro.
rst	Reset port.

Returns

Reset signal.

Definition at line 121 of file rram_macro.c.