RRAM_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 "hw/top/dt/rram_ctrl.h"

Data Structures
struct	dif_rram_ctrl
	A handle to rram_ctrl. More...

Macros
#define	kDifRramCtrlIrqWrEmpty kDtRramCtrlIrqWrEmpty
	A rram_ctrl interrupt request type.

#define	kDifRramCtrlIrqWrLvl kDtRramCtrlIrqWrLvl
	Write FIFO drained to level.

#define	kDifRramCtrlIrqRdFull kDtRramCtrlIrqRdFull
	Read FIFO full.

#define	kDifRramCtrlIrqRdLvl kDtRramCtrlIrqRdLvl
	Read FIFO filled to level.

#define	kDifRramCtrlIrqOpDone kDtRramCtrlIrqOpDone
	Operation complete.

#define	kDifRramCtrlIrqCorrErr kDtRramCtrlIrqCorrErr
	Correctable error encountered.

Typedefs
typedef struct dif_rram_ctrl	dif_rram_ctrl_t
	A handle to rram_ctrl.

typedef enum dif_rram_ctrl_alert	dif_rram_ctrl_alert_t
	A rram_ctrl alert type.

typedef dt_rram_ctrl_irq_t	dif_rram_ctrl_irq_t

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

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

Enumerations
enum	dif_rram_ctrl_alert { kDifRramCtrlAlertRecovErr = 0 , kDifRramCtrlAlertFatalStdErr = 1 , kDifRramCtrlAlertFatalErr = 2 , kDifRramCtrlAlertFatalMacroErr = 3 , kDifRramCtrlAlertRecovMacroErr = 4 }
	A rram_ctrl alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_rram_ctrl_init (mmio_region_t base_addr, dif_rram_ctrl_t *rram_ctrl)
	Creates a new handle for a(n) rram_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_rram_ctrl_init_from_dt (dt_rram_ctrl_t dt, dif_rram_ctrl_t *rram_ctrl)
	Creates a new handle for a(n) rram_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_rram_ctrl_get_dt (const dif_rram_ctrl_t rram_ctrl, dt_rram_ctrl_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_rram_ctrl_alert_force (const dif_rram_ctrl_t *rram_ctrl, dif_rram_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_rram_ctrl_irq_get_type (const dif_rram_ctrl_t rram_ctrl, dif_rram_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_rram_ctrl_irq_get_state (const dif_rram_ctrl_t rram_ctrl, dif_rram_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_rram_ctrl_irq_is_pending (const dif_rram_ctrl_t rram_ctrl, dif_rram_ctrl_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_rram_ctrl_irq_acknowledge_state (const dif_rram_ctrl_t *rram_ctrl, dif_rram_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_rram_ctrl_irq_acknowledge_all (const dif_rram_ctrl_t *rram_ctrl)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_rram_ctrl_irq_acknowledge (const dif_rram_ctrl_t *rram_ctrl, dif_rram_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_rram_ctrl_irq_force (const dif_rram_ctrl_t *rram_ctrl, dif_rram_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_rram_ctrl_irq_get_enabled (const dif_rram_ctrl_t rram_ctrl, dif_rram_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_rram_ctrl_irq_set_enabled (const dif_rram_ctrl_t *rram_ctrl, dif_rram_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_rram_ctrl_irq_disable_all (const dif_rram_ctrl_t rram_ctrl, dif_rram_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_rram_ctrl_irq_restore_all (const dif_rram_ctrl_t rram_ctrl, const dif_rram_ctrl_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

RRAM_CTRL Device Interface Functions

Definition in file dif_rram_ctrl_autogen.h.

Data Structure Documentation

◆ dif_rram_ctrl

struct dif_rram_ctrl

A handle to rram_ctrl.

This type should be treated as opaque by users.

Definition at line 37 of file dif_rram_ctrl_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the rram_ctrl hardware registers.
dt_rram_ctrl_t	dt	The instance, set to `kDtRramCtrlCount` if not initialized through `dif_rram_ctrl_init_from_dt`.

Macro Definition Documentation

◆ kDifRramCtrlIrqCorrErr

#define kDifRramCtrlIrqCorrErr kDtRramCtrlIrqCorrErr

Correctable error encountered.

Definition at line 170 of file dif_rram_ctrl_autogen.h.

◆ kDifRramCtrlIrqOpDone

#define kDifRramCtrlIrqOpDone kDtRramCtrlIrqOpDone

Operation complete.

Definition at line 166 of file dif_rram_ctrl_autogen.h.

◆ kDifRramCtrlIrqRdFull

#define kDifRramCtrlIrqRdFull kDtRramCtrlIrqRdFull

Read FIFO full.

Definition at line 158 of file dif_rram_ctrl_autogen.h.

◆ kDifRramCtrlIrqRdLvl

#define kDifRramCtrlIrqRdLvl kDtRramCtrlIrqRdLvl

Read FIFO filled to level.

Definition at line 162 of file dif_rram_ctrl_autogen.h.

◆ kDifRramCtrlIrqWrEmpty

#define kDifRramCtrlIrqWrEmpty kDtRramCtrlIrqWrEmpty

A rram_ctrl interrupt request type.

DEPRECATED Use dt_rram_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. Write FIFO empty

Definition at line 150 of file dif_rram_ctrl_autogen.h.

◆ kDifRramCtrlIrqWrLvl

#define kDifRramCtrlIrqWrLvl kDtRramCtrlIrqWrLvl

Write FIFO drained to level.

Definition at line 154 of file dif_rram_ctrl_autogen.h.

Typedef Documentation

◆ dif_rram_ctrl_irq_enable_snapshot_t

typedef uint32_t dif_rram_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_rram_ctrl_irq_disable_all() and dif_rram_ctrl_irq_restore_all() functions.

Definition at line 280 of file dif_rram_ctrl_autogen.h.

◆ dif_rram_ctrl_irq_state_snapshot_t

typedef uint32_t dif_rram_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_rram_ctrl_irq_get_state() and dif_rram_ctrl_irq_acknowledge_state() functions.

Definition at line 178 of file dif_rram_ctrl_autogen.h.

◆ dif_rram_ctrl_irq_t

typedef dt_rram_ctrl_irq_t dif_rram_ctrl_irq_t

Definition at line 136 of file dif_rram_ctrl_autogen.h.

◆ dif_rram_ctrl_t

typedef struct dif_rram_ctrl dif_rram_ctrl_t

A handle to rram_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_rram_ctrl_alert

enum dif_rram_ctrl_alert

A rram_ctrl alert type.

Enumerator
kDifRramCtrlAlertRecovErr	RRAM recoverable errors.
kDifRramCtrlAlertFatalStdErr	RRAM standard fatal errors.
kDifRramCtrlAlertFatalErr	RRAM fatal errors including uncorrectable ECC errors. Note that this alert is not always fatal. The underlying error bits in the !!FAULT_STATUS register remain set until reset, meaning the alert keeps firing. This doesn't hold for !!FAULT_STATUS.PHY_RELBL_ERR. To enable firmware dealing with multi-bit ECC errors during firmware selection and verification, these error bits can be cleared. After passing this stage, it is recommended that firmware classifies the corresponding alert as fatal on the receiver end, i.e, inside the alert handler.
kDifRramCtrlAlertFatalMacroErr	Fatal errors triggered inside the RRAM macro, including fatal TL-UL bus integrity faults of the test interface.
kDifRramCtrlAlertRecovMacroErr	Recoverable errors triggered inside the RRAM macro.

Definition at line 98 of file dif_rram_ctrl_autogen.h.

Function Documentation

◆ dif_rram_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_alert_force	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_alert_t	alert )

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

Parameters

rram_ctrl	A rram_ctrl handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_get_dt	(	const dif_rram_ctrl_t *	rram_ctrl,
		dt_rram_ctrl_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 52 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_init	(	mmio_region_t	base_addr,
		dif_rram_ctrl_t *	rram_ctrl )

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

This function does not actuate the hardware.

Parameters

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

◆ dif_rram_ctrl_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_init_from_dt	(	dt_rram_ctrl_t	dt,
		dif_rram_ctrl_t *	rram_ctrl )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 39 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_acknowledge	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_t	irq )

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

Parameters

rram_ctrl	A rram_ctrl handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 241 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_acknowledge_all ( const dif_rram_ctrl_t * rram_ctrl )

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

Parameters

rram_ctrl A rram_ctrl handle.

Returns: The result of the operation.

Definition at line 222 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_acknowledge_state	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_state_snapshot_t	snapshot )

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

Parameters

rram_ctrl	A rram_ctrl handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 180 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_disable_all	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 349 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_force	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 266 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_get_enabled	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 291 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_get_state	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 163 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_get_type	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_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

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

Returns: The result of the operation.

Definition at line 144 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_is_pending	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	rram_ctrl	A rram_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 197 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_restore_all	(	const dif_rram_ctrl_t *	rram_ctrl,
		const dif_rram_ctrl_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

rram_ctrl	A rram_ctrl handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 376 of file dif_rram_ctrl_autogen.c.

◆ dif_rram_ctrl_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_rram_ctrl_irq_set_enabled	(	const dif_rram_ctrl_t *	rram_ctrl,
		dif_rram_ctrl_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 318 of file dif_rram_ctrl_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_rram_ctrl

Macro Definition Documentation

◆ kDifRramCtrlIrqCorrErr

◆ kDifRramCtrlIrqOpDone

◆ kDifRramCtrlIrqRdFull

◆ kDifRramCtrlIrqRdLvl

◆ kDifRramCtrlIrqWrEmpty

◆ kDifRramCtrlIrqWrLvl

Typedef Documentation

◆ dif_rram_ctrl_irq_enable_snapshot_t

◆ dif_rram_ctrl_irq_state_snapshot_t

◆ dif_rram_ctrl_irq_t

◆ dif_rram_ctrl_t

Enumeration Type Documentation

◆ dif_rram_ctrl_alert

Function Documentation

◆ dif_rram_ctrl_alert_force()

◆ dif_rram_ctrl_get_dt()

◆ dif_rram_ctrl_init()

◆ dif_rram_ctrl_init_from_dt()

◆ dif_rram_ctrl_irq_acknowledge()

◆ dif_rram_ctrl_irq_acknowledge_all()

◆ dif_rram_ctrl_irq_acknowledge_state()

◆ dif_rram_ctrl_irq_disable_all()

◆ dif_rram_ctrl_irq_force()

◆ dif_rram_ctrl_irq_get_enabled()

◆ dif_rram_ctrl_irq_get_state()

◆ dif_rram_ctrl_irq_get_type()

◆ dif_rram_ctrl_irq_is_pending()

◆ dif_rram_ctrl_irq_restore_all()

◆ dif_rram_ctrl_irq_set_enabled()