MCUXpresso SDK API Reference Manual
Rev. 0
NXP Semiconductors
|
Files | |
file | fsl_spi.h |
Data Structures | |
struct | spi_delay_config_t |
SPI delay time configure structure. More... | |
struct | spi_master_config_t |
SPI master user configure structure. More... | |
struct | spi_slave_config_t |
SPI slave user configure structure. More... | |
struct | spi_transfer_t |
SPI transfer structure. More... | |
struct | spi_half_duplex_transfer_t |
SPI half-duplex(master only) transfer structure. More... | |
struct | spi_config_t |
Internal configuration structure used in 'spi' and 'spi_dma' driver. More... | |
struct | spi_master_handle_t |
SPI transfer handle structure. More... | |
Macros | |
#define | SPI_DUMMYDATA (0xFFU) |
SPI dummy transfer data, the data is sent while txBuff is NULL. More... | |
Typedefs | |
typedef spi_master_handle_t | spi_slave_handle_t |
Slave handle type. | |
typedef void(* | spi_master_callback_t )(SPI_Type *base, spi_master_handle_t *handle, status_t status, void *userData) |
SPI master callback for finished transmit. | |
typedef void(* | spi_slave_callback_t )(SPI_Type *base, spi_slave_handle_t *handle, status_t status, void *userData) |
SPI slave callback for finished transmit. | |
typedef void(* | flexcomm_spi_master_irq_handler_t )(SPI_Type *base, spi_master_handle_t *handle) |
Typedef for master interrupt handler. More... | |
typedef void(* | flexcomm_spi_slave_irq_handler_t )(SPI_Type *base, spi_slave_handle_t *handle) |
Typedef for slave interrupt handler. More... | |
Variables | |
volatile uint8_t | s_dummyData [] |
Global variable for dummy data value setting. More... | |
Driver version | |
#define | FSL_SPI_DRIVER_VERSION (MAKE_VERSION(2, 1, 0)) |
SPI driver version 2.1.0. More... | |
This section describes the programming interface of the SPI DMA driver.
struct spi_delay_config_t |
Note: The DLY register controls several programmable delays related to SPI signalling, it stands for how many SPI clock time will be inserted. The maxinun value of these delay time is 15.
Data Fields | |
uint8_t | preDelay |
Delay between SSEL assertion and the beginning of transfer. More... | |
uint8_t | postDelay |
Delay between the end of transfer and SSEL deassertion. More... | |
uint8_t | frameDelay |
Delay between frame to frame. More... | |
uint8_t | transferDelay |
Delay between transfer to transfer. More... | |
uint8_t spi_delay_config_t::preDelay |
uint8_t spi_delay_config_t::postDelay |
uint8_t spi_delay_config_t::frameDelay |
uint8_t spi_delay_config_t::transferDelay |
struct spi_master_config_t |
Data Fields | |
bool | enableLoopback |
Enable loopback for test purpose. | |
bool | enableMaster |
Enable SPI at initialization time. | |
spi_clock_polarity_t | polarity |
Clock polarity. | |
spi_clock_phase_t | phase |
Clock phase. | |
spi_shift_direction_t | direction |
MSB or LSB. | |
uint32_t | baudRate_Bps |
Baud Rate for SPI in Hz. | |
spi_data_width_t | dataWidth |
Width of the data. | |
spi_ssel_t | sselNum |
Slave select number. | |
spi_spol_t | sselPol |
Configure active CS polarity. | |
uint8_t | txWatermark |
txFIFO watermark | |
uint8_t | rxWatermark |
rxFIFO watermark | |
spi_delay_config_t | delayConfig |
Delay configuration. More... | |
spi_delay_config_t spi_master_config_t::delayConfig |
struct spi_slave_config_t |
Data Fields | |
bool | enableSlave |
Enable SPI at initialization time. | |
spi_clock_polarity_t | polarity |
Clock polarity. | |
spi_clock_phase_t | phase |
Clock phase. | |
spi_shift_direction_t | direction |
MSB or LSB. | |
spi_data_width_t | dataWidth |
Width of the data. | |
spi_spol_t | sselPol |
Configure active CS polarity. | |
uint8_t | txWatermark |
txFIFO watermark | |
uint8_t | rxWatermark |
rxFIFO watermark | |
struct spi_transfer_t |
Data Fields | |
uint8_t * | txData |
Send buffer. | |
uint8_t * | rxData |
Receive buffer. | |
uint32_t | configFlags |
Additional option to control transfer, spi_xfer_option_t. More... | |
size_t | dataSize |
Transfer bytes. | |
uint32_t spi_transfer_t::configFlags |
struct spi_half_duplex_transfer_t |
Data Fields | |
uint8_t * | txData |
Send buffer. | |
uint8_t * | rxData |
Receive buffer. | |
size_t | txDataSize |
Transfer bytes for transmit. | |
size_t | rxDataSize |
Transfer bytes. | |
uint32_t | configFlags |
Transfer configuration flags, spi_xfer_option_t. More... | |
bool | isPcsAssertInTransfer |
If PCS pin keep assert between transmit and receive. More... | |
bool | isTransmitFirst |
True for transmit first and false for receive first. More... | |
uint32_t spi_half_duplex_transfer_t::configFlags |
bool spi_half_duplex_transfer_t::isPcsAssertInTransfer |
true for assert and false for deassert.
bool spi_half_duplex_transfer_t::isTransmitFirst |
struct spi_config_t |
struct _spi_master_handle |
Master handle type.
Data Fields | |
uint8_t *volatile | txData |
Transfer buffer. | |
uint8_t *volatile | rxData |
Receive buffer. | |
volatile size_t | txRemainingBytes |
Number of data to be transmitted [in bytes]. | |
volatile size_t | rxRemainingBytes |
Number of data to be received [in bytes]. | |
volatile size_t | toReceiveCount |
Receive data remaining in bytes. | |
size_t | totalByteCount |
A number of transfer bytes. | |
volatile uint32_t | state |
SPI internal state. | |
spi_master_callback_t | callback |
SPI callback. | |
void * | userData |
Callback parameter. | |
uint8_t | dataWidth |
Width of the data [Valid values: 1 to 16]. | |
uint8_t | sselNum |
Slave select number to be asserted when transferring data [Valid values: 0 to 3]. | |
uint32_t | configFlags |
Additional option to control transfer. | |
uint8_t | txWatermark |
txFIFO watermark | |
uint8_t | rxWatermark |
rxFIFO watermark | |
#define FSL_SPI_DRIVER_VERSION (MAKE_VERSION(2, 1, 0)) |
#define SPI_DUMMYDATA (0xFFU) |
typedef void(* flexcomm_spi_master_irq_handler_t)(SPI_Type *base, spi_master_handle_t *handle) |
typedef void(* flexcomm_spi_slave_irq_handler_t)(SPI_Type *base, spi_slave_handle_t *handle) |
enum spi_xfer_option_t |
enum spi_clock_polarity_t |
enum spi_clock_phase_t |
enum spi_data_width_t |
enum spi_ssel_t |
anonymous enum |
enum _spi_statusflags |
volatile uint8_t s_dummyData[] |