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

#include "dt/dt_rstmgr.h"
#include "dt_sysrst_ctrl.h"
#include "dt_aon_timer.h"

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

struct	dt_desc_rstmgr.ext

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

Typedefs
typedef struct dt_desc_rstmgr	dt_desc_rstmgr_t
	Description of instances.

Functions
dt_rstmgr_t	dt_rstmgr_from_instance_id (dt_instance_id_t inst_id)
	Get the rstmgr instance from an instance ID.

dt_instance_id_t	dt_rstmgr_instance_id (dt_rstmgr_t dt)
	Get the instance ID of an instance.

uint32_t	dt_rstmgr_reg_block (dt_rstmgr_t dt, dt_rstmgr_reg_block_t reg_block)
	Get the register base address of an instance.

dt_alert_id_t	dt_rstmgr_alert_to_alert_id (dt_rstmgr_t dt, dt_rstmgr_alert_t alert)
	Get the alert ID of a rstmgr alert for a given instance.

dt_rstmgr_alert_t	dt_rstmgr_alert_from_alert_id (dt_rstmgr_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local rstmgr alert type.

dt_clock_t	dt_rstmgr_clock (dt_rstmgr_t dt, dt_rstmgr_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_rstmgr_reset (dt_rstmgr_t dt, dt_rstmgr_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

size_t	dt_rstmgr_sw_reset_count (dt_rstmgr_t dt)
	Get the number of software resets.

dt_reset_t	dt_rstmgr_sw_reset (dt_rstmgr_t dt, size_t idx)
	Get the reset ID of a software reset.

Detailed Description

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

Definition in file dt_rstmgr.c.

Data Structure Documentation

◆ dt_desc_rstmgr

struct dt_desc_rstmgr

Description of instances.

Definition at line 21 of file dt_rstmgr.c.

Data Fields
uint32_t	base_addr[kDtRstmgrRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtRstmgrClockCount]	Clock signal connected to each clock port.
struct dt_desc_rstmgr	ext	Extension.
struct dt_desc_rstmgr	ext	Extension.
struct dt_desc_rstmgr.ext	ext	Extension.
top_darjeeling_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
top_earlgrey_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
dt_instance_id_t	inst_id	Instance ID.
dt_reset_t	reset[kDtRstmgrResetCount]	Reset signal connected to each reset port.

◆ dt_desc_rstmgr.ext

struct dt_desc_rstmgr.ext

Definition at line 25 of file dt_rstmgr.c.

Data Fields
dt_rstmgr_reset_req_src_t	hw_req[4]	List of hardware reset requests, in the order of the register fields.
dt_rstmgr_reset_req_src_t	hw_req[5]	List of hardware reset requests, in the order of the register fields.
dt_rstmgr_reset_req_src_t	hw_req[5]	List of hardware reset requests, in the order of the register fields.
dt_reset_t	sw_rst[3]	List of software resets, in the order of the register fields.
dt_reset_t	sw_rst[3]	List of software resets, in the order of the register fields.
dt_reset_t	sw_rst[8]	List of software resets, in the order of the register fields.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_rstmgr_t)0 || (dt) >= kDtRstmgrCount) return (default); &rstmgr_desc[dt]; })

Return a pointer to the dt_rstmgr_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 104 of file dt_rstmgr.c.

Function Documentation

◆ dt_rstmgr_alert_from_alert_id()

dt_rstmgr_alert_t dt_rstmgr_alert_from_alert_id	(	dt_rstmgr_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns: The rstmgr alert, or kDtRstmgrAlertCount.

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

Definition at line 132 of file dt_rstmgr.c.

◆ dt_rstmgr_alert_to_alert_id()

dt_alert_id_t dt_rstmgr_alert_to_alert_id	(	dt_rstmgr_t	dt,
		dt_rstmgr_alert_t	alert )

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

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

Definition at line 126 of file dt_rstmgr.c.

◆ dt_rstmgr_clock()

dt_clock_t dt_rstmgr_clock	(	dt_rstmgr_t	dt,
		dt_rstmgr_clock_t	clk )

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

Parameters

dt	Instance of rstmgr.
clk	Clock port.

Returns: Clock signal.

Definition at line 144 of file dt_rstmgr.c.

◆ dt_rstmgr_from_instance_id()

dt_rstmgr_t dt_rstmgr_from_instance_id ( dt_instance_id_t inst_id )

Get the rstmgr instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A rstmgr instance.

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

Definition at line 106 of file dt_rstmgr.c.

◆ dt_rstmgr_instance_id()

dt_instance_id_t dt_rstmgr_instance_id ( dt_rstmgr_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of rstmgr.

Returns: The instance ID of that instance.

Definition at line 113 of file dt_rstmgr.c.

◆ dt_rstmgr_reg_block()

uint32_t dt_rstmgr_reg_block	(	dt_rstmgr_t	dt,
		dt_rstmgr_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of rstmgr.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 118 of file dt_rstmgr.c.

◆ dt_rstmgr_reset()

dt_reset_t dt_rstmgr_reset	(	dt_rstmgr_t	dt,
		dt_rstmgr_reset_t	rst )

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

Parameters

dt	Instance of rstmgr.
rst	Reset port.

Returns: Reset signal.

Definition at line 151 of file dt_rstmgr.c.

◆ dt_rstmgr_sw_reset()

dt_reset_t dt_rstmgr_sw_reset	(	dt_rstmgr_t	dt,
		size_t	idx )

Get the reset ID of a software reset.

The resets are ordered in the same way as they appear in the registers.

Parameters

dt	Instance of rstmgr.
idx	Index of the software reset, between 0 and `dt_rstmgr_sw_reset_count(dt)-1`.

Returns: Reset ID, or kDtResetUnknown for invalid parameters.

Definition at line 166 of file dt_rstmgr.c.

◆ dt_rstmgr_sw_reset_count()

size_t dt_rstmgr_sw_reset_count ( dt_rstmgr_t dt )

Get the number of software resets.

Parameters

dt	Instance of rstmgr.

Returns: Number of software resets.

Definition at line 162 of file dt_rstmgr.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_rstmgr

◆ dt_desc_rstmgr.ext

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_rstmgr_alert_from_alert_id()

◆ dt_rstmgr_alert_to_alert_id()

◆ dt_rstmgr_clock()

◆ dt_rstmgr_from_instance_id()

◆ dt_rstmgr_instance_id()

◆ dt_rstmgr_reg_block()

◆ dt_rstmgr_reset()

◆ dt_rstmgr_sw_reset()

◆ dt_rstmgr_sw_reset_count()