stm32f4xx_hal_i2s.h

Go to the documentation of this file.

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __STM32F4xx_HAL_I2S_H
#define __STM32F4xx_HAL_I2S_H

#ifdef __cplusplus
 extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "stm32f4xx_hal_def.h"  

/* Exported types ------------------------------------------------------------*/
typedef struct
{
  uint32_t Mode;         
  uint32_t Standard;     
  uint32_t DataFormat;   
  uint32_t MCLKOutput;   
  uint32_t AudioFreq;    
  uint32_t CPOL;         
  uint32_t ClockSource;  
  uint32_t FullDuplexMode;  
}I2S_InitTypeDef;

typedef enum
{
  HAL_I2S_STATE_RESET      = 0x00U,  
  HAL_I2S_STATE_READY      = 0x01U,  
  HAL_I2S_STATE_BUSY       = 0x02U,  
  HAL_I2S_STATE_BUSY_TX    = 0x12U,  
  HAL_I2S_STATE_BUSY_RX    = 0x22U,  
  HAL_I2S_STATE_BUSY_TX_RX = 0x32U,  
  HAL_I2S_STATE_TIMEOUT    = 0x03U,  
  HAL_I2S_STATE_ERROR      = 0x04U   
}HAL_I2S_StateTypeDef;

typedef struct
{
  SPI_TypeDef                *Instance;    /* I2S registers base address        */

  I2S_InitTypeDef            Init;         /* I2S communication parameters      */
  
  uint16_t                   *pTxBuffPtr;  /* Pointer to I2S Tx transfer buffer */
  
  __IO uint16_t              TxXferSize;   /* I2S Tx transfer size              */
  
  __IO uint16_t              TxXferCount;  /* I2S Tx transfer Counter           */
  
  uint16_t                   *pRxBuffPtr;  /* Pointer to I2S Rx transfer buffer */
  
  __IO uint16_t              RxXferSize;   /* I2S Rx transfer size              */
  
  __IO uint16_t              RxXferCount;  /* I2S Rx transfer counter           */

  DMA_HandleTypeDef          *hdmatx;      /* I2S Tx DMA handle parameters      */

  DMA_HandleTypeDef          *hdmarx;      /* I2S Rx DMA handle parameters      */
  
  __IO HAL_LockTypeDef       Lock;         /* I2S locking object                */
  
  __IO HAL_I2S_StateTypeDef  State;        /* I2S communication state           */
  
  __IO uint32_t              ErrorCode;    /* I2S Error code                    */
  
}I2S_HandleTypeDef;
/* Exported constants --------------------------------------------------------*/
#define HAL_I2S_ERROR_NONE          ((uint32_t)0x00000000U)    
#define HAL_I2S_ERROR_UDR           ((uint32_t)0x00000001U)    
#define HAL_I2S_ERROR_OVR           ((uint32_t)0x00000002U)    
#define HAL_I2SEX_ERROR_UDR         ((uint32_t)0x00000004U)    
#define HAL_I2SEX_ERROR_OVR         ((uint32_t)0x00000008U)    
#define HAL_I2S_ERROR_FRE           ((uint32_t)0x00000010U)    
#define HAL_I2S_ERROR_DMA           ((uint32_t)0x00000020U)    
#define I2S_MODE_SLAVE_TX                ((uint32_t)0x00000000U)
#define I2S_MODE_SLAVE_RX                ((uint32_t)0x00000100U)
#define I2S_MODE_MASTER_TX               ((uint32_t)0x00000200U)
#define I2S_MODE_MASTER_RX               ((uint32_t)0x00000300U)

#define I2S_STANDARD_PHILIPS             ((uint32_t)0x00000000U)
#define I2S_STANDARD_MSB                 ((uint32_t)0x00000010U)
#define I2S_STANDARD_LSB                 ((uint32_t)0x00000020U)
#define I2S_STANDARD_PCM_SHORT           ((uint32_t)0x00000030U)
#define I2S_STANDARD_PCM_LONG            ((uint32_t)0x000000B0U)

#define I2S_DATAFORMAT_16B               ((uint32_t)0x00000000U)
#define I2S_DATAFORMAT_16B_EXTENDED      ((uint32_t)0x00000001U)
#define I2S_DATAFORMAT_24B               ((uint32_t)0x00000003U)
#define I2S_DATAFORMAT_32B               ((uint32_t)0x00000005U)

#define I2S_MCLKOUTPUT_ENABLE           ((uint32_t)SPI_I2SPR_MCKOE)
#define I2S_MCLKOUTPUT_DISABLE          ((uint32_t)0x00000000U)

#define I2S_AUDIOFREQ_192K               ((uint32_t)192000U)
#define I2S_AUDIOFREQ_96K                ((uint32_t)96000U)
#define I2S_AUDIOFREQ_48K                ((uint32_t)48000U)
#define I2S_AUDIOFREQ_44K                ((uint32_t)44100U)
#define I2S_AUDIOFREQ_32K                ((uint32_t)32000U)
#define I2S_AUDIOFREQ_22K                ((uint32_t)22050U)
#define I2S_AUDIOFREQ_16K                ((uint32_t)16000U)
#define I2S_AUDIOFREQ_11K                ((uint32_t)11025U)
#define I2S_AUDIOFREQ_8K                 ((uint32_t)8000U)
#define I2S_AUDIOFREQ_DEFAULT            ((uint32_t)2U)

#define I2S_FULLDUPLEXMODE_DISABLE                   ((uint32_t)0x00000000U)
#define I2S_FULLDUPLEXMODE_ENABLE                    ((uint32_t)0x00000001U)

#define I2S_CPOL_LOW                    ((uint32_t)0x00000000U)
#define I2S_CPOL_HIGH                   ((uint32_t)SPI_I2SCFGR_CKPOL)

#define I2S_IT_TXE                      SPI_CR2_TXEIE
#define I2S_IT_RXNE                     SPI_CR2_RXNEIE
#define I2S_IT_ERR                      SPI_CR2_ERRIE

#define I2S_FLAG_TXE                    SPI_SR_TXE
#define I2S_FLAG_RXNE                   SPI_SR_RXNE

#define I2S_FLAG_UDR                    SPI_SR_UDR
#define I2S_FLAG_OVR                    SPI_SR_OVR
#define I2S_FLAG_FRE                    SPI_SR_FRE

#define I2S_FLAG_CHSIDE                 SPI_SR_CHSIDE
#define I2S_FLAG_BSY                    SPI_SR_BSY

/* Exported macro ------------------------------------------------------------*/
#define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)

#define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
#define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)

#define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
#define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= ~(__INTERRUPT__))
 
#define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

#define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))

#define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)     \
  do{                                           \
    __IO uint32_t tmpreg = 0x00U;               \
    tmpreg = (__HANDLE__)->Instance->DR;        \
    tmpreg = (__HANDLE__)->Instance->SR;        \
    UNUSED(tmpreg);                             \
  } while(0)
    
#define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)     \
  do{                                           \
  __IO uint32_t tmpreg = 0x00U;                 \
  tmpreg = (__HANDLE__)->Instance->SR;          \
  UNUSED(tmpreg);                               \
  } while(0)

/* Include I2S Extension module */
#include "stm32f4xx_hal_i2s_ex.h"

/* Exported functions --------------------------------------------------------*/
/* Initialization/de-initialization functions  **********************************/
HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
/* I/O operation functions  *****************************************************/
/* Blocking mode: Polling */
HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);

 /* Non-Blocking mode: Interrupt */
HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);

/* Non-Blocking mode: DMA */
HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);

HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);

/* Peripheral Control and State functions  **************************************/
HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);

/* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
#define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX)  || \
                           ((MODE) == I2S_MODE_SLAVE_RX)  || \
                           ((MODE) == I2S_MODE_MASTER_TX) || \
                           ((MODE) == I2S_MODE_MASTER_RX))
                           
#define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS)   || \
                                   ((STANDARD) == I2S_STANDARD_MSB)       || \
                                   ((STANDARD) == I2S_STANDARD_LSB)       || \
                                   ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
                                   ((STANDARD) == I2S_STANDARD_PCM_LONG))

#define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B)          || \
                                    ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
                                    ((FORMAT) == I2S_DATAFORMAT_24B)          || \
                                    ((FORMAT) == I2S_DATAFORMAT_32B))

#define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
                                    ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
                                    
#define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
                                  ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
                                  ((FREQ) == I2S_AUDIOFREQ_DEFAULT))

#define IS_I2S_FULLDUPLEX_MODE(MODE) (((MODE) == I2S_FULLDUPLEXMODE_DISABLE) || \
                                      ((MODE) == I2S_FULLDUPLEXMODE_ENABLE))

#define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
                           ((CPOL) == I2S_CPOL_HIGH))
 
/* Private functions ---------------------------------------------------------*/
void              I2S_DMATxCplt(DMA_HandleTypeDef *hdma);
void              I2S_DMATxHalfCplt(DMA_HandleTypeDef *hdma); 
void              I2S_DMARxCplt(DMA_HandleTypeDef *hdma);
void              I2S_DMARxHalfCplt(DMA_HandleTypeDef *hdma);
void              I2S_DMAError(DMA_HandleTypeDef *hdma);
HAL_StatusTypeDef I2S_WaitFlagStateUntilTimeout(I2S_HandleTypeDef *hi2s, uint32_t Flag, uint32_t Status, uint32_t Timeout);
HAL_StatusTypeDef I2S_Transmit_IT(I2S_HandleTypeDef *hi2s);
HAL_StatusTypeDef I2S_Receive_IT(I2S_HandleTypeDef *hi2s);
#ifdef __cplusplus
}
#endif


#endif /* __STM32F4xx_HAL_I2S_H */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/