2 ******************************************************************************
3 * @file stm32f7xx_hal_i2s.h
4 * @author MCD Application Team
7 * @brief Header file of I2S HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2017 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 __STM32F7xx_HAL_I2S_H
40 #define __STM32F7xx_HAL_I2S_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f7xx_hal_def.h"
49 /** @addtogroup STM32F7xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
58 /** @defgroup I2S_Exported_Types I2S Exported Types
63 * @brief I2S Init structure definition
67 uint32_t Mode
; /*!< Specifies the I2S operating mode.
68 This parameter can be a value of @ref I2S_Mode */
70 uint32_t Standard
; /*!< Specifies the standard used for the I2S communication.
71 This parameter can be a value of @ref I2S_Standard */
73 uint32_t DataFormat
; /*!< Specifies the data format for the I2S communication.
74 This parameter can be a value of @ref I2S_Data_Format */
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 */
79 uint32_t AudioFreq
; /*!< Specifies the frequency selected for the I2S communication.
80 This parameter can be a value of @ref I2S_Audio_Frequency */
82 uint32_t CPOL
; /*!< Specifies the idle state of the I2S clock.
83 This parameter can be a value of @ref I2S_Clock_Polarity */
85 uint32_t ClockSource
; /*!< Specifies the I2S Clock Source.
86 This parameter can be a value of @ref I2S_Clock_Source */
90 * @brief HAL State structures definition
94 HAL_I2S_STATE_RESET
= 0x00U
, /*!< I2S not yet initialized or disabled */
95 HAL_I2S_STATE_READY
= 0x01U
, /*!< I2S initialized and ready for use */
96 HAL_I2S_STATE_BUSY
= 0x02U
, /*!< I2S internal process is ongoing */
97 HAL_I2S_STATE_BUSY_TX
= 0x03U
, /*!< Data Transmission process is ongoing */
98 HAL_I2S_STATE_BUSY_RX
= 0x04U
, /*!< Data Reception process is ongoing */
99 HAL_I2S_STATE_BUSY_TX_RX
= 0x05U
, /*!< Data Transmission and Reception process is ongoing */
100 HAL_I2S_STATE_TIMEOUT
= 0x06U
, /*!< I2S timeout state */
101 HAL_I2S_STATE_ERROR
= 0x07U
/*!< I2S error state */
103 }HAL_I2S_StateTypeDef
;
106 * @brief I2S handle Structure definition
110 SPI_TypeDef
*Instance
; /* I2S registers base address */
112 I2S_InitTypeDef Init
; /* I2S communication parameters */
114 uint16_t *pTxBuffPtr
; /* Pointer to I2S Tx transfer buffer */
116 __IO
uint16_t TxXferSize
; /* I2S Tx transfer size */
118 __IO
uint16_t TxXferCount
; /* I2S Tx transfer Counter */
120 uint16_t *pRxBuffPtr
; /* Pointer to I2S Rx transfer buffer */
122 __IO
uint16_t RxXferSize
; /* I2S Rx transfer size */
124 __IO
uint16_t RxXferCount
; /* I2S Rx transfer counter
125 (This field is initialized at the
126 same value as transfer size at the
127 beginning of the transfer and
128 decremented when a sample is received.
129 NbSamplesReceived = RxBufferSize-RxBufferCount) */
131 DMA_HandleTypeDef
*hdmatx
; /* I2S Tx DMA handle parameters */
133 DMA_HandleTypeDef
*hdmarx
; /* I2S Rx DMA handle parameters */
135 __IO HAL_LockTypeDef Lock
; /* I2S locking object */
137 __IO HAL_I2S_StateTypeDef State
; /* I2S communication state */
139 __IO
uint32_t ErrorCode
; /* I2S Error code */
146 /* Exported constants --------------------------------------------------------*/
147 /** @defgroup I2S_Exported_Constants I2S Exported Constants
151 /** @defgroup I2S_Error_Defintion I2S_Error_Defintion
152 *@brief I2S Error Code
155 #define HAL_I2S_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
156 #define HAL_I2S_ERROR_TIMEOUT ((uint32_t)0x00000001U) /*!< Timeout error */
157 #define HAL_I2S_ERROR_OVR ((uint32_t)0x00000002U) /*!< OVR error */
158 #define HAL_I2S_ERROR_UDR ((uint32_t)0x00000004U) /*!< UDR error */
159 #define HAL_I2S_ERROR_DMA ((uint32_t)0x00000008U) /*!< DMA transfer error */
160 #define HAL_I2S_ERROR_UNKNOW ((uint32_t)0x00000010U) /*!< Unknow Error error */
165 /** @defgroup I2S_Clock_Source I2S Clock Source
168 #define I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001U)
169 #define I2S_CLOCK_PLL ((uint32_t)0x00000002U)
174 /** @defgroup I2S_Mode I2S Mode
177 #define I2S_MODE_SLAVE_TX ((uint32_t)0x00000000U)
178 #define I2S_MODE_SLAVE_RX ((uint32_t)0x00000100U)
179 #define I2S_MODE_MASTER_TX ((uint32_t)0x00000200U)
180 #define I2S_MODE_MASTER_RX ((uint32_t)0x00000300U)
185 /** @defgroup I2S_Standard I2S Standard
188 #define I2S_STANDARD_PHILIPS ((uint32_t)0x00000000U)
189 #define I2S_STANDARD_MSB ((uint32_t)0x00000010U)
190 #define I2S_STANDARD_LSB ((uint32_t)0x00000020U)
191 #define I2S_STANDARD_PCM_SHORT ((uint32_t)0x00000030U)
192 #define I2S_STANDARD_PCM_LONG ((uint32_t)0x000000B0U)
197 /** @defgroup I2S_Data_Format I2S Data Format
200 #define I2S_DATAFORMAT_16B ((uint32_t)0x00000000U)
201 #define I2S_DATAFORMAT_16B_EXTENDED ((uint32_t)0x00000001U)
202 #define I2S_DATAFORMAT_24B ((uint32_t)0x00000003U)
203 #define I2S_DATAFORMAT_32B ((uint32_t)0x00000005U)
208 /** @defgroup I2S_MCLK_Output I2S Mclk Output
211 #define I2S_MCLKOUTPUT_ENABLE ((uint32_t)SPI_I2SPR_MCKOE)
212 #define I2S_MCLKOUTPUT_DISABLE ((uint32_t)0x00000000U)
217 /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
220 #define I2S_AUDIOFREQ_192K ((uint32_t)192000U)
221 #define I2S_AUDIOFREQ_96K ((uint32_t)96000U)
222 #define I2S_AUDIOFREQ_48K ((uint32_t)48000U)
223 #define I2S_AUDIOFREQ_44K ((uint32_t)44100U)
224 #define I2S_AUDIOFREQ_32K ((uint32_t)32000U)
225 #define I2S_AUDIOFREQ_22K ((uint32_t)22050U)
226 #define I2S_AUDIOFREQ_16K ((uint32_t)16000U)
227 #define I2S_AUDIOFREQ_11K ((uint32_t)11025U)
228 #define I2S_AUDIOFREQ_8K ((uint32_t)8000U)
229 #define I2S_AUDIOFREQ_DEFAULT ((uint32_t)2U)
235 /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
238 #define I2S_CPOL_LOW ((uint32_t)0x00000000U)
239 #define I2S_CPOL_HIGH ((uint32_t)SPI_I2SCFGR_CKPOL)
244 /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
247 #define I2S_IT_TXE SPI_CR2_TXEIE
248 #define I2S_IT_RXNE SPI_CR2_RXNEIE
249 #define I2S_IT_ERR SPI_CR2_ERRIE
254 /** @defgroup I2S_Flags_Definition I2S Flags Definition
257 #define I2S_FLAG_TXE SPI_SR_TXE
258 #define I2S_FLAG_RXNE SPI_SR_RXNE
260 #define I2S_FLAG_UDR SPI_SR_UDR
261 #define I2S_FLAG_OVR SPI_SR_OVR
262 #define I2S_FLAG_FRE SPI_SR_FRE
264 #define I2S_FLAG_CHSIDE SPI_SR_CHSIDE
265 #define I2S_FLAG_BSY SPI_SR_BSY
274 /* Exported macros -----------------------------------------------------------*/
275 /** @defgroup I2S_Exported_Macros I2S Exported Macros
279 /** @brief Reset I2S handle state
280 * @param __HANDLE__: specifies the I2S handle.
283 #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
285 /** @brief Enable or disable the specified SPI peripheral (in I2S mode).
286 * @param __HANDLE__: specifies the I2S Handle.
289 #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
290 #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
292 /** @brief Enable or disable the specified I2S interrupts.
293 * @param __HANDLE__: specifies the I2S Handle.
294 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
295 * This parameter can be one of the following values:
296 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
297 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
298 * @arg I2S_IT_ERR: Error interrupt enable
301 #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
302 #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= ~(__INTERRUPT__))
304 /** @brief Checks if the specified I2S interrupt source is enabled or disabled.
305 * @param __HANDLE__: specifies the I2S Handle.
306 * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
307 * @param __INTERRUPT__: specifies the I2S interrupt source to check.
308 * This parameter can be one of the following values:
309 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
310 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
311 * @arg I2S_IT_ERR: Error interrupt enable
312 * @retval The new state of __IT__ (TRUE or FALSE).
314 #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
316 /** @brief Checks whether the specified I2S flag is set or not.
317 * @param __HANDLE__: specifies the I2S Handle.
318 * @param __FLAG__: specifies the flag to check.
319 * This parameter can be one of the following values:
320 * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
321 * @arg I2S_FLAG_TXE: Transmit buffer empty flag
322 * @arg I2S_FLAG_UDR: Underrun flag
323 * @arg I2S_FLAG_OVR: Overrun flag
324 * @arg I2S_FLAG_FRE: Frame error flag
325 * @arg I2S_FLAG_CHSIDE: Channel Side flag
326 * @arg I2S_FLAG_BSY: Busy flag
327 * @retval The new state of __FLAG__ (TRUE or FALSE).
329 #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
331 /** @brief Clears the I2S OVR pending flag.
332 * @param __HANDLE__: specifies the I2S Handle.
335 #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) \
337 __IO uint32_t tmpreg; \
338 tmpreg = (__HANDLE__)->Instance->DR; \
339 tmpreg = (__HANDLE__)->Instance->SR; \
343 /** @brief Clears the I2S UDR pending flag.
344 * @param __HANDLE__: specifies the I2S Handle.
347 #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) \
349 __IO uint32_t tmpreg; \
350 tmpreg = (__HANDLE__)->Instance->SR; \
357 /* Exported functions --------------------------------------------------------*/
358 /** @addtogroup I2S_Exported_Functions I2S Exported Functions
362 /** @addtogroup I2S_Exported_Functions_Group1 Initialization and de-initialization functions
366 /* Initialization and de-initialization functions *****************************/
367 HAL_StatusTypeDef
HAL_I2S_Init(I2S_HandleTypeDef
*hi2s
);
368 HAL_StatusTypeDef
HAL_I2S_DeInit (I2S_HandleTypeDef
*hi2s
);
369 void HAL_I2S_MspInit(I2S_HandleTypeDef
*hi2s
);
370 void HAL_I2S_MspDeInit(I2S_HandleTypeDef
*hi2s
);
375 /** @addtogroup I2S_Exported_Functions_Group2 Input and Output operation functions
378 /* I/O operation functions ***************************************************/
379 /* Blocking mode: Polling */
380 HAL_StatusTypeDef
HAL_I2S_Transmit(I2S_HandleTypeDef
*hi2s
, uint16_t *pData
, uint16_t Size
, uint32_t Timeout
);
381 HAL_StatusTypeDef
HAL_I2S_Receive(I2S_HandleTypeDef
*hi2s
, uint16_t *pData
, uint16_t Size
, uint32_t Timeout
);
383 /* Non-Blocking mode: Interrupt */
384 HAL_StatusTypeDef
HAL_I2S_Transmit_IT(I2S_HandleTypeDef
*hi2s
, uint16_t *pData
, uint16_t Size
);
385 HAL_StatusTypeDef
HAL_I2S_Receive_IT(I2S_HandleTypeDef
*hi2s
, uint16_t *pData
, uint16_t Size
);
386 void HAL_I2S_IRQHandler(I2S_HandleTypeDef
*hi2s
);
388 /* Non-Blocking mode: DMA */
389 HAL_StatusTypeDef
HAL_I2S_Transmit_DMA(I2S_HandleTypeDef
*hi2s
, uint16_t *pData
, uint16_t Size
);
390 HAL_StatusTypeDef
HAL_I2S_Receive_DMA(I2S_HandleTypeDef
*hi2s
, uint16_t *pData
, uint16_t Size
);
392 HAL_StatusTypeDef
HAL_I2S_DMAPause(I2S_HandleTypeDef
*hi2s
);
393 HAL_StatusTypeDef
HAL_I2S_DMAResume(I2S_HandleTypeDef
*hi2s
);
394 HAL_StatusTypeDef
HAL_I2S_DMAStop(I2S_HandleTypeDef
*hi2s
);
396 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
397 void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef
*hi2s
);
398 void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef
*hi2s
);
399 void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef
*hi2s
);
400 void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef
*hi2s
);
401 void HAL_I2S_ErrorCallback(I2S_HandleTypeDef
*hi2s
);
406 /** @addtogroup I2S_Exported_Functions_Group3 Peripheral State and Errors functions
409 /* Peripheral Control and State functions ************************************/
410 HAL_I2S_StateTypeDef
HAL_I2S_GetState(I2S_HandleTypeDef
*hi2s
);
411 uint32_t HAL_I2S_GetError(I2S_HandleTypeDef
*hi2s
);
421 /* Private types -------------------------------------------------------------*/
422 /* Private variables ---------------------------------------------------------*/
423 /* Private constants ---------------------------------------------------------*/
424 /** @defgroup I2S_Private_Constants I2S Private Constants
432 /* Private macros ------------------------------------------------------------*/
433 /** @defgroup I2S_Private_Macros I2S Private Macros
436 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) || \
437 ((CLOCK) == I2S_CLOCK_PLL))
439 #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX) || \
440 ((MODE) == I2S_MODE_SLAVE_RX) || \
441 ((MODE) == I2S_MODE_MASTER_TX)|| \
442 ((MODE) == I2S_MODE_MASTER_RX))
444 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS) || \
445 ((STANDARD) == I2S_STANDARD_MSB) || \
446 ((STANDARD) == I2S_STANDARD_LSB) || \
447 ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
448 ((STANDARD) == I2S_STANDARD_PCM_LONG))
450 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B) || \
451 ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
452 ((FORMAT) == I2S_DATAFORMAT_24B) || \
453 ((FORMAT) == I2S_DATAFORMAT_32B))
455 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
456 ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
458 #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
459 ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
460 ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
462 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
463 ((CPOL) == I2S_CPOL_HIGH))
481 #endif /* __STM32F7xx_HAL_I2S_H */
483 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/