lib/main/STM32F4/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2s.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_i2s.h
   4   * @author  MCD Application Team
   5   * @version V1.7.1
   6   * @date    14-April-2017
   7   * @brief   Header file of I2S HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F4xx_HAL_I2S_H
  40 #define __STM32F4xx_HAL_I2S_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f4xx_hal_def.h"
  48
  49 /** @addtogroup STM32F4xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup I2S I2S
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup I2S_Exported_Types I2S Exported Types
  59   * @{
  60   */
  61
  62 /**
  63   * @brief I2S Init structure definition
  64   */
  65 typedef struct
  66 {
  67   uint32_t Mode;            /*!< Specifies the I2S operating mode.
  68                                  This parameter can be a value of @ref I2S_Mode */
  69
  70   uint32_t Standard;        /*!< Specifies the standard used for the I2S communication.
  71                                  This parameter can be a value of @ref I2S_Standard */
  72
  73   uint32_t DataFormat;      /*!< Specifies the data format for the I2S communication.
  74                                  This parameter can be a value of @ref I2S_Data_Format */
  75
  76   uint32_t MCLKOutput;      /*!< Specifies whether the I2S MCLK output is enabled or not.
  77                                  This parameter can be a value of @ref I2S_MCLK_Output */
  78
  79   uint32_t AudioFreq;       /*!< Specifies the frequency selected for the I2S communication.
  80                                  This parameter can be a value of @ref I2S_Audio_Frequency */
  81
  82   uint32_t CPOL;            /*!< Specifies the idle state of the I2S clock.
  83                                  This parameter can be a value of @ref I2S_Clock_Polarity */
  84
  85   uint32_t ClockSource;     /*!< Specifies the I2S Clock Source.
  86                                  This parameter can be a value of @ref I2S_Clock_Source */
  87
  88   uint32_t FullDuplexMode;  /*!< Specifies the I2S FullDuplex mode.
  89                                  This parameter can be a value of @ref I2S_FullDuplex_Mode */
  90
  91 }I2S_InitTypeDef;
  92
  93 /**
  94   * @brief  HAL State structures definition
  95   */
  96 typedef enum
  97 {
  98   HAL_I2S_STATE_RESET      = 0x00U,  /*!< I2S not yet initialized or disabled                */
  99   HAL_I2S_STATE_READY      = 0x01U,  /*!< I2S initialized and ready for use                  */
 100   HAL_I2S_STATE_BUSY       = 0x02U,  /*!< I2S internal process is ongoing                    */
 101   HAL_I2S_STATE_BUSY_TX    = 0x03U,  /*!< Data Transmission process is ongoing               */
 102   HAL_I2S_STATE_BUSY_RX    = 0x04U,  /*!< Data Reception process is ongoing                  */
 103   HAL_I2S_STATE_BUSY_TX_RX = 0x05U,  /*!< Data Transmission and Reception process is ongoing */
 104   HAL_I2S_STATE_TIMEOUT    = 0x06U,  /*!< I2S timeout state                                  */
 105   HAL_I2S_STATE_ERROR      = 0x07U   /*!< I2S error state                                    */
 106
 107 }HAL_I2S_StateTypeDef;
 108
 109 /**
 110   * @brief I2S handle Structure definition
 111   */
 112 typedef struct __I2S_HandleTypeDef
 113 {
 114   SPI_TypeDef                *Instance;    /*!< I2S registers base address        */
 115
 116   I2S_InitTypeDef            Init;         /*!< I2S communication parameters      */
 117
 118   uint16_t                   *pTxBuffPtr;  /*!< Pointer to I2S Tx transfer buffer */
 119
 120   __IO uint16_t              TxXferSize;   /*!< I2S Tx transfer size              */
 121
 122   __IO uint16_t              TxXferCount;  /*!< I2S Tx transfer Counter           */
 123
 124   uint16_t                   *pRxBuffPtr;  /*!< Pointer to I2S Rx transfer buffer */
 125
 126   __IO uint16_t              RxXferSize;   /*!< I2S Rx transfer size              */
 127
 128   __IO uint16_t              RxXferCount;  /*!< I2S Rx transfer counter
 129                                               (This field is initialized at the
 130                                                same value as transfer size at the
 131                                                beginning of the transfer and
 132                                                decremented when a sample is received
 133                                                NbSamplesReceived = RxBufferSize-RxBufferCount) */
 134
 135   void (*IrqHandlerISR)      (struct __I2S_HandleTypeDef *hi2s);   /*!< I2S function pointer on IrqHandler   */
 136
 137   DMA_HandleTypeDef          *hdmatx;      /*!< I2S Tx DMA handle parameters      */
 138
 139   DMA_HandleTypeDef          *hdmarx;      /*!< I2S Rx DMA handle parameters      */
 140
 141   __IO HAL_LockTypeDef       Lock;         /*!< I2S locking object                */
 142
 143   __IO HAL_I2S_StateTypeDef  State;        /*!< I2S communication state           */
 144
 145   __IO uint32_t              ErrorCode;    /*!< I2S Error code
 146                                               This parameter can be a value of @ref I2S_ErrorCode */
 147
 148 }I2S_HandleTypeDef;
 149 /**
 150   * @}
 151   */
 152
 153 /* Exported constants --------------------------------------------------------*/
 154 /** @defgroup I2S_Exported_Constants I2S Exported Constants
 155   * @{
 156   */
 157 /**
 158   * @defgroup  I2S_ErrorCode I2S Error Code
 159   * @{
 160   */
 161 #define HAL_I2S_ERROR_NONE               (0x00000000U)  /*!< No error                    */
 162 #define HAL_I2S_ERROR_TIMEOUT            (0x00000001U)  /*!< Timeout error               */
 163 #define HAL_I2S_ERROR_OVR                (0x00000002U)  /*!< OVR error                   */
 164 #define HAL_I2S_ERROR_UDR                (0x00000004U)  /*!< UDR error                   */
 165 #define HAL_I2S_ERROR_DMA                (0x00000008U)  /*!< DMA transfer error          */
 166 #define HAL_I2S_ERROR_PRESCALER          (0x00000010U)  /*!< Prescaler Calculation error */
 167 /**
 168   * @}
 169   */
 170
 171 /** @defgroup I2S_Mode I2S Mode
 172   * @{
 173   */
 174 #define I2S_MODE_SLAVE_TX                (0x00000000U)
 175 #define I2S_MODE_SLAVE_RX                (0x00000100U)
 176 #define I2S_MODE_MASTER_TX               (0x00000200U)
 177 #define I2S_MODE_MASTER_RX               (0x00000300U)
 178 /**
 179   * @}
 180   */
 181
 182 /** @defgroup I2S_Standard I2S Standard
 183   * @{
 184   */
 185 #define I2S_STANDARD_PHILIPS             (0x00000000U)
 186 #define I2S_STANDARD_MSB                 (0x00000010U)
 187 #define I2S_STANDARD_LSB                 (0x00000020U)
 188 #define I2S_STANDARD_PCM_SHORT           (0x00000030U)
 189 #define I2S_STANDARD_PCM_LONG            (0x000000B0U)
 190 /**
 191   * @}
 192   */
 193
 194 /** @defgroup I2S_Data_Format I2S Data Format
 195   * @{
 196   */
 197 #define I2S_DATAFORMAT_16B               (0x00000000U)
 198 #define I2S_DATAFORMAT_16B_EXTENDED      (0x00000001U)
 199 #define I2S_DATAFORMAT_24B               (0x00000003U)
 200 #define I2S_DATAFORMAT_32B               (0x00000005U)
 201 /**
 202   * @}
 203   */
 204
 205 /** @defgroup I2S_MCLK_Output I2S Mclk Output
 206   * @{
 207   */
 208 #define I2S_MCLKOUTPUT_ENABLE            SPI_I2SPR_MCKOE
 209 #define I2S_MCLKOUTPUT_DISABLE          (0x00000000U)
 210 /**
 211   * @}
 212   */
 213
 214 /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
 215   * @{
 216   */
 217 #define I2S_AUDIOFREQ_192K               (192000U)
 218 #define I2S_AUDIOFREQ_96K                (96000U)
 219 #define I2S_AUDIOFREQ_48K                (48000U)
 220 #define I2S_AUDIOFREQ_44K                (44100U)
 221 #define I2S_AUDIOFREQ_32K                (32000U)
 222 #define I2S_AUDIOFREQ_22K                (22050U)
 223 #define I2S_AUDIOFREQ_16K                (16000U)
 224 #define I2S_AUDIOFREQ_11K                (11025U)
 225 #define I2S_AUDIOFREQ_8K                 (8000U)
 226 #define I2S_AUDIOFREQ_DEFAULT            (2U)
 227 /**
 228   * @}
 229   */
 230
 231 /** @defgroup I2S_FullDuplex_Mode I2S FullDuplex Mode
 232   * @{
 233   */
 234 #define I2S_FULLDUPLEXMODE_DISABLE                   (0x00000000U)
 235 #define I2S_FULLDUPLEXMODE_ENABLE                    (0x00000001U)
 236 /**
 237   * @}
 238   */
 239
 240 /** @defgroup I2S_Clock_Polarity  I2S Clock Polarity
 241   * @{
 242   */
 243 #define I2S_CPOL_LOW                    (0x00000000U)
 244 #define I2S_CPOL_HIGH                   (SPI_I2SCFGR_CKPOL)
 245 /**
 246   * @}
 247   */
 248
 249 /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
 250   * @{
 251   */
 252 #define I2S_IT_TXE                      SPI_CR2_TXEIE
 253 #define I2S_IT_RXNE                     SPI_CR2_RXNEIE
 254 #define I2S_IT_ERR                      SPI_CR2_ERRIE
 255 /**
 256   * @}
 257   */
 258
 259 /** @defgroup I2S_Flags_Definition I2S Flags Definition
 260   * @{
 261   */
 262 #define I2S_FLAG_TXE                    SPI_SR_TXE
 263 #define I2S_FLAG_RXNE                   SPI_SR_RXNE
 264
 265 #define I2S_FLAG_UDR                    SPI_SR_UDR
 266 #define I2S_FLAG_OVR                    SPI_SR_OVR
 267 #define I2S_FLAG_FRE                    SPI_SR_FRE
 268
 269 #define I2S_FLAG_CHSIDE                 SPI_SR_CHSIDE
 270 #define I2S_FLAG_BSY                    SPI_SR_BSY
 271 /**
 272   * @}
 273   */
 274 /** @defgroup I2S_Clock_Source I2S Clock Source Definition
 275   * @{
 276   */
 277 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
 278     defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
 279     defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F469xx) || \
 280     defined(STM32F479xx)
 281 #define I2S_CLOCK_PLL                     (0x00000000U)
 282 #define I2S_CLOCK_EXTERNAL                (0x00000001U)
 283 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
 284           STM32F401xC || STM32F401xE || STM32F411xE || STM32F469xx || STM32F479xx */
 285
 286 #if defined(STM32F446xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F412Cx) ||\
 287     defined(STM32F413xx) || defined(STM32F423xx)
 288 #define I2S_CLOCK_PLL                     (0x00000000U)
 289 #define I2S_CLOCK_EXTERNAL                (0x00000001U)
 290 #define I2S_CLOCK_PLLR                    (0x00000002U)
 291 #define I2S_CLOCK_PLLSRC                  (0x00000003U)
 292 #endif /* STM32F446xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
 293
 294 #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx)
 295 #define I2S_CLOCK_PLLSRC                  (0x00000000U)
 296 #define I2S_CLOCK_EXTERNAL                (0x00000001U)
 297 #define I2S_CLOCK_PLLR                    (0x00000002U)
 298 #endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx */
 299 /**
 300   * @}
 301   */
 302
 303 /**
 304   * @}
 305   */
 306
 307 /* Exported macro ------------------------------------------------------------*/
 308 /** @defgroup I2S_Exported_Macros I2S Exported Macros
 309   * @{
 310   */
 311
 312 /** @brief Reset I2S handle state
 313   * @param  __HANDLE__: specifies the I2S Handle.
 314   * @retval None
 315   */
 316 #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
 317
 318 /** @brief  Enable or disable the specified SPI peripheral (in I2S mode).
 319   * @param  __HANDLE__: specifies the I2S Handle.
 320   * @retval None
 321   */
 322 #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
 323 #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &=(uint16_t)(~SPI_I2SCFGR_I2SE))
 324
 325 /** @brief  Enable or disable the specified I2S interrupts.
 326   * @param  __HANDLE__: specifies the I2S Handle.
 327   * @param  __INTERRUPT__: specifies the interrupt source to enable or disable.
 328   *         This parameter can be one of the following values:
 329   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
 330   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
 331   *            @arg I2S_IT_ERR: Error interrupt enable
 332   * @retval None
 333   */
 334 #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
 335 #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &=(uint16_t)(~(__INTERRUPT__)))
 336
 337 /** @brief  Checks if the specified I2S interrupt source is enabled or disabled.
 338   * @param  __HANDLE__: specifies the I2S Handle.
 339   *         This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
 340   * @param  __INTERRUPT__: specifies the I2S interrupt source to check.
 341   *          This parameter can be one of the following values:
 342   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
 343   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
 344   *            @arg I2S_IT_ERR: Error interrupt enable
 345   * @retval The new state of __IT__ (TRUE or FALSE).
 346   */
 347 #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
 348
 349 /** @brief  Checks whether the specified I2S flag is set or not.
 350   * @param  __HANDLE__: specifies the I2S Handle.
 351   * @param  __FLAG__: specifies the flag to check.
 352   *         This parameter can be one of the following values:
 353   *            @arg I2S_FLAG_RXNE: Receive buffer not empty flag
 354   *            @arg I2S_FLAG_TXE: Transmit buffer empty flag
 355   *            @arg I2S_FLAG_UDR: Underrun flag
 356   *            @arg I2S_FLAG_OVR: Overrun flag
 357   *            @arg I2S_FLAG_FRE: Frame error flag
 358   *            @arg I2S_FLAG_CHSIDE: Channel Side flag
 359   *            @arg I2S_FLAG_BSY: Busy flag
 360   * @retval The new state of __FLAG__ (TRUE or FALSE).
 361   */
 362 #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 363
 364 /** @brief Clears the I2S OVR pending flag.
 365   * @param  __HANDLE__: specifies the I2S Handle.
 366   * @retval None
 367   */
 368 #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__)     \
 369   do{                                           \
 370     __IO uint32_t tmpreg = 0x00U;               \
 371     tmpreg = (__HANDLE__)->Instance->DR;        \
 372     tmpreg = (__HANDLE__)->Instance->SR;        \
 373     UNUSED(tmpreg);                             \
 374   } while(0)
 375
 376 /** @brief Clears the I2S UDR pending flag.
 377   * @param  __HANDLE__: specifies the I2S Handle.
 378   * @retval None
 379   */
 380 #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)     \
 381   do{                                           \
 382   __IO uint32_t tmpreg = 0x00U;                 \
 383   tmpreg = (__HANDLE__)->Instance->SR;          \
 384   UNUSED(tmpreg);                               \
 385   } while(0)
 386 /**
 387   * @}
 388   */
 389
 390 /* Include I2S Extension module */
 391 #include "stm32f4xx_hal_i2s_ex.h"
 392
 393 /* Exported functions --------------------------------------------------------*/
 394 /** @defgroup I2S_Exported_Functions I2S Exported Functions
 395   * @{
 396   */
 397
 398 /** @defgroup I2S_Exported_Functions_Group1 I2S Initialization and de-initialization functions
 399   * @{
 400   */
 401 /* Initialization/de-initialization functions  **********************************/
 402 HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
 403 HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
 404 void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
 405 void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
 406 /**
 407   * @}
 408   */
 409
 410 /** @defgroup I2S_Exported_Functions_Group2 I2S IO operation functions
 411   * @{
 412   */
 413 /* I/O operation functions  *****************************************************/
 414 /* Blocking mode: Polling */
 415 HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
 416 HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
 417
 418  /* Non-Blocking mode: Interrupt */
 419 HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
 420 HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
 421 void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
 422
 423 /* Non-Blocking mode: DMA */
 424 HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
 425 HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
 426
 427 HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
 428 HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
 429 HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
 430
 431 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
 432 void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
 433 void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
 434 void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
 435 void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
 436 void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
 437 /**
 438   * @}
 439   */
 440
 441 /** @defgroup I2S_Exported_Functions_Group3 I2S Peripheral Control and State functions
 442   * @{
 443   */
 444 /* Peripheral Control and State functions  ************************************/
 445 HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
 446 uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
 447 /**
 448   * @}
 449   */
 450
 451 /**
 452   * @}
 453   */
 454
 455 /* Private types -------------------------------------------------------------*/
 456 /* Private variables ---------------------------------------------------------*/
 457 /* Private constants ---------------------------------------------------------*/
 458 /** @defgroup I2S_Private_Constants I2S Private Constants
 459   * @{
 460   */
 461
 462 /**
 463   * @}
 464   */
 465
 466 /* Private macros ------------------------------------------------------------*/
 467 /** @defgroup I2S_Private_Macros I2S Private Macros
 468   * @{
 469   */
 470 #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX)  || \
 471                            ((MODE) == I2S_MODE_SLAVE_RX)  || \
 472                            ((MODE) == I2S_MODE_MASTER_TX) || \
 473                            ((MODE) == I2S_MODE_MASTER_RX))
 474
 475 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS)   || \
 476                                    ((STANDARD) == I2S_STANDARD_MSB)       || \
 477                                    ((STANDARD) == I2S_STANDARD_LSB)       || \
 478                                    ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
 479                                    ((STANDARD) == I2S_STANDARD_PCM_LONG))
 480
 481 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B)          || \
 482                                     ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
 483                                     ((FORMAT) == I2S_DATAFORMAT_24B)          || \
 484                                     ((FORMAT) == I2S_DATAFORMAT_32B))
 485
 486 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
 487                                     ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
 488
 489 #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
 490                                   ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
 491                                   ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
 492
 493 #define IS_I2S_FULLDUPLEX_MODE(MODE) (((MODE) == I2S_FULLDUPLEXMODE_DISABLE) || \
 494                                       ((MODE) == I2S_FULLDUPLEXMODE_ENABLE))
 495
 496 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
 497                            ((CPOL) == I2S_CPOL_HIGH))
 498
 499 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
 500     defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
 501     defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F469xx) || \
 502     defined(STM32F479xx)
 503 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
 504                                    ((CLOCK) == I2S_CLOCK_PLL))
 505 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
 506           STM32F401xC || STM32F401xE || STM32F411xE || STM32F469xx || STM32F479xx */
 507
 508 #if defined(STM32F446xx) || defined(STM32F412Zx) || defined(STM32F412Vx)  ||\
 509     defined(STM32F412Rx) || defined(STM32F412Cx) || defined (STM32F413xx) ||\
 510     defined(STM32F423xx)
 511 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
 512                                    ((CLOCK) == I2S_CLOCK_PLL)      ||\
 513                                    ((CLOCK) == I2S_CLOCK_PLLSRC)   ||\
 514                                    ((CLOCK) == I2S_CLOCK_PLLR))
 515 #endif /* STM32F446xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
 516
 517 #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx)
 518 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
 519                                    ((CLOCK) == I2S_CLOCK_PLLSRC)     ||\
 520                                    ((CLOCK) == I2S_CLOCK_PLLR))
 521 #endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx */
 522
 523 /**
 524   * @}
 525   */
 526
 527 /* Private functions ---------------------------------------------------------*/
 528 /**
 529   * @}
 530   */
 531
 532 /**
 533   * @}
 534   */
 535
 536 #ifdef __cplusplus
 537 }
 538 #endif
 539
 540
 541 #endif /* __STM32F4xx_HAL_I2S_H */
 542
 543 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/