Software APIs
Data Structures | Typedefs | Enumerations | Functions
dif_spi_device_autogen.h File Reference

(a649ec5)

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"

Go to the source code of this file.

Data Structures

struct  dif_spi_device
 A handle to spi_device. More...
 

Typedefs

typedef struct dif_spi_device dif_spi_device_t
 A handle to spi_device. More...
 
typedef enum dif_spi_device_alert dif_spi_device_alert_t
 A spi_device alert type.
 
typedef enum dif_spi_device_irq dif_spi_device_irq_t
 A spi_device interrupt request type.
 
typedef uint32_t dif_spi_device_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_spi_device_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_spi_device_alert { kDifSpiDeviceAlertFatalFault = 0 }
 A spi_device alert type. More...
 
enum  dif_spi_device_irq {
  kDifSpiDeviceIrqUploadCmdfifoNotEmpty = 0,
  kDifSpiDeviceIrqUploadPayloadNotEmpty = 1,
  kDifSpiDeviceIrqUploadPayloadOverflow = 2,
  kDifSpiDeviceIrqReadbufWatermark = 3,
  kDifSpiDeviceIrqReadbufFlip = 4,
  kDifSpiDeviceIrqTpmHeaderNotEmpty = 5,
  kDifSpiDeviceIrqTpmRdfifoCmdEnd = 6,
  kDifSpiDeviceIrqTpmRdfifoDrop = 7
}
 A spi_device interrupt request 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

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

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

Typedef Documentation

◆ 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 224 of file dif_spi_device_autogen.h.

◆ 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 128 of file dif_spi_device_autogen.h.

◆ 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

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

◆ dif_spi_device_irq

A spi_device interrupt request type.

Enumerator
kDifSpiDeviceIrqUploadCmdfifoNotEmpty 

Upload Command FIFO is not empty.

kDifSpiDeviceIrqUploadPayloadNotEmpty 

Upload payload is not empty.

The event occurs after SPI transaction completed

kDifSpiDeviceIrqUploadPayloadOverflow 

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.

kDifSpiDeviceIrqReadbufWatermark 

Read Buffer Threshold event.

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

kDifSpiDeviceIrqReadbufFlip 

Read buffer flipped event.

The host system accesses other side of buffer.

kDifSpiDeviceIrqTpmHeaderNotEmpty 

TPM Header(Command/Address) buffer available.

kDifSpiDeviceIrqTpmRdfifoCmdEnd 

TPM RdFIFO command ended.

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

kDifSpiDeviceIrqTpmRdfifoDrop 

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 79 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_deviceA spi_device handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 28 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_addrThe MMIO base address of the spi_device peripheral.
[out]spi_deviceOut param for the initialized handle.
Returns
The result of the operation.

Definition at line 17 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_deviceA spi_device handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 171 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_deviceA spi_device handle.
Returns
The result of the operation.

Definition at line 157 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_deviceA spi_device handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 122 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_deviceA spi_device handle.
[out]snapshotOut-param for the snapshot; may be NULL.
Returns
The result of the operation.

Definition at line 260 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_deviceA spi_device handle.
irqAn interrupt request.
valValue to be set.
Returns
The result of the operation.

Definition at line 192 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_deviceA spi_device handle.
irqAn interrupt request.
[out]stateOut-param toggle state of the interrupt.
Returns
The result of the operation.

Definition at line 213 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_deviceA spi_device handle.
[out]snapshotOut-param for interrupt state snapshot.
Returns
The result of the operation.

Definition at line 108 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_deviceA spi_device handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 94 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_deviceA spi_device handle.
irqAn interrupt request.
[out]is_pendingOut-param for whether the interrupt is pending.
Returns
The result of the operation.

Definition at line 136 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_deviceA spi_device handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 281 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_deviceA spi_device handle.
irqAn interrupt request.
stateThe new toggle state for the interrupt.
Returns
The result of the operation.

Definition at line 235 of file dif_spi_device_autogen.c.