MBX 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_mbx.h"

Go to the source code of this file.

Data Structures
struct	dif_mbx
	A handle to mbx. More...

Macros
#define	kDifMbxIrqMbxReady kDtMbxIrqMbxReady
	A mbx interrupt request type.

#define	kDifMbxIrqMbxAbort kDtMbxIrqMbxAbort
	An abort request was received from the requester.

#define	kDifMbxIrqMbxError kDtMbxIrqMbxError
	The mailbox instance generated an error.

Typedefs
typedef struct dif_mbx	dif_mbx_t
	A handle to mbx.

typedef enum dif_mbx_alert	dif_mbx_alert_t
	A mbx alert type.

typedef dt_mbx_irq_t	dif_mbx_irq_t

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

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

Enumerations
enum	dif_mbx_alert { kDifMbxAlertFatalFault = 0 , kDifMbxAlertRecovFault = 1 }
	A mbx alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_init (mmio_region_t base_addr, dif_mbx_t *mbx)
	Creates a new handle for a(n) mbx peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_init_from_dt (dt_mbx_t dt, dif_mbx_t *mbx)
	Creates a new handle for a(n) mbx peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_get_dt (const dif_mbx_t mbx, dt_mbx_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_alert_force (const dif_mbx_t *mbx, dif_mbx_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_mbx_irq_get_type (const dif_mbx_t mbx, dif_mbx_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_mbx_irq_get_state (const dif_mbx_t mbx, dif_mbx_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_mbx_irq_is_pending (const dif_mbx_t mbx, dif_mbx_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_irq_acknowledge_state (const dif_mbx_t *mbx, dif_mbx_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_mbx_irq_acknowledge_all (const dif_mbx_t *mbx)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_irq_acknowledge (const dif_mbx_t *mbx, dif_mbx_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_irq_force (const dif_mbx_t *mbx, dif_mbx_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_mbx_irq_get_enabled (const dif_mbx_t mbx, dif_mbx_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_irq_set_enabled (const dif_mbx_t *mbx, dif_mbx_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_irq_disable_all (const dif_mbx_t mbx, dif_mbx_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_mbx_irq_restore_all (const dif_mbx_t mbx, const dif_mbx_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

MBX Device Interface Functions

Definition in file dif_mbx_autogen.h.

Data Structure Documentation

◆ dif_mbx

struct dif_mbx

A handle to mbx.

This type should be treated as opaque by users.

Definition at line 37 of file dif_mbx_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the mbx hardware registers.
dt_mbx_t	dt	The instance, set to `kDtMbxCount` if not initialized through `dif_mbx_init_from_dt`.

Macro Definition Documentation

◆ kDifMbxIrqMbxAbort

#define kDifMbxIrqMbxAbort kDtMbxIrqMbxAbort

An abort request was received from the requester.

Definition at line 142 of file dif_mbx_autogen.h.

◆ kDifMbxIrqMbxError

#define kDifMbxIrqMbxError kDtMbxIrqMbxError

The mailbox instance generated an error.

Definition at line 146 of file dif_mbx_autogen.h.

◆ kDifMbxIrqMbxReady

#define kDifMbxIrqMbxReady kDtMbxIrqMbxReady

A mbx interrupt request type.

DEPRECATED Use dt_mbx_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. A new object was received in the inbound mailbox.

Definition at line 138 of file dif_mbx_autogen.h.

Typedef Documentation

◆ dif_mbx_irq_enable_snapshot_t

typedef uint32_t dif_mbx_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_mbx_irq_disable_all() and dif_mbx_irq_restore_all() functions.

Definition at line 256 of file dif_mbx_autogen.h.

◆ dif_mbx_irq_state_snapshot_t

typedef uint32_t dif_mbx_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_mbx_irq_get_state() and dif_mbx_irq_acknowledge_state() functions.

Definition at line 154 of file dif_mbx_autogen.h.

◆ dif_mbx_irq_t

typedef dt_mbx_irq_t dif_mbx_irq_t

Definition at line 124 of file dif_mbx_autogen.h.

◆ dif_mbx_t

typedef struct dif_mbx dif_mbx_t

A handle to mbx.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_mbx_alert

enum dif_mbx_alert

A mbx alert type.

Enumerator
kDifMbxAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
kDifMbxAlertRecovFault	This recoverable alert is triggered when memory with invalid ECC (e.g., uninitialized memory) or at an invalid address is accessed.

Definition at line 98 of file dif_mbx_autogen.h.

Function Documentation

◆ dif_mbx_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_alert_force	(	const dif_mbx_t *	mbx,
		dif_mbx_alert_t	alert )

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

Parameters

mbx	A mbx handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_mbx_autogen.c.

◆ dif_mbx_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_get_dt	(	const dif_mbx_t *	mbx,
		dt_mbx_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 52 of file dif_mbx_autogen.c.

◆ dif_mbx_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_init	(	mmio_region_t	base_addr,
		dif_mbx_t *	mbx )

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

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the mbx peripheral.
[out]	mbx	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_mbx_autogen.c.

◆ dif_mbx_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_init_from_dt	(	dt_mbx_t	dt,
		dif_mbx_t *	mbx )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 39 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_acknowledge	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_t	irq )

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

Parameters

mbx	A mbx handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 220 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_acknowledge_all ( const dif_mbx_t * mbx )

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

Parameters

mbx	A mbx handle.

Returns: The result of the operation.

Definition at line 201 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_acknowledge_state	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_state_snapshot_t	snapshot )

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

Parameters

mbx	A mbx handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 159 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_disable_all	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 328 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_force	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 245 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_get_enabled	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 270 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_get_state	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 142 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_get_type	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 123 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_is_pending	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	mbx	A mbx 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 176 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_restore_all	(	const dif_mbx_t *	mbx,
		const dif_mbx_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

mbx	A mbx handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 355 of file dif_mbx_autogen.c.

◆ dif_mbx_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_mbx_irq_set_enabled	(	const dif_mbx_t *	mbx,
		dif_mbx_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 297 of file dif_mbx_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_mbx

Macro Definition Documentation

◆ kDifMbxIrqMbxAbort

◆ kDifMbxIrqMbxError

◆ kDifMbxIrqMbxReady

Typedef Documentation

◆ dif_mbx_irq_enable_snapshot_t

◆ dif_mbx_irq_state_snapshot_t

◆ dif_mbx_irq_t

◆ dif_mbx_t

Enumeration Type Documentation

◆ dif_mbx_alert

Function Documentation

◆ dif_mbx_alert_force()

◆ dif_mbx_get_dt()

◆ dif_mbx_init()

◆ dif_mbx_init_from_dt()

◆ dif_mbx_irq_acknowledge()

◆ dif_mbx_irq_acknowledge_all()

◆ dif_mbx_irq_acknowledge_state()

◆ dif_mbx_irq_disable_all()

◆ dif_mbx_irq_force()

◆ dif_mbx_irq_get_enabled()

◆ dif_mbx_irq_get_state()

◆ dif_mbx_irq_get_type()

◆ dif_mbx_irq_is_pending()

◆ dif_mbx_irq_restore_all()

◆ dif_mbx_irq_set_enabled()