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.
 
 
 

452 lines
17 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f0xx_hal_i2s.h
  4. * @author MCD Application Team
  5. * @brief Header file of I2S HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification,
  12. * are permitted provided that the following conditions are met:
  13. * 1. Redistributions of source code must retain the above copyright notice,
  14. * this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright notice,
  16. * this list of conditions and the following disclaimer in the documentation
  17. * and/or other materials provided with the distribution.
  18. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. *
  33. ******************************************************************************
  34. */
  35. /* Define to prevent recursive inclusion -------------------------------------*/
  36. #ifndef __STM32F0xx_HAL_I2S_H
  37. #define __STM32F0xx_HAL_I2S_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. #if defined(STM32F031x6) || defined(STM32F038xx) || \
  42. defined(STM32F051x8) || defined(STM32F058xx) || \
  43. defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || \
  44. defined(STM32F042x6) || defined(STM32F048xx) || \
  45. defined(STM32F091xC) || defined(STM32F098xx)
  46. /* Includes ------------------------------------------------------------------*/
  47. #include "stm32f0xx_hal_def.h"
  48. /** @addtogroup STM32F0xx_HAL_Driver
  49. * @{
  50. */
  51. /** @addtogroup I2S
  52. * @{
  53. */
  54. /* Exported types ------------------------------------------------------------*/
  55. /** @defgroup I2S_Exported_Types I2S Exported Types
  56. * @{
  57. */
  58. /**
  59. * @brief I2S Init structure definition
  60. */
  61. typedef struct
  62. {
  63. uint32_t Mode; /*!< Specifies the I2S operating mode.
  64. This parameter can be a value of @ref I2S_Mode */
  65. uint32_t Standard; /*!< Specifies the standard used for the I2S communication.
  66. This parameter can be a value of @ref I2S_Standard */
  67. uint32_t DataFormat; /*!< Specifies the data format for the I2S communication.
  68. This parameter can be a value of @ref I2S_Data_Format */
  69. uint32_t MCLKOutput; /*!< Specifies whether the I2S MCLK output is enabled or not.
  70. This parameter can be a value of @ref I2S_MCLK_Output */
  71. uint32_t AudioFreq; /*!< Specifies the frequency selected for the I2S communication.
  72. This parameter can be a value of @ref I2S_Audio_Frequency */
  73. uint32_t CPOL; /*!< Specifies the idle state of the I2S clock.
  74. This parameter can be a value of @ref I2S_Clock_Polarity */
  75. }I2S_InitTypeDef;
  76. /**
  77. * @brief HAL State structures definition
  78. */
  79. typedef enum
  80. {
  81. HAL_I2S_STATE_RESET = 0x00U, /*!< I2S not yet initialized or disabled */
  82. HAL_I2S_STATE_READY = 0x01U, /*!< I2S initialized and ready for use */
  83. HAL_I2S_STATE_BUSY = 0x02U, /*!< I2S internal process is ongoing */
  84. HAL_I2S_STATE_BUSY_TX = 0x03U, /*!< Data Transmission process is ongoing */
  85. HAL_I2S_STATE_BUSY_RX = 0x04U, /*!< Data Reception process is ongoing */
  86. HAL_I2S_STATE_PAUSE = 0x06U, /*!< I2S pause state: used in case of DMA */
  87. HAL_I2S_STATE_ERROR = 0x07U /*!< I2S error state */
  88. }HAL_I2S_StateTypeDef;
  89. /**
  90. * @brief I2S handle Structure definition
  91. */
  92. typedef struct
  93. {
  94. SPI_TypeDef *Instance; /*!< I2S registers base address */
  95. I2S_InitTypeDef Init; /*!< I2S communication parameters */
  96. uint16_t *pTxBuffPtr; /*!< Pointer to I2S Tx transfer buffer */
  97. __IO uint16_t TxXferSize; /*!< I2S Tx transfer size */
  98. __IO uint16_t TxXferCount; /*!< I2S Tx transfer Counter */
  99. uint16_t *pRxBuffPtr; /*!< Pointer to I2S Rx transfer buffer */
  100. __IO uint16_t RxXferSize; /*!< I2S Rx transfer size */
  101. __IO uint16_t RxXferCount; /*!< I2S Rx transfer counter
  102. (This field is initialized at the
  103. same value as transfer size at the
  104. beginning of the transfer and
  105. decremented when a sample is received.
  106. NbSamplesReceived = RxBufferSize-RxBufferCount) */
  107. DMA_HandleTypeDef *hdmatx; /*!< I2S Tx DMA handle parameters */
  108. DMA_HandleTypeDef *hdmarx; /*!< I2S Rx DMA handle parameters */
  109. __IO HAL_LockTypeDef Lock; /*!< I2S locking object */
  110. __IO HAL_I2S_StateTypeDef State; /*!< I2S communication state */
  111. __IO uint32_t ErrorCode; /*!< I2S Error code
  112. This parameter can be a value of @ref I2S_Error */
  113. }I2S_HandleTypeDef;
  114. /**
  115. * @}
  116. */
  117. /* Exported constants --------------------------------------------------------*/
  118. /** @defgroup I2S_Exported_Constants I2S Exported Constants
  119. * @{
  120. */
  121. /** @defgroup I2S_Error I2S Error
  122. * @{
  123. */
  124. #define HAL_I2S_ERROR_NONE (0x00000000U) /*!< No error */
  125. #define HAL_I2S_ERROR_TIMEOUT (0x00000001U) /*!< Timeout error */
  126. #define HAL_I2S_ERROR_OVR (0x00000002U) /*!< OVR error */
  127. #define HAL_I2S_ERROR_UDR (0x00000004U) /*!< UDR error */
  128. #define HAL_I2S_ERROR_DMA (0x00000008U) /*!< DMA transfer error */
  129. #define HAL_I2S_ERROR_UNKNOW (0x00000010U) /*!< Unknow Error error */
  130. /**
  131. * @}
  132. */
  133. /** @defgroup I2S_Mode I2S Mode
  134. * @{
  135. */
  136. #define I2S_MODE_SLAVE_TX (0x00000000U)
  137. #define I2S_MODE_SLAVE_RX (0x00000100U)
  138. #define I2S_MODE_MASTER_TX (0x00000200U)
  139. #define I2S_MODE_MASTER_RX (0x00000300U)
  140. #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX) || \
  141. ((MODE) == I2S_MODE_SLAVE_RX) || \
  142. ((MODE) == I2S_MODE_MASTER_TX)|| \
  143. ((MODE) == I2S_MODE_MASTER_RX))
  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. #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS) || \
  156. ((STANDARD) == I2S_STANDARD_MSB) || \
  157. ((STANDARD) == I2S_STANDARD_LSB) || \
  158. ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
  159. ((STANDARD) == I2S_STANDARD_PCM_LONG))
  160. /**
  161. * @}
  162. */
  163. /** @defgroup I2S_Data_Format I2S Data Format
  164. * @{
  165. */
  166. #define I2S_DATAFORMAT_16B (0x00000000U)
  167. #define I2S_DATAFORMAT_16B_EXTENDED (0x00000001U)
  168. #define I2S_DATAFORMAT_24B (0x00000003U)
  169. #define I2S_DATAFORMAT_32B (0x00000005U)
  170. #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B) || \
  171. ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
  172. ((FORMAT) == I2S_DATAFORMAT_24B) || \
  173. ((FORMAT) == I2S_DATAFORMAT_32B))
  174. /**
  175. * @}
  176. */
  177. /** @defgroup I2S_MCLK_Output I2S MCLK Output
  178. * @{
  179. */
  180. #define I2S_MCLKOUTPUT_ENABLE ((uint32_t)SPI_I2SPR_MCKOE)
  181. #define I2S_MCLKOUTPUT_DISABLE (0x00000000U)
  182. #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
  183. ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
  184. /**
  185. * @}
  186. */
  187. /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
  188. * @{
  189. */
  190. #define I2S_AUDIOFREQ_192K (192000U)
  191. #define I2S_AUDIOFREQ_96K (96000U)
  192. #define I2S_AUDIOFREQ_48K (48000U)
  193. #define I2S_AUDIOFREQ_44K (44100U)
  194. #define I2S_AUDIOFREQ_32K (32000U)
  195. #define I2S_AUDIOFREQ_22K (22050U)
  196. #define I2S_AUDIOFREQ_16K (16000U)
  197. #define I2S_AUDIOFREQ_11K (11025U)
  198. #define I2S_AUDIOFREQ_8K (8000U)
  199. #define I2S_AUDIOFREQ_DEFAULT (2U)
  200. #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
  201. ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
  202. ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
  203. /**
  204. * @}
  205. */
  206. /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
  207. * @{
  208. */
  209. #define I2S_CPOL_LOW (0x00000000U)
  210. #define I2S_CPOL_HIGH ((uint32_t)SPI_I2SCFGR_CKPOL)
  211. #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
  212. ((CPOL) == I2S_CPOL_HIGH))
  213. /**
  214. * @}
  215. */
  216. /** @defgroup I2S_Interrupt_configuration_definition I2S Interrupt configuration definition
  217. * @{
  218. */
  219. #define I2S_IT_TXE SPI_CR2_TXEIE
  220. #define I2S_IT_RXNE SPI_CR2_RXNEIE
  221. #define I2S_IT_ERR SPI_CR2_ERRIE
  222. /**
  223. * @}
  224. */
  225. /** @defgroup I2S_Flag_definition I2S Flag definition
  226. * @{
  227. */
  228. #define I2S_FLAG_TXE SPI_SR_TXE
  229. #define I2S_FLAG_RXNE SPI_SR_RXNE
  230. #define I2S_FLAG_UDR SPI_SR_UDR
  231. #define I2S_FLAG_OVR SPI_SR_OVR
  232. #define I2S_FLAG_FRE SPI_SR_FRE
  233. #define I2S_FLAG_CHSIDE SPI_SR_CHSIDE
  234. #define I2S_FLAG_BSY SPI_SR_BSY
  235. /**
  236. * @}
  237. */
  238. /**
  239. * @}
  240. */
  241. /* Exported macros -----------------------------------------------------------*/
  242. /** @defgroup I2S_Exported_macros I2S Exported Macros
  243. * @{
  244. */
  245. /** @brief Reset I2S handle state
  246. * @param __HANDLE__ I2S handle.
  247. * @retval None
  248. */
  249. #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
  250. /** @brief Enable or disable the specified SPI peripheral (in I2S mode).
  251. * @param __HANDLE__ specifies the I2S Handle.
  252. * @retval None
  253. */
  254. #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
  255. #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= (uint16_t)(~SPI_I2SCFGR_I2SE))
  256. /** @brief Enable or disable the specified I2S interrupts.
  257. * @param __HANDLE__ specifies the I2S Handle.
  258. * @param __INTERRUPT__ specifies the interrupt source to enable or disable.
  259. * This parameter can be one of the following values:
  260. * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  261. * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  262. * @arg I2S_IT_ERR: Error interrupt enable
  263. * @retval None
  264. */
  265. #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
  266. #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= (uint16_t)(~(__INTERRUPT__)))
  267. /** @brief Checks if the specified I2S interrupt source is enabled or disabled.
  268. * @param __HANDLE__ specifies the I2S Handle.
  269. * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
  270. * @param __INTERRUPT__ specifies the I2S interrupt source to check.
  271. * This parameter can be one of the following values:
  272. * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  273. * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  274. * @arg I2S_IT_ERR: Error interrupt enable
  275. * @retval The new state of __IT__ (TRUE or FALSE).
  276. */
  277. #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  278. /** @brief Checks whether the specified I2S flag is set or not.
  279. * @param __HANDLE__ specifies the I2S Handle.
  280. * @param __FLAG__ specifies the flag to check.
  281. * This parameter can be one of the following values:
  282. * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
  283. * @arg I2S_FLAG_TXE: Transmit buffer empty flag
  284. * @arg I2S_FLAG_UDR: Underrun flag
  285. * @arg I2S_FLAG_OVR: Overrun flag
  286. * @arg I2S_FLAG_FRE: Frame error flag
  287. * @arg I2S_FLAG_CHSIDE: Channel Side flag
  288. * @arg I2S_FLAG_BSY: Busy flag
  289. * @retval The new state of __FLAG__ (TRUE or FALSE).
  290. */
  291. #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
  292. /** @brief Clears the I2S OVR pending flag.
  293. * @param __HANDLE__ specifies the I2S Handle.
  294. * @retval None
  295. */
  296. #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) do{ \
  297. __IO uint32_t tmpreg; \
  298. tmpreg = (__HANDLE__)->Instance->DR; \
  299. tmpreg = (__HANDLE__)->Instance->SR; \
  300. UNUSED(tmpreg); \
  301. }while(0)
  302. /** @brief Clears the I2S UDR pending flag.
  303. * @param __HANDLE__ specifies the I2S Handle.
  304. * @retval None
  305. */
  306. #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) do{\
  307. __IO uint32_t tmpreg;\
  308. tmpreg = ((__HANDLE__)->Instance->SR);\
  309. UNUSED(tmpreg); \
  310. }while(0)
  311. /**
  312. * @}
  313. */
  314. /* Exported functions --------------------------------------------------------*/
  315. /** @addtogroup I2S_Exported_Functions
  316. * @{
  317. */
  318. /** @addtogroup I2S_Exported_Functions_Group1
  319. * @{
  320. */
  321. /* Initialization/de-initialization functions **********************************/
  322. HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
  323. HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
  324. void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
  325. void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
  326. /**
  327. * @}
  328. */
  329. /** @addtogroup I2S_Exported_Functions_Group2
  330. * @{
  331. */
  332. /* I/O operation functions ***************************************************/
  333. /* Blocking mode: Polling */
  334. HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
  335. HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
  336. /* Non-Blocking mode: Interrupt */
  337. HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  338. HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  339. void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
  340. /* Non-Blocking mode: DMA */
  341. HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  342. HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  343. HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
  344. HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
  345. HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
  346. /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
  347. void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
  348. void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
  349. void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
  350. void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
  351. void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
  352. /**
  353. * @}
  354. */
  355. /** @addtogroup I2S_Exported_Functions_Group3
  356. * @{
  357. */
  358. /* Peripheral Control and State functions ************************************/
  359. HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
  360. uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
  361. /**
  362. * @}
  363. */
  364. /**
  365. * @}
  366. */
  367. /**
  368. * @}
  369. */
  370. /**
  371. * @}
  372. */
  373. #endif /* defined(STM32F031x6) || defined(STM32F038xx) || */
  374. /* defined(STM32F051x8) || defined(STM32F058xx) || */
  375. /* defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) ||*/
  376. /* defined(STM32F042x6) || defined(STM32F048xx) || */
  377. /* defined(STM32F091xC) || defined(STM32F098xx) */
  378. #ifdef __cplusplus
  379. }
  380. #endif
  381. #endif /* __STM32F0xx_HAL_I2S_H */
  382. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/