i2s_001.h

Go to the documentation of this file.

/*
 * @brief I2S Registers and control functions
 *
 * @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 __I2S_001_H_
#define __I2S_001_H_

#include "sys_config.h"
#include "cmsis.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {    
 __IO uint32_t DAO;   
 __IO uint32_t DAI;   
 __O uint32_t TXFIFO;  
 __I uint32_t RXFIFO;  
 __I uint32_t STATE;   
 __IO uint32_t DMA1;   
 __IO uint32_t DMA2;   
 __IO uint32_t IRQ;   
 __IO uint32_t TXRATE;  
 __IO uint32_t RXRATE;  
 __IO uint32_t TXBITRATE; 
 __IO uint32_t RXBITRATE; 
 __IO uint32_t TXMODE;  
 __IO uint32_t RXMODE;  
} IP_I2S_001_T;

#define I2S_WORDWIDTH_8     (0UL << 0) 
#define I2S_WORDWIDTH_16    (1UL << 0) 
#define I2S_WORDWIDTH_32    (3UL << 0) 
#define I2S_STEREO          (0UL << 2) 
#define I2S_MONO            (1UL << 2) 
#define I2S_MASTER_MODE     (0UL << 5) 
#define I2S_SLAVE_MODE      (1UL << 5) 
#define I2S_STOP_ENABLE     (0UL << 3) 
#define I2S_STOP_DISABLE    (1UL << 3) 
#define I2S_RESET_ENABLE    (1UL << 4) 
#define I2S_RESET_DISABLE   (0UL << 4) 
#define I2S_MUTE_ENABLE     (1UL << 15) 
#define I2S_MUTE_DISABLE    (0UL << 15) 
#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_WORDWIDTH_MASK  ((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 & 0x1FF) << 6)) 
#define I2S_DAO_WS_HALFPERIOD_MASK  ((uint32_t) ((0x1FF) << 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_WORDWIDTH_MASK  ((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_WS_HALFPERIOD_MASK  ((uint32_t) ((0x1FF) << 6))  
#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 & 0x0F) << 8)) 
#define I2S_IRQ_RX_DEPTH_MASK   ((uint32_t) ((0x0F) << 8))
#define I2S_IRQ_TX_DEPTH(n)     ((uint32_t) ((n & 0x0F) << 16)) 
#define I2S_IRQ_TX_DEPTH_MASK   ((uint32_t) ((0x0F) << 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)) 
typedef enum IP_I2S_TRxMode {
 I2S_TX_MODE, 
 I2S_RX_MODE, 
} IP_I2S_TRxMode_T;

typedef enum IP_I2S_DMARequestNumber {
 IP_I2S_DMA_REQUEST_NUMBER_1, 
 IP_I2S_DMA_REQUEST_NUMBER_2, 
} IP_I2S_DMARequestNumber_T;

/**********************************************************************************
 * I2S Init/DeInit functions
 *********************************************************************************/

void IP_I2S_Init(IP_I2S_001_T *pI2S);

void IP_I2S_DeInit(IP_I2S_001_T *pI2S);

/**********************************************************************************
 * I2S configuration functions
 *********************************************************************************/

void IP_I2S_SetWordWidth(IP_I2S_001_T *pI2S, uint8_t TRMode, uint32_t wordwidth);

void IP_I2S_SetMono(IP_I2S_001_T *pI2S, uint8_t TRMode, uint32_t mono);

void IP_I2S_SetMasterSlaveMode(IP_I2S_001_T *pI2S, uint8_t TRMode, uint32_t mode);

void IP_I2S_SetBitRate(IP_I2S_001_T *pI2S, uint8_t TRMode, uint32_t mclk_divider);

void IP_I2S_SetXYDivider(IP_I2S_001_T *pI2S, uint8_t TRMode, uint8_t x_divider, uint8_t y_devider);

void IP_I2S_SetWS_Halfperiod(IP_I2S_001_T *pI2S, uint8_t TRMode, uint32_t ws_halfperiod);

void IP_I2S_ModeConfig(IP_I2S_001_T *pI2S, uint8_t TRMode, uint32_t clksel, uint32_t fpin, uint32_t mcena);

uint8_t IP_I2S_GetLevel(IP_I2S_001_T *pI2S, uint8_t TRMode);

/**********************************************************************************
 * I2S operate functions
 *********************************************************************************/

void IP_I2S_Send(IP_I2S_001_T *pI2S, uint32_t data);

uint32_t IP_I2S_Receive(IP_I2S_001_T *pI2S);

void IP_I2S_Start(IP_I2S_001_T *pI2S, uint8_t TRMode);

void IP_I2S_Pause(IP_I2S_001_T *pI2S, uint8_t TRMode);

STATIC INLINE void IP_I2S_EnableMute(IP_I2S_001_T *pI2S)
{
 pI2S->DAO |= I2S_DAO_MUTE;
}

STATIC INLINE void IP_I2S_DisableMute(IP_I2S_001_T *pI2S)
{
 pI2S->DAO &= ~I2S_DAO_MUTE;
}

void IP_I2S_Stop(IP_I2S_001_T *pI2S, uint8_t TRMode);

/**********************************************************************************
 * I2S DMA functions
 *********************************************************************************/

void IP_I2S_SetFIFODepthDMA(IP_I2S_001_T *pI2S, uint8_t TRMode, IP_I2S_DMARequestNumber_T DMANum, uint32_t depth);

void IP_I2S_DMACmd(IP_I2S_001_T *pI2S, IP_I2S_DMARequestNumber_T DMANum, uint8_t TRMode, FunctionalState NewState);

/**********************************************************************************
 * I2S IRQ functions
 *********************************************************************************/

void IP_I2S_InterruptCmd(IP_I2S_001_T *pI2S, uint8_t TRMode, FunctionalState NewState);

void IP_I2S_SetFIFODepthIRQ(IP_I2S_001_T *pI2S, uint8_t TRMode, uint32_t depth);

Status IP_I2S_GetIntStatus(IP_I2S_001_T *pI2S, uint8_t TRMode);

#ifdef __cplusplus
}
#endif

#endif /* __I2S_001_H_ */