SPI_DEVICE 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/spi_device.h"

Data Structures
struct	dif_spi_device
	A handle to spi_device. More...

Macros
#define	kDifSpiDeviceIrqUploadCmdfifoNotEmpty kDtSpiDeviceIrqUploadCmdfifoNotEmpty
	A spi_device interrupt request type.

#define	kDifSpiDeviceIrqUploadPayloadNotEmpty kDtSpiDeviceIrqUploadPayloadNotEmpty
	Upload payload is not empty.

#define	kDifSpiDeviceIrqUploadPayloadOverflow kDtSpiDeviceIrqUploadPayloadOverflow
	Upload payload overflow event.

#define	kDifSpiDeviceIrqReadbufWatermark kDtSpiDeviceIrqReadbufWatermark
	Read Buffer Threshold event.

#define	kDifSpiDeviceIrqReadbufFlip kDtSpiDeviceIrqReadbufFlip
	Read buffer flipped event.

#define	kDifSpiDeviceIrqTpmHeaderNotEmpty kDtSpiDeviceIrqTpmHeaderNotEmpty
	TPM Header(Command/Address) buffer available.

#define	kDifSpiDeviceIrqTpmRdfifoCmdEnd kDtSpiDeviceIrqTpmRdfifoCmdEnd
	TPM RdFIFO command ended.

#define	kDifSpiDeviceIrqTpmRdfifoDrop kDtSpiDeviceIrqTpmRdfifoDrop
	TPM RdFIFO data dropped.

Typedefs
typedef struct dif_spi_device	dif_spi_device_t
	A handle to spi_device.

typedef enum dif_spi_device_alert	dif_spi_device_alert_t
	A spi_device alert type.

typedef dt_spi_device_irq_t	dif_spi_device_irq_t

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

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

Enumerations
enum	dif_spi_device_alert { kDifSpiDeviceAlertFatalFault = 0 }
	A spi_device alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_init (mmio_region_t base_addr, dif_spi_device_t *spi_device)
	Creates a new handle for a(n) spi_device peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_init_from_dt (dt_spi_device_t dt, dif_spi_device_t *spi_device)
	Creates a new handle for a(n) spi_device peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_get_dt (const dif_spi_device_t spi_device, dt_spi_device_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_alert_force (const dif_spi_device_t *spi_device, dif_spi_device_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_spi_device_irq_get_type (const dif_spi_device_t spi_device, dif_spi_device_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_spi_device_irq_get_state (const dif_spi_device_t spi_device, dif_spi_device_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_spi_device_irq_is_pending (const dif_spi_device_t spi_device, dif_spi_device_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_irq_acknowledge_state (const dif_spi_device_t *spi_device, dif_spi_device_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_spi_device_irq_acknowledge_all (const dif_spi_device_t *spi_device)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_irq_acknowledge (const dif_spi_device_t *spi_device, dif_spi_device_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_irq_force (const dif_spi_device_t *spi_device, dif_spi_device_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_spi_device_irq_get_enabled (const dif_spi_device_t spi_device, dif_spi_device_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_irq_set_enabled (const dif_spi_device_t *spi_device, dif_spi_device_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_irq_disable_all (const dif_spi_device_t spi_device, dif_spi_device_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_spi_device_irq_restore_all (const dif_spi_device_t spi_device, const dif_spi_device_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

SPI_DEVICE Device Interface Functions

Definition in file dif_spi_device_autogen.h.

Data Structure Documentation

◆ dif_spi_device

struct dif_spi_device

A handle to spi_device.

This type should be treated as opaque by users.

Definition at line 37 of file dif_spi_device_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the spi_device hardware registers.
dt_spi_device_t	dt	The instance, set to `kDtSpiDeviceCount` if not initialized through `dif_spi_device_init_from_dt`.

Macro Definition Documentation

◆ kDifSpiDeviceIrqReadbufFlip

#define kDifSpiDeviceIrqReadbufFlip kDtSpiDeviceIrqReadbufFlip

Read buffer flipped event.

The host system accesses other side of buffer.

Definition at line 150 of file dif_spi_device_autogen.h.

◆ kDifSpiDeviceIrqReadbufWatermark

#define kDifSpiDeviceIrqReadbufWatermark kDtSpiDeviceIrqReadbufWatermark

Read Buffer Threshold event.

The host system accesses greater than or equal to the threshold of a buffer.

Definition at line 146 of file dif_spi_device_autogen.h.

◆ kDifSpiDeviceIrqTpmHeaderNotEmpty

#define kDifSpiDeviceIrqTpmHeaderNotEmpty kDtSpiDeviceIrqTpmHeaderNotEmpty

TPM Header(Command/Address) buffer available.

Definition at line 154 of file dif_spi_device_autogen.h.

◆ kDifSpiDeviceIrqTpmRdfifoCmdEnd

#define kDifSpiDeviceIrqTpmRdfifoCmdEnd kDtSpiDeviceIrqTpmRdfifoCmdEnd

TPM RdFIFO command ended.

The TPM Read command targeting the RdFIFO ended. Check TPM_STATUS.rdfifo_aborted to see if the transaction completed.

Definition at line 158 of file dif_spi_device_autogen.h.

◆ kDifSpiDeviceIrqTpmRdfifoDrop

#define kDifSpiDeviceIrqTpmRdfifoDrop kDtSpiDeviceIrqTpmRdfifoDrop

TPM RdFIFO data dropped.

Data was dropped from the RdFIFO. Data was written while a read command was not active, and it was not accepted. This can occur when the host aborts a read command.

Definition at line 162 of file dif_spi_device_autogen.h.

◆ kDifSpiDeviceIrqUploadCmdfifoNotEmpty

#define kDifSpiDeviceIrqUploadCmdfifoNotEmpty kDtSpiDeviceIrqUploadCmdfifoNotEmpty

A spi_device interrupt request type.

DEPRECATED Use dt_spi_device_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. Upload Command FIFO is not empty

Definition at line 134 of file dif_spi_device_autogen.h.

◆ kDifSpiDeviceIrqUploadPayloadNotEmpty

#define kDifSpiDeviceIrqUploadPayloadNotEmpty kDtSpiDeviceIrqUploadPayloadNotEmpty

Upload payload is not empty.

The event occurs after SPI transaction completed

Definition at line 138 of file dif_spi_device_autogen.h.

◆ kDifSpiDeviceIrqUploadPayloadOverflow

#define kDifSpiDeviceIrqUploadPayloadOverflow kDtSpiDeviceIrqUploadPayloadOverflow

Upload payload overflow event.

When a SPI Host system issues a command with payload more than 256B, this event is reported. When it happens, SW should read the last written payload index CSR to figure out the starting address of the last 256B.

Definition at line 142 of file dif_spi_device_autogen.h.

Typedef Documentation

◆ dif_spi_device_irq_enable_snapshot_t

typedef uint32_t dif_spi_device_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_spi_device_irq_disable_all() and dif_spi_device_irq_restore_all() functions.

Definition at line 272 of file dif_spi_device_autogen.h.

◆ dif_spi_device_irq_state_snapshot_t

typedef uint32_t dif_spi_device_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_spi_device_irq_get_state() and dif_spi_device_irq_acknowledge_state() functions.

Definition at line 170 of file dif_spi_device_autogen.h.

◆ dif_spi_device_irq_t

typedef dt_spi_device_irq_t dif_spi_device_irq_t

Definition at line 120 of file dif_spi_device_autogen.h.

◆ dif_spi_device_t

typedef struct dif_spi_device dif_spi_device_t

A handle to spi_device.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_spi_device_alert

enum dif_spi_device_alert

A spi_device alert type.

Enumerator
kDifSpiDeviceAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 98 of file dif_spi_device_autogen.h.

Function Documentation

◆ dif_spi_device_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_alert_force	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_alert_t	alert )

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

Parameters

spi_device	A spi_device handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 62 of file dif_spi_device_autogen.c.

◆ dif_spi_device_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_get_dt	(	const dif_spi_device_t *	spi_device,
		dt_spi_device_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

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

Definition at line 52 of file dif_spi_device_autogen.c.

◆ dif_spi_device_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_init	(	mmio_region_t	base_addr,
		dif_spi_device_t *	spi_device )

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

This function does not actuate the hardware.

Parameters

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

◆ dif_spi_device_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_init_from_dt	(	dt_spi_device_t	dt,
		dif_spi_device_t *	spi_device )

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

This function does not actuate the hardware.

Parameters

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

Returns: The result of the operation.

Definition at line 39 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_acknowledge	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_t	irq )

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

Parameters

spi_device	A spi_device handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 237 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_acknowledge_all ( const dif_spi_device_t * spi_device )

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

Parameters

spi_device A spi_device handle.

Returns: The result of the operation.

Definition at line 218 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_acknowledge_state	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_state_snapshot_t	snapshot )

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

Parameters

spi_device	A spi_device handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 176 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_disable_all	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 345 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_force	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns: The result of the operation.

Definition at line 262 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_get_enabled	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 287 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_get_state	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns: The result of the operation.

Definition at line 159 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_get_type	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns: The result of the operation.

Definition at line 140 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_is_pending	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	spi_device	A spi_device 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 193 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_restore_all	(	const dif_spi_device_t *	spi_device,
		const dif_spi_device_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

spi_device	A spi_device handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 372 of file dif_spi_device_autogen.c.

◆ dif_spi_device_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_spi_device_irq_set_enabled	(	const dif_spi_device_t *	spi_device,
		dif_spi_device_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns: The result of the operation.

Definition at line 314 of file dif_spi_device_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_spi_device

Macro Definition Documentation

◆ kDifSpiDeviceIrqReadbufFlip

◆ kDifSpiDeviceIrqReadbufWatermark

◆ kDifSpiDeviceIrqTpmHeaderNotEmpty

◆ kDifSpiDeviceIrqTpmRdfifoCmdEnd

◆ kDifSpiDeviceIrqTpmRdfifoDrop

◆ kDifSpiDeviceIrqUploadCmdfifoNotEmpty

◆ kDifSpiDeviceIrqUploadPayloadNotEmpty

◆ kDifSpiDeviceIrqUploadPayloadOverflow

Typedef Documentation

◆ dif_spi_device_irq_enable_snapshot_t

◆ dif_spi_device_irq_state_snapshot_t

◆ dif_spi_device_irq_t

◆ dif_spi_device_t

Enumeration Type Documentation

◆ dif_spi_device_alert

Function Documentation

◆ dif_spi_device_alert_force()

◆ dif_spi_device_get_dt()

◆ dif_spi_device_init()

◆ dif_spi_device_init_from_dt()

◆ dif_spi_device_irq_acknowledge()

◆ dif_spi_device_irq_acknowledge_all()

◆ dif_spi_device_irq_acknowledge_state()

◆ dif_spi_device_irq_disable_all()

◆ dif_spi_device_irq_force()

◆ dif_spi_device_irq_get_enabled()

◆ dif_spi_device_irq_get_state()

◆ dif_spi_device_irq_get_type()

◆ dif_spi_device_irq_is_pending()

◆ dif_spi_device_irq_restore_all()

◆ dif_spi_device_irq_set_enabled()