Skip to content

Struct SYN_SPI_Transaction

ClassList > SYN_SPI_Transaction

SPI Transaction Descriptor.

  • #include <syn_spi_queue.h>

Public Attributes

Type Name
uint32_t baudrate_hz
uint8_t bus
SYN_SPI_Queue_Callback callback
SYN_GPIO_Pin cs_pin
bool keep_cs_active
size_t len
SYN_SPI_Mode mode
uint8_t * rx_data
const uint8_t * tx_data
void * user_data

Public Attributes Documentation

variable baudrate_hz

uint32_t SYN_SPI_Transaction::baudrate_hz;

Target baud rate in Hz (0 = default 1 MHz)


variable bus

uint8_t SYN_SPI_Transaction::bus;

SPI bus index


variable callback

SYN_SPI_Queue_Callback SYN_SPI_Transaction::callback;

Completion callback


variable cs_pin

SYN_GPIO_Pin SYN_SPI_Transaction::cs_pin;

Target Chip Select GPIO pin


variable keep_cs_active

bool SYN_SPI_Transaction::keep_cs_active;

If true, leaves CS low upon transfer completion


variable len

size_t SYN_SPI_Transaction::len;

Transfer byte count


variable mode

SYN_SPI_Mode SYN_SPI_Transaction::mode;

Target SPI mode (0-3)


variable rx_data

uint8_t* SYN_SPI_Transaction::rx_data;

RX buffer (NULL → discard RX)


variable tx_data

const uint8_t* SYN_SPI_Transaction::tx_data;

TX buffer (NULL → send dummy 0xFF)


variable user_data

void* SYN_SPI_Transaction::user_data;

User context pointer



The documentation for this class was generated from the following file src/syntropic/drivers/syn_spi_queue.h