(dec4bc1838)

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"

Go to the source code of this file.

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

Typedefs
typedef struct dif_flash_ctrl	dif_flash_ctrl_t
	A handle to flash_ctrl. More...

typedef enum dif_flash_ctrl_alert	dif_flash_ctrl_alert_t
	A flash_ctrl alert type.

typedef enum dif_flash_ctrl_irq	dif_flash_ctrl_irq_t
	A flash_ctrl interrupt request type.

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

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

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

enum	dif_flash_ctrl_irq { kDifFlashCtrlIrqProgEmpty = 0 , kDifFlashCtrlIrqProgLvl = 1 , kDifFlashCtrlIrqRdFull = 2 , kDifFlashCtrlIrqRdLvl = 3 , kDifFlashCtrlIrqOpDone = 4 , kDifFlashCtrlIrqCorrErr = 5 }
	A flash_ctrl interrupt request 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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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 33 of file dif_flash_ctrl_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the flash_ctrl hardware registers.

Typedef Documentation

◆ dif_flash_ctrl_irq_enable_snapshot_t

typedef uint32_t dif_flash_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_flash_ctrl_irq_disable_all() and dif_flash_ctrl_irq_restore_all() functions.

Definition at line 232 of file dif_flash_ctrl_autogen.h.

◆ dif_flash_ctrl_irq_state_snapshot_t

typedef uint32_t dif_flash_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_flash_ctrl_irq_get_state() and dif_flash_ctrl_irq_acknowledge_state() functions.

Definition at line 136 of file dif_flash_ctrl_autogen.h.

◆ 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 56 of file dif_flash_ctrl_autogen.h.

◆ dif_flash_ctrl_irq

enum dif_flash_ctrl_irq

A flash_ctrl interrupt request type.

Enumerator
kDifFlashCtrlIrqProgEmpty	Program FIFO empty.
kDifFlashCtrlIrqProgLvl	Program FIFO drained to level.
kDifFlashCtrlIrqRdFull	Read FIFO full.
kDifFlashCtrlIrqRdLvl	Read FIFO filled to level.
kDifFlashCtrlIrqOpDone	Operation complete.
kDifFlashCtrlIrqCorrErr	Correctable error encountered.

Definition at line 103 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 28 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.

Definition at line 17 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 177 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 163 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 128 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 266 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 198 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 219 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 114 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 100 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 142 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 287 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 241 of file dif_flash_ctrl_autogen.c.

(dec4bc1838)

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_flash_ctrl

Typedef Documentation

◆ dif_flash_ctrl_irq_enable_snapshot_t

◆ dif_flash_ctrl_irq_state_snapshot_t

◆ dif_flash_ctrl_t

Enumeration Type Documentation

◆ dif_flash_ctrl_alert

◆ dif_flash_ctrl_irq

Function Documentation

◆ dif_flash_ctrl_alert_force()

◆ dif_flash_ctrl_init()

◆ 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()