CHERIOT_MEM_SYS 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/cheriot_mem_sys.h"

Data Structures
struct	dif_cheriot_mem_sys
	A handle to cheriot_mem_sys. More...

Macros
#define	kDifCheriotMemSysIrqTbreDone kDtCheriotMemSysIrqTbreDone
	A cheriot_mem_sys interrupt request type.

Typedefs
typedef struct dif_cheriot_mem_sys	dif_cheriot_mem_sys_t
	A handle to cheriot_mem_sys.

typedef enum dif_cheriot_mem_sys_alert	dif_cheriot_mem_sys_alert_t
	A cheriot_mem_sys alert type.

typedef dt_cheriot_mem_sys_irq_t	dif_cheriot_mem_sys_irq_t

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

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

Enumerations
enum	dif_cheriot_mem_sys_alert { kDifCheriotMemSysAlertFatalFault = 0 }
	A cheriot_mem_sys alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_init (mmio_region_t base_addr, dif_cheriot_mem_sys_t *cheriot_mem_sys)
	Creates a new handle for a(n) cheriot_mem_sys peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_init_from_dt (dt_cheriot_mem_sys_t dt, dif_cheriot_mem_sys_t *cheriot_mem_sys)
	Creates a new handle for a(n) cheriot_mem_sys peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_get_dt (const dif_cheriot_mem_sys_t cheriot_mem_sys, dt_cheriot_mem_sys_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_alert_force (const dif_cheriot_mem_sys_t *cheriot_mem_sys, dif_cheriot_mem_sys_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_cheriot_mem_sys_irq_get_type (const dif_cheriot_mem_sys_t cheriot_mem_sys, dif_cheriot_mem_sys_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_cheriot_mem_sys_irq_get_state (const dif_cheriot_mem_sys_t cheriot_mem_sys, dif_cheriot_mem_sys_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_cheriot_mem_sys_irq_is_pending (const dif_cheriot_mem_sys_t cheriot_mem_sys, dif_cheriot_mem_sys_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_irq_acknowledge_state (const dif_cheriot_mem_sys_t *cheriot_mem_sys, dif_cheriot_mem_sys_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_cheriot_mem_sys_irq_acknowledge_all (const dif_cheriot_mem_sys_t *cheriot_mem_sys)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_irq_acknowledge (const dif_cheriot_mem_sys_t *cheriot_mem_sys, dif_cheriot_mem_sys_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_irq_force (const dif_cheriot_mem_sys_t *cheriot_mem_sys, dif_cheriot_mem_sys_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_cheriot_mem_sys_irq_get_enabled (const dif_cheriot_mem_sys_t cheriot_mem_sys, dif_cheriot_mem_sys_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_irq_set_enabled (const dif_cheriot_mem_sys_t *cheriot_mem_sys, dif_cheriot_mem_sys_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_irq_disable_all (const dif_cheriot_mem_sys_t cheriot_mem_sys, dif_cheriot_mem_sys_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_cheriot_mem_sys_irq_restore_all (const dif_cheriot_mem_sys_t cheriot_mem_sys, const dif_cheriot_mem_sys_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

CHERIOT_MEM_SYS Device Interface Functions

Definition in file dif_cheriot_mem_sys_autogen.h.

Data Structure Documentation

◆ dif_cheriot_mem_sys

struct dif_cheriot_mem_sys

A handle to cheriot_mem_sys.

This type should be treated as opaque by users.

Definition at line 38 of file dif_cheriot_mem_sys_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the cheriot_mem_sys hardware registers.
dt_cheriot_mem_sys_t	dt	The instance, set to `kDtCheriotMemSysCount` if not initialized through `dif_cheriot_mem_sys_init_from_dt`.

Macro Definition Documentation

◆ kDifCheriotMemSysIrqTbreDone

#define kDifCheriotMemSysIrqTbreDone kDtCheriotMemSysIrqTbreDone

A cheriot_mem_sys interrupt request type.

DEPRECATED Use dt_cheriot_mem_sys_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. Raised when the revocation engine has resolved every capability of a sweep.

Definition at line 135 of file dif_cheriot_mem_sys_autogen.h.

Typedef Documentation

◆ dif_cheriot_mem_sys_irq_enable_snapshot_t

typedef uint32_t dif_cheriot_mem_sys_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_cheriot_mem_sys_irq_disable_all() and dif_cheriot_mem_sys_irq_restore_all() functions.

Definition at line 245 of file dif_cheriot_mem_sys_autogen.h.

◆ dif_cheriot_mem_sys_irq_state_snapshot_t

typedef uint32_t dif_cheriot_mem_sys_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_cheriot_mem_sys_irq_get_state() and dif_cheriot_mem_sys_irq_acknowledge_state() functions.

Definition at line 143 of file dif_cheriot_mem_sys_autogen.h.

◆ dif_cheriot_mem_sys_irq_t

typedef dt_cheriot_mem_sys_irq_t dif_cheriot_mem_sys_irq_t

Definition at line 121 of file dif_cheriot_mem_sys_autogen.h.

◆ dif_cheriot_mem_sys_t

typedef struct dif_cheriot_mem_sys dif_cheriot_mem_sys_t

A handle to cheriot_mem_sys.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_cheriot_mem_sys_alert

enum dif_cheriot_mem_sys_alert

A cheriot_mem_sys alert type.

Enumerator
kDifCheriotMemSysAlertFatalFault	This fatal alert is triggered when an integrity fault is detected, when the meta SRAM path returns a device error, when the revocation engine reports a fault, when a capability store to the NVM is partial, or when a request breaks the core's capability store sequence.

Definition at line 99 of file dif_cheriot_mem_sys_autogen.h.

Function Documentation

◆ dif_cheriot_mem_sys_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_alert_force	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_alert_t	alert )

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

Parameters

cheriot_mem_sys	A cheriot_mem_sys handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 63 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_get_dt	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dt_cheriot_mem_sys_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 53 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_init	(	mmio_region_t	base_addr,
		dif_cheriot_mem_sys_t *	cheriot_mem_sys )

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

This function does not actuate the hardware.

Parameters

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

◆ dif_cheriot_mem_sys_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_init_from_dt	(	dt_cheriot_mem_sys_t	dt,
		dif_cheriot_mem_sys_t *	cheriot_mem_sys )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 40 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_acknowledge	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_t	irq )

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

Parameters

cheriot_mem_sys	A cheriot_mem_sys handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 213 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_acknowledge_all ( const dif_cheriot_mem_sys_t * cheriot_mem_sys )

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

Parameters

cheriot_mem_sys A cheriot_mem_sys handle.

Returns: The result of the operation.

Definition at line 194 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_acknowledge_state	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_state_snapshot_t	snapshot )

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

Parameters

cheriot_mem_sys	A cheriot_mem_sys handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 152 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_disable_all	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 321 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_force	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 238 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_get_enabled	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 263 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_get_state	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 135 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_get_type	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 116 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_is_pending	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	cheriot_mem_sys	A cheriot_mem_sys 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 169 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_restore_all	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		const dif_cheriot_mem_sys_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

cheriot_mem_sys	A cheriot_mem_sys handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 348 of file dif_cheriot_mem_sys_autogen.c.

◆ dif_cheriot_mem_sys_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_cheriot_mem_sys_irq_set_enabled	(	const dif_cheriot_mem_sys_t *	cheriot_mem_sys,
		dif_cheriot_mem_sys_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 290 of file dif_cheriot_mem_sys_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_cheriot_mem_sys

Macro Definition Documentation

◆ kDifCheriotMemSysIrqTbreDone

Typedef Documentation

◆ dif_cheriot_mem_sys_irq_enable_snapshot_t

◆ dif_cheriot_mem_sys_irq_state_snapshot_t

◆ dif_cheriot_mem_sys_irq_t

◆ dif_cheriot_mem_sys_t

Enumeration Type Documentation

◆ dif_cheriot_mem_sys_alert

Function Documentation

◆ dif_cheriot_mem_sys_alert_force()

◆ dif_cheriot_mem_sys_get_dt()

◆ dif_cheriot_mem_sys_init()

◆ dif_cheriot_mem_sys_init_from_dt()

◆ dif_cheriot_mem_sys_irq_acknowledge()

◆ dif_cheriot_mem_sys_irq_acknowledge_all()

◆ dif_cheriot_mem_sys_irq_acknowledge_state()

◆ dif_cheriot_mem_sys_irq_disable_all()

◆ dif_cheriot_mem_sys_irq_force()

◆ dif_cheriot_mem_sys_irq_get_enabled()

◆ dif_cheriot_mem_sys_irq_get_state()

◆ dif_cheriot_mem_sys_irq_get_type()

◆ dif_cheriot_mem_sys_irq_is_pending()

◆ dif_cheriot_mem_sys_irq_restore_all()

◆ dif_cheriot_mem_sys_irq_set_enabled()