2 ******************************************************************************
3 * @file stm32f3xx_hal_i2s.h
4 * @author MCD Application Team
7 * @brief Header file of I2S HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
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.
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.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F3xx_HAL_I2S_H
40 #define __STM32F3xx_HAL_I2S_H
46 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \
47 defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
48 defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) || \
49 defined(STM32F373xC) || defined(STM32F378xx)
51 /* Includes ------------------------------------------------------------------*/
52 #include "stm32f3xx_hal_def.h"
54 /** @addtogroup STM32F3xx_HAL_Driver
58 /** @addtogroup I2S I2S HAL module driver
62 /* Exported types ------------------------------------------------------------*/
63 /** @defgroup I2S_Exported_Types I2S Exported Types
68 * @brief I2S Init structure definition
72 uint32_t Mode; /*!< Specifies the I2S operating mode.
73 This parameter can be a value of @ref I2S_Mode */
75 uint32_t Standard; /*!< Specifies the standard used for the I2S communication.
76 This parameter can be a value of @ref I2S_Standard */
78 uint32_t DataFormat; /*!< Specifies the data format for the I2S communication.
79 This parameter can be a value of @ref I2S_Data_Format */
81 uint32_t MCLKOutput; /*!< Specifies whether the I2S MCLK output is enabled or not.
82 This parameter can be a value of @ref I2S_MCLK_Output */
84 uint32_t AudioFreq; /*!< Specifies the frequency selected for the I2S communication.
85 This parameter can be a value of @ref I2S_Audio_Frequency */
87 uint32_t CPOL; /*!< Specifies the idle state of the I2S clock.
88 This parameter can be a value of @ref I2S_Clock_Polarity */
90 uint32_t ClockSource; /*!< Specifies the I2S Clock Source.
91 This parameter can be a value of @ref I2S_Clock_Source */
93 uint32_t FullDuplexMode; /*!< Specifies the I2S FullDuplex mode.
94 This parameter can be a value of @ref I2S_FullDuplex_Mode */
99 * @brief HAL State structures definition
103 HAL_I2S_STATE_RESET = 0x00, /*!< I2S not yet initialized or disabled */
104 HAL_I2S_STATE_READY = 0x01, /*!< I2S initialized and ready for use */
105 HAL_I2S_STATE_BUSY = 0x02, /*!< I2S internal process is ongoing */
106 HAL_I2S_STATE_BUSY_TX = 0x03, /*!< Data Transmission process is ongoing */
107 HAL_I2S_STATE_BUSY_RX = 0x04, /*!< Data Reception process is ongoing */
108 HAL_I2S_STATE_BUSY_TX_RX = 0x05, /*!< Data Transmission and Reception process is ongoing */
109 HAL_I2S_STATE_TIMEOUT = 0x06, /*!< I2S timeout state */
110 HAL_I2S_STATE_ERROR = 0x07 /*!< I2S error state */
112 }HAL_I2S_StateTypeDef;
115 * @brief HAL I2S Error Code structure definition
119 HAL_I2S_ERROR_NONE = 0x00, /*!< No error */
120 HAL_I2S_ERROR_TIMEOUT = 0x01, /*!< Timeout error */
121 HAL_I2S_ERROR_OVR = 0x02, /*!< OVR error */
122 HAL_I2S_ERROR_UDR = 0x04, /*!< UDR error */
123 HAL_I2S_ERROR_DMA = 0x08, /*!< DMA transfer error */
124 HAL_I2S_ERROR_UNKNOW = 0x10 /*!< Unknow Error error */
125 }HAL_I2S_ErrorTypeDef;
128 * @brief I2S handle Structure definition
132 SPI_TypeDef *Instance; /* I2S registers base address */
134 I2S_InitTypeDef Init; /* I2S communication parameters */
136 uint16_t *pTxBuffPtr; /* Pointer to I2S Tx transfer buffer */
138 __IO uint16_t TxXferSize; /* I2S Tx transfer size */
140 __IO uint16_t TxXferCount; /* I2S Tx transfer Counter */
142 uint16_t *pRxBuffPtr; /* Pointer to I2S Rx transfer buffer */
144 __IO uint16_t RxXferSize; /* I2S Rx transfer size */
146 __IO uint16_t RxXferCount; /* I2S Rx transfer counter
147 (This field is initialized at the
148 same value as transfer size at the
149 beginning of the transfer and
150 decremented when a sample is received.
151 NbSamplesReceived = RxBufferSize-RxBufferCount) */
153 DMA_HandleTypeDef *hdmatx; /* I2S Tx DMA handle parameters */
155 DMA_HandleTypeDef *hdmarx; /* I2S Rx DMA handle parameters */
157 __IO HAL_LockTypeDef Lock; /* I2S locking object */
159 __IO HAL_I2S_StateTypeDef State; /* I2S communication state */
161 __IO HAL_I2S_ErrorTypeDef ErrorCode; /* I2S Error code */
168 /* Exported constants --------------------------------------------------------*/
169 /** @defgroup I2S_Exported_Constants I2S Exported Constants
173 /** @defgroup I2S_Clock_Source I2S Clock Source
176 #define I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001)
177 #define I2S_CLOCK_SYSCLK ((uint32_t)0x00000002)
179 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) || \
180 ((CLOCK) == I2S_CLOCK_SYSCLK))
185 /** @defgroup I2S_Mode I2S Mode
188 #define I2S_MODE_SLAVE_TX ((uint32_t)0x00000000)
189 #define I2S_MODE_SLAVE_RX ((uint32_t)0x00000100)
190 #define I2S_MODE_MASTER_TX ((uint32_t)0x00000200)
191 #define I2S_MODE_MASTER_RX ((uint32_t)0x00000300)
193 #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX) || \
194 ((MODE) == I2S_MODE_SLAVE_RX) || \
195 ((MODE) == I2S_MODE_MASTER_TX)|| \
196 ((MODE) == I2S_MODE_MASTER_RX))
201 /** @defgroup I2S_Standard I2S Standard
204 #define I2S_STANDARD_PHILIPS ((uint32_t)0x00000000)
205 #define I2S_STANDARD_MSB ((uint32_t)0x00000010)
206 #define I2S_STANDARD_LSB ((uint32_t)0x00000020)
207 #define I2S_STANDARD_PCM_SHORT ((uint32_t)0x00000030)
208 #define I2S_STANDARD_PCM_LONG ((uint32_t)0x000000B0)
210 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS) || \
211 ((STANDARD) == I2S_STANDARD_MSB) || \
212 ((STANDARD) == I2S_STANDARD_LSB) || \
213 ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
214 ((STANDARD) == I2S_STANDARD_PCM_LONG))
219 /** @defgroup I2S_Data_Format I2S Data Format
222 #define I2S_DATAFORMAT_16B ((uint32_t)0x00000000)
223 #define I2S_DATAFORMAT_16B_EXTENDED ((uint32_t)0x00000001)
224 #define I2S_DATAFORMAT_24B ((uint32_t)0x00000003)
225 #define I2S_DATAFORMAT_32B ((uint32_t)0x00000005)
227 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B) || \
228 ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
229 ((FORMAT) == I2S_DATAFORMAT_24B) || \
230 ((FORMAT) == I2S_DATAFORMAT_32B))
235 /** @defgroup I2S_MCLK_Output I2S MCLK Output
238 #define I2S_MCLKOUTPUT_ENABLE ((uint32_t)SPI_I2SPR_MCKOE)
239 #define I2S_MCLKOUTPUT_DISABLE ((uint32_t)0x00000000)
241 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
242 ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
247 /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
250 #define I2S_AUDIOFREQ_192K ((uint32_t)192000)
251 #define I2S_AUDIOFREQ_96K ((uint32_t)96000)
252 #define I2S_AUDIOFREQ_48K ((uint32_t)48000)
253 #define I2S_AUDIOFREQ_44K ((uint32_t)44100)
254 #define I2S_AUDIOFREQ_32K ((uint32_t)32000)
255 #define I2S_AUDIOFREQ_22K ((uint32_t)22050)
256 #define I2S_AUDIOFREQ_16K ((uint32_t)16000)
257 #define I2S_AUDIOFREQ_11K ((uint32_t)11025)
258 #define I2S_AUDIOFREQ_8K ((uint32_t)8000)
259 #define I2S_AUDIOFREQ_DEFAULT ((uint32_t)2)
261 #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
262 ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
263 ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
268 /** @defgroup I2S_FullDuplex_Mode I2S Full Duplex Mode
271 #define I2S_FULLDUPLEXMODE_DISABLE ((uint32_t)0x00000000)
272 #define I2S_FULLDUPLEXMODE_ENABLE ((uint32_t)0x00000001)
274 #define IS_I2S_FULLDUPLEX_MODE(MODE) (((MODE) == I2S_FULLDUPLEXMODE_DISABLE) || \
275 ((MODE) == I2S_FULLDUPLEXMODE_ENABLE))
280 /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
283 #define I2S_CPOL_LOW ((uint32_t)0x00000000)
284 #define I2S_CPOL_HIGH ((uint32_t)SPI_I2SCFGR_CKPOL)
286 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
287 ((CPOL) == I2S_CPOL_HIGH))
292 /** @defgroup I2S_Interrupt_configuration_definition I2S Interrupt configuration definition
295 #define I2S_IT_TXE SPI_CR2_TXEIE
296 #define I2S_IT_RXNE SPI_CR2_RXNEIE
297 #define I2S_IT_ERR SPI_CR2_ERRIE
302 /** @defgroup I2S_Flag_definition I2S Flag definition
305 #define I2S_FLAG_TXE SPI_SR_TXE
306 #define I2S_FLAG_RXNE SPI_SR_RXNE
308 #define I2S_FLAG_UDR SPI_SR_UDR
309 #define I2S_FLAG_OVR SPI_SR_OVR
310 #define I2S_FLAG_FRE SPI_SR_FRE
312 #define I2S_FLAG_CHSIDE SPI_SR_CHSIDE
313 #define I2S_FLAG_BSY SPI_SR_BSY
322 /* Exported macros -----------------------------------------------------------*/
323 /** @defgroup I2S_Exported_Macros I2S Exported Macros
327 /** @brief Reset I2S handle state
328 * @param __HANDLE__: I2S handle.
331 #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
333 /** @brief Enable or disable the specified SPI peripheral (in I2S mode).
334 * @param __HANDLE__: specifies the I2S Handle.
337 #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
338 #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
340 /** @brief Enable or disable the specified I2S interrupts.
341 * @param __HANDLE__: specifies the I2S Handle.
342 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
343 * This parameter can be one of the following values:
344 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
345 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
346 * @arg I2S_IT_ERR: Error interrupt enable
349 #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
350 #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= ~(__INTERRUPT__))
352 /** @brief Checks if the specified I2S interrupt source is enabled or disabled.
353 * @param __HANDLE__: specifies the I2S Handle.
354 * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
355 * @param __INTERRUPT__: specifies the I2S interrupt source to check.
356 * This parameter can be one of the following values:
357 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
358 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
359 * @arg I2S_IT_ERR: Error interrupt enable
360 * @retval The new state of __IT__ (TRUE or FALSE).
362 #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
364 /** @brief Checks whether the specified I2S flag is set or not.
365 * @param __HANDLE__: specifies the I2S Handle.
366 * @param __FLAG__: specifies the flag to check.
367 * This parameter can be one of the following values:
368 * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
369 * @arg I2S_FLAG_TXE: Transmit buffer empty flag
370 * @arg I2S_FLAG_UDR: Underrun flag
371 * @arg I2S_FLAG_OVR: Overrun flag
372 * @arg I2S_FLAG_FRE: Frame error flag
373 * @arg I2S_FLAG_CHSIDE: Channel Side flag
374 * @arg I2S_FLAG_BSY: Busy flag
375 * @retval The new state of __FLAG__ (TRUE or FALSE).
377 #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
379 /** @brief Clears the I2S OVR pending flag.
380 * @param __HANDLE__: specifies the I2S Handle.
383 #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) do{(__HANDLE__)->Instance->DR;\
384 (__HANDLE__)->Instance->SR;}while(0)
385 /** @brief Clears the I2S UDR pending flag.
386 * @param __HANDLE__: specifies the I2S Handle.
389 #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)((__HANDLE__)->Instance->SR)
394 /* Include I2S HAL Extended module */
395 #include "stm32f3xx_hal_i2s_ex.h"
397 /* Exported functions --------------------------------------------------------*/
398 /** @addtogroup I2S_Exported_Functions I2S Exported Functions
402 /** @addtogroup I2S_Exported_Functions_Group1 Initialization and de-initialization functions
406 /* Initialization and de-initialization functions *****************************/
407 HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
408 HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
409 void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
410 void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
415 /** @addtogroup I2S_Exported_Functions_Group2 Input and Output operation functions
418 /* I/O operation functions ***************************************************/
419 /* Blocking mode: Polling */
420 HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
421 HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
423 /* Non-Blocking mode: Interrupt */
424 HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
425 HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
426 void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
428 /* Non-Blocking mode: DMA */
429 HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
430 HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
432 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
433 void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
434 void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
435 void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
436 void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
437 void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
442 /** @addtogroup I2S_Exported_Functions_Group3 Peripheral State and Errors functions
445 /* Peripheral Control and State functions ************************************/
446 HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
447 HAL_I2S_ErrorTypeDef HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
465 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
466 /* STM32F302xC || STM32F303xC || STM32F358xx || */
467 /* STM32F301x8 || STM32F302x8 || STM32F318xx || */
468 /* STM32F373xC || STM32F378xx */
475 #endif /* __STM32F3xx_HAL_I2S_H */
477 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/