You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

544 lines
22 KiB

  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. /* Define to prevent recursive inclusion -------------------------------------*/
  38. #ifndef __STM32F4xx_HAL_I2S_H
  39. #define __STM32F4xx_HAL_I2S_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. /* Includes ------------------------------------------------------------------*/
  44. #include "stm32f4xx_hal_def.h"
  45. /** @addtogroup STM32F4xx_HAL_Driver
  46. * @{
  47. */
  48. /** @addtogroup I2S I2S
  49. * @{
  50. */
  51. /* Exported types ------------------------------------------------------------*/
  52. /** @defgroup I2S_Exported_Types I2S Exported Types
  53. * @{
  54. */
  55. /**
  56. * @brief I2S Init structure definition
  57. */
  58. typedef struct
  59. {
  60. uint32_t Mode; /*!< Specifies the I2S operating mode.
  61. This parameter can be a value of @ref I2S_Mode */
  62. uint32_t Standard; /*!< Specifies the standard used for the I2S communication.
  63. This parameter can be a value of @ref I2S_Standard */
  64. uint32_t DataFormat; /*!< Specifies the data format for the I2S communication.
  65. This parameter can be a value of @ref I2S_Data_Format */
  66. uint32_t MCLKOutput; /*!< Specifies whether the I2S MCLK output is enabled or not.
  67. This parameter can be a value of @ref I2S_MCLK_Output */
  68. uint32_t AudioFreq; /*!< Specifies the frequency selected for the I2S communication.
  69. This parameter can be a value of @ref I2S_Audio_Frequency */
  70. uint32_t CPOL; /*!< Specifies the idle state of the I2S clock.
  71. This parameter can be a value of @ref I2S_Clock_Polarity */
  72. uint32_t ClockSource; /*!< Specifies the I2S Clock Source.
  73. This parameter can be a value of @ref I2S_Clock_Source */
  74. uint32_t FullDuplexMode; /*!< Specifies the I2S FullDuplex mode.
  75. This parameter can be a value of @ref I2S_FullDuplex_Mode */
  76. }I2S_InitTypeDef;
  77. /**
  78. * @brief HAL State structures definition
  79. */
  80. typedef enum
  81. {
  82. HAL_I2S_STATE_RESET = 0x00U, /*!< I2S not yet initialized or disabled */
  83. HAL_I2S_STATE_READY = 0x01U, /*!< I2S initialized and ready for use */
  84. HAL_I2S_STATE_BUSY = 0x02U, /*!< I2S internal process is ongoing */
  85. HAL_I2S_STATE_BUSY_TX = 0x03U, /*!< Data Transmission process is ongoing */
  86. HAL_I2S_STATE_BUSY_RX = 0x04U, /*!< Data Reception process is ongoing */
  87. HAL_I2S_STATE_BUSY_TX_RX = 0x05U, /*!< Data Transmission and Reception process is ongoing */
  88. HAL_I2S_STATE_TIMEOUT = 0x06U, /*!< I2S timeout state */
  89. HAL_I2S_STATE_ERROR = 0x07U /*!< I2S error state */
  90. }HAL_I2S_StateTypeDef;
  91. /**
  92. * @brief I2S handle Structure definition
  93. */
  94. typedef struct __I2S_HandleTypeDef
  95. {
  96. SPI_TypeDef *Instance; /*!< I2S registers base address */
  97. I2S_InitTypeDef Init; /*!< I2S communication parameters */
  98. uint16_t *pTxBuffPtr; /*!< Pointer to I2S Tx transfer buffer */
  99. __IO uint16_t TxXferSize; /*!< I2S Tx transfer size */
  100. __IO uint16_t TxXferCount; /*!< I2S Tx transfer Counter */
  101. uint16_t *pRxBuffPtr; /*!< Pointer to I2S Rx transfer buffer */
  102. __IO uint16_t RxXferSize; /*!< I2S Rx transfer size */
  103. __IO uint16_t RxXferCount; /*!< I2S Rx transfer counter
  104. (This field is initialized at the
  105. same value as transfer size at the
  106. beginning of the transfer and
  107. decremented when a sample is received
  108. NbSamplesReceived = RxBufferSize-RxBufferCount) */
  109. void (*IrqHandlerISR) (struct __I2S_HandleTypeDef *hi2s); /*!< I2S function pointer on IrqHandler */
  110. DMA_HandleTypeDef *hdmatx; /*!< I2S Tx DMA handle parameters */
  111. DMA_HandleTypeDef *hdmarx; /*!< I2S Rx DMA handle parameters */
  112. __IO HAL_LockTypeDef Lock; /*!< I2S locking object */
  113. __IO HAL_I2S_StateTypeDef State; /*!< I2S communication state */
  114. __IO uint32_t ErrorCode; /*!< I2S Error code
  115. This parameter can be a value of @ref I2S_ErrorCode */
  116. }I2S_HandleTypeDef;
  117. /**
  118. * @}
  119. */
  120. /* Exported constants --------------------------------------------------------*/
  121. /** @defgroup I2S_Exported_Constants I2S Exported Constants
  122. * @{
  123. */
  124. /**
  125. * @defgroup I2S_ErrorCode I2S Error Code
  126. * @{
  127. */
  128. #define HAL_I2S_ERROR_NONE (0x00000000U) /*!< No error */
  129. #define HAL_I2S_ERROR_TIMEOUT (0x00000001U) /*!< Timeout error */
  130. #define HAL_I2S_ERROR_OVR (0x00000002U) /*!< OVR error */
  131. #define HAL_I2S_ERROR_UDR (0x00000004U) /*!< UDR error */
  132. #define HAL_I2S_ERROR_DMA (0x00000008U) /*!< DMA transfer error */
  133. #define HAL_I2S_ERROR_PRESCALER (0x00000010U) /*!< Prescaler Calculation error */
  134. /**
  135. * @}
  136. */
  137. /** @defgroup I2S_Mode I2S Mode
  138. * @{
  139. */
  140. #define I2S_MODE_SLAVE_TX (0x00000000U)
  141. #define I2S_MODE_SLAVE_RX (0x00000100U)
  142. #define I2S_MODE_MASTER_TX (0x00000200U)
  143. #define I2S_MODE_MASTER_RX (0x00000300U)
  144. /**
  145. * @}
  146. */
  147. /** @defgroup I2S_Standard I2S Standard
  148. * @{
  149. */
  150. #define I2S_STANDARD_PHILIPS (0x00000000U)
  151. #define I2S_STANDARD_MSB (0x00000010U)
  152. #define I2S_STANDARD_LSB (0x00000020U)
  153. #define I2S_STANDARD_PCM_SHORT (0x00000030U)
  154. #define I2S_STANDARD_PCM_LONG (0x000000B0U)
  155. /**
  156. * @}
  157. */
  158. /** @defgroup I2S_Data_Format I2S Data Format
  159. * @{
  160. */
  161. #define I2S_DATAFORMAT_16B (0x00000000U)
  162. #define I2S_DATAFORMAT_16B_EXTENDED (0x00000001U)
  163. #define I2S_DATAFORMAT_24B (0x00000003U)
  164. #define I2S_DATAFORMAT_32B (0x00000005U)
  165. /**
  166. * @}
  167. */
  168. /** @defgroup I2S_MCLK_Output I2S Mclk Output
  169. * @{
  170. */
  171. #define I2S_MCLKOUTPUT_ENABLE SPI_I2SPR_MCKOE
  172. #define I2S_MCLKOUTPUT_DISABLE (0x00000000U)
  173. /**
  174. * @}
  175. */
  176. /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
  177. * @{
  178. */
  179. #define I2S_AUDIOFREQ_192K (192000U)
  180. #define I2S_AUDIOFREQ_96K (96000U)
  181. #define I2S_AUDIOFREQ_48K (48000U)
  182. #define I2S_AUDIOFREQ_44K (44100U)
  183. #define I2S_AUDIOFREQ_32K (32000U)
  184. #define I2S_AUDIOFREQ_22K (22050U)
  185. #define I2S_AUDIOFREQ_16K (16000U)
  186. #define I2S_AUDIOFREQ_11K (11025U)
  187. #define I2S_AUDIOFREQ_8K (8000U)
  188. #define I2S_AUDIOFREQ_DEFAULT (2U)
  189. /**
  190. * @}
  191. */
  192. /** @defgroup I2S_FullDuplex_Mode I2S FullDuplex Mode
  193. * @{
  194. */
  195. #define I2S_FULLDUPLEXMODE_DISABLE (0x00000000U)
  196. #define I2S_FULLDUPLEXMODE_ENABLE (0x00000001U)
  197. /**
  198. * @}
  199. */
  200. /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
  201. * @{
  202. */
  203. #define I2S_CPOL_LOW (0x00000000U)
  204. #define I2S_CPOL_HIGH (SPI_I2SCFGR_CKPOL)
  205. /**
  206. * @}
  207. */
  208. /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
  209. * @{
  210. */
  211. #define I2S_IT_TXE SPI_CR2_TXEIE
  212. #define I2S_IT_RXNE SPI_CR2_RXNEIE
  213. #define I2S_IT_ERR SPI_CR2_ERRIE
  214. /**
  215. * @}
  216. */
  217. /** @defgroup I2S_Flags_Definition I2S Flags Definition
  218. * @{
  219. */
  220. #define I2S_FLAG_TXE SPI_SR_TXE
  221. #define I2S_FLAG_RXNE SPI_SR_RXNE
  222. #define I2S_FLAG_UDR SPI_SR_UDR
  223. #define I2S_FLAG_OVR SPI_SR_OVR
  224. #define I2S_FLAG_FRE SPI_SR_FRE
  225. #define I2S_FLAG_CHSIDE SPI_SR_CHSIDE
  226. #define I2S_FLAG_BSY SPI_SR_BSY
  227. /**
  228. * @}
  229. */
  230. /** @defgroup I2S_Clock_Source I2S Clock Source Definition
  231. * @{
  232. */
  233. #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
  234. defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
  235. defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F469xx) || \
  236. defined(STM32F479xx)
  237. #define I2S_CLOCK_PLL (0x00000000U)
  238. #define I2S_CLOCK_EXTERNAL (0x00000001U)
  239. #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
  240. STM32F401xC || STM32F401xE || STM32F411xE || STM32F469xx || STM32F479xx */
  241. #if defined(STM32F446xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F412Cx) ||\
  242. defined(STM32F413xx) || defined(STM32F423xx)
  243. #define I2S_CLOCK_PLL (0x00000000U)
  244. #define I2S_CLOCK_EXTERNAL (0x00000001U)
  245. #define I2S_CLOCK_PLLR (0x00000002U)
  246. #define I2S_CLOCK_PLLSRC (0x00000003U)
  247. #endif /* STM32F446xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
  248. #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx)
  249. #define I2S_CLOCK_PLLSRC (0x00000000U)
  250. #define I2S_CLOCK_EXTERNAL (0x00000001U)
  251. #define I2S_CLOCK_PLLR (0x00000002U)
  252. #endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx */
  253. /**
  254. * @}
  255. */
  256. /**
  257. * @}
  258. */
  259. /* Exported macro ------------------------------------------------------------*/
  260. /** @defgroup I2S_Exported_Macros I2S Exported Macros
  261. * @{
  262. */
  263. /** @brief Reset I2S handle state
  264. * @param __HANDLE__: specifies the I2S Handle.
  265. * @retval None
  266. */
  267. #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
  268. /** @brief Enable or disable the specified SPI peripheral (in I2S mode).
  269. * @param __HANDLE__: specifies the I2S Handle.
  270. * @retval None
  271. */
  272. #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
  273. #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &=(uint16_t)(~SPI_I2SCFGR_I2SE))
  274. /** @brief Enable or disable the specified I2S interrupts.
  275. * @param __HANDLE__: specifies the I2S Handle.
  276. * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
  277. * This parameter can be one of the following values:
  278. * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  279. * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  280. * @arg I2S_IT_ERR: Error interrupt enable
  281. * @retval None
  282. */
  283. #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
  284. #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &=(uint16_t)(~(__INTERRUPT__)))
  285. /** @brief Checks if the specified I2S interrupt source is enabled or disabled.
  286. * @param __HANDLE__: specifies the I2S Handle.
  287. * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
  288. * @param __INTERRUPT__: specifies the I2S interrupt source to check.
  289. * This parameter can be one of the following values:
  290. * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  291. * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  292. * @arg I2S_IT_ERR: Error interrupt enable
  293. * @retval The new state of __IT__ (TRUE or FALSE).
  294. */
  295. #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  296. /** @brief Checks whether the specified I2S flag is set or not.
  297. * @param __HANDLE__: specifies the I2S Handle.
  298. * @param __FLAG__: specifies the flag to check.
  299. * This parameter can be one of the following values:
  300. * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
  301. * @arg I2S_FLAG_TXE: Transmit buffer empty flag
  302. * @arg I2S_FLAG_UDR: Underrun flag
  303. * @arg I2S_FLAG_OVR: Overrun flag
  304. * @arg I2S_FLAG_FRE: Frame error flag
  305. * @arg I2S_FLAG_CHSIDE: Channel Side flag
  306. * @arg I2S_FLAG_BSY: Busy flag
  307. * @retval The new state of __FLAG__ (TRUE or FALSE).
  308. */
  309. #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
  310. /** @brief Clears the I2S OVR pending flag.
  311. * @param __HANDLE__: specifies the I2S Handle.
  312. * @retval None
  313. */
  314. #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) \
  315. do{ \
  316. __IO uint32_t tmpreg = 0x00U; \
  317. tmpreg = (__HANDLE__)->Instance->DR; \
  318. tmpreg = (__HANDLE__)->Instance->SR; \
  319. UNUSED(tmpreg); \
  320. } while(0)
  321. /** @brief Clears the I2S UDR pending flag.
  322. * @param __HANDLE__: specifies the I2S Handle.
  323. * @retval None
  324. */
  325. #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) \
  326. do{ \
  327. __IO uint32_t tmpreg = 0x00U; \
  328. tmpreg = (__HANDLE__)->Instance->SR; \
  329. UNUSED(tmpreg); \
  330. } while(0)
  331. /**
  332. * @}
  333. */
  334. /* Include I2S Extension module */
  335. #include "stm32f4xx_hal_i2s_ex.h"
  336. /* Exported functions --------------------------------------------------------*/
  337. /** @defgroup I2S_Exported_Functions I2S Exported Functions
  338. * @{
  339. */
  340. /** @defgroup I2S_Exported_Functions_Group1 I2S Initialization and de-initialization functions
  341. * @{
  342. */
  343. /* Initialization/de-initialization functions **********************************/
  344. HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
  345. HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
  346. void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
  347. void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
  348. /**
  349. * @}
  350. */
  351. /** @defgroup I2S_Exported_Functions_Group2 I2S IO operation functions
  352. * @{
  353. */
  354. /* I/O operation functions *****************************************************/
  355. /* Blocking mode: Polling */
  356. HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
  357. HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
  358. /* Non-Blocking mode: Interrupt */
  359. HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  360. HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  361. void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
  362. /* Non-Blocking mode: DMA */
  363. HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  364. HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  365. HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
  366. HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
  367. HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
  368. /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
  369. void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
  370. void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
  371. void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
  372. void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
  373. void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
  374. /**
  375. * @}
  376. */
  377. /** @defgroup I2S_Exported_Functions_Group3 I2S Peripheral Control and State functions
  378. * @{
  379. */
  380. /* Peripheral Control and State functions ************************************/
  381. HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
  382. uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
  383. /**
  384. * @}
  385. */
  386. /**
  387. * @}
  388. */
  389. /* Private types -------------------------------------------------------------*/
  390. /* Private variables ---------------------------------------------------------*/
  391. /* Private constants ---------------------------------------------------------*/
  392. /** @defgroup I2S_Private_Constants I2S Private Constants
  393. * @{
  394. */
  395. /**
  396. * @}
  397. */
  398. /* Private macros ------------------------------------------------------------*/
  399. /** @defgroup I2S_Private_Macros I2S Private Macros
  400. * @{
  401. */
  402. #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX) || \
  403. ((MODE) == I2S_MODE_SLAVE_RX) || \
  404. ((MODE) == I2S_MODE_MASTER_TX) || \
  405. ((MODE) == I2S_MODE_MASTER_RX))
  406. #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS) || \
  407. ((STANDARD) == I2S_STANDARD_MSB) || \
  408. ((STANDARD) == I2S_STANDARD_LSB) || \
  409. ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
  410. ((STANDARD) == I2S_STANDARD_PCM_LONG))
  411. #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B) || \
  412. ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
  413. ((FORMAT) == I2S_DATAFORMAT_24B) || \
  414. ((FORMAT) == I2S_DATAFORMAT_32B))
  415. #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
  416. ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
  417. #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
  418. ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
  419. ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
  420. #define IS_I2S_FULLDUPLEX_MODE(MODE) (((MODE) == I2S_FULLDUPLEXMODE_DISABLE) || \
  421. ((MODE) == I2S_FULLDUPLEXMODE_ENABLE))
  422. #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
  423. ((CPOL) == I2S_CPOL_HIGH))
  424. #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
  425. defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
  426. defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F469xx) || \
  427. defined(STM32F479xx)
  428. #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
  429. ((CLOCK) == I2S_CLOCK_PLL))
  430. #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
  431. STM32F401xC || STM32F401xE || STM32F411xE || STM32F469xx || STM32F479xx */
  432. #if defined(STM32F446xx) || defined(STM32F412Zx) || defined(STM32F412Vx) ||\
  433. defined(STM32F412Rx) || defined(STM32F412Cx) || defined (STM32F413xx) ||\
  434. defined(STM32F423xx)
  435. #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
  436. ((CLOCK) == I2S_CLOCK_PLL) ||\
  437. ((CLOCK) == I2S_CLOCK_PLLSRC) ||\
  438. ((CLOCK) == I2S_CLOCK_PLLR))
  439. #endif /* STM32F446xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
  440. #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx)
  441. #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
  442. ((CLOCK) == I2S_CLOCK_PLLSRC) ||\
  443. ((CLOCK) == I2S_CLOCK_PLLR))
  444. #endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx */
  445. /**
  446. * @}
  447. */
  448. /* Private functions ---------------------------------------------------------*/
  449. /**
  450. * @}
  451. */
  452. /**
  453. * @}
  454. */
  455. #ifdef __cplusplus
  456. }
  457. #endif
  458. #endif /* __STM32F4xx_HAL_I2S_H */
  459. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/