SPI

Modules
	SPI_Registers

Typedefs
typedef void(*	mxc_spi_callback_t) (void *, int result)

Enumerations
enum	mxc_spi_type_t
enum	mxc_spi_tscontrol_t
enum	mxc_spi_state_t
enum	mxc_spi_interface_t
enum	mxc_spi_clkmode_t
enum	mxc_spi_width_t
enum	mxc_spi_mode_t

Functions
int	MXC_SPI_Init (mxc_spi_regs_t *spi, mxc_spi_type_t controller_target, mxc_spi_interface_t if_mode, int numTargets, uint8_t ts_active_pol_mask, uint32_t freq, mxc_spi_pins_t pins)
int	MXC_SPI_Config (mxc_spi_cfg_t *cfg)
int	MXC_SPI_ConfigStruct (mxc_spi_cfg_t *cfg, bool use_dma_tx, bool use_dma_rx)
int	MXC_SPI_Shutdown (mxc_spi_regs_t *spi)
unsigned int	MXC_SPI_GetFlags (mxc_spi_regs_t *spi)
void	MXC_SPI_ClearFlags (mxc_spi_regs_t *spi)
void	MXC_SPI_EnableInt (mxc_spi_regs_t *spi, unsigned int intEn)
void	MXC_SPI_DisableInt (mxc_spi_regs_t *spi, unsigned int intDis)
int	MXC_SPI_GetPeripheralClock (mxc_spi_regs_t *spi)
int	MXC_SPI_SetTSControl (mxc_spi_regs_t *spi, mxc_spi_tscontrol_t ts_control)
int	MXC_SPI_SetFrequency (mxc_spi_regs_t *spi, unsigned int hz)
unsigned int	MXC_SPI_GetFrequency (mxc_spi_regs_t *spi)
int	MXC_SPI_SetFrameSize (mxc_spi_regs_t *spi, int frame_size)
int	MXC_SPI_GetFrameSize (mxc_spi_regs_t *spi)
int	MXC_SPI_SetInterface (mxc_spi_regs_t *spi, mxc_spi_interface_t if_mode)
mxc_spi_interface_t	MXC_SPI_GetInterface (mxc_spi_regs_t *spi)
int	MXC_SPI_SetClkMode (mxc_spi_regs_t *spi, mxc_spi_clkmode_t clk_mode)
mxc_spi_clkmode_t	MXC_SPI_GetClkMode (mxc_spi_regs_t *spi)
int	MXC_SPI_SetCallback (mxc_spi_regs_t *spi, mxc_spi_callback_t callback, void *data)
int	MXC_SPI_GetActive (mxc_spi_regs_t *spi)
int	MXC_SPI_ReadyForSleep (mxc_spi_regs_t *spi)
int	MXC_SPI_StartTransmission (mxc_spi_regs_t *spi)
int	MXC_SPI_AbortTransmission (mxc_spi_regs_t *spi)
void	MXC_SPI_AbortAsync (mxc_spi_regs_t *spi)
unsigned int	MXC_SPI_GetTXFIFOAvailable (mxc_spi_regs_t *spi)
unsigned int	MXC_SPI_GetRXFIFOAvailable (mxc_spi_regs_t *spi)
void	MXC_SPI_ClearTXFIFO (mxc_spi_regs_t *spi)
void	MXC_SPI_ClearRXFIFO (mxc_spi_regs_t *spi)
int	MXC_SPI_SetTXThreshold (mxc_spi_regs_t *spi, unsigned int numBytes)
int	MXC_SPI_SetRXThreshold (mxc_spi_regs_t *spi, unsigned int numBytes)
unsigned int	MXC_SPI_GetTXThreshold (mxc_spi_regs_t *spi)
unsigned int	MXC_SPI_GetRXThreshold (mxc_spi_regs_t *spi)
int	MXC_SPI_SetDataSize (mxc_spi_regs_t *spi, int dataSize)
int	MXC_SPI_GetDataSize (mxc_spi_regs_t *spi)
int	MXC_SPI_SetWidth (mxc_spi_regs_t *spi, mxc_spi_width_t spiWidth)
mxc_spi_width_t	MXC_SPI_GetWidth (mxc_spi_regs_t *spi)
int	MXC_SPI_SetSlave (mxc_spi_regs_t *spi, int ssIdx)
int	MXC_SPI_GetSlave (mxc_spi_regs_t *spi)
int	MXC_SPI_SetMode (mxc_spi_regs_t *spi, mxc_spi_mode_t spiMode)
mxc_spi_mode_t	MXC_SPI_GetMode (mxc_spi_regs_t *spi)
unsigned int	MXC_SPI_WriteTXFIFO (mxc_spi_regs_t *spi, unsigned char *bytes, unsigned int len)
unsigned int	MXC_SPI_ReadRXFIFO (mxc_spi_regs_t *spi, unsigned char *bytes, unsigned int len)
int	MXC_SPI_SetDefaultTXData (mxc_spi_regs_t *spi, unsigned int defaultTXData)
void	MXC_SPI_HWSSControl (mxc_spi_regs_t *spi, int state)
int	MXC_SPI_DMA_Init (mxc_spi_regs_t *spi, mxc_dma_regs_t *dma, bool use_dma_tx, bool use_dma_rx)
bool	MXC_SPI_DMA_GetInitialized (mxc_spi_regs_t *spi)
int	MXC_SPI_DMA_GetTXChannel (mxc_spi_regs_t *spi)
int	MXC_SPI_DMA_GetRXChannel (mxc_spi_regs_t *spi)
int	MXC_SPI_DMA_SetRequestSelect (mxc_spi_regs_t *spi, bool use_dma_tx, bool use_dma_rx)
int	MXC_SPI_MasterTransaction (mxc_spi_req_t *req)
int	MXC_SPI_MasterTransactionAsync (mxc_spi_req_t *req)
int	MXC_SPI_MasterTransactionDMA (mxc_spi_req_t *req)
int	MXC_SPI_ControllerTransaction (mxc_spi_req_t *req)
int	MXC_SPI_ControllerTransactionAsync (mxc_spi_req_t *req)
int	MXC_SPI_ControllerTransactionDMA (mxc_spi_req_t *req)
int	MXC_SPI_ControllerTransactionDMAB (mxc_spi_req_t *req)
int	MXC_SPI_SlaveTransaction (mxc_spi_req_t *req)
int	MXC_SPI_SlaveTransactionAsync (mxc_spi_req_t *req)
int	MXC_SPI_SlaveTransactionDMA (mxc_spi_req_t *req)
int	MXC_SPI_TargetTransaction (mxc_spi_req_t *req)
int	MXC_SPI_TargetTransactionAsync (mxc_spi_req_t *req)
int	MXC_SPI_TargetTransactionDMA (mxc_spi_req_t *req)
void	MXC_SPI_AsyncHandler (mxc_spi_regs_t *spi)
void	MXC_SPI_Handler (mxc_spi_regs_t *spi)
void	MXC_SPI_DMA_TX_Handler (mxc_spi_regs_t *spi)
void	MXC_SPI_DMA_RX_Handler (mxc_spi_regs_t *spi)

Detailed Description

Typedef Documentation

mxc_spi_callback_t

typedef void(* mxc_spi_callback_t) (void *, int result)

The callback routine used to indicate the transaction has terminated.

Parameters

req	The details of the transaction.
result	See Error Codes for the list of error codes.

Enumeration Type Documentation

mxc_spi_clkmode_t

enum mxc_spi_clkmode_t

The list of SPI clock modes.

SPI supports four combinations of clock and phase polarity.

Clock polarity is controlled using the bit SPIn_CTRL2.cpol and determines if the clock is active high or active low

Clock phase determines when the data must be stable for sampling

mxc_spi_mode_t

enum mxc_spi_mode_t

The list of SPI modes.

SPI supports four combinations of clock and phase polarity

Clock polarity is controlled using the bit SPIn_CTRL2.cpol and determines if the clock is active high or active low

Clock phase determines when the data must be stable for sampling

Enumerator
SPI_MODE_0	clock phase = 0, clock polarity = 0
SPI_MODE_1	clock phase = 0, clock polarity = 1
SPI_MODE_2	clock phase = 1, clock polarity = 0
SPI_MODE_3	clock phase = 1, clock polarity = 1

mxc_spi_width_t

enum mxc_spi_width_t

‍

Deprecated:

The list of SPI Widths supported

Deprecated:

Enumerator
SPI_WIDTH_3WIRE	1 Data line, half duplex
SPI_WIDTH_STANDARD	MISO/MOSI, full duplex.
SPI_WIDTH_DUAL	2 Data lines, half duplex
SPI_WIDTH_QUAD	4 Data lines, half duplex

Function Documentation

MXC_SPI_AbortAsync()

void MXC_SPI_AbortAsync

(

mxc_spi_regs_t *

spi

)

Abort any asynchronous requests in progress.

Abort any asynchronous requests in progress. Any callbacks associated with the active transaction will be executed to indicate when the transaction has been terminated.

Parameters

spi	Pointer to SPI instance's registers.

MXC_SPI_AbortTransmission()

int MXC_SPI_AbortTransmission

(

mxc_spi_regs_t *

spi

)

Aborts an ongoing SPI Transmission.

This function is applicable in Master mode only

Parameters

spi	Pointer to SPI instance's registers.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_AsyncHandler()

void MXC_SPI_AsyncHandler

(

mxc_spi_regs_t *

spi

)

The processing function for asynchronous transactions.

When using the asynchronous functions, the application must call this function periodically. This can be done from within the SPI interrupt handler or periodically by the application if SPI interrupts are disabled.

Parameters

spi	Pointer to SPI instance's registers.

MXC_SPI_ClearFlags()

void MXC_SPI_ClearFlags

(

mxc_spi_regs_t *

spi

)

Clears the interrupt flags that are currently set.

These functions should not be used while using non-blocking Transaction Level functions (Async or DMA).

Parameters

spi	Pointer to SPI registers (selects the SPI block used).

MXC_SPI_ClearRXFIFO()

void MXC_SPI_ClearRXFIFO

(

mxc_spi_regs_t *

spi

)

Removes and discards all bytes currently in the receive FIFO.

Parameters

spi	Pointer to SPI instance's registers.

MXC_SPI_ClearTXFIFO()

void MXC_SPI_ClearTXFIFO

(

mxc_spi_regs_t *

spi

)

Removes and discards all bytes currently in the transmit FIFO.

Parameters

spi	Pointer to SPI instance's registers.

MXC_SPI_Config()

int MXC_SPI_Config

(

mxc_spi_cfg_t *

cfg

)

Configure the SPI peripheral.

List of Setting that will be updated: Clock Mode. Frame Size (bits). Interface Mode (Dual, Quad, Standard, 3-Wire). If DMA selections are true, configure and acquire DMA channels.

Parameters

cfg	Pointer to SPI configuration struct.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_ConfigStruct()

int MXC_SPI_ConfigStruct	(	mxc_spi_cfg_t *	cfg,
		bool	use_dma_tx,
		bool	use_dma_rx
	)

Overwrite the cfg struct with default values.

Settings: SPI APB (SPI1) instance Default, predefined SPI pins at VDDIO Controller Mode Standard 4-wire mode 100KHz speed CPOL: 0, CPHA: 0 Automatic Hardware mode for TS Control TS0 pin Target active polarity is LOW (0) If use_dma = true, set DMATX and RX to true and set the DMA0 as the default instance.

Parameters

cfg	Pointer to SPI configuration struct.
use_dma_tx	True/False option to configure DMA TX.
use_dma_rx	True/False option to configure DMA RX.

Returns

Success/Fail, see Error Codes for a list of return codes.odes.

MXC_SPI_ControllerTransaction()

int MXC_SPI_ControllerTransaction

(

mxc_spi_req_t *

req

)

Set up a blocking, non-interrupt-driven SPI controller transaction.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_ControllerTransactionAsync()

int MXC_SPI_ControllerTransactionAsync

(

mxc_spi_req_t *

req

)

Set up a non-blocking, interrupt-driven SPI controller transaction.

The MXC_SPI_Handler function must be called in the selected SPI instance's interrupt handler to process the transaction.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_ControllerTransactionDMA()

int MXC_SPI_ControllerTransactionDMA

(

mxc_spi_req_t *

req

)

Set up a non-blocking, DMA-driven SPI controller transaction.

The MXC_SPI_Config(...) or MXC_SPI_DMA_Init(..). functions must be called before calling this DMA transaction function. This function does not initialize the DMA.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_ControllerTransactionDMAB()

int MXC_SPI_ControllerTransactionDMAB

(

mxc_spi_req_t *

req

)

Set up a blocking, DMA-driven SPI controller transaction.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_DisableInt()

void MXC_SPI_DisableInt	(	mxc_spi_regs_t *	spi,
		unsigned int	intDis
	)

Disables specific interrupts.

These functions should not be used while using non-blocking Transaction Level functions (Async or DMA)

Parameters

spi	Pointer to SPI registers (selects the SPI block used).
intDis	The interrupts to be disabled

MXC_SPI_DMA_GetInitialized()

bool MXC_SPI_DMA_GetInitialized

(

mxc_spi_regs_t *

spi

)

Helper function that checks whether the MXC_SPI_Init function cfgalized DMA for SPI DMA transactons.

Parameters

spi	Pointer to SPI instance's registers.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_DMA_GetRXChannel()

int MXC_SPI_DMA_GetRXChannel

(

mxc_spi_regs_t *

spi

)

Retreive the DMA RX Channel associated with SPI instance.

Parameters

spi	Pointer to SPI instance's registers.

Returns

If successful, the DMA RX Channel number is returned. Otherwise, see Error Codes for a list of return codes.

MXC_SPI_DMA_GetTXChannel()

int MXC_SPI_DMA_GetTXChannel

(

mxc_spi_regs_t *

spi

)

Retreive the DMA TX Channel associated with SPI instance.

Parameters

spi	Pointer to SPI instance's registers.

Returns

If successful, the DMA TX Channel number is returned. Otherwise, see Error Codes for a list of return codes.

MXC_SPI_DMA_Init()

int MXC_SPI_DMA_Init	(	mxc_spi_regs_t *	spi,
		mxc_dma_regs_t *	dma,
		bool	use_dma_tx,
		bool	use_dma_rx
	)

This function initializes the DMA for SPI DMA transactions.

Note

This function must run before any SPI DMA transactions.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).
dma	Pointer to DMA registers (selects the DMA block used).
use_dma_tx	True/False setting to initialize SPI DMA TX. Acquire DMA TX channel.
use_dma_rx	True/False setting to initialize SPI DMA RX. Acquire DMA RX channel. use_dma_tx must be true even if use_dma_rx is false.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_DMA_RX_Handler()

void MXC_SPI_DMA_RX_Handler

(

mxc_spi_regs_t *

spi

)

The processing function for DMA RX transactions.

This function calls the callback function at the end of a TX/RX transaction.

Parameters

spi	Pointer to SPI instance's registers.

MXC_SPI_DMA_SetRequestSelect()

int MXC_SPI_DMA_SetRequestSelect	(	mxc_spi_regs_t *	spi,
		bool	use_dma_tx,
		bool	use_dma_rx
	)

Sets the SPI instance's DMA TX/RX request select.

Parameters

spi	Pointer to SPI instance's registers.
use_dma_tx	True/False setting to set SPI DMA TX request select.
use_dma_rx	True/False setting to set SPI DMA RX request select.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_DMA_TX_Handler()

void MXC_SPI_DMA_TX_Handler

(

mxc_spi_regs_t *

spi

)

The processing function for DMA TX transactions.

This function calls the callback function if only TX transaction was made.

Parameters

spi	Pointer to SPI instance's registers.

MXC_SPI_EnableInt()

void MXC_SPI_EnableInt	(	mxc_spi_regs_t *	spi,
		unsigned int	intEn
	)

Enables specific interrupts.

These functions should not be used while using non-blocking Transaction Level functions (Async or DMA).

Parameters

spi	Pointer to SPI registers (selects the SPI block used).
intEn	The interrupts to be enabled.

MXC_SPI_GetActive()

int MXC_SPI_GetActive

(

mxc_spi_regs_t *

spi

)

Checks the SPI instance for an ongoing transmission.

This function is applicable in Controller mode only.

Parameters

spi	Pointer to SPI instance's registers.

Returns

Active/Inactive, see Error Codes for a list of return codes.

MXC_SPI_GetClkMode()

mxc_spi_clkmode_t MXC_SPI_GetClkMode

(

mxc_spi_regs_t *

spi

)

Gets the SPI clock mode (clock polarity and clock phase).

Parameters

spi	Pointer to SPI instance's registers.
clk_mode	SPI clock mode. See mxc_spi_clkmode_t

Returns

The selected SPI instance's clock mode. See mxc_spi_clkwidth_t.

MXC_SPI_GetDataSize()

int MXC_SPI_GetDataSize

(

mxc_spi_regs_t *

spi

)

Gets the number of bits per character.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_GetFlags()

unsigned int MXC_SPI_GetFlags

(

mxc_spi_regs_t *

spi

)

Gets the interrupt flags that are currently set.

These functions should not be used while using non-blocking Transaction Level functions (Async or DMA)

Parameters

spi	Pointer to SPI registers (selects the SPI block used).

Returns

The interrupt flags.

MXC_SPI_GetFrameSize()

int MXC_SPI_GetFrameSize

(

mxc_spi_regs_t *

spi

)

Gets the number of bits per frame.

Parameters

spi	Pointer to SPI instance's registers.

Returns

If successful, the SPI instance's set data size is returned. Otherwise, see Error Codes for a list of return codes.

MXC_SPI_GetFrequency()

unsigned int MXC_SPI_GetFrequency

(

mxc_spi_regs_t *

spi

)

Get the frequency of the SPI interface.

This function is applicable in Master mode only

Parameters

spi	Pointer to SPI instance's registers.

Returns

If successful, the SPI instance's set frequency value is returned. Otherwise, see Error Codes for a list of return codes.

MXC_SPI_GetInterface()

mxc_spi_interface_t MXC_SPI_GetInterface

(

mxc_spi_regs_t *

spi

)

Gets the SPI interface mode used for transmissions.

3-Wire, Standard (4-Wire), Quad, Dual Modes

Parameters

spi	Pointer to SPI instance's registers.

Returns

The selected SPI instance's data line width. See mxc_spi_datawidth_t.

MXC_SPI_GetMode()

mxc_spi_mode_t MXC_SPI_GetMode

(

mxc_spi_regs_t *

spi

)

Gets the spi mode.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).

Returns

mxc_spi_mode_t mxc_spi_mode_t

MXC_SPI_GetPeripheralClock()

int MXC_SPI_GetPeripheralClock

(

mxc_spi_regs_t *

spi

)

Returns the frequency of the clock used as the bit rate generator for a given SPI instance.

Parameters

spi	Pointer to SPI instance's registers.

Returns

Frequency of the clock used as the bit rate generator

MXC_SPI_GetRXFIFOAvailable()

unsigned int MXC_SPI_GetRXFIFOAvailable

(

mxc_spi_regs_t *

spi

)

Get the number of bytes currently available in the receive FIFO.

Parameters

spi	Pointer to SPI instance's registers.

Returns

The number of bytes available.

MXC_SPI_GetRXThreshold()

unsigned int MXC_SPI_GetRXThreshold

(

mxc_spi_regs_t *

spi

)

Get the current receive threshold level.

Parameters

spi	Pointer to SPI instance's registers.

Returns

The receive threshold value (in bytes).

MXC_SPI_GetSlave()

int MXC_SPI_GetSlave

(

mxc_spi_regs_t *

spi

)

Gets the slave select (SS) line used for transmissions.

This function is applicable in Master mode only

Parameters

spi	Pointer to SPI instance's registers.

Returns

slave slect

MXC_SPI_GetTXFIFOAvailable()

unsigned int MXC_SPI_GetTXFIFOAvailable

(

mxc_spi_regs_t *

spi

)

Get the amount of free space available in the transmit FIFO.

Parameters

spi	Pointer to SPI instance's registers.

Returns

The number of bytes available.

MXC_SPI_GetTXThreshold()

unsigned int MXC_SPI_GetTXThreshold

(

mxc_spi_regs_t *

spi

)

Get the current transmit threshold level.

Parameters

spi	Pointer to SPI instance's registers.

Returns

The transmit threshold value (in bytes).

MXC_SPI_GetWidth()

mxc_spi_width_t MXC_SPI_GetWidth

(

mxc_spi_regs_t *

spi

)

Gets the SPI width used for transmissions.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).

Returns

Spi Width

MXC_SPI_Handler()

void MXC_SPI_Handler

(

mxc_spi_regs_t *

spi

)

The processing function for asynchronous transactions.

When using the asynchronous functions, the application must call this function periodically. This can be done from within the SPI interrupt handler or periodically by the application if SPI interrupts are disabled.

Parameters

spi	Pointer to SPI instance's registers.

MXC_SPI_HWSSControl()

void MXC_SPI_HWSSControl	(	mxc_spi_regs_t *	spi,
		int	state
	)

Enable/Disable HW CS control feature.

Depending on the application, the user might need to manually drive the slave select pin. The SPI driver automatically drives the SS pin and this function enables/disables this feature.

Parameters

spi	Pointer to SPI registers (selects the SPI block used.)
state	Non-zero values: enable HW SS mode. Zero: disable HW SS mode.

MXC_SPI_Init()

int MXC_SPI_Init	(	mxc_spi_regs_t *	spi,
		mxc_spi_type_t	controller_target,
		mxc_spi_interface_t	if_mode,
		int	numTargets,
		uint8_t	ts_active_pol_mask,
		uint32_t	freq,
		mxc_spi_pins_t	pins
	)

Initialize and enable SPI peripheral.

This function does not set the Clock Mode (defaults to Clock Mode 0) and only two interface modes are selectable (Quad Mode or 4-Wire Standard Mode). To change the clock mode, call MXC_SPI_SetClkMode(..).. To select another interface mode, call MXC_SPI_SetInterface(..)..

These parameters can be modified after cfgialization using low level functions

Parameters

spi	Pointer to SPI instance's registers.
controller_target	Whether to put the device in controller or target mode. Use non-zero for controller mode, and zero for target mode. MXC_SPI_TYPE_CONTROLLER - 1 MXC_SPI_TYPE_TARGET - 0
if_mode	Set the interface mode. MXC_SPI_INTERFACE_STANDARD - 0 (4 wire) MXC_SPI_INTERFACE_QUAD - 1 MXC_SPI_INTERFACE_3WIRE - 2 MXC_SPI_INTERFACE_DUAL - 3
numTargets	This parameter is UNUSED for SPI v2. The number of target used, if in controller mode. This is used to obtain control of the necessary TS pins. In target mode this is ignored and TS1 is used.
ts_active_pol_mask	This field sets the TS active polarity for each target, each bit position corresponds to each TS line. ts_active_pol_mask[0] - TS0 ts_active_pol_mask[1] - TS1 ts_active_pol_mask[n] - TSn
freq	The requested clock frequency. The actual clock frequency will be returned by the function if successful. Used in master mode only.
pins	SPI pin structure. Pins selected as true will be initialized for the requested SPI block.

Returns

If successful, the actual clock frequency is returned. Otherwise, see Error Codes for a list of return codes.

MXC_SPI_MasterTransaction()

int MXC_SPI_MasterTransaction

(

mxc_spi_req_t *

req

)

Performs a blocking SPI transaction.

Performs a blocking SPI transaction. These actions will be performed in Master Mode:

1. Assert the specified SS
2. In Full Duplex Modes, send TX data while receiving RX Data if rxLen > txLen, pad txData with DefaultTXData if txLen > rxLen, discard rxData where rxCnt > rxLen
3. In Half Duplex Modes, send TX Data, then receive RX Data
4. Deassert the specified SS

These actions will be performed in Slave Mode:

1. Fill FIFO with txData
2. Wait for SS Assert
3. If needed, pad txData with DefaultTXData
4. Unload RX FIFO as needed
5. On SS Deassert, return

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_MasterTransactionAsync()

int MXC_SPI_MasterTransactionAsync

(

mxc_spi_req_t *

req

)

Setup an interrupt-driven SPI transaction.

The TX FIFO will be filled with txData, padded with DefaultTXData if necessary Relevant interrupts will be enabled, and relevant registers set (SS, Width, etc)

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_MasterTransactionDMA()

int MXC_SPI_MasterTransactionDMA

(

mxc_spi_req_t *

req

)

Setup a DMA driven SPI transaction.

The TX FIFO will be filled with txData, padded with DefaultTXData if necessary Relevant interrupts will be enabled, and relevant registers set (SS, Width, etc)

The lowest-indexed unused DMA channel will be acquired (using the DMA API) and set up to load/unload the FIFOs with as few interrupt-based events as possible. The channel will be reset and returned to the system at the end of the transaction.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_ReadRXFIFO()

unsigned int MXC_SPI_ReadRXFIFO	(	mxc_spi_regs_t *	spi,
		unsigned char *	bytes,
		unsigned int	len
	)

Unloads bytes from the receive FIFO.

Parameters

spi	Pointer to SPI instance's registers.
bytes	The buffer to read the data into.
len	The number of bytes to read.

Returns

The number of bytes actually read.

MXC_SPI_ReadyForSleep()

int MXC_SPI_ReadyForSleep

(

mxc_spi_regs_t *

spi

)

Checks whether the SPI instance is ready for sleep.

Parameters

spi	Pointer to SPI instance's registers.

Returns

Busy/Ready, see Error Codes for a list of return codes.

MXC_SPI_SetCallback()

int MXC_SPI_SetCallback	(	mxc_spi_regs_t *	spi,
		mxc_spi_callback_t	callback,
		void *	data
	)

Sets the SPI instance's callback function.

Parameters

spi	Pointer to SPI instance's registers.
callback	Pointer to callback function called when transaction is complete.
data	Pointer for data to pass through callback funciton.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetClkMode()

int MXC_SPI_SetClkMode	(	mxc_spi_regs_t *	spi,
		mxc_spi_clkmode_t	clk_mode
	)

Sets the SPI clock mode (clock polarity and clock phase).

Parameters

spi	Pointer to SPI instance's registers.
clk_mode	SPI clock mode. See mxc_spi_clkmode_t.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetDataSize()

int MXC_SPI_SetDataSize	(	mxc_spi_regs_t *	spi,
		int	dataSize
	)

Sets the number of bits per character.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).
dataSize	The number of bits per character

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetDefaultTXData()

int MXC_SPI_SetDefaultTXData	(	mxc_spi_regs_t *	spi,
		unsigned int	defaultTXData
	)

Sets the TX data to transmit as a 'dummy' byte.

In single wire master mode, this data is transmitted on MOSI when performing an RX (MISO) only transaction. This defaults to 0.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).
defaultTXData	Data to shift out in RX-only transactions

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetFrameSize()

int MXC_SPI_SetFrameSize	(	mxc_spi_regs_t *	spi,
		int	frame_size
	)

Sets the number of bits per frame.

Parameters

spi	Pointer to SPI instance's registers.
frame_size	The number of bits per frame.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetFrequency()

int MXC_SPI_SetFrequency	(	mxc_spi_regs_t *	spi,
		unsigned int	hz
	)

Set the frequency of the SPI interface.

This function is applicable in Master mode only

Parameters

spi	Pointer to SPI instance's registers.
hz	The desired frequency in Hertz.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetInterface()

int MXC_SPI_SetInterface	(	mxc_spi_regs_t *	spi,
		mxc_spi_interface_t	if_mode
	)

Sets the SPI interface mode used for transmissions.

3-Wire, Standard (4-Wire), Quad, Dual Modes

Parameters

spi	Pointer to SPI instance's registers.
if_mode	SPI interface mode (3-Wire, Standard, Dual SPI, Quad SPI). See mxc_spi_datawidth_t

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetMode()

int MXC_SPI_SetMode	(	mxc_spi_regs_t *	spi,
		mxc_spi_mode_t	spiMode
	)

Sets the spi mode using clock polarity and clock phase.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).
spiMode	mxc_spi_mode_t

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetRXThreshold()

int MXC_SPI_SetRXThreshold	(	mxc_spi_regs_t *	spi,
		unsigned int	numBytes
	)

Set the receive threshold level.

RX FIFO Receive threshold. Smaller values will cause interrupts to occur more often, but reduce the possibility of losing data because of a FIFO overflow. Larger values will reduce the time required by the ISR, but increase the possibility of data loss. Passing an invalid value will cause the driver to use the value already set in the appropriate register.

Parameters

spi	Pointer to SPI instance's registers.
numBytes	The threshold level to set. This value must be between 0 and 30 inclusive.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetSlave()

int MXC_SPI_SetSlave	(	mxc_spi_regs_t *	spi,
		int	ssIdx
	)

Sets the slave select (SS) line used for transmissions.

This function is applicable in Master mode only

Parameters

spi	Pointer to SPI instance's registers.
ssIdx	Slave select index

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetTSControl()

int MXC_SPI_SetTSControl	(	mxc_spi_regs_t *	spi,
		mxc_spi_tscontrol_t	ts_control
	)

Configures the Pre-defined SPI Target Select pins for a specific instance.

Parameters

spi	Pointer to SPI instance's registers.
ts_control	Target Select Control Scheme (mxc_spi_tscontrol_t).

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetTXThreshold()

int MXC_SPI_SetTXThreshold	(	mxc_spi_regs_t *	spi,
		unsigned int	numBytes
	)

Set the transmit threshold level.

TX FIFO threshold. Smaller values will cause interrupts to occur more often, but reduce the possibility of terminating a transaction early in master mode, or transmitting invalid data in slave mode. Larger values will reduce the time required by the ISR, but increase the possibility errors occurring. Passing an invalid value will cause the driver to use the value already set in the appropriate register.

Parameters

spi	Pointer to SPI instance's registers.
numBytes	The threshold level to set. This value must be between 0 and 30 inclusive.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SetWidth()

int MXC_SPI_SetWidth	(	mxc_spi_regs_t *	spi,
		mxc_spi_width_t	spiWidth
	)

Sets the SPI width used for transmissions.

Parameters

spi	Pointer to SPI registers (selects the SPI block used).
spiWidth	SPI Width (3-Wire, Standard, Dual SPI, Quad SPI)

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_Shutdown()

int MXC_SPI_Shutdown

(

mxc_spi_regs_t *

spi

)

Disable and shutdown the SPI instance.

Parameters

spi	Pointer to SPI instance's registers.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_SlaveTransaction()

int MXC_SPI_SlaveTransaction

(

mxc_spi_req_t *

req

)

Performs a blocking SPI transaction.

Parameters

req	Pointer to details of the transaction

Returns

See Error Codes for the list of error return codes.

MXC_SPI_SlaveTransactionAsync()

int MXC_SPI_SlaveTransactionAsync

(

mxc_spi_req_t *

req

)

Setup an interrupt-driven SPI transaction.

Parameters

req	Pointer to details of the transactionz

Returns

See Error Codes for the list of error return codes.

MXC_SPI_SlaveTransactionDMA()

int MXC_SPI_SlaveTransactionDMA

(

mxc_spi_req_t *

req

)

Setup a DMA driven SPI transaction.

The TX FIFO will be filled with txData, padded with DefaultTXData if necessary Relevant interrupts will be enabled, and relevant registers set (SS, Width, etc)

The lowest-indexed unused DMA channel will be acquired (using the DMA API) and set up to load/unload the FIFOs with as few interrupt-based events as possible. The channel will be reset and returned to the system at the end of the transaction.

Parameters

req	Pointer to details of the transaction

Returns

See Error Codes for the list of error return codes.

MXC_SPI_StartTransmission()

int MXC_SPI_StartTransmission

(

mxc_spi_regs_t *

spi

)

Starts a SPI Transmission.

This function is applicable in Master mode only

The user must ensure that there are no ongoing transmissions before calling this function

Parameters

spi	Pointer to SPI instance's registers.

Returns

Success/Fail, see Error Codes for a list of return codes.

MXC_SPI_TargetTransaction()

int MXC_SPI_TargetTransaction

(

mxc_spi_req_t *

req

)

Setup a blocking SPI Target transaction.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_TargetTransactionAsync()

int MXC_SPI_TargetTransactionAsync

(

mxc_spi_req_t *

req

)

Setup an interrupt-driven, non-blocking SPI Target transaction.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_TargetTransactionDMA()

int MXC_SPI_TargetTransactionDMA

(

mxc_spi_req_t *

req

)

Setup a DMA-driven SPI Target transaction.

The MXC_SPI_Config(...) or MXC_SPI_DMA_Init(..). functions must be called before calling this DMA transaction function. This function does not initialize the DMA.

Parameters

req	Pointer to details of the transaction.

Returns

See Error Codes for the list of error return codes.

MXC_SPI_WriteTXFIFO()

unsigned int MXC_SPI_WriteTXFIFO	(	mxc_spi_regs_t *	spi,
		unsigned char *	bytes,
		unsigned int	len
	)

Loads bytes into the transmit FIFO.

Parameters

spi	Pointer to SPI instance's registers.
bytes	The buffer containing the bytes to write
len	The number of bytes to write.

Returns

The number of bytes actually written.