SPIMSS

Modules
	SPIMSS_Registers

Data Structures
struct	mxc_i2s_config_t
struct	mxc_spimss_req_t

Typedefs
typedef void(*	mxc_spimss_callback_fn) (mxc_spimss_req_t *req, int error_code)

Enumerations
enum	mxc_i2s_direction_t
enum	mxc_spimss_width_t

Functions
int	MXC_I2S_Init (const mxc_i2s_config_t *cfg, void(*dma_ctz_cb)(int, int))
int	MXC_I2S_Shutdown (void)
int	MXC_I2S_Mute (void)
int	MXC_I2S_Unmute (void)
int	MXC_I2S_Pause (void)
int	MXC_I2S_Unpause (void)
int	MXC_I2S_Stop (void)
int	MXC_I2S_Start (void)
int	MXC_I2S_DMA_ClearFlags (void)
int	MXC_I2S_DMA_SetAddrCnt (void *src_addr, void *dst_addr, unsigned int count)
int	MXC_I2S_DMA_SetReload (void *src_addr, void *dst_addr, unsigned int count)
int	MXC_SPIMSS_Init (mxc_spimss_regs_t *spi, unsigned mode, unsigned freq)
int	MXC_SPIMSS_Shutdown (mxc_spimss_regs_t *spi)
int	MXC_SPIMSS_MasterTrans (mxc_spimss_regs_t *spi, mxc_spimss_req_t *req)
void	MXC_SPIMSS_Handler (mxc_spimss_regs_t *spi)
int	MXC_SPIMSS_SlaveTrans (mxc_spimss_regs_t *spi, mxc_spimss_req_t *req)
int	MXC_SPIMSS_MasterTransAsync (mxc_spimss_regs_t *spi, mxc_spimss_req_t *req)
int	MXC_SPIMSS_SlaveTransAsync (mxc_spimss_regs_t *spi, mxc_spimss_req_t *req)
int	MXC_SPIMSS_AbortAsync (mxc_spimss_req_t *req)
int	MXC_SPIMSS_MasterTransDMA (mxc_spimss_regs_t *spi, mxc_spimss_req_t *req)
int	MXC_SPIMSS_SetAutoDMAHandlers (mxc_spimss_regs_t *spi, bool enable)
int	MXC_SPIMSS_SetTXDMAChannel (mxc_spimss_regs_t *spi, unsigned int channel)
int	MXC_SPIMSS_GetTXDMAChannel (mxc_spimss_regs_t *spi)
int	MXC_SPIMSS_SetRXDMAChannel (mxc_spimss_regs_t *spi, unsigned int channel)
int	MXC_SPIMSS_GetRXDMAChannel (mxc_spimss_regs_t *spi)

Detailed Description

---

Data Structure Documentation

mxc_i2s_config_t

struct mxc_i2s_config_t

I2S Configuration Struct.

mxc_spimss_req

struct mxc_spimss_req

Structure definition for an SPI Master Transaction request.

Structure type representing a SPI Master Transaction request.

Note

When using this structure for an asynchronous operation, the structure must remain allocated until the callback is completed.

Data Fields
uint8_t	ssel
uint8_t	deass
void *	tx_data
void *	rx_data
mxc_spimss_width_t	width
unsigned	len
unsigned	bits
unsigned	rx_num
unsigned	tx_num
mxc_spimss_callback_fn	callback

Field Documentation

bits

unsigned bits

Number of bits in transfer unit (e.g. 8 for byte, 16 for short)

callback

mxc_spimss_callback_fn callback

Callback function if desired, NULL otherwise

deass

uint8_t deass

Not Used

len

unsigned len

Number of transfer units to send from the tx_data buffer.

rx_data

void* rx_data

Pointer to a buffer to store data received. NULL if undesired.

rx_num

unsigned rx_num

Number of bytes actually read into the rx_data buffer.

ssel

uint8_t ssel

Not Used

tx_data

void* tx_data

Pointer to a buffer to transmit data from. NULL if undesired.

tx_num

unsigned tx_num

Number of bytes actually sent from the tx_data buffer

width

mxc_spimss_width_t width

Not Used

Typedef Documentation

mxc_spimss_callback_fn

typedef void(* mxc_spimss_callback_fn) (mxc_spimss_req_t *req, int error_code)

Callback function type used in asynchronous SPI Master communication requests.

The function declaration for the SPI Master callback is:

void callback(spi_req_t * req, int error_code);

req	Pointer to a #spi_req object representing the active SPI Master active transaction.
error_code	An error code if the active transaction had a failure or E_NO_ERROR if successful.

Note

Callback will execute in interrupt context

Enumeration Type Documentation

mxc_spimss_width_t

enum mxc_spimss_width_t

Enumeration type for setting the number data lines to use for communication.

Enumerator
DUMMY_1	NOT USED
DUMMY_2	NOT USED
DUMMY_3	NOT USED

Function Documentation

MXC_I2S_DMA_ClearFlags()

int MXC_I2S_DMA_ClearFlags

(

void

)

Clears DMA Interrupt Flags.

Clears the DMA Interrupt flags, should be called at the end of a dma_ctz_cb

Returns

E_NO_ERROR

MXC_I2S_DMA_SetAddrCnt()

int MXC_I2S_DMA_SetAddrCnt	(	void *	src_addr,
		void *	dst_addr,
		unsigned int	count
	)

Set DMA Addr (Source or Dest) and bytes to transfer.

Parameters

src_addr	The address to read data from (Audio Out)
dst_addr	The address to write data to (Audio In)
count	The length of the transfer in bytes

Sets the address to read/write data in memory and the length of the transfer. The unused addr parameter is ignored.

Returns

E_NO_ERROR

MXC_I2S_DMA_SetReload()

int MXC_I2S_DMA_SetReload	(	void *	src_addr,
		void *	dst_addr,
		unsigned int	count
	)

Sets the DMA reload address and count.

Parameters

src_addr	The address to read data from (Audio Out)
dst_addr	The address to write data to (Audio In)
count	The length of the transfer in bytes

If DMA reload is enabled, when the DMA has transfered $count bytes (a CTZ event occurs) the src, dst, and count registers will be set to these. The DMA reload flag clears after a reload occurs.

Returns

E_NO_ERROR

MXC_I2S_Init()

int MXC_I2S_Init	(	const mxc_i2s_config_t *	cfg,
		void(*)(int, int)	dma_ctz_cb
	)

Initialize I2S resources.

Parameters

cfg	I2S Configuration Struct
dma_ctz_cb	Optional function to be called when the DMA completes a transfer. Set to NULL if unused.

This initialization is required before using the I2S driver functions.

Returns

E_NO_ERROR if successful

MXC_I2S_Mute()

int MXC_I2S_Mute

(

void

)

Mute I2S Output.

Sets I2S data to zero, continues sending clock and accessing DMA

Returns

E_NO_ERROR

MXC_I2S_Pause()

int MXC_I2S_Pause

(

void

)

Pause I2S Output.

Similar to mute, but stops FIFO and DMA access, clocks continue

Returns

E_NO_ERROR

MXC_I2S_Shutdown()

int MXC_I2S_Shutdown

(

void

)

Release I2S.

Deconfigures the I2S protocol and stops DMA request

Returns

E_BAD_PARAM if DMA cannot be stopped, E_NO_ERROR otherwise

MXC_I2S_Start()

int MXC_I2S_Start

(

void

)

Starts I2S Output.

Starts I2S Output, automatically called by configure if requested

Returns

E_NO_ERROR

MXC_I2S_Stop()

int MXC_I2S_Stop

(

void

)

Stops I2S Output.

Similar to pause, but also halts clock

Returns

E_NO_ERROR

MXC_I2S_Unmute()

int MXC_I2S_Unmute

(

void

)

Unmute I2S Output.

Restores I2S data

Returns

E_NO_ERROR

MXC_I2S_Unpause()

int MXC_I2S_Unpause

(

void

)

Unpause I2S Output.

Similar to mute, but restarts FIFO and DMA access

Returns

E_NO_ERROR

MXC_SPIMSS_AbortAsync()

int MXC_SPIMSS_AbortAsync

(

mxc_spimss_req_t *

req

)

Aborts an Asynchronous request.

Parameters

req	Pointer to spi request

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_GetRXDMAChannel()

int MXC_SPIMSS_GetRXDMAChannel

(

mxc_spimss_regs_t *

spi

)

Returns the current RX channel id set for SPIMSS DMA transaction.

Parameters

spi	Pointer to spi module

Returns

#RXDMA_ChannelId of the spi module.

MXC_SPIMSS_GetTXDMAChannel()

int MXC_SPIMSS_GetTXDMAChannel

(

mxc_spimss_regs_t *

spi

)

Returns the current TX channel id set for SPIMSS DMA transaction.

Parameters

spi	Pointer to spi module

Returns

#TXDMA_ChannelId of the spi module.

MXC_SPIMSS_Handler()

void MXC_SPIMSS_Handler

(

mxc_spimss_regs_t *

spi

)

Execute SPI transaction based on interrupt handler.

Parameters

spi

The spi

MXC_SPIMSS_Init()

int MXC_SPIMSS_Init	(	mxc_spimss_regs_t *	spi,
		unsigned	mode,
		unsigned	freq
	)

Initialize the spi.

Parameters

spi	Pointer to spi module to initialize.
mode	SPI mode for clock phase and polarity.
freq	Desired clock frequency.
sys_cfg	System configuration object

Returns

E_NO_ERROR if successful, appropriate error otherwise

MXC_SPIMSS_MasterTrans()

int MXC_SPIMSS_MasterTrans	(	mxc_spimss_regs_t *	spi,
		mxc_spimss_req_t *	req
	)

Execute a master transaction.

Parameters

spi	Pointer to spi module.
req	Pointer to spi request

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_MasterTransAsync()

int MXC_SPIMSS_MasterTransAsync	(	mxc_spimss_regs_t *	spi,
		mxc_spimss_req_t *	req
	)

Asynchronously read/write SPI Master data.

Parameters

spi	Pointer to spi module
req	Pointer to spi request

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_MasterTransDMA()

int MXC_SPIMSS_MasterTransDMA	(	mxc_spimss_regs_t *	spi,
		mxc_spimss_req_t *	req
	)

Execute a master transaction over DMA.

Parameters

spi	Pointer to spi module.
req	Pointer to spi request.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_SetAutoDMAHandlers()

int MXC_SPIMSS_SetAutoDMAHandlers	(	mxc_spimss_regs_t *	spi,
		bool	enable
	)

Enable Disable auto dma handling. If set to true, dma channel for transaction is acquired in the MXC_SPIMSS_MasterTransDMA function. Otherwise, user has to set tx and rx channel for SPIMSS DMA transaction with MXC_SPIMSS_SetTXDMAChannel and MXC_SPIMSS_SetRXDMAChannel functions.

Parameters

spi	Pointer to spi module
enable	Enable Disable auto handler

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_SetRXDMAChannel()

int MXC_SPIMSS_SetRXDMAChannel	(	mxc_spimss_regs_t *	spi,
		unsigned int	channel
	)

Set the RX channel id for DMA to be used in SPIMSS DMA transaction.

Parameters

spi	Pointer to spi module
channel	Id of the channel for RXDma Channel.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_SetTXDMAChannel()

int MXC_SPIMSS_SetTXDMAChannel	(	mxc_spimss_regs_t *	spi,
		unsigned int	channel
	)

Set the TX channel id for DMA to be used in SPIMSS DMA transaction.

Parameters

spi	Pointer to spi module
channel	Id of the channel for TXDma Channel.

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_Shutdown()

int MXC_SPIMSS_Shutdown

(

mxc_spimss_regs_t *

spi

)

Shutdown SPI module.

Parameters

spi	Pointer to SPI regs.

Returns

E_NO_ERROR if successful, appropriate error otherwise

MXC_SPIMSS_SlaveTrans()

int MXC_SPIMSS_SlaveTrans	(	mxc_spimss_regs_t *	spi,
		mxc_spimss_req_t *	req
	)

Execute a slave transaction.

Parameters

spi	Pointer to spi module.
req	Pointer to spi request

Returns

E_NO_ERROR if successful, error if unsuccessful.

MXC_SPIMSS_SlaveTransAsync()

int MXC_SPIMSS_SlaveTransAsync	(	mxc_spimss_regs_t *	spi,
		mxc_spimss_req_t *	req
	)

Asynchronously read/write SPI Slave data.

Parameters

spi	Pointer to spi module
req	Pointer to spi request

Returns

E_NO_ERROR if successful, error if unsuccessful.