flash_macro_wrapper.h File Reference

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

#include "hw/top/dt/api.h"
#include <stdint.h>

Go to the source code of this file.

Typedefs
typedef enum dt_flash_macro_wrapper	dt_flash_macro_wrapper_t
	List of instances.
typedef enum dt_flash_macro_wrapper_reg_block	dt_flash_macro_wrapper_reg_block_t
	List of register blocks.
typedef enum dt_flash_macro_wrapper_clock	dt_flash_macro_wrapper_clock_t
	List of clock ports.
typedef enum dt_flash_macro_wrapper_reset	dt_flash_macro_wrapper_reset_t
	List of reset ports.
typedef enum dt_flash_macro_wrapper_periph_io	dt_flash_macro_wrapper_periph_io_t
	List of peripheral I/O.

Enumerations
enum	dt_flash_macro_wrapper {   kDtFlashMacroWrapperFirst = 0 ,   kDtFlashMacroWrapper = 0 }
	List of instances. More...
enum	{ kDtFlashMacroWrapperCount = 1 }
enum	dt_flash_macro_wrapper_reg_block { kDtFlashMacroWrapperRegBlockCore = 0 }
	List of register blocks. More...
enum	{ kDtFlashMacroWrapperRegBlockCount = 1 }
enum	dt_flash_macro_wrapper_clock { kDtFlashMacroWrapperClockClk = 0 }
	List of clock ports. More...
enum	{ kDtFlashMacroWrapperClockCount = 1 }
enum	dt_flash_macro_wrapper_reset { kDtFlashMacroWrapperResetRst = 0 }
	List of reset ports. More...
enum	{ kDtFlashMacroWrapperResetCount = 1 }
enum	dt_flash_macro_wrapper_periph_io {   kDtFlashMacroWrapperPeriphIoTck = 0 ,   kDtFlashMacroWrapperPeriphIoTms = 1 ,   kDtFlashMacroWrapperPeriphIoTdi = 2 ,   kDtFlashMacroWrapperPeriphIoTdo = 3 }
	List of peripheral I/O. More...
enum	{ kDtFlashMacroWrapperPeriphIoCount = 4 }

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.

This file contains the type definitions and global functions of the flash_macro_wrapper.

Definition in file flash_macro_wrapper.h.

Typedef Documentation

dt_flash_macro_wrapper_clock_t

typedef enum dt_flash_macro_wrapper_clock dt_flash_macro_wrapper_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_flash_macro_wrapper_periph_io_t

typedef enum dt_flash_macro_wrapper_periph_io dt_flash_macro_wrapper_periph_io_t

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

dt_flash_macro_wrapper_reg_block_t

typedef enum dt_flash_macro_wrapper_reg_block dt_flash_macro_wrapper_reg_block_t

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

dt_flash_macro_wrapper_reset_t

typedef enum dt_flash_macro_wrapper_reset dt_flash_macro_wrapper_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kDtFlashMacroWrapperResetCount	Number of reset ports.

Definition at line 79 of file flash_macro_wrapper.h.

anonymous enum

anonymous enum

Enumerator
kDtFlashMacroWrapperRegBlockCount	Number of register blocks.

Definition at line 48 of file flash_macro_wrapper.h.

anonymous enum

anonymous enum

Enumerator
kDtFlashMacroWrapperPeriphIoCount	Number of peripheral I/O.

Definition at line 96 of file flash_macro_wrapper.h.

anonymous enum

anonymous enum

Enumerator
kDtFlashMacroWrapperClockCount	Number of clock ports.

Definition at line 65 of file flash_macro_wrapper.h.

anonymous enum

anonymous enum

Enumerator
kDtFlashMacroWrapperCount	Number of instances.

Definition at line 34 of file flash_macro_wrapper.h.

dt_flash_macro_wrapper

enum dt_flash_macro_wrapper

List of instances.

Enumerator
kDtFlashMacroWrapperFirst	First instance.
kDtFlashMacroWrapper	flash_macro_wrapper

Definition at line 29 of file flash_macro_wrapper.h.

dt_flash_macro_wrapper_clock

enum dt_flash_macro_wrapper_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtFlashMacroWrapperClockClk	Clock port clk_i.

Definition at line 61 of file flash_macro_wrapper.h.

dt_flash_macro_wrapper_periph_io

enum dt_flash_macro_wrapper_periph_io

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

Definition at line 89 of file flash_macro_wrapper.h.

dt_flash_macro_wrapper_reg_block

enum dt_flash_macro_wrapper_reg_block

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 44 of file flash_macro_wrapper.h.

dt_flash_macro_wrapper_reset

enum dt_flash_macro_wrapper_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtFlashMacroWrapperResetRst	Reset port rst_ni.

Definition at line 75 of file flash_macro_wrapper.h.

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.