rram_macro.h File Reference

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

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

Go to the source code of this file.

Typedefs
typedef enum dt_rram_macro	dt_rram_macro_t
	List of instances.
typedef enum dt_rram_macro_reg_block	dt_rram_macro_reg_block_t
	List of register blocks.
typedef enum dt_rram_macro_clock	dt_rram_macro_clock_t
	List of clock ports.
typedef enum dt_rram_macro_reset	dt_rram_macro_reset_t
	List of reset ports.
typedef enum dt_rram_macro_periph_io	dt_rram_macro_periph_io_t
	List of peripheral I/O.

Enumerations
enum	dt_rram_macro {   kDtRramMacroFirst = 0 ,   kDtRramMacro = 0 }
	List of instances. More...
enum	{ kDtRramMacroCount = 1 }
enum	dt_rram_macro_reg_block { kDtRramMacroRegBlockPrim = 0 }
	List of register blocks. More...
enum	{ kDtRramMacroRegBlockCount = 1 }
enum	dt_rram_macro_clock { kDtRramMacroClockClk = 0 }
	List of clock ports. More...
enum	{ kDtRramMacroClockCount = 1 }
enum	dt_rram_macro_reset { kDtRramMacroResetRst = 0 }
	List of reset ports. More...
enum	{ kDtRramMacroResetCount = 1 }
enum	dt_rram_macro_periph_io {   kDtRramMacroPeriphIoTck = 0 ,   kDtRramMacroPeriphIoTms = 1 ,   kDtRramMacroPeriphIoTdi = 2 ,   kDtRramMacroPeriphIoTdo = 3 }
	List of peripheral I/O. More...
enum	{ kDtRramMacroPeriphIoCount = 4 }

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.

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

Definition in file rram_macro.h.

Typedef Documentation

dt_rram_macro_clock_t

typedef enum dt_rram_macro_clock dt_rram_macro_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_rram_macro_periph_io_t

typedef enum dt_rram_macro_periph_io dt_rram_macro_periph_io_t

List of peripheral I/O.

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

dt_rram_macro_reg_block_t

typedef enum dt_rram_macro_reg_block dt_rram_macro_reg_block_t

List of register blocks.

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

dt_rram_macro_reset_t

typedef enum dt_rram_macro_reset dt_rram_macro_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kDtRramMacroRegBlockCount	Number of register blocks.

Definition at line 48 of file rram_macro.h.

anonymous enum

anonymous enum

Enumerator
kDtRramMacroResetCount	Number of reset ports.

Definition at line 79 of file rram_macro.h.

anonymous enum

anonymous enum

Enumerator
kDtRramMacroClockCount	Number of clock ports.

Definition at line 65 of file rram_macro.h.

anonymous enum

anonymous enum

Enumerator
kDtRramMacroPeriphIoCount	Number of peripheral I/O.

Definition at line 96 of file rram_macro.h.

anonymous enum

anonymous enum

Enumerator
kDtRramMacroCount	Number of instances.

Definition at line 34 of file rram_macro.h.

dt_rram_macro

enum dt_rram_macro

List of instances.

Enumerator
kDtRramMacroFirst	First instance.
kDtRramMacro	rram_macro

Definition at line 29 of file rram_macro.h.

dt_rram_macro_clock

enum dt_rram_macro_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRramMacroClockClk	Clock port clk_i.

Definition at line 61 of file rram_macro.h.

dt_rram_macro_periph_io

enum dt_rram_macro_periph_io

List of peripheral I/O.

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

Definition at line 89 of file rram_macro.h.

dt_rram_macro_reg_block

enum dt_rram_macro_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 rram_macro.h.

dt_rram_macro_reset

enum dt_rram_macro_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRramMacroResetRst	Reset port rst_ni.

Definition at line 75 of file rram_macro.h.

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.