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

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

Macros
#define	OPENTITAN_SYSRST_CTRL_HAS_COMBO_DETECT 1
	List of supported hardware features.

#define	OPENTITAN_SYSRST_CTRL_HAS_AUTO_BLOCK_KEY_OUTPUT 1

#define	OPENTITAN_SYSRST_CTRL_HAS_INPUT_TRIGGERED_INTERRUPT 1

#define	OPENTITAN_SYSRST_CTRL_HAS_ULTRA_LOW_POWER_WAKEUP 1

#define	OPENTITAN_SYSRST_CTRL_HAS_PINOUT_KEY_INVERSION_CONTROL 1

#define	OPENTITAN_SYSRST_CTRL_HAS_HARDWARE_RESET_STRETCH 1

#define	OPENTITAN_SYSRST_CTRL_HAS_FLASH_WRITE_PROTECT 1

#define	OPENTITAN_SYSRST_CTRL_HAS_PIN_INPUT_VALUE_ACCESS 1

Typedefs
typedef enum dt_sysrst_ctrl	dt_sysrst_ctrl_t
	List of instances.

typedef enum dt_sysrst_ctrl_reg_block	dt_sysrst_ctrl_reg_block_t
	List of register blocks.

typedef enum dt_sysrst_ctrl_memory	dt_sysrst_ctrl_memory_t
	List of memories.

typedef enum dt_sysrst_ctrl_irq	dt_sysrst_ctrl_irq_t
	List of IRQs.

typedef enum dt_sysrst_ctrl_alert	dt_sysrst_ctrl_alert_t
	List of Alerts.

typedef enum dt_sysrst_ctrl_clock	dt_sysrst_ctrl_clock_t
	List of clock ports.

typedef enum dt_sysrst_ctrl_reset_req	dt_sysrst_ctrl_reset_req_t
	List of reset requests.

typedef enum dt_sysrst_ctrl_reset	dt_sysrst_ctrl_reset_t
	List of reset ports.

typedef enum dt_sysrst_ctrl_periph_io	dt_sysrst_ctrl_periph_io_t
	List of peripheral I/O.

typedef enum dt_sysrst_ctrl_wakeup	dt_sysrst_ctrl_wakeup_t
	List of wakeups.

Enumerations
enum	dt_sysrst_ctrl { kDtSysrstCtrlAon = 0 , kDtSysrstCtrlFirst = 0 , kDtSysrstCtrlCount = 1 }
	List of instances. More...

enum	dt_sysrst_ctrl_reg_block { kDtSysrstCtrlRegBlockCore = 0 , kDtSysrstCtrlRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_sysrst_ctrl_memory { kDtSysrstCtrlMemoryCount = 0 }
	List of memories. More...

enum	dt_sysrst_ctrl_irq { kDtSysrstCtrlIrqEventDetected = 0 , kDtSysrstCtrlIrqCount = 1 }
	List of IRQs. More...

enum	dt_sysrst_ctrl_alert { kDtSysrstCtrlAlertFatalFault = 0 , kDtSysrstCtrlAlertCount = 1 }
	List of Alerts. More...

enum	dt_sysrst_ctrl_clock { kDtSysrstCtrlClockClk = 0 , kDtSysrstCtrlClockAon = 1 , kDtSysrstCtrlClockCount = 2 }
	List of clock ports. More...

enum	dt_sysrst_ctrl_reset_req { kDtSysrstCtrlResetReqRstReq = 0 , kDtSysrstCtrlResetReqCount = 1 }
	List of reset requests. More...

enum	dt_sysrst_ctrl_reset { kDtSysrstCtrlResetRst = 0 , kDtSysrstCtrlResetAon = 1 , kDtSysrstCtrlResetCount = 2 }
	List of reset ports. More...

enum	dt_sysrst_ctrl_periph_io { kDtSysrstCtrlPeriphIoAcPresent = 0 , kDtSysrstCtrlPeriphIoKey0In = 1 , kDtSysrstCtrlPeriphIoKey1In = 2 , kDtSysrstCtrlPeriphIoKey2In = 3 , kDtSysrstCtrlPeriphIoPwrbIn = 4 , kDtSysrstCtrlPeriphIoLidOpen = 5 , kDtSysrstCtrlPeriphIoBatDisable = 6 , kDtSysrstCtrlPeriphIoKey0Out = 7 , kDtSysrstCtrlPeriphIoKey1Out = 8 , kDtSysrstCtrlPeriphIoKey2Out = 9 , kDtSysrstCtrlPeriphIoPwrbOut = 10 , kDtSysrstCtrlPeriphIoZ3Wakeup = 11 , kDtSysrstCtrlPeriphIoEcRstL = 12 , kDtSysrstCtrlPeriphIoFlashWpL = 13 , kDtSysrstCtrlPeriphIoCount = 14 }
	List of peripheral I/O. More...

enum	dt_sysrst_ctrl_wakeup { kDtSysrstCtrlWakeupWkupReq = 0 , kDtSysrstCtrlWakeupCount = 1 }
	List of wakeups. More...

Functions
dt_sysrst_ctrl_t	dt_sysrst_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the sysrst_ctrl instance from an instance ID.

dt_instance_id_t	dt_sysrst_ctrl_instance_id (dt_sysrst_ctrl_t dt)
	Get the instance ID of an instance.

uint32_t	dt_sysrst_ctrl_reg_block (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.

uint32_t	dt_sysrst_ctrl_memory_base (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_memory_t mem)
	Get the base address of a memory.

uint32_t	dt_sysrst_ctrl_memory_size (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_memory_t mem)
	Get the size of a memory.

dt_plic_irq_id_t	dt_sysrst_ctrl_irq_to_plic_id (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_irq_t irq)
	Get the PLIC ID of a sysrst_ctrl IRQ for a given instance.

dt_sysrst_ctrl_irq_t	dt_sysrst_ctrl_irq_from_plic_id (dt_sysrst_ctrl_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local sysrst_ctrl IRQ type.

dt_alert_id_t	dt_sysrst_ctrl_alert_to_alert_id (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_alert_t alert)
	Get the alert ID of a sysrst_ctrl alert for a given instance.

dt_sysrst_ctrl_alert_t	dt_sysrst_ctrl_alert_from_alert_id (dt_sysrst_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local sysrst_ctrl alert type.

dt_periph_io_t	dt_sysrst_ctrl_periph_io (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_periph_io_t sig)
	Get the peripheral I/O description of an instance.

dt_clock_t	dt_sysrst_ctrl_clock (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_sysrst_ctrl_reset (dt_sysrst_ctrl_t dt, dt_sysrst_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

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

Definition in file dt_sysrst_ctrl.h.

Macro Definition Documentation

◆ OPENTITAN_SYSRST_CTRL_HAS_AUTO_BLOCK_KEY_OUTPUT

#define OPENTITAN_SYSRST_CTRL_HAS_AUTO_BLOCK_KEY_OUTPUT 1

Definition at line 146 of file dt_sysrst_ctrl.h.

◆ OPENTITAN_SYSRST_CTRL_HAS_COMBO_DETECT

#define OPENTITAN_SYSRST_CTRL_HAS_COMBO_DETECT 1

List of supported hardware features.

Definition at line 145 of file dt_sysrst_ctrl.h.

◆ OPENTITAN_SYSRST_CTRL_HAS_FLASH_WRITE_PROTECT

#define OPENTITAN_SYSRST_CTRL_HAS_FLASH_WRITE_PROTECT 1

Definition at line 151 of file dt_sysrst_ctrl.h.

◆ OPENTITAN_SYSRST_CTRL_HAS_HARDWARE_RESET_STRETCH

#define OPENTITAN_SYSRST_CTRL_HAS_HARDWARE_RESET_STRETCH 1

Definition at line 150 of file dt_sysrst_ctrl.h.

◆ OPENTITAN_SYSRST_CTRL_HAS_INPUT_TRIGGERED_INTERRUPT

#define OPENTITAN_SYSRST_CTRL_HAS_INPUT_TRIGGERED_INTERRUPT 1

Definition at line 147 of file dt_sysrst_ctrl.h.

◆ OPENTITAN_SYSRST_CTRL_HAS_PIN_INPUT_VALUE_ACCESS

#define OPENTITAN_SYSRST_CTRL_HAS_PIN_INPUT_VALUE_ACCESS 1

Definition at line 152 of file dt_sysrst_ctrl.h.

◆ OPENTITAN_SYSRST_CTRL_HAS_PINOUT_KEY_INVERSION_CONTROL

#define OPENTITAN_SYSRST_CTRL_HAS_PINOUT_KEY_INVERSION_CONTROL 1

Definition at line 149 of file dt_sysrst_ctrl.h.

◆ OPENTITAN_SYSRST_CTRL_HAS_ULTRA_LOW_POWER_WAKEUP

#define OPENTITAN_SYSRST_CTRL_HAS_ULTRA_LOW_POWER_WAKEUP 1

Definition at line 148 of file dt_sysrst_ctrl.h.

Typedef Documentation

◆ dt_sysrst_ctrl_alert_t

typedef enum dt_sysrst_ctrl_alert dt_sysrst_ctrl_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_sysrst_ctrl_clock_t

typedef enum dt_sysrst_ctrl_clock dt_sysrst_ctrl_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_sysrst_ctrl_irq_t

typedef enum dt_sysrst_ctrl_irq dt_sysrst_ctrl_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_sysrst_ctrl_memory_t

typedef enum dt_sysrst_ctrl_memory dt_sysrst_ctrl_memory_t

List of memories.

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

◆ dt_sysrst_ctrl_periph_io_t

typedef enum dt_sysrst_ctrl_periph_io dt_sysrst_ctrl_periph_io_t

List of peripheral I/O.

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

◆ dt_sysrst_ctrl_reg_block_t

typedef enum dt_sysrst_ctrl_reg_block dt_sysrst_ctrl_reg_block_t

List of register blocks.

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

◆ dt_sysrst_ctrl_reset_req_t

typedef enum dt_sysrst_ctrl_reset_req dt_sysrst_ctrl_reset_req_t

List of reset requests.

Reset requests are guaranteed to be numbered consecutively from 0.

◆ dt_sysrst_ctrl_reset_t

typedef enum dt_sysrst_ctrl_reset dt_sysrst_ctrl_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

◆ dt_sysrst_ctrl_wakeup_t

typedef enum dt_sysrst_ctrl_wakeup dt_sysrst_ctrl_wakeup_t

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_sysrst_ctrl

enum dt_sysrst_ctrl

List of instances.

Enumerator
kDtSysrstCtrlAon	sysrst_ctrl_aon

Definition at line 29 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_alert

enum dt_sysrst_ctrl_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSysrstCtrlAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 72 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_clock

enum dt_sysrst_ctrl_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSysrstCtrlClockClk	Clock port clk_i.
kDtSysrstCtrlClockAon	Clock port clk_aon_i.

Definition at line 82 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_irq

enum dt_sysrst_ctrl_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSysrstCtrlIrqEventDetected	Common interrupt triggered by combo or keyboard events.

Definition at line 62 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_memory

enum dt_sysrst_ctrl_memory

List of memories.

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

Definition at line 53 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_periph_io

enum dt_sysrst_ctrl_periph_io

List of peripheral I/O.

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

Definition at line 114 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_reg_block

enum dt_sysrst_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_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_reset

enum dt_sysrst_ctrl_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSysrstCtrlResetRst	Reset port rst_ni.
kDtSysrstCtrlResetAon	Reset port rst_aon_ni.

Definition at line 103 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_reset_req

enum dt_sysrst_ctrl_reset_req

List of reset requests.

Reset requests are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSysrstCtrlResetReqRstReq	OpenTitan reset request to `rstmgr` (running on AON clock).

Definition at line 93 of file dt_sysrst_ctrl.h.

◆ dt_sysrst_ctrl_wakeup

enum dt_sysrst_ctrl_wakeup

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSysrstCtrlWakeupWkupReq	OpenTitan wake request signal to `pwrmgr` (running on AON clock).

Definition at line 137 of file dt_sysrst_ctrl.h.

Function Documentation

◆ dt_sysrst_ctrl_alert_from_alert_id()

dt_sysrst_ctrl_alert_t dt_sysrst_ctrl_alert_from_alert_id	(	dt_sysrst_ctrl_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The sysrst_ctrl alert, or kDtSysrstCtrlAlertCount.

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

Definition at line 252 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_alert_to_alert_id()

dt_alert_id_t dt_sysrst_ctrl_alert_to_alert_id	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_alert_t	alert )

Get the alert ID of a sysrst_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 sysrst_ctrl.
alert	A sysrst_ctrl alert.

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

Definition at line 246 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_clock()

dt_clock_t dt_sysrst_ctrl_clock	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_clock_t	clk )

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

Parameters

dt	Instance of sysrst_ctrl.
clk	Clock port.

Returns: Clock signal.

Definition at line 270 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_from_instance_id()

dt_sysrst_ctrl_t dt_sysrst_ctrl_from_instance_id ( dt_instance_id_t inst_id )

Get the sysrst_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A sysrst_ctrl instance.

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

Definition at line 188 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_instance_id()

dt_instance_id_t dt_sysrst_ctrl_instance_id ( dt_sysrst_ctrl_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of sysrst_ctrl.

Returns: The instance ID of that instance.

Definition at line 195 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_irq_from_plic_id()

dt_sysrst_ctrl_irq_t dt_sysrst_ctrl_irq_from_plic_id	(	dt_sysrst_ctrl_t	dt,
		dt_plic_irq_id_t	irq )

Convert a global IRQ ID to a local sysrst_ctrl IRQ type.

Parameters

dt	Instance of sysrst_ctrl.
irq	A PLIC ID that belongs to this instance.

Returns: The sysrst_ctrl IRQ, or kDtSysrstCtrlIrqCount.

Note: This function assumes that the PLIC ID belongs to the instance of sysrst_ctrl passed in parameter. In other words, it must be the case that dt_sysrst_ctrl_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtSysrstCtrlIrqCount.

Definition at line 231 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_irq_to_plic_id()

dt_plic_irq_id_t dt_sysrst_ctrl_irq_to_plic_id	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_irq_t	irq )

Get the PLIC ID of a sysrst_ctrl IRQ for a given instance.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters

dt	Instance of sysrst_ctrl.
irq	A sysrst_ctrl IRQ.

Returns: The PLIC ID of the IRQ of this instance.

Definition at line 221 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_memory_base()

uint32_t dt_sysrst_ctrl_memory_base	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of sysrst_ctrl.
mem	The memory requested.

Returns: The base address of the requested memory.

Definition at line 207 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_memory_size()

uint32_t dt_sysrst_ctrl_memory_size	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of sysrst_ctrl.
mem	The memory requested.

Returns: The size of the requested memory.

Definition at line 214 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_periph_io()

dt_periph_io_t dt_sysrst_ctrl_periph_io	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

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

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

Definition at line 263 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_reg_block()

uint32_t dt_sysrst_ctrl_reg_block	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of sysrst_ctrl.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 200 of file dt_sysrst_ctrl.c.

◆ dt_sysrst_ctrl_reset()

dt_reset_t dt_sysrst_ctrl_reset	(	dt_sysrst_ctrl_t	dt,
		dt_sysrst_ctrl_reset_t	rst )

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

Parameters

dt	Instance of sysrst_ctrl.
rst	Reset port.

Returns: Reset signal.

Definition at line 277 of file dt_sysrst_ctrl.c.

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ OPENTITAN_SYSRST_CTRL_HAS_AUTO_BLOCK_KEY_OUTPUT

◆ OPENTITAN_SYSRST_CTRL_HAS_COMBO_DETECT

◆ OPENTITAN_SYSRST_CTRL_HAS_FLASH_WRITE_PROTECT

◆ OPENTITAN_SYSRST_CTRL_HAS_HARDWARE_RESET_STRETCH

◆ OPENTITAN_SYSRST_CTRL_HAS_INPUT_TRIGGERED_INTERRUPT

◆ OPENTITAN_SYSRST_CTRL_HAS_PIN_INPUT_VALUE_ACCESS

◆ OPENTITAN_SYSRST_CTRL_HAS_PINOUT_KEY_INVERSION_CONTROL

◆ OPENTITAN_SYSRST_CTRL_HAS_ULTRA_LOW_POWER_WAKEUP

Typedef Documentation

◆ dt_sysrst_ctrl_alert_t

◆ dt_sysrst_ctrl_clock_t

◆ dt_sysrst_ctrl_irq_t

◆ dt_sysrst_ctrl_memory_t

◆ dt_sysrst_ctrl_periph_io_t

◆ dt_sysrst_ctrl_reg_block_t

◆ dt_sysrst_ctrl_reset_req_t

◆ dt_sysrst_ctrl_reset_t

◆ dt_sysrst_ctrl_wakeup_t

Enumeration Type Documentation

◆ dt_sysrst_ctrl

◆ dt_sysrst_ctrl_alert

◆ dt_sysrst_ctrl_clock

◆ dt_sysrst_ctrl_irq

◆ dt_sysrst_ctrl_memory

◆ dt_sysrst_ctrl_periph_io

◆ dt_sysrst_ctrl_reg_block

◆ dt_sysrst_ctrl_reset

◆ dt_sysrst_ctrl_reset_req

◆ dt_sysrst_ctrl_wakeup

Function Documentation

◆ dt_sysrst_ctrl_alert_from_alert_id()

◆ dt_sysrst_ctrl_alert_to_alert_id()

◆ dt_sysrst_ctrl_clock()

◆ dt_sysrst_ctrl_from_instance_id()

◆ dt_sysrst_ctrl_instance_id()

◆ dt_sysrst_ctrl_irq_from_plic_id()

◆ dt_sysrst_ctrl_irq_to_plic_id()

◆ dt_sysrst_ctrl_memory_base()

◆ dt_sysrst_ctrl_memory_size()

◆ dt_sysrst_ctrl_periph_io()

◆ dt_sysrst_ctrl_reg_block()

◆ dt_sysrst_ctrl_reset()