lpc17xx_i2s.h

Go to the documentation of this file.

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

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


#ifdef __cplusplus
extern "C"
{
#endif

/* Public Macros -------------------------------------------------------------- */
/*********************************************************************/
#define I2S_WORDWIDTH_8     ((uint32_t)(0))
#define I2S_WORDWIDTH_16    ((uint32_t)(1))
#define I2S_WORDWIDTH_32    ((uint32_t)(3))

#define I2S_STEREO          ((uint32_t)(0))
#define I2S_MONO            ((uint32_t)(1))

#define I2S_MASTER_MODE     ((uint8_t)(0))
#define I2S_SLAVE_MODE      ((uint8_t)(1))

#define I2S_STOP_ENABLE     ((uint8_t)(1))
#define I2S_STOP_DISABLE    ((uint8_t)(0))

#define I2S_RESET_ENABLE    ((uint8_t)(1))
#define I2S_RESET_DISABLE   ((uint8_t)(0))

#define I2S_MUTE_ENABLE     ((uint8_t)(1))
#define I2S_MUTE_DISABLE    ((uint8_t)(0))

#define I2S_TX_MODE         ((uint8_t)(0))
#define I2S_RX_MODE         ((uint8_t)(1))

#define I2S_CLKSEL_FRDCLK   ((uint8_t)(0))
#define I2S_CLKSEL_MCLK     ((uint8_t)(2))

#define I2S_4PIN_ENABLE     ((uint8_t)(1))
#define I2S_4PIN_DISABLE    ((uint8_t)(0))

#define I2S_MCLK_ENABLE     ((uint8_t)(1))
#define I2S_MCLK_DISABLE    ((uint8_t)(0))

#define I2S_DMA_1           ((uint8_t)(0))
#define I2S_DMA_2           ((uint8_t)(1))

/* Private Macros ------------------------------------------------------------- */
/*********************************************************************/
#define I2S_DAO_WORDWIDTH_8     ((uint32_t)(0))     
#define I2S_DAO_WORDWIDTH_16    ((uint32_t)(1))     
#define I2S_DAO_WORDWIDTH_32    ((uint32_t)(3))     
#define I2S_DAO_MONO            ((uint32_t)(1<<2))

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

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

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

#define I2S_DAO_WS_HALFPERIOD(n)    ((uint32_t)(n<<6))

#define I2S_DAO_MUTE            ((uint32_t)(1<<15))

/*********************************************************************/
#define I2S_DAI_WORDWIDTH_8     ((uint32_t)(0))     
#define I2S_DAI_WORDWIDTH_16    ((uint32_t)(1))     
#define I2S_DAI_WORDWIDTH_32    ((uint32_t)(3))     
#define I2S_DAI_MONO            ((uint32_t)(1<<2))

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

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

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

#define I2S_DAI_WS_HALFPERIOD(n)    ((uint32_t)((n&0x1FF)<<6))

#define I2S_DAI_MUTE            ((uint32_t)(1<<15))

/*********************************************************************/
#define I2S_STATE_IRQ       ((uint32_t)(1))

#define I2S_STATE_DMA1      ((uint32_t)(1<<1))

#define I2S_STATE_DMA2      ((uint32_t)(1<<2))

#define I2S_STATE_RX_LEVEL(n)   ((uint32_t)((n&1F)<<8))

#define I2S_STATE_TX_LEVEL(n)   ((uint32_t)((n&1F)<<16))

/*********************************************************************/
#define I2S_DMA1_RX_ENABLE      ((uint32_t)(1))

#define I2S_DMA1_TX_ENABLE      ((uint32_t)(1<<1))

#define I2S_DMA1_RX_DEPTH(n)    ((uint32_t)((n&0x1F)<<8))

#define I2S_DMA1_TX_DEPTH(n)    ((uint32_t)((n&0x1F)<<16))

/*********************************************************************/
#define I2S_DMA2_RX_ENABLE      ((uint32_t)(1))

#define I2S_DMA2_TX_ENABLE      ((uint32_t)(1<<1))

#define I2S_DMA2_RX_DEPTH(n)    ((uint32_t)((n&0x1F)<<8))

#define I2S_DMA2_TX_DEPTH(n)    ((uint32_t)((n&0x1F)<<16))

/*********************************************************************/
#define I2S_IRQ_RX_ENABLE       ((uint32_t)(1))

#define I2S_IRQ_TX_ENABLE       ((uint32_t)(1<<1))

#define I2S_IRQ_RX_DEPTH(n)     ((uint32_t)((n&0x1F)<<8))

#define I2S_IRQ_TX_DEPTH(n)     ((uint32_t)((n&0x1F)<<16))

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

#define I2S_TXRATE_X_DIVIDER(n) ((uint32_t)((n&0xFF)<<8))

#define I2S_RXRATE_Y_DIVIDER(n) ((uint32_t)(n&0xFF))

#define I2S_RXRATE_X_DIVIDER(n) ((uint32_t)((n&0xFF)<<8))

/*************************************************************************************/
#define I2S_TXBITRATE(n)    ((uint32_t)(n&0x3F))
#define I2S_RXBITRATE(n)    ((uint32_t)(n&0x3F))

/**********************************************************************************/
#define I2S_TXMODE_CLKSEL(n)    ((uint32_t)(n&0x03))

#define I2S_TXMODE_4PIN_ENABLE  ((uint32_t)(1<<2))

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

#define I2S_RXMODE_CLKSEL(n)    ((uint32_t)(n&0x03))

#define I2S_RXMODE_4PIN_ENABLE  ((uint32_t)(1<<2))

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


/* ---------------- CHECK PARAMETER DEFINITIONS ---------------------------- */
#define PARAM_I2Sx(n)   (((uint32_t *)n)==((uint32_t *)LPC_I2S))

#define PRAM_I2S_FREQ(freq)     ((freq>=16000)&&(freq <= 96000))
/* Macro check I2S word width type */
#define PARAM_I2S_WORDWIDTH(n)  ((n==I2S_WORDWIDTH_8)||(n==I2S_WORDWIDTH_16)\
||(n==I2S_WORDWIDTH_32))
/* Macro check I2S channel type */
#define PARAM_I2S_CHANNEL(n)    ((n==I2S_STEREO)||(n==I2S_MONO))
/* Macro check I2S master/slave mode */
#define PARAM_I2S_WS_SEL(n)     ((n==I2S_MASTER_MODE)||(n==I2S_SLAVE_MODE))
/* Macro check I2S stop mode */
#define PARAM_I2S_STOP(n)   ((n==I2S_STOP_ENABLE)||(n==I2S_STOP_DISABLE))
/* Macro check I2S reset mode */
#define PARAM_I2S_RESET(n)  ((n==I2S_RESET_ENABLE)||(n==I2S_RESET_DISABLE))
/* Macro check I2S reset mode */
#define PARAM_I2S_MUTE(n)   ((n==I2S_MUTE_ENABLE)||(n==I2S_MUTE_DISABLE))
/* Macro check I2S transmit/receive mode */
#define PARAM_I2S_TRX(n)        ((n==I2S_TX_MODE)||(n==I2S_RX_MODE))
/* Macro check I2S clock select mode */
#define PARAM_I2S_CLKSEL(n)     ((n==I2S_CLKSEL_FRDCLK)||(n==I2S_CLKSEL_MCLK))
/* Macro check I2S 4-pin mode */
#define PARAM_I2S_4PIN(n)   ((n==I2S_4PIN_ENABLE)||(n==I2S_4PIN_DISABLE))
/* Macro check I2S MCLK mode */
#define PARAM_I2S_MCLK(n)   ((n==I2S_MCLK_ENABLE)||(n==I2S_MCLK_DISABLE))
/* Macro check I2S DMA mode */
#define PARAM_I2S_DMA(n)        ((n==I2S_DMA_1)||(n==I2S_DMA_2))
/* Macro check I2S DMA depth value */
#define PARAM_I2S_DMA_DEPTH(n)  ((n>=0)||(n<=31))
/* Macro check I2S irq level value */
#define PARAM_I2S_IRQ_LEVEL(n)  ((n>=0)||(n<=31))
/* Macro check I2S half-period value */
#define PARAM_I2S_HALFPERIOD(n) ((n>0)&&(n<512))
/* Macro check I2S bit-rate value */
#define PARAM_I2S_BITRATE(n)    ((n>=0)&&(n<=63))

/* Public Types --------------------------------------------------------------- */
typedef struct {
    uint8_t wordwidth;      
    uint8_t mono;           
    uint8_t stop;           
    uint8_t reset;          
    uint8_t ws_sel;         
    uint8_t mute;           
    uint8_t Reserved0[2];
} I2S_CFG_Type;

typedef struct {
    uint8_t DMAIndex;       
    uint8_t depth;          
    uint8_t Reserved0[2];
}I2S_DMAConf_Type;

typedef struct{
    uint8_t clksel;         
    uint8_t fpin;           
    uint8_t mcena;          
    uint8_t Reserved;
}I2S_MODEConf_Type;


/* Public Functions ----------------------------------------------------------- */
/* I2S Init/DeInit functions ---------*/
void I2S_Init(LPC_I2S_TypeDef *I2Sx);
void I2S_DeInit(LPC_I2S_TypeDef *I2Sx);

/* I2S configuration functions --------*/
void I2S_Config(LPC_I2S_TypeDef *I2Sx, uint8_t TRMode, I2S_CFG_Type* ConfigStruct);
Status I2S_FreqConfig(LPC_I2S_TypeDef *I2Sx, uint32_t Freq, uint8_t TRMode);
void I2S_SetBitRate(LPC_I2S_TypeDef *I2Sx, uint8_t bitrate, uint8_t TRMode);
void I2S_ModeConfig(LPC_I2S_TypeDef *I2Sx, I2S_MODEConf_Type* ModeConfig, uint8_t TRMode);
uint8_t I2S_GetLevel(LPC_I2S_TypeDef *I2Sx, uint8_t TRMode);

/* I2S operate functions -------------*/
void I2S_Send(LPC_I2S_TypeDef *I2Sx, uint32_t BufferData);
uint32_t I2S_Receive(LPC_I2S_TypeDef* I2Sx);
void I2S_Start(LPC_I2S_TypeDef *I2Sx);
void I2S_Pause(LPC_I2S_TypeDef *I2Sx, uint8_t TRMode);
void I2S_Mute(LPC_I2S_TypeDef *I2Sx, uint8_t TRMode);
void I2S_Stop(LPC_I2S_TypeDef *I2Sx, uint8_t TRMode);

/* I2S DMA functions ----------------*/
void I2S_DMAConfig(LPC_I2S_TypeDef *I2Sx, I2S_DMAConf_Type* DMAConfig, uint8_t TRMode);
void I2S_DMACmd(LPC_I2S_TypeDef *I2Sx, uint8_t DMAIndex,uint8_t TRMode, FunctionalState NewState);

/* I2S IRQ functions ----------------*/
void I2S_IRQCmd(LPC_I2S_TypeDef *I2Sx,uint8_t TRMode, FunctionalState NewState);
void I2S_IRQConfig(LPC_I2S_TypeDef *I2Sx, uint8_t TRMode, uint8_t level);
FunctionalState I2S_GetIRQStatus(LPC_I2S_TypeDef *I2Sx,uint8_t TRMode);
uint8_t I2S_GetIRQDepth(LPC_I2S_TypeDef *I2Sx,uint8_t TRMode);

#ifdef __cplusplus
}
#endif


#endif /* LPC17XX_SSP_H_ */

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