ALERT_HANDLER 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 "hw/top/dt/alert_handler.h"

Data Structures
struct	dif_alert_handler
	A handle to alert_handler. More...

Macros
#define	kDifAlertHandlerIrqClassa kDtAlertHandlerIrqClassa
	A alert_handler interrupt request type.

#define	kDifAlertHandlerIrqClassb kDtAlertHandlerIrqClassb
	Interrupt state bit of Class B.

#define	kDifAlertHandlerIrqClassc kDtAlertHandlerIrqClassc
	Interrupt state bit of Class C.

#define	kDifAlertHandlerIrqClassd kDtAlertHandlerIrqClassd
	Interrupt state bit of Class D.

Typedefs
typedef struct dif_alert_handler	dif_alert_handler_t
	A handle to alert_handler.

typedef dt_alert_handler_irq_t	dif_alert_handler_irq_t

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

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

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_init (mmio_region_t base_addr, dif_alert_handler_t *alert_handler)
	Creates a new handle for a(n) alert_handler peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_init_from_dt (dt_alert_handler_t dt, dif_alert_handler_t *alert_handler)
	Creates a new handle for a(n) alert_handler peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_get_dt (const dif_alert_handler_t alert_handler, dt_alert_handler_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_irq_get_type (const dif_alert_handler_t alert_handler, dif_alert_handler_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_alert_handler_irq_get_state (const dif_alert_handler_t alert_handler, dif_alert_handler_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_alert_handler_irq_is_pending (const dif_alert_handler_t alert_handler, dif_alert_handler_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_irq_acknowledge_state (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_acknowledge_all (const dif_alert_handler_t *alert_handler)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_irq_acknowledge (const dif_alert_handler_t *alert_handler, dif_alert_handler_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_irq_force (const dif_alert_handler_t *alert_handler, dif_alert_handler_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_alert_handler_irq_get_enabled (const dif_alert_handler_t alert_handler, dif_alert_handler_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_irq_set_enabled (const dif_alert_handler_t *alert_handler, dif_alert_handler_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_irq_disable_all (const dif_alert_handler_t alert_handler, dif_alert_handler_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_alert_handler_irq_restore_all (const dif_alert_handler_t alert_handler, const dif_alert_handler_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

ALERT_HANDLER Device Interface Functions

Definition in file dif_alert_handler_autogen.h.

Data Structure Documentation

◆ dif_alert_handler

struct dif_alert_handler

A handle to alert_handler.

This type should be treated as opaque by users.

Definition at line 38 of file dif_alert_handler_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the alert_handler hardware registers.
dt_alert_handler_t	dt	The instance, set to `kDtAlertHandlerCount` if not initialized through `dif_alert_handler_init_from_dt`.

Macro Definition Documentation

◆ kDifAlertHandlerIrqClassa

#define kDifAlertHandlerIrqClassa kDtAlertHandlerIrqClassa

A alert_handler interrupt request type.

DEPRECATED Use dt_alert_handler_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. Interrupt state bit of Class A. Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

Definition at line 113 of file dif_alert_handler_autogen.h.

◆ kDifAlertHandlerIrqClassb

#define kDifAlertHandlerIrqClassb kDtAlertHandlerIrqClassb

Interrupt state bit of Class B.

Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

Definition at line 117 of file dif_alert_handler_autogen.h.

◆ kDifAlertHandlerIrqClassc

#define kDifAlertHandlerIrqClassc kDtAlertHandlerIrqClassc

Interrupt state bit of Class C.

Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

Definition at line 121 of file dif_alert_handler_autogen.h.

◆ kDifAlertHandlerIrqClassd

#define kDifAlertHandlerIrqClassd kDtAlertHandlerIrqClassd

Interrupt state bit of Class D.

Set by HW in case an alert within this class triggered. Defaults true, write one to clear.

Definition at line 125 of file dif_alert_handler_autogen.h.

Typedef Documentation

◆ dif_alert_handler_irq_enable_snapshot_t

typedef uint32_t dif_alert_handler_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_alert_handler_irq_disable_all() and dif_alert_handler_irq_restore_all() functions.

Definition at line 235 of file dif_alert_handler_autogen.h.

◆ dif_alert_handler_irq_state_snapshot_t

typedef uint32_t dif_alert_handler_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_alert_handler_irq_get_state() and dif_alert_handler_irq_acknowledge_state() functions.

Definition at line 133 of file dif_alert_handler_autogen.h.

◆ dif_alert_handler_irq_t

typedef dt_alert_handler_irq_t dif_alert_handler_irq_t

Definition at line 99 of file dif_alert_handler_autogen.h.

◆ dif_alert_handler_t

typedef struct dif_alert_handler dif_alert_handler_t

A handle to alert_handler.

This type should be treated as opaque by users.

Function Documentation

◆ dif_alert_handler_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_get_dt	(	const dif_alert_handler_t *	alert_handler,
		dt_alert_handler_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 53 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_init	(	mmio_region_t	base_addr,
		dif_alert_handler_t *	alert_handler )

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

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the alert_handler peripheral.
[out]	alert_handler	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 26 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_init_from_dt	(	dt_alert_handler_t	dt,
		dif_alert_handler_t *	alert_handler )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 40 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_t	irq )

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

Parameters

alert_handler	A alert_handler handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 197 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge_all ( const dif_alert_handler_t * alert_handler )

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

Parameters

alert_handler A alert_handler handle.

Returns: The result of the operation.

Definition at line 178 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_acknowledge_state	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_state_snapshot_t	snapshot )

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

Parameters

alert_handler	A alert_handler handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 136 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_disable_all	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 305 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_force	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 222 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_get_enabled	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 247 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_get_state	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 119 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_get_type	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 100 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_is_pending	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	alert_handler	A alert_handler 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 153 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_restore_all	(	const dif_alert_handler_t *	alert_handler,
		const dif_alert_handler_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

alert_handler	A alert_handler handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 332 of file dif_alert_handler_autogen.c.

◆ dif_alert_handler_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_alert_handler_irq_set_enabled	(	const dif_alert_handler_t *	alert_handler,
		dif_alert_handler_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 274 of file dif_alert_handler_autogen.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dif_alert_handler

Macro Definition Documentation

◆ kDifAlertHandlerIrqClassa

◆ kDifAlertHandlerIrqClassb

◆ kDifAlertHandlerIrqClassc

◆ kDifAlertHandlerIrqClassd

Typedef Documentation

◆ dif_alert_handler_irq_enable_snapshot_t

◆ dif_alert_handler_irq_state_snapshot_t

◆ dif_alert_handler_irq_t

◆ dif_alert_handler_t

Function Documentation

◆ dif_alert_handler_get_dt()

◆ dif_alert_handler_init()

◆ dif_alert_handler_init_from_dt()

◆ dif_alert_handler_irq_acknowledge()

◆ dif_alert_handler_irq_acknowledge_all()

◆ dif_alert_handler_irq_acknowledge_state()

◆ dif_alert_handler_irq_disable_all()

◆ dif_alert_handler_irq_force()

◆ dif_alert_handler_irq_get_enabled()

◆ dif_alert_handler_irq_get_state()

◆ dif_alert_handler_irq_get_type()

◆ dif_alert_handler_irq_is_pending()

◆ dif_alert_handler_irq_restore_all()

◆ dif_alert_handler_irq_set_enabled()