lpc17xx_spi.h

Go to the documentation of this file.

/***********************************************************************/
/* Peripheral group ----------------------------------------------------------- */
#ifndef LPC17XX_SPI_H_
#define LPC17XX_SPI_H_

/* Includes ------------------------------------------------------------------- */
#include "LPC17xx.h"
#include "lpc_types.h"


#ifdef __cplusplus
extern "C"
{
#endif

/* Public Macros -------------------------------------------------------------- */
/*********************************************************************/
#define SPI_CPHA_FIRST          ((uint32_t)(0))
#define SPI_CPHA_SECOND         ((uint32_t)(1<<3))

#define SPI_CPOL_HI             ((uint32_t)(0))
#define SPI_CPOL_LO             ((uint32_t)(1<<4))

#define SPI_SLAVE_MODE          ((uint32_t)(0))
#define SPI_MASTER_MODE         ((uint32_t)(1<<5))

#define SPI_DATA_MSB_FIRST      ((uint32_t)(0))
#define SPI_DATA_LSB_FIRST      ((uint32_t)(1<<6))

#define SPI_DATABIT_16      SPI_SPCR_BITS(0)        
#define SPI_DATABIT_8       SPI_SPCR_BITS(0x08)     
#define SPI_DATABIT_9       SPI_SPCR_BITS(0x09)     
#define SPI_DATABIT_10      SPI_SPCR_BITS(0x0A)     
#define SPI_DATABIT_11      SPI_SPCR_BITS(0x0B)     
#define SPI_DATABIT_12      SPI_SPCR_BITS(0x0C)     
#define SPI_DATABIT_13      SPI_SPCR_BITS(0x0D)     
#define SPI_DATABIT_14      SPI_SPCR_BITS(0x0E)     
#define SPI_DATABIT_15      SPI_SPCR_BITS(0x0F)     
/*********************************************************************/
#define SPI_STAT_ABRT       SPI_SPSR_ABRT

#define SPI_STAT_MODF       SPI_SPSR_MODF

#define SPI_STAT_ROVR       SPI_SPSR_ROVR

#define SPI_STAT_WCOL       SPI_SPSR_WCOL

#define SPI_STAT_SPIF       SPI_SPSR_SPIF

/* SPI Status Implementation definitions */
#define SPI_STAT_DONE       (1UL<<8)        
#define SPI_STAT_ERROR      (1UL<<9)        
/* Private Macros ------------------------------------------------------------- */

/* --------------------- BIT DEFINITIONS -------------------------------------- */
/*********************************************************************/
#define SPI_SPCR_BIT_EN         ((uint32_t)(1<<2))

#define SPI_SPCR_CPHA_SECOND    ((uint32_t)(1<<3))

#define SPI_SPCR_CPOL_LOW       ((uint32_t)(1<<4))

#define SPI_SPCR_MSTR           ((uint32_t)(1<<5))

#define SPI_SPCR_LSBF           ((uint32_t)(1<<6))

#define SPI_SPCR_SPIE           ((uint32_t)(1<<7))

#define SPI_SPCR_BITS(n)        ((n==0) ? ((uint32_t)0) : ((uint32_t)((n&0x0F)<<8)))

#define SPI_SPCR_BITMASK        ((uint32_t)(0xFFC))

/*********************************************************************/
#define SPI_SPSR_ABRT       ((uint32_t)(1<<3))

#define SPI_SPSR_MODF       ((uint32_t)(1<<4))

#define SPI_SPSR_ROVR       ((uint32_t)(1<<5))

#define SPI_SPSR_WCOL       ((uint32_t)(1<<6))

#define SPI_SPSR_SPIF       ((uint32_t)(1<<7))

#define SPI_SPSR_BITMASK    ((uint32_t)(0xF8))

/*********************************************************************/
#define SPI_SPDR_LO_MASK    ((uint32_t)(0xFF))

#define SPI_SPDR_HI_MASK    ((uint32_t)(0xFF00))

#define SPI_SPDR_BITMASK    ((uint32_t)(0xFFFF))

/*********************************************************************/
#define SPI_SPCCR_COUNTER(n)    ((uint32_t)(n&0xFF))

#define SPI_SPCCR_BITMASK       ((uint32_t)(0xFF))

/***********************************************************************
 * Macro defines for SPI Test Control Register
 **********************************************************************/
#define SPI_SPTCR_TEST_MASK ((uint32_t)(0xFE))

#define SPI_SPTCR_BITMASK   ((uint32_t)(0xFE))

/*********************************************************************/
#define SPI_SPTSR_ABRT      ((uint32_t)(1<<3))

#define SPI_SPTSR_MODF      ((uint32_t)(1<<4))

#define SPI_SPTSR_ROVR      ((uint32_t)(1<<5))

#define SPI_SPTSR_WCOL      ((uint32_t)(1<<6))

#define SPI_SPTSR_SPIF      ((uint32_t)(1<<7))

#define SPI_SPTSR_MASKBIT   ((uint32_t)(0xF8))

/*********************************************************************/
#define SPI_SPINT_INTFLAG   ((uint32_t)(1<<0))

#define SPI_SPINT_BITMASK   ((uint32_t)(0x01))


/* ---------------- CHECK PARAMETER DEFINITIONS ---------------------------- */
#define PARAM_SPIx(n)   (((uint32_t *)n)==((uint32_t *)LPC_SPI))

#define PARAM_SPI_CPHA(n)   ((n==SPI_CPHA_FIRST) || (n==SPI_CPHA_SECOND))

#define PARAM_SPI_CPOL(n)   ((n==SPI_CPOL_HI) || (n==SPI_CPOL_LO))

#define PARAM_SPI_MODE(n)   ((n==SPI_SLAVE_MODE) || (n==SPI_MASTER_MODE))

#define PARAM_SPI_DATA_ORDER(n) ((n==SPI_DATA_MSB_FIRST) || (n==SPI_DATA_LSB_FIRST))

#define PARAM_SPI_DATABIT(n)    ((n==SPI_DATABIT_16) || (n==SPI_DATABIT_8) \
|| (n==SPI_DATABIT_9) || (n==SPI_DATABIT_10) \
|| (n==SPI_DATABIT_11) || (n==SPI_DATABIT_12) \
|| (n==SPI_DATABIT_13) || (n==SPI_DATABIT_14) \
|| (n==SPI_DATABIT_15))

#define PARAM_SPI_STAT(n)   ((n==SPI_STAT_ABRT) || (n==SPI_STAT_MODF) \
|| (n==SPI_STAT_ROVR) || (n==SPI_STAT_WCOL) \
|| (n==SPI_STAT_SPIF))

/* Public Types --------------------------------------------------------------- */
typedef struct {
    uint32_t Databit;       
    uint32_t CPHA;          
    uint32_t CPOL;          
    uint32_t Mode;          
    uint32_t DataOrder;     
    uint32_t ClockRate;     
} SPI_CFG_Type;


typedef enum {
    SPI_TRANSFER_POLLING = 0,   
    SPI_TRANSFER_INTERRUPT      
} SPI_TRANSFER_Type;

typedef struct {
    void *tx_data;              
    void *rx_data;              
    uint32_t length;            
    uint32_t counter;           
    uint32_t status;            
} SPI_DATA_SETUP_Type;

/* Public Functions ----------------------------------------------------------- */
/* SPI Init/DeInit functions ---------*/
void SPI_Init(LPC_SPI_TypeDef *SPIx, SPI_CFG_Type *SPI_ConfigStruct);
void SPI_DeInit(LPC_SPI_TypeDef *SPIx);
void SPI_SetClock (LPC_SPI_TypeDef *SPIx, uint32_t target_clock);
void SPI_ConfigStructInit(SPI_CFG_Type *SPI_InitStruct);

/* SPI transfer functions ------------*/
void SPI_SendData(LPC_SPI_TypeDef *SPIx, uint16_t Data);
uint16_t SPI_ReceiveData(LPC_SPI_TypeDef *SPIx);
int32_t SPI_ReadWrite (LPC_SPI_TypeDef *SPIx, SPI_DATA_SETUP_Type *dataCfg, SPI_TRANSFER_Type xfType);

/* SPI Interrupt functions ---------*/
void SPI_IntCmd(LPC_SPI_TypeDef *SPIx, FunctionalState NewState);
IntStatus SPI_GetIntStatus (LPC_SPI_TypeDef *SPIx);
void SPI_ClearIntPending(LPC_SPI_TypeDef *SPIx);

/* SPI get information functions-----*/
uint8_t SPI_GetDataSize (LPC_SPI_TypeDef *SPIx);
uint32_t SPI_GetStatus(LPC_SPI_TypeDef *SPIx);
FlagStatus SPI_CheckStatus (uint32_t inputSPIStatus,  uint8_t SPIStatus);

#ifdef __cplusplus
}
#endif

#endif /* LPC17XX_SPI_H_ */

/* --------------------------------- End Of File ------------------------------ */