SYSRST_CTRL Device Interface Functions More...

#include <stdbool.h>
#include <stdint.h>
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"
#include "dt/dt_sysrst_ctrl.h"

Go to the source code of this file.

Data Structures
struct	dif_sysrst_ctrl
	A handle to sysrst_ctrl. More...

Macros
#define	kDifSysrstCtrlIrqEventDetected kDtSysrstCtrlIrqEventDetected
	A sysrst_ctrl interrupt request type.

Typedefs
typedef struct dif_sysrst_ctrl	dif_sysrst_ctrl_t
	A handle to sysrst_ctrl.

typedef enum dif_sysrst_ctrl_alert	dif_sysrst_ctrl_alert_t
	A sysrst_ctrl alert type.

typedef dt_sysrst_ctrl_irq_t	dif_sysrst_ctrl_irq_t

typedef uint32_t	dif_sysrst_ctrl_irq_state_snapshot_t
	A snapshot of the state of the interrupts for this IP.

typedef uint32_t	dif_sysrst_ctrl_irq_enable_snapshot_t
	A snapshot of the enablement state of the interrupts for this IP.

Enumerations
enum	dif_sysrst_ctrl_alert { kDifSysrstCtrlAlertFatalFault = 0 }
	A sysrst_ctrl alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_init (mmio_region_t base_addr, dif_sysrst_ctrl_t *sysrst_ctrl)
	Creates a new handle for a(n) sysrst_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_init_from_dt (dt_sysrst_ctrl_t dt, dif_sysrst_ctrl_t *sysrst_ctrl)
	Creates a new handle for a(n) sysrst_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_get_dt (const dif_sysrst_ctrl_t sysrst_ctrl, dt_sysrst_ctrl_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_alert_force (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_alert_t alert)
	Forces a particular alert, causing it to be escalated as if the hardware had raised it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_get_type (const dif_sysrst_ctrl_t sysrst_ctrl, dif_sysrst_ctrl_irq_t, dif_irq_type_t type)
	Returns the type of a given interrupt (i.e., event or status) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_get_state (const dif_sysrst_ctrl_t sysrst_ctrl, dif_sysrst_ctrl_irq_state_snapshot_t snapshot)
	Returns the state of all interrupts (i.e., pending or not) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_is_pending (const dif_sysrst_ctrl_t sysrst_ctrl, dif_sysrst_ctrl_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_acknowledge_state (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_irq_state_snapshot_t snapshot)
	Acknowledges all interrupts that were pending at the time of the state snapshot.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_acknowledge_all (const dif_sysrst_ctrl_t *sysrst_ctrl)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_acknowledge (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_force (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_irq_t, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_get_enabled (const dif_sysrst_ctrl_t sysrst_ctrl, dif_sysrst_ctrl_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_set_enabled (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_disable_all (const dif_sysrst_ctrl_t sysrst_ctrl, dif_sysrst_ctrl_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_sysrst_ctrl_irq_restore_all (const dif_sysrst_ctrl_t sysrst_ctrl, const dif_sysrst_ctrl_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

SYSRST_CTRL Device Interface Functions

Definition in file dif_sysrst_ctrl_autogen.h.

Data Structure Documentation

◆ dif_sysrst_ctrl

struct dif_sysrst_ctrl

A handle to sysrst_ctrl.

This type should be treated as opaque by users.

Definition at line 37 of file dif_sysrst_ctrl_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the sysrst_ctrl hardware registers.
dt_sysrst_ctrl_t	dt	The instance, set to `kDtSysrstCtrlCount` if not initialized through `dif_sysrst_ctrl_init_from_dt`.

Macro Definition Documentation

◆ kDifSysrstCtrlIrqEventDetected

#define kDifSysrstCtrlIrqEventDetected kDtSysrstCtrlIrqEventDetected

A sysrst_ctrl interrupt request type.

DEPRECATED Use dt_sysrst_ctrl_irq_t instead. This enumeration exists solely for the transition to dt-based interrupt numbers and will be removed in the future.

The following are defines to keep the types consistent with DT. Common interrupt triggered by combo or keyboard events.

Definition at line 134 of file dif_sysrst_ctrl_autogen.h.

Typedef Documentation

◆ dif_sysrst_ctrl_irq_enable_snapshot_t

typedef uint32_t dif_sysrst_ctrl_irq_enable_snapshot_t

A snapshot of the enablement state of the interrupts for this IP.

This is an opaque type, to be used with the dif_sysrst_ctrl_irq_disable_all() and dif_sysrst_ctrl_irq_restore_all() functions.

Definition at line 244 of file dif_sysrst_ctrl_autogen.h.

◆ dif_sysrst_ctrl_irq_state_snapshot_t

typedef uint32_t dif_sysrst_ctrl_irq_state_snapshot_t

A snapshot of the state of the interrupts for this IP.

This is an opaque type, to be used with the dif_sysrst_ctrl_irq_get_state() and dif_sysrst_ctrl_irq_acknowledge_state() functions.

Definition at line 142 of file dif_sysrst_ctrl_autogen.h.

◆ dif_sysrst_ctrl_irq_t

typedef dt_sysrst_ctrl_irq_t dif_sysrst_ctrl_irq_t

Definition at line 120 of file dif_sysrst_ctrl_autogen.h.

◆ dif_sysrst_ctrl_t

typedef struct dif_sysrst_ctrl dif_sysrst_ctrl_t

A handle to sysrst_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_sysrst_ctrl_alert

enum dif_sysrst_ctrl_alert

A sysrst_ctrl alert type.

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

Definition at line 98 of file dif_sysrst_ctrl_autogen.h.

Function Documentation

◆ dif_sysrst_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_alert_force	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_alert_t	alert )

Forces a particular alert, causing it to be escalated as if the hardware had raised it.

Parameters

sysrst_ctrl	A sysrst_ctrl handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_get_dt	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dt_sysrst_ctrl_t *	dt )

Get the DT handle from this DIF.

If this DIF was initialized by dif_sysrst_ctrl_init_from_dt(dt, ..) then this function will return dt. Otherwise it will return an error.

Parameters

	sysrst_ctrl	A sysrst_ctrl handle.
[out]	dt	DT handle.

Returns: kDifBadArg if the DIF has no DT information, kDifOk otherwise.

Definition at line 52 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_init	(	mmio_region_t	base_addr,
		dif_sysrst_ctrl_t *	sysrst_ctrl )

Creates a new handle for a(n) sysrst_ctrl peripheral.

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the sysrst_ctrl peripheral.
[out]	sysrst_ctrl	Out param for the initialized handle.

Returns: The result of the operation.

DEPRECATED This function exists solely for the transition to dt-based DIFs and will be removed in the future.

Definition at line 25 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_init_from_dt	(	dt_sysrst_ctrl_t	dt,
		dif_sysrst_ctrl_t *	sysrst_ctrl )

Creates a new handle for a(n) sysrst_ctrl peripheral.

This function does not actuate the hardware.

Parameters

	dt	The devicetable description of the device.
[out]	sysrst_ctrl	Out param for the initialized handle.

Returns: The result of the operation.

Definition at line 39 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_acknowledge	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_t	irq )

Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

Parameters

sysrst_ctrl	A sysrst_ctrl handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 209 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_acknowledge_all ( const dif_sysrst_ctrl_t * sysrst_ctrl )

Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

Parameters

sysrst_ctrl A sysrst_ctrl handle.

Returns: The result of the operation.

Definition at line 190 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_acknowledge_state	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_state_snapshot_t	snapshot )

Acknowledges all interrupts that were pending at the time of the state snapshot.

Parameters

sysrst_ctrl	A sysrst_ctrl handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 148 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_disable_all	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_enable_snapshot_t *	snapshot )

Disables all interrupts, optionally snapshotting all enable states for later restoration.

Parameters

	sysrst_ctrl	A sysrst_ctrl handle.
[out]	snapshot	Out-param for the snapshot; may be `NULL`.

Returns: The result of the operation.

Definition at line 317 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_force	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_t	irq,
		const bool	val )

Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

Parameters

sysrst_ctrl	A sysrst_ctrl handle.
irq	An interrupt request.
val	Value to be set.

Returns: The result of the operation.

Definition at line 234 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_get_enabled	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

	sysrst_ctrl	A sysrst_ctrl handle.
	irq	An interrupt request.
[out]	state	Out-param toggle state of the interrupt.

Returns: The result of the operation.

Definition at line 259 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_get_state	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_state_snapshot_t *	snapshot )

Returns the state of all interrupts (i.e., pending or not) for this IP.

Parameters

	sysrst_ctrl	A sysrst_ctrl handle.
[out]	snapshot	Out-param for interrupt state snapshot.

Returns: The result of the operation.

Definition at line 131 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_get_type	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_t	irq,
		dif_irq_type_t *	type )

Returns the type of a given interrupt (i.e., event or status) for this IP.

Parameters

	sysrst_ctrl	A sysrst_ctrl handle.
	irq	An interrupt request.
[out]	type	Out-param for the interrupt type.

Returns: The result of the operation.

Definition at line 112 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_is_pending	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	sysrst_ctrl	A sysrst_ctrl handle.
	irq	An interrupt request.
[out]	is_pending	Out-param for whether the interrupt is pending.

Returns: The result of the operation.

Definition at line 165 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_restore_all	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		const dif_sysrst_ctrl_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

sysrst_ctrl	A sysrst_ctrl handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 344 of file dif_sysrst_ctrl_autogen.c.

◆ dif_sysrst_ctrl_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_irq_set_enabled	(	const dif_sysrst_ctrl_t *	sysrst_ctrl,
		dif_sysrst_ctrl_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

sysrst_ctrl	A sysrst_ctrl handle.
irq	An interrupt request.
state	The new toggle state for the interrupt.

Returns: The result of the operation.

Definition at line 286 of file dif_sysrst_ctrl_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_sysrst_ctrl

Macro Definition Documentation

◆ kDifSysrstCtrlIrqEventDetected

Typedef Documentation

◆ dif_sysrst_ctrl_irq_enable_snapshot_t

◆ dif_sysrst_ctrl_irq_state_snapshot_t

◆ dif_sysrst_ctrl_irq_t

◆ dif_sysrst_ctrl_t

Enumeration Type Documentation

◆ dif_sysrst_ctrl_alert

Function Documentation

◆ dif_sysrst_ctrl_alert_force()

◆ dif_sysrst_ctrl_get_dt()

◆ dif_sysrst_ctrl_init()

◆ dif_sysrst_ctrl_init_from_dt()

◆ dif_sysrst_ctrl_irq_acknowledge()

◆ dif_sysrst_ctrl_irq_acknowledge_all()

◆ dif_sysrst_ctrl_irq_acknowledge_state()

◆ dif_sysrst_ctrl_irq_disable_all()

◆ dif_sysrst_ctrl_irq_force()

◆ dif_sysrst_ctrl_irq_get_enabled()

◆ dif_sysrst_ctrl_irq_get_state()

◆ dif_sysrst_ctrl_irq_get_type()

◆ dif_sysrst_ctrl_irq_is_pending()

◆ dif_sysrst_ctrl_irq_restore_all()

◆ dif_sysrst_ctrl_irq_set_enabled()