spi_device.h File Reference

Device Tables (DT) for IP spi_device and top earlgrey. More...

#include "hw/top/dt/api.h"
#include <stdint.h>

Go to the source code of this file.

Macros
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION   1
	List of supported hardware features.
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_TPM   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_LANES   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_SERDES_ORDERING   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_CSB_STATUS   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_COMMANDS   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_FLASH_EMULATION_BLOCKS   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_READ_COMMAND_PROCESSOR   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_DUMMY_CYCLE   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_WRITE_ENABLE_DISABLE   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_LAST_READ_ADDR   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_CMDINFOS   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_COMMAND_UPLOAD   1
#define	OPENTITAN_SPI_DEVICE_HAS_HW_3B4B_ADDRESSING   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_CMD_FILTER   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_ADDRESS_MANIPULATION   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_STATUS_MANIPULATION   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_OUTPUT_ENABLE_CONTROL   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_INTERCEPT_EN   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_MAILBOX   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_RETURN_BY_HW_REGS   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_AUTO_WAIT   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_READ_FIFO_MODE   1
#define	OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_CAPABILITY   1

Typedefs
typedef enum dt_spi_device	dt_spi_device_t
	List of instances.
typedef enum dt_spi_device_reg_block	dt_spi_device_reg_block_t
	List of register blocks.
typedef enum dt_spi_device_irq	dt_spi_device_irq_t
	List of IRQs.
typedef enum dt_spi_device_alert	dt_spi_device_alert_t
	List of Alerts.
typedef enum dt_spi_device_clock	dt_spi_device_clock_t
	List of clock ports.
typedef enum dt_spi_device_reset	dt_spi_device_reset_t
	List of reset ports.
typedef enum dt_spi_device_periph_io	dt_spi_device_periph_io_t
	List of peripheral I/O.

Enumerations
enum	dt_spi_device {   kDtSpiDeviceFirst = 0 ,   kDtSpiDevice = 0 }
	List of instances. More...
enum	{ kDtSpiDeviceCount = 1 }
enum	dt_spi_device_reg_block { kDtSpiDeviceRegBlockCore = 0 }
	List of register blocks. More...
enum	{ kDtSpiDeviceRegBlockCount = 1 }
enum	dt_spi_device_irq {   kDtSpiDeviceIrqUploadCmdfifoNotEmpty = 0 ,   kDtSpiDeviceIrqUploadPayloadNotEmpty = 1 ,   kDtSpiDeviceIrqUploadPayloadOverflow = 2 ,   kDtSpiDeviceIrqReadbufWatermark = 3 ,   kDtSpiDeviceIrqReadbufFlip = 4 ,   kDtSpiDeviceIrqTpmHeaderNotEmpty = 5 ,   kDtSpiDeviceIrqTpmRdfifoCmdEnd = 6 ,   kDtSpiDeviceIrqTpmRdfifoDrop = 7 }
	List of IRQs. More...
enum	{ kDtSpiDeviceIrqCount = 8 }
enum	dt_spi_device_alert { kDtSpiDeviceAlertFatalFault = 0 }
	List of Alerts. More...
enum	{ kDtSpiDeviceAlertCount = 1 }
enum	dt_spi_device_clock { kDtSpiDeviceClockClk = 0 }
	List of clock ports. More...
enum	{ kDtSpiDeviceClockCount = 1 }
enum	dt_spi_device_reset { kDtSpiDeviceResetRst = 0 }
	List of reset ports. More...
enum	{ kDtSpiDeviceResetCount = 1 }
enum	dt_spi_device_periph_io {   kDtSpiDevicePeriphIoSck = 0 ,   kDtSpiDevicePeriphIoCsb = 1 ,   kDtSpiDevicePeriphIoTpmCsb = 2 ,   kDtSpiDevicePeriphIoSd0 = 3 ,   kDtSpiDevicePeriphIoSd1 = 4 ,   kDtSpiDevicePeriphIoSd2 = 5 ,   kDtSpiDevicePeriphIoSd3 = 6 }
	List of peripheral I/O. More...
enum	{ kDtSpiDevicePeriphIoCount = 7 }

Functions
dt_spi_device_t	dt_spi_device_from_instance_id (dt_instance_id_t inst_id)
	Get the spi_device instance from an instance ID.
dt_instance_id_t	dt_spi_device_instance_id (dt_spi_device_t dt)
	Get the instance ID of an instance.
uint32_t	dt_spi_device_reg_block (dt_spi_device_t dt, dt_spi_device_reg_block_t reg_block)
	Get the register base address of an instance.
dt_plic_irq_id_t	dt_spi_device_irq_to_plic_id (dt_spi_device_t dt, dt_spi_device_irq_t irq)
	Get the PLIC ID of a spi_device IRQ for a given instance.
dt_spi_device_irq_t	dt_spi_device_irq_from_plic_id (dt_spi_device_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local spi_device IRQ type.
dt_alert_id_t	dt_spi_device_alert_to_alert_id (dt_spi_device_t dt, dt_spi_device_alert_t alert)
	Get the alert ID of a spi_device alert for a given instance.
dt_spi_device_alert_t	dt_spi_device_alert_from_alert_id (dt_spi_device_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local spi_device alert type.
dt_periph_io_t	dt_spi_device_periph_io (dt_spi_device_t dt, dt_spi_device_periph_io_t sig)
	Get the peripheral I/O description of an instance.
dt_clock_t	dt_spi_device_clock (dt_spi_device_t dt, dt_spi_device_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_spi_device_reset (dt_spi_device_t dt, dt_spi_device_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP spi_device and top earlgrey.

This file contains the type definitions and global functions of the spi_device.

Definition in file spi_device.h.

Macro Definition Documentation

OPENTITAN_SPI_DEVICE_HAS_HW_3B4B_ADDRESSING

#define OPENTITAN_SPI_DEVICE_HAS_HW_3B4B_ADDRESSING   1

Definition at line 175 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_HW_CMDINFOS

#define OPENTITAN_SPI_DEVICE_HAS_HW_CMDINFOS   1

Definition at line 173 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_HW_COMMAND_UPLOAD

#define OPENTITAN_SPI_DEVICE_HAS_HW_COMMAND_UPLOAD   1

Definition at line 174 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_HW_CSB_STATUS

#define OPENTITAN_SPI_DEVICE_HAS_HW_CSB_STATUS   1

Definition at line 166 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_HW_FLASH_EMULATION_BLOCKS

#define OPENTITAN_SPI_DEVICE_HAS_HW_FLASH_EMULATION_BLOCKS   1

Definition at line 168 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_HW_LANES

#define OPENTITAN_SPI_DEVICE_HAS_HW_LANES   1

Definition at line 164 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_HW_LAST_READ_ADDR

#define OPENTITAN_SPI_DEVICE_HAS_HW_LAST_READ_ADDR   1

Definition at line 172 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_HW_SERDES_ORDERING

#define OPENTITAN_SPI_DEVICE_HAS_HW_SERDES_ORDERING   1

Definition at line 165 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION

#define OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION   1

List of supported hardware features.

Definition at line 161 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_COMMANDS

#define OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_COMMANDS   1

Definition at line 167 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_DUMMY_CYCLE

#define OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_DUMMY_CYCLE   1

Definition at line 170 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_READ_COMMAND_PROCESSOR

#define OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_READ_COMMAND_PROCESSOR   1

Definition at line 169 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_WRITE_ENABLE_DISABLE

#define OPENTITAN_SPI_DEVICE_HAS_MODE_FLASH_EMULATION_WRITE_ENABLE_DISABLE   1

Definition at line 171 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH

#define OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH   1

Definition at line 162 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_ADDRESS_MANIPULATION

#define OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_ADDRESS_MANIPULATION   1

Definition at line 177 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_CMD_FILTER

#define OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_CMD_FILTER   1

Definition at line 176 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_INTERCEPT_EN

#define OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_INTERCEPT_EN   1

Definition at line 180 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_MAILBOX

#define OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_MAILBOX   1

Definition at line 181 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_OUTPUT_ENABLE_CONTROL

#define OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_OUTPUT_ENABLE_CONTROL   1

Definition at line 179 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_STATUS_MANIPULATION

#define OPENTITAN_SPI_DEVICE_HAS_MODE_PASSTHROUGH_STATUS_MANIPULATION   1

Definition at line 178 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_TPM

#define OPENTITAN_SPI_DEVICE_HAS_MODE_TPM   1

Definition at line 163 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_AUTO_WAIT

#define OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_AUTO_WAIT   1

Definition at line 183 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_CAPABILITY

#define OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_CAPABILITY   1

Definition at line 185 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_READ_FIFO_MODE

#define OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_READ_FIFO_MODE   1

Definition at line 184 of file spi_device.h.

OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_RETURN_BY_HW_REGS

#define OPENTITAN_SPI_DEVICE_HAS_MODE_TPM_RETURN_BY_HW_REGS   1

Definition at line 182 of file spi_device.h.

Typedef Documentation

dt_spi_device_alert_t

typedef enum dt_spi_device_alert dt_spi_device_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

dt_spi_device_clock_t

typedef enum dt_spi_device_clock dt_spi_device_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_spi_device_irq_t

typedef enum dt_spi_device_irq dt_spi_device_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

dt_spi_device_periph_io_t

typedef enum dt_spi_device_periph_io dt_spi_device_periph_io_t

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

dt_spi_device_reg_block_t

typedef enum dt_spi_device_reg_block dt_spi_device_reg_block_t

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

dt_spi_device_reset_t

typedef enum dt_spi_device_reset dt_spi_device_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kDtSpiDeviceAlertCount	Number of Alerts.

Definition at line 105 of file spi_device.h.

anonymous enum

anonymous enum

Enumerator
kDtSpiDeviceIrqCount	Number of IRQs.

Definition at line 91 of file spi_device.h.

anonymous enum

anonymous enum

Enumerator
kDtSpiDevicePeriphIoCount	Number of peripheral I/O.

Definition at line 153 of file spi_device.h.

anonymous enum

anonymous enum

Enumerator
kDtSpiDeviceCount	Number of instances.

Definition at line 34 of file spi_device.h.

anonymous enum

anonymous enum

Enumerator
kDtSpiDeviceClockCount	Number of clock ports.

Definition at line 119 of file spi_device.h.

anonymous enum

anonymous enum

Enumerator
kDtSpiDeviceRegBlockCount	Number of register blocks.

Definition at line 48 of file spi_device.h.

anonymous enum

anonymous enum

Enumerator
kDtSpiDeviceResetCount	Number of reset ports.

Definition at line 133 of file spi_device.h.

dt_spi_device

enum dt_spi_device

List of instances.

Enumerator
kDtSpiDeviceFirst	First instance.
kDtSpiDevice	spi_device

Definition at line 29 of file spi_device.h.

dt_spi_device_alert

enum dt_spi_device_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

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

Definition at line 101 of file spi_device.h.

dt_spi_device_clock

enum dt_spi_device_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSpiDeviceClockClk	Clock port clk_i.

Definition at line 115 of file spi_device.h.

dt_spi_device_irq

enum dt_spi_device_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSpiDeviceIrqUploadCmdfifoNotEmpty	Upload Command FIFO is not empty.
kDtSpiDeviceIrqUploadPayloadNotEmpty	Upload payload is not empty. The event occurs after SPI transaction completed
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.
kDtSpiDeviceIrqReadbufWatermark	Read Buffer Threshold event. The host system accesses greater than or equal to the threshold of a buffer.
kDtSpiDeviceIrqReadbufFlip	Read buffer flipped event. The host system accesses other side of buffer.
kDtSpiDeviceIrqTpmHeaderNotEmpty	TPM Header(Command/Address) buffer available.
kDtSpiDeviceIrqTpmRdfifoCmdEnd	TPM RdFIFO command ended. The TPM Read command targeting the RdFIFO ended. Check TPM_STATUS.rdfifo_aborted to see if the transaction completed.
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 61 of file spi_device.h.

dt_spi_device_periph_io

enum dt_spi_device_periph_io

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

Definition at line 143 of file spi_device.h.

dt_spi_device_reg_block

enum dt_spi_device_reg_block

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 44 of file spi_device.h.

dt_spi_device_reset

enum dt_spi_device_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtSpiDeviceResetRst	Reset port rst_ni.

Definition at line 129 of file spi_device.h.

Function Documentation

dt_spi_device_alert_from_alert_id()

dt_spi_device_alert_t dt_spi_device_alert_from_alert_id	(	dt_spi_device_t	dt,
		dt_alert_id_t	alert )

Convert a global alert ID to a local spi_device alert type.

Parameters

dt	Instance of spi_device.
alert	A global alert ID that belongs to this instance.

Returns

The spi_device alert, or kDtSpiDeviceAlertCount.

Note: This function assumes that the global alert ID belongs to the instance of spi_device passed in parameter. In other words, it must be the case that dt_spi_device_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtSpiDeviceAlertCount.

Definition at line 174 of file spi_device.c.

dt_spi_device_alert_to_alert_id()

dt_alert_id_t dt_spi_device_alert_to_alert_id	(	dt_spi_device_t	dt,
		dt_spi_device_alert_t	alert )

Get the alert ID of a spi_device alert for a given instance.

Note: This function only makes sense if the instance is connected to the Alert Handler. For any instances where the instance is not connected, the return value is unspecified.

Parameters

dt	Instance of spi_device.
alert	A spi_device alert.

Returns

The Alert Handler alert ID of the alert of this instance.

Definition at line 168 of file spi_device.c.

dt_spi_device_clock()

dt_clock_t dt_spi_device_clock	(	dt_spi_device_t	dt,
		dt_spi_device_clock_t	clk )

Get the clock signal connected to a clock port of an instance.

Parameters

dt	Instance of spi_device.
clk	Clock port.

Returns

Clock signal.

Definition at line 192 of file spi_device.c.

dt_spi_device_from_instance_id()

dt_spi_device_t dt_spi_device_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the spi_device instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A spi_device instance.

Note: This function only makes sense if the instance ID has device type spi_device, otherwise the returned value is unspecified.

Definition at line 124 of file spi_device.c.

dt_spi_device_instance_id()

dt_instance_id_t dt_spi_device_instance_id

(

dt_spi_device_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of spi_device.

Returns

The instance ID of that instance.

Definition at line 131 of file spi_device.c.

dt_spi_device_irq_from_plic_id()

dt_spi_device_irq_t dt_spi_device_irq_from_plic_id	(	dt_spi_device_t	dt,
		dt_plic_irq_id_t	irq )

Convert a global IRQ ID to a local spi_device IRQ type.

Parameters

dt	Instance of spi_device.
irq	A PLIC ID that belongs to this instance.

Returns

The spi_device IRQ, or kDtSpiDeviceIrqCount.

Note: This function assumes that the PLIC ID belongs to the instance of spi_device passed in parameter. In other words, it must be the case that dt_spi_device_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtSpiDeviceIrqCount.

Definition at line 153 of file spi_device.c.

dt_spi_device_irq_to_plic_id()

dt_plic_irq_id_t dt_spi_device_irq_to_plic_id	(	dt_spi_device_t	dt,
		dt_spi_device_irq_t	irq )

Get the PLIC ID of a spi_device IRQ for a given instance.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters

dt	Instance of spi_device.
irq	A spi_device IRQ.

Returns

The PLIC ID of the IRQ of this instance.

Definition at line 143 of file spi_device.c.

dt_spi_device_periph_io()

dt_periph_io_t dt_spi_device_periph_io	(	dt_spi_device_t	dt,
		dt_spi_device_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

dt	Instance of spi_device.
sig	Requested peripheral I/O.

Returns

Description of the requested peripheral I/O for this instance.

Definition at line 185 of file spi_device.c.

dt_spi_device_reg_block()

uint32_t dt_spi_device_reg_block	(	dt_spi_device_t	dt,
		dt_spi_device_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of spi_device.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 136 of file spi_device.c.

dt_spi_device_reset()

dt_reset_t dt_spi_device_reset	(	dt_spi_device_t	dt,
		dt_spi_device_reset_t	rst )

Get the reset signal connected to a reset port of an instance.

Parameters

dt	Instance of spi_device.
rst	Reset port.

Returns

Reset signal.

Definition at line 199 of file spi_device.c.