spi_17xx_40xx.h

Go to the documentation of this file.

/*
 * @brief LPC17xx/40xx SPI driver
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __SPI_17XX_40XX_H_
#define __SPI_17XX_40XX_H_

#ifdef __cplusplus
extern "C" {
#endif

#define CHIP_SPI_CLOCK_MODE_T       IP_SPI_CLOCK_MODE_T
#define CHIP_SPI_MODE_T             IP_SPI_MODE_T
#define CHIP_SPI_DATA_ORDER_T       IP_SPI_DATA_ORDER_T
#define CHIP_SPI_BITS_T             IP_SPI_BITS_T

typedef void (*CHIP_SPI_CALLBACK_T)(void);
/*
 * @brief SPI config format
 */
typedef struct CHIP_SPI_CONFIG_FORMAT_T {
 CHIP_SPI_BITS_T bits;      
 CHIP_SPI_CLOCK_MODE_T clockMode; 
 CHIP_SPI_DATA_ORDER_T dataOrder; 
} CHIP_SPI_CONFIG_FORMAT_T;

/*
 * @brief SPI data setup structure
 */
typedef struct {
 uint8_t      *pTxData;     
 uint8_t      *pRxData;     
 uint32_t  cnt;       
 uint32_t  length;      
 CHIP_SPI_CALLBACK_T    fnBefFrame;    
 CHIP_SPI_CALLBACK_T    fnAftFrame;    
 CHIP_SPI_CALLBACK_T    fnBefTransfer;   
 CHIP_SPI_CALLBACK_T    fnAftTransfer;   
} CHIP_SPI_DATA_SETUP_T;

STATIC INLINE uint32_t Chip_SPI_GetStatus(LPC_SPI_T *pSPI)
{
 return IP_SPI_GetStatus(pSPI);
}

void Chip_SPI_Int_FlushData(LPC_SPI_T *pSPI);

Status Chip_SPI_Int_RWFrames8Bits(LPC_SPI_T *pSPI, CHIP_SPI_DATA_SETUP_T *xf_setup);

Status Chip_SPI_Int_RWFrames16Bits(LPC_SPI_T *pSPI, CHIP_SPI_DATA_SETUP_T *xf_setup);

uint32_t Chip_SPI_RWFrames_Blocking(LPC_SPI_T *pSPI, CHIP_SPI_DATA_SETUP_T *pXfSetup);

uint32_t Chip_SPI_WriteFrames_Blocking(LPC_SPI_T *pSPI, uint8_t *buffer, uint32_t buffer_len);

uint32_t Chip_SPI_ReadFrames_Blocking(LPC_SPI_T *pSPI, uint8_t *buffer, uint32_t buffer_len);

void Chip_SPI_Init(LPC_SPI_T *pSPI);

void Chip_SPI_DeInit(LPC_SPI_T *pSPI);

STATIC INLINE void Chip_SPI_SetMode(LPC_SPI_T *pSPI, CHIP_SPI_MODE_T mode)
{
 IP_SPI_SetMode(pSPI, mode);
}

void Chip_SPI_SetBitRate(LPC_SPI_T *pSPI, uint32_t bitRate);

STATIC INLINE void Chip_SPI_SetFormat(LPC_SPI_T *pSPI, CHIP_SPI_CONFIG_FORMAT_T *format)
{
 IP_SPI_SetFormat(pSPI, format->bits, format->clockMode, format->dataOrder);
}

STATIC INLINE void Chip_SPI_Int_Enable(LPC_SPI_T *pSPI)
{
 IP_SPI_IntEnable(pSPI);
}

STATIC INLINE void Chip_SPI_Int_Disable(LPC_SPI_T *pSPI)
{
 IP_SPI_IntDisable(pSPI);
}

#ifdef __cplusplus
}
#endif

#endif /* __SPI_17XX_40XX_H_ */