no-OS
Public Attributes | List of all members
spiSettings_t Struct Reference

Data structure to hold SPI settings for all system device types. More...

#include <common.h>

Public Attributes

uint8_t chipSelectIndex
 valid 1~8 More...
 
uint8_t writeBitPolarity
 the level of the write bit of a SPI write instruction word, value is inverted for SPI read operation More...
 
uint8_t longInstructionWord
 1 = 16bit instruction word, 0 = 8bit instruction word More...
 
uint8_t MSBFirst
 1 = MSBFirst, 0 = LSBFirst More...
 
uint8_t CPHA
 clock phase, sets which clock edge the data updates (valid 0 or 1) More...
 
uint8_t CPOL
 clock polarity 0 = clock starts low, 1 = clock starts high More...
 
uint8_t enSpiStreaming
 Not implemented. SW feature to improve SPI throughput. More...
 
uint8_t autoIncAddrUp
 Not implemented. For SPI Streaming, set address increment direction. 1= next addr = addr+1, 0:addr = addr-1. More...
 
uint8_t fourWireMode
 1: Use 4-wire SPI, 0: 3-wire SPI (SDIO pin is bidirectional). NOTE: ADI's FPGA platform always uses 4-wire mode. More...
 
uint32_t spiClkFreq_Hz
 SPI Clk frequency in Hz (default 25000000), platform will use next lowest frequency that it's baud rate generator can create *‍/. More...
 

Detailed Description

Data structure to hold SPI settings for all system device types.

Member Data Documentation

◆ autoIncAddrUp

uint8_t spiSettings_t::autoIncAddrUp

Not implemented. For SPI Streaming, set address increment direction. 1= next addr = addr+1, 0:addr = addr-1.

◆ chipSelectIndex

uint8_t spiSettings_t::chipSelectIndex

valid 1~8

◆ CPHA

uint8_t spiSettings_t::CPHA

clock phase, sets which clock edge the data updates (valid 0 or 1)

◆ CPOL

uint8_t spiSettings_t::CPOL

clock polarity 0 = clock starts low, 1 = clock starts high

◆ enSpiStreaming

uint8_t spiSettings_t::enSpiStreaming

Not implemented. SW feature to improve SPI throughput.

◆ fourWireMode

uint8_t spiSettings_t::fourWireMode

1: Use 4-wire SPI, 0: 3-wire SPI (SDIO pin is bidirectional). NOTE: ADI's FPGA platform always uses 4-wire mode.

◆ longInstructionWord

uint8_t spiSettings_t::longInstructionWord

1 = 16bit instruction word, 0 = 8bit instruction word

◆ MSBFirst

uint8_t spiSettings_t::MSBFirst

1 = MSBFirst, 0 = LSBFirst

◆ spiClkFreq_Hz

uint32_t spiSettings_t::spiClkFreq_Hz

SPI Clk frequency in Hz (default 25000000), platform will use next lowest frequency that it's baud rate generator can create *‍/.

◆ writeBitPolarity

uint8_t spiSettings_t::writeBitPolarity

the level of the write bit of a SPI write instruction word, value is inverted for SPI read operation


The documentation for this struct was generated from the following file: