FLASH_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/flash_ctrl.h"

Data Structures
struct	dif_flash_ctrl
	A handle to flash_ctrl. More...

Macros
#define	kDifFlashCtrlIrqProgEmpty kDtFlashCtrlIrqProgEmpty
	A flash_ctrl interrupt request type.

#define	kDifFlashCtrlIrqProgLvl kDtFlashCtrlIrqProgLvl
	Program FIFO drained to level.

#define	kDifFlashCtrlIrqRdFull kDtFlashCtrlIrqRdFull
	Read FIFO full.

#define	kDifFlashCtrlIrqRdLvl kDtFlashCtrlIrqRdLvl
	Read FIFO filled to level.

#define	kDifFlashCtrlIrqOpDone kDtFlashCtrlIrqOpDone
	Operation complete.

#define	kDifFlashCtrlIrqCorrErr kDtFlashCtrlIrqCorrErr
	Correctable error encountered.

Typedefs
typedef struct dif_flash_ctrl	dif_flash_ctrl_t
	A handle to flash_ctrl.

typedef enum dif_flash_ctrl_alert	dif_flash_ctrl_alert_t
	A flash_ctrl alert type.

Enumerations
enum	dif_flash_ctrl_alert { kDifFlashCtrlAlertRecovErr = 0 , kDifFlashCtrlAlertFatalStdErr = 1 , kDifFlashCtrlAlertFatalErr = 2 , kDifFlashCtrlAlertFatalPrimFlashAlert = 3 , kDifFlashCtrlAlertRecovPrimFlashAlert = 4 }
	A flash_ctrl alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_flash_ctrl_init (mmio_region_t base_addr, dif_flash_ctrl_t *flash_ctrl)
	Creates a new handle for a(n) flash_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_flash_ctrl_init_from_dt (dt_flash_ctrl_t dt, dif_flash_ctrl_t *flash_ctrl)
	Creates a new handle for a(n) flash_ctrl peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_flash_ctrl_get_dt (const dif_flash_ctrl_t flash_ctrl, dt_flash_ctrl_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_flash_ctrl_alert_force (const dif_flash_ctrl_t *flash_ctrl, dif_flash_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_flash_ctrl_irq_get_type (const dif_flash_ctrl_t flash_ctrl, dif_flash_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_flash_ctrl_irq_get_state (const dif_flash_ctrl_t flash_ctrl, dif_flash_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_flash_ctrl_irq_is_pending (const dif_flash_ctrl_t flash_ctrl, dif_flash_ctrl_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_flash_ctrl_irq_acknowledge_state (const dif_flash_ctrl_t *flash_ctrl, dif_flash_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_flash_ctrl_irq_acknowledge_all (const dif_flash_ctrl_t *flash_ctrl)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_flash_ctrl_irq_acknowledge (const dif_flash_ctrl_t *flash_ctrl, dif_flash_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_flash_ctrl_irq_force (const dif_flash_ctrl_t *flash_ctrl, dif_flash_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_flash_ctrl_irq_get_enabled (const dif_flash_ctrl_t flash_ctrl, dif_flash_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_flash_ctrl_irq_set_enabled (const dif_flash_ctrl_t *flash_ctrl, dif_flash_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_flash_ctrl_irq_disable_all (const dif_flash_ctrl_t flash_ctrl, dif_flash_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_flash_ctrl_irq_restore_all (const dif_flash_ctrl_t flash_ctrl, const dif_flash_ctrl_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

FLASH_CTRL Device Interface Functions

Definition in file dif_flash_ctrl_autogen.h.

Data Structure Documentation

◆ dif_flash_ctrl

struct dif_flash_ctrl

A handle to flash_ctrl.

This type should be treated as opaque by users.

Definition at line 38 of file dif_flash_ctrl_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the flash_ctrl hardware registers.
dt_flash_ctrl_t	dt	The instance, set to `kDtFlashCtrlCount` if not initialized through `dif_flash_ctrl_init_from_dt`.

Macro Definition Documentation

◆ kDifFlashCtrlIrqCorrErr

#define kDifFlashCtrlIrqCorrErr kDtFlashCtrlIrqCorrErr

Correctable error encountered.

Definition at line 171 of file dif_flash_ctrl_autogen.h.

◆ kDifFlashCtrlIrqOpDone

#define kDifFlashCtrlIrqOpDone kDtFlashCtrlIrqOpDone

Operation complete.

Definition at line 167 of file dif_flash_ctrl_autogen.h.

◆ kDifFlashCtrlIrqProgEmpty

#define kDifFlashCtrlIrqProgEmpty kDtFlashCtrlIrqProgEmpty

A flash_ctrl interrupt request type.

DEPRECATED Use dt_flash_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. Program FIFO empty

Definition at line 151 of file dif_flash_ctrl_autogen.h.

◆ kDifFlashCtrlIrqProgLvl

#define kDifFlashCtrlIrqProgLvl kDtFlashCtrlIrqProgLvl

Program FIFO drained to level.

Definition at line 155 of file dif_flash_ctrl_autogen.h.

◆ kDifFlashCtrlIrqRdFull

#define kDifFlashCtrlIrqRdFull kDtFlashCtrlIrqRdFull

Read FIFO full.

Definition at line 159 of file dif_flash_ctrl_autogen.h.

◆ kDifFlashCtrlIrqRdLvl

#define kDifFlashCtrlIrqRdLvl kDtFlashCtrlIrqRdLvl

Read FIFO filled to level.

Definition at line 163 of file dif_flash_ctrl_autogen.h.

Typedef Documentation

◆ dif_flash_ctrl_t

typedef struct dif_flash_ctrl dif_flash_ctrl_t

A handle to flash_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_flash_ctrl_alert

enum dif_flash_ctrl_alert

A flash_ctrl alert type.

Enumerator
kDifFlashCtrlAlertRecovErr	Flash recoverable errors.
kDifFlashCtrlAlertFatalStdErr	Flash standard fatal errors.
kDifFlashCtrlAlertFatalErr	Flash 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 and !!FAULT_STATUS.PHY_STORAGE_ERR. To enable firmware dealing with multi-bit ECC and ICV 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.
kDifFlashCtrlAlertFatalPrimFlashAlert	Fatal alert triggered inside the flash primitive, including fatal TL-UL bus integrity faults of the test interface.
kDifFlashCtrlAlertRecovPrimFlashAlert	Recoverable alert triggered inside the flash primitive.

Definition at line 99 of file dif_flash_ctrl_autogen.h.

Function Documentation

◆ dif_flash_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_alert_force	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_alert_t	alert )

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

Parameters

flash_ctrl	A flash_ctrl handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 63 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_get_dt	(	const dif_flash_ctrl_t *	flash_ctrl,
		dt_flash_ctrl_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 53 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_init	(	mmio_region_t	base_addr,
		dif_flash_ctrl_t *	flash_ctrl )

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

This function does not actuate the hardware.

Parameters

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

◆ dif_flash_ctrl_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_init_from_dt	(	dt_flash_ctrl_t	dt,
		dif_flash_ctrl_t *	flash_ctrl )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 40 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_acknowledge	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_t	irq )

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

Parameters

flash_ctrl	A flash_ctrl handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 242 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_acknowledge_all ( const dif_flash_ctrl_t * flash_ctrl )

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

Parameters

flash_ctrl A flash_ctrl handle.

Returns: The result of the operation.

Definition at line 223 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_acknowledge_state	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_state_snapshot_t	snapshot )

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

Parameters

flash_ctrl	A flash_ctrl handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 181 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_disable_all	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 350 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_force	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 267 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_get_enabled	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 292 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_get_state	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 164 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_get_type	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_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

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

Returns: The result of the operation.

Definition at line 145 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_is_pending	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	flash_ctrl	A flash_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 198 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_restore_all	(	const dif_flash_ctrl_t *	flash_ctrl,
		const dif_flash_ctrl_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

flash_ctrl	A flash_ctrl handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 377 of file dif_flash_ctrl_autogen.c.

◆ dif_flash_ctrl_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_flash_ctrl_irq_set_enabled	(	const dif_flash_ctrl_t *	flash_ctrl,
		dif_flash_ctrl_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 319 of file dif_flash_ctrl_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_flash_ctrl

Macro Definition Documentation

◆ kDifFlashCtrlIrqCorrErr

◆ kDifFlashCtrlIrqOpDone

◆ kDifFlashCtrlIrqProgEmpty

◆ kDifFlashCtrlIrqProgLvl

◆ kDifFlashCtrlIrqRdFull

◆ kDifFlashCtrlIrqRdLvl

Typedef Documentation

◆ dif_flash_ctrl_t

Enumeration Type Documentation

◆ dif_flash_ctrl_alert

Function Documentation

◆ dif_flash_ctrl_alert_force()

◆ dif_flash_ctrl_get_dt()

◆ dif_flash_ctrl_init()

◆ dif_flash_ctrl_init_from_dt()

◆ dif_flash_ctrl_irq_acknowledge()

◆ dif_flash_ctrl_irq_acknowledge_all()

◆ dif_flash_ctrl_irq_acknowledge_state()

◆ dif_flash_ctrl_irq_disable_all()

◆ dif_flash_ctrl_irq_force()

◆ dif_flash_ctrl_irq_get_enabled()

◆ dif_flash_ctrl_irq_get_state()

◆ dif_flash_ctrl_irq_get_type()

◆ dif_flash_ctrl_irq_is_pending()

◆ dif_flash_ctrl_irq_restore_all()

◆ dif_flash_ctrl_irq_set_enabled()