MAX32665 SDK Documentation  0.2
Software Development Kit Overview and API Documentation
SPI

Modules

 SPI17Y
 

Data Structures

union  spi_regs_t
 Union consolidating SPI registers. More...
 
struct  spi_req_t
 Structure type representing a SPI Master Transaction request. More...
 

Macros

#define MXC_SPI0   MXC_SPI17Y0
 
#define MXC_SPI1   MXC_SPI17Y1
 
#define MXC_SPI2   MXC_SPI17Y2
 
#define SPI0_IRQn   SPI17Y0_IRQn
 Renaming Interrupt SPI Interrupt sources.
 
#define SPI1_IRQn   SPI17Y1_IRQn
 
#define SPI2_IRQn   SPI17Y2_IRQn
 
#define SPI_WIDTH_1   SPI17Y_WIDTH_1
 Renaming SPI Width. More...
 
#define SPI_WIDTH_2   SPI17Y_WIDTH_2
 2 Data Lines (x2). More...
 
#define SPI_WIDTH_4   SPI17Y_WIDTH_4
 4 Data Lines (x4). More...
 
#define SPI_POL_LOW   SPI17Y_POL_LOW
 Renaming SPI Polarity. More...
 
#define SPI_POL_HIGH   SPI17Y_POL_HIGH
 Slave Select polarity High. More...
 

Typedefs

typedef sys_cfg_spi17y_t sys_cfg_spi_t
 
typedef void(* spi_callback_fn) (void *req, int error_code)
 

Enumerations

enum  spi_type {
  SPI0,
  SPI1,
  SPI2
}
 Assigning SPI0 instances.
 

Functions

int SPI_Init (spi_type spi_name, unsigned int mode, unsigned int freq, sys_cfg_spi_t spi17y_cfg)
 Initialize the spi. More...
 
int SPI_MasterTransAsync (spi_type spi_name, spi_req_t *req)
 Asynchronously read/write SPI Master data. More...
 
int SPI_MasterTrans (spi_type spi_name, spi_req_t *req)
 Execute a master transaction. More...
 
int SPI_SlaveTransAsync (spi_type spi_name, spi_req_t *req)
 Asynchronously read/write SPI Slave data. More...
 
int SPI_SlaveTrans (spi_type spi_name, spi_req_t *req)
 Execute a slave transaction. More...
 
int SPI_Shutdown (spi_type spi_name)
 Shutdown SPI module. More...
 
int SPI_AbortAsync (spi_type spi_name, spi_req_t *req)
 Aborts an Asynchronous request. More...
 
int SPI_Handler (spi_type spi_name)
 Execute SPI transaction based on interrupt handler. More...
 
int SPI_Enable (spi_type spi_name)
 Enable SPI. More...
 
int SPI_Disable (spi_type spi_name)
 Disable SPI. More...
 
int SPI_Clear_fifo (spi_type spi_name)
 Clear the TX and RX FIFO. More...
 

Detailed Description

Macro Definition Documentation

◆ SPI_WIDTH_1

#define SPI_WIDTH_1   SPI17Y_WIDTH_1

1 Data Line.

◆ SPI_WIDTH_2

#define SPI_WIDTH_2   SPI17Y_WIDTH_2

◆ SPI_WIDTH_4

#define SPI_WIDTH_4   SPI17Y_WIDTH_4

◆ SPI_POL_LOW

#define SPI_POL_LOW   SPI17Y_POL_LOW

Slave Select polarity Low.

◆ SPI_POL_HIGH

#define SPI_POL_HIGH   SPI17Y_POL_HIGH

Function Documentation

◆ SPI_Init()

int SPI_Init ( spi_type  spi_name,
unsigned int  mode,
unsigned int  freq,
sys_cfg_spi_t  spi17y_cfg 
)
Parameters
spi_nameSPI instance being used
modeSPI mode for clock phase and polarity.
freqDesired clock frequency.
spi17y_cfgThe spi configuration
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_MasterTransAsync()

int SPI_MasterTransAsync ( spi_type  spi_name,
spi_req_t *  req 
)
Parameters
spi_nameSPI instance being used
reqPointer to spi request
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_MasterTrans()

int SPI_MasterTrans ( spi_type  spi_name,
spi_req_t *  req 
)
Parameters
spi_nameSPI instance being used
reqPointer to spi request
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_SlaveTransAsync()

int SPI_SlaveTransAsync ( spi_type  spi_name,
spi_req_t *  req 
)
Parameters
spi_nameSPI instance being used
reqPointer to spi request
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_SlaveTrans()

int SPI_SlaveTrans ( spi_type  spi_name,
spi_req_t *  req 
)
Parameters
spi_nameSPI instance being used
reqPointer to spi request
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_Shutdown()

int SPI_Shutdown ( spi_type  spi_name)
Parameters
spi_nameSPI instance being used
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_AbortAsync()

int SPI_AbortAsync ( spi_type  spi_name,
spi_req_t *  req 
)
Parameters
spi_nameSPI instance being used
reqPointer to spi request
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_Handler()

int SPI_Handler ( spi_type  spi_name)
Parameters
spi_nameSPI instance being used
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_Enable()

int SPI_Enable ( spi_type  spi_name)
Parameters
spi_namePointer to spi module.
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_Disable()

int SPI_Disable ( spi_type  spi_name)
Parameters
spi_namePointer to spi module.
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.

◆ SPI_Clear_fifo()

int SPI_Clear_fifo ( spi_type  spi_name)
Parameters
spi_namePointer to spi module.
Returns
E_NO_ERROR If everything is successful.
Error Codes If function is unsuccessful.