flash_macro_wrapper.c File Reference

Device Tables (DT) for IP flash_macro_wrapper and top egret. More...

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

Go to the source code of this file.

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

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

Typedefs
typedef struct dt_desc_flash_macro_wrapper	dt_desc_flash_macro_wrapper_t
	Description of instances.

Functions
dt_flash_macro_wrapper_t	dt_flash_macro_wrapper_from_instance_id (dt_instance_id_t inst_id)
	Get the flash_macro_wrapper instance from an instance ID.
dt_instance_id_t	dt_flash_macro_wrapper_instance_id (dt_flash_macro_wrapper_t dt)
	Get the instance ID of an instance.
uint32_t	dt_flash_macro_wrapper_reg_block (dt_flash_macro_wrapper_t dt, dt_flash_macro_wrapper_reg_block_t reg_block)
	Get the register base address of an instance.
dt_periph_io_t	dt_flash_macro_wrapper_periph_io (dt_flash_macro_wrapper_t dt, dt_flash_macro_wrapper_periph_io_t sig)
	Get the peripheral I/O description of an instance.
dt_clock_t	dt_flash_macro_wrapper_clock (dt_flash_macro_wrapper_t dt, dt_flash_macro_wrapper_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_flash_macro_wrapper_reset (dt_flash_macro_wrapper_t dt, dt_flash_macro_wrapper_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP flash_macro_wrapper and top egret.

Definition in file flash_macro_wrapper.c.

---

Data Structure Documentation

dt_desc_flash_macro_wrapper

struct dt_desc_flash_macro_wrapper

Description of instances.

Definition at line 19 of file flash_macro_wrapper.c.

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

Macro Definition Documentation

TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({     if ((dt) < (dt_flash_macro_wrapper_t)0 || (int)(dt) >= kDtFlashMacroWrapperCount)       return (default);     &flash_macro_wrapper_desc[dt];   })

Return a pointer to the dt_flash_macro_wrapper_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 flash_macro_wrapper.c.

Function Documentation

dt_flash_macro_wrapper_clock()

dt_clock_t dt_flash_macro_wrapper_clock	(	dt_flash_macro_wrapper_t	dt,
		dt_flash_macro_wrapper_clock_t	clk )

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

Parameters

dt	Instance of flash_macro_wrapper.
clk	Clock port.

Returns

Clock signal.

Definition at line 114 of file flash_macro_wrapper.c.

dt_flash_macro_wrapper_from_instance_id()

dt_flash_macro_wrapper_t dt_flash_macro_wrapper_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the flash_macro_wrapper instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A flash_macro_wrapper instance.

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

Definition at line 86 of file flash_macro_wrapper.c.

dt_flash_macro_wrapper_instance_id()

dt_instance_id_t dt_flash_macro_wrapper_instance_id

(

dt_flash_macro_wrapper_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of flash_macro_wrapper.

Returns

The instance ID of that instance.

Definition at line 93 of file flash_macro_wrapper.c.

dt_flash_macro_wrapper_periph_io()

dt_periph_io_t dt_flash_macro_wrapper_periph_io	(	dt_flash_macro_wrapper_t	dt,
		dt_flash_macro_wrapper_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

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

Returns

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

Definition at line 107 of file flash_macro_wrapper.c.

dt_flash_macro_wrapper_reg_block()

uint32_t dt_flash_macro_wrapper_reg_block	(	dt_flash_macro_wrapper_t	dt,
		dt_flash_macro_wrapper_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of flash_macro_wrapper.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 98 of file flash_macro_wrapper.c.

dt_flash_macro_wrapper_reset()

dt_reset_t dt_flash_macro_wrapper_reset	(	dt_flash_macro_wrapper_t	dt,
		dt_flash_macro_wrapper_reset_t	rst )

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

Parameters

dt	Instance of flash_macro_wrapper.
rst	Reset port.

Returns

Reset signal.

Definition at line 121 of file flash_macro_wrapper.c.