dt_rom_ctrl.h File Reference

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

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

Go to the source code of this file.

Macros
#define	OPENTITAN_ROM_CTRL_HAS_SCRAMBLED   1
	List of supported hardware features.
#define	OPENTITAN_ROM_CTRL_HAS_DIGESTS   1
#define	OPENTITAN_ROM_CTRL_HAS_EXP_DIGESTS   1

Typedefs
typedef enum dt_rom_ctrl	dt_rom_ctrl_t
	List of instances.
typedef enum dt_rom_ctrl_reg_block	dt_rom_ctrl_reg_block_t
	List of register blocks.
typedef enum dt_rom_ctrl_memory	dt_rom_ctrl_memory_t
	List of memories.
typedef enum dt_rom_ctrl_alert	dt_rom_ctrl_alert_t
	List of Alerts.
typedef enum dt_rom_ctrl_clock	dt_rom_ctrl_clock_t
	List of clock ports.
typedef enum dt_rom_ctrl_reset	dt_rom_ctrl_reset_t
	List of reset ports.

Enumerations
enum	dt_rom_ctrl {   kDtRomCtrl = 0 ,   kDtRomCtrlFirst = 0 ,   kDtRomCtrlCount = 1 }
	List of instances. More...
enum	dt_rom_ctrl_reg_block {   kDtRomCtrlRegBlockRegs = 0 ,   kDtRomCtrlRegBlockCount = 1 }
	List of register blocks. More...
enum	dt_rom_ctrl_memory {   kDtRomCtrlMemoryRom = 0 ,   kDtRomCtrlMemoryCount = 1 }
	List of memories. More...
enum	dt_rom_ctrl_alert {   kDtRomCtrlAlertFatal = 0 ,   kDtRomCtrlAlertCount = 1 }
	List of Alerts. More...
enum	dt_rom_ctrl_clock {   kDtRomCtrlClockClk = 0 ,   kDtRomCtrlClockCount = 1 }
	List of clock ports. More...
enum	dt_rom_ctrl_reset {   kDtRomCtrlResetRst = 0 ,   kDtRomCtrlResetCount = 1 }
	List of reset ports. More...

Functions
dt_rom_ctrl_t	dt_rom_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the rom_ctrl instance from an instance ID.
dt_instance_id_t	dt_rom_ctrl_instance_id (dt_rom_ctrl_t dt)
	Get the instance ID of an instance.
uint32_t	dt_rom_ctrl_reg_block (dt_rom_ctrl_t dt, dt_rom_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.
uint32_t	dt_rom_ctrl_memory_base (dt_rom_ctrl_t dt, dt_rom_ctrl_memory_t mem)
	Get the base address of a memory.
uint32_t	dt_rom_ctrl_memory_size (dt_rom_ctrl_t dt, dt_rom_ctrl_memory_t mem)
	Get the size of a memory.
dt_alert_id_t	dt_rom_ctrl_alert_to_alert_id (dt_rom_ctrl_t dt, dt_rom_ctrl_alert_t alert)
	Get the alert ID of a rom_ctrl alert for a given instance.
dt_rom_ctrl_alert_t	dt_rom_ctrl_alert_from_alert_id (dt_rom_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local rom_ctrl alert type.
dt_clock_t	dt_rom_ctrl_clock (dt_rom_ctrl_t dt, dt_rom_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_rom_ctrl_reset (dt_rom_ctrl_t dt, dt_rom_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

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

Definition in file dt_rom_ctrl.h.

Macro Definition Documentation

OPENTITAN_ROM_CTRL_HAS_DIGESTS

#define OPENTITAN_ROM_CTRL_HAS_DIGESTS   1

Definition at line 92 of file dt_rom_ctrl.h.

OPENTITAN_ROM_CTRL_HAS_EXP_DIGESTS

#define OPENTITAN_ROM_CTRL_HAS_EXP_DIGESTS   1

Definition at line 93 of file dt_rom_ctrl.h.

OPENTITAN_ROM_CTRL_HAS_SCRAMBLED

#define OPENTITAN_ROM_CTRL_HAS_SCRAMBLED   1

List of supported hardware features.

Definition at line 91 of file dt_rom_ctrl.h.

Typedef Documentation

dt_rom_ctrl_alert_t

typedef enum dt_rom_ctrl_alert dt_rom_ctrl_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

dt_rom_ctrl_clock_t

typedef enum dt_rom_ctrl_clock dt_rom_ctrl_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_rom_ctrl_memory_t

typedef enum dt_rom_ctrl_memory dt_rom_ctrl_memory_t

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

dt_rom_ctrl_reg_block_t

typedef enum dt_rom_ctrl_reg_block dt_rom_ctrl_reg_block_t

List of register blocks.

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

dt_rom_ctrl_reset_t

typedef enum dt_rom_ctrl_reset dt_rom_ctrl_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

dt_rom_ctrl

enum dt_rom_ctrl

List of instances.

Enumerator
kDtRomCtrl	rom_ctrl

Definition at line 29 of file dt_rom_ctrl.h.

dt_rom_ctrl_alert

enum dt_rom_ctrl_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRomCtrlAlertFatal	A fatal error. Fatal alerts are non-recoverable and will be asserted until a hard reset.

Definition at line 63 of file dt_rom_ctrl.h.

dt_rom_ctrl_clock

enum dt_rom_ctrl_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRomCtrlClockClk	Clock port clk_i.

Definition at line 73 of file dt_rom_ctrl.h.

dt_rom_ctrl_memory

enum dt_rom_ctrl_memory

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 53 of file dt_rom_ctrl.h.

dt_rom_ctrl_reg_block

enum dt_rom_ctrl_reg_block

List of register blocks.

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

Definition at line 40 of file dt_rom_ctrl.h.

dt_rom_ctrl_reset

enum dt_rom_ctrl_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRomCtrlResetRst	Reset port rst_ni.

Definition at line 83 of file dt_rom_ctrl.h.

Function Documentation

dt_rom_ctrl_alert_from_alert_id()

dt_rom_ctrl_alert_t dt_rom_ctrl_alert_from_alert_id	(	dt_rom_ctrl_t	dt,
		dt_alert_id_t	alert )

Convert a global alert ID to a local rom_ctrl alert type.

Parameters

dt	Instance of rom_ctrl.
alert	A global alert ID that belongs to this instance.

Returns

The rom_ctrl alert, or kDtRomCtrlAlertCount.

Note: This function assumes that the global alert ID belongs to the instance of rom_ctrl passed in parameter. In other words, it must be the case that dt_rom_ctrl_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtRomCtrlAlertCount.

Definition at line 106 of file dt_rom_ctrl.c.

dt_rom_ctrl_alert_to_alert_id()

dt_alert_id_t dt_rom_ctrl_alert_to_alert_id	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_alert_t	alert )

Get the alert ID of a rom_ctrl alert for a given instance.

Note: This function only makes sense if the instance is connected to the Alert Handler. For any instances where the instance is not connected, the return value is unspecified.

Parameters

dt	Instance of rom_ctrl.
alert	A rom_ctrl alert.

Returns

The Alert Handler alert ID of the alert of this instance.

Definition at line 100 of file dt_rom_ctrl.c.

dt_rom_ctrl_clock()

dt_clock_t dt_rom_ctrl_clock	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_clock_t	clk )

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

Parameters

dt	Instance of rom_ctrl.
clk	Clock port.

Returns

Clock signal.

Definition at line 118 of file dt_rom_ctrl.c.

dt_rom_ctrl_from_instance_id()

dt_rom_ctrl_t dt_rom_ctrl_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the rom_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A rom_ctrl instance.

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

Definition at line 66 of file dt_rom_ctrl.c.

dt_rom_ctrl_instance_id()

dt_instance_id_t dt_rom_ctrl_instance_id

(

dt_rom_ctrl_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of rom_ctrl.

Returns

The instance ID of that instance.

Definition at line 73 of file dt_rom_ctrl.c.

dt_rom_ctrl_memory_base()

uint32_t dt_rom_ctrl_memory_base	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of rom_ctrl.
mem	The memory requested.

Returns

The base address of the requested memory.

Definition at line 85 of file dt_rom_ctrl.c.

dt_rom_ctrl_memory_size()

uint32_t dt_rom_ctrl_memory_size	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of rom_ctrl.
mem	The memory requested.

Returns

The size of the requested memory.

Definition at line 92 of file dt_rom_ctrl.c.

dt_rom_ctrl_reg_block()

uint32_t dt_rom_ctrl_reg_block	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of rom_ctrl.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 78 of file dt_rom_ctrl.c.

dt_rom_ctrl_reset()

dt_reset_t dt_rom_ctrl_reset	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_reset_t	rst )

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

Parameters

dt	Instance of rom_ctrl.
rst	Reset port.

Returns

Reset signal.

Definition at line 125 of file dt_rom_ctrl.c.