2 ******************************************************************************
\r
3 * @file stm32f7xx_hal_i2s.h
\r
4 * @author MCD Application Team
\r
6 * @date 24-March-2015
\r
7 * @brief Header file of I2S HAL module.
\r
8 ******************************************************************************
\r
11 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
\r
13 * Redistribution and use in source and binary forms, with or without modification,
\r
14 * are permitted provided that the following conditions are met:
\r
15 * 1. Redistributions of source code must retain the above copyright notice,
\r
16 * this list of conditions and the following disclaimer.
\r
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
\r
18 * this list of conditions and the following disclaimer in the documentation
\r
19 * and/or other materials provided with the distribution.
\r
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
\r
21 * may be used to endorse or promote products derived from this software
\r
22 * without specific prior written permission.
\r
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
\r
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
\r
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
\r
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\r
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
\r
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
\r
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
\r
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
\r
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
35 ******************************************************************************
\r
38 /* Define to prevent recursive inclusion -------------------------------------*/
\r
39 #ifndef __STM32F7xx_HAL_I2S_H
\r
40 #define __STM32F7xx_HAL_I2S_H
\r
46 /* Includes ------------------------------------------------------------------*/
\r
47 #include "stm32f7xx_hal_def.h"
\r
49 /** @addtogroup STM32F7xx_HAL_Driver
\r
57 /* Exported types ------------------------------------------------------------*/
\r
58 /** @defgroup I2S_Exported_Types I2S Exported Types
\r
63 * @brief I2S Init structure definition
\r
67 uint32_t Mode; /*!< Specifies the I2S operating mode.
\r
68 This parameter can be a value of @ref I2S_Mode */
\r
70 uint32_t Standard; /*!< Specifies the standard used for the I2S communication.
\r
71 This parameter can be a value of @ref I2S_Standard */
\r
73 uint32_t DataFormat; /*!< Specifies the data format for the I2S communication.
\r
74 This parameter can be a value of @ref I2S_Data_Format */
\r
76 uint32_t MCLKOutput; /*!< Specifies whether the I2S MCLK output is enabled or not.
\r
77 This parameter can be a value of @ref I2S_MCLK_Output */
\r
79 uint32_t AudioFreq; /*!< Specifies the frequency selected for the I2S communication.
\r
80 This parameter can be a value of @ref I2S_Audio_Frequency */
\r
82 uint32_t CPOL; /*!< Specifies the idle state of the I2S clock.
\r
83 This parameter can be a value of @ref I2S_Clock_Polarity */
\r
85 uint32_t ClockSource; /*!< Specifies the I2S Clock Source.
\r
86 This parameter can be a value of @ref I2S_Clock_Source */
\r
90 * @brief HAL State structures definition
\r
94 HAL_I2S_STATE_RESET = 0x00, /*!< I2S not yet initialized or disabled */
\r
95 HAL_I2S_STATE_READY = 0x01, /*!< I2S initialized and ready for use */
\r
96 HAL_I2S_STATE_BUSY = 0x02, /*!< I2S internal process is ongoing */
\r
97 HAL_I2S_STATE_BUSY_TX = 0x03, /*!< Data Transmission process is ongoing */
\r
98 HAL_I2S_STATE_BUSY_RX = 0x04, /*!< Data Reception process is ongoing */
\r
99 HAL_I2S_STATE_BUSY_TX_RX = 0x05, /*!< Data Transmission and Reception process is ongoing */
\r
100 HAL_I2S_STATE_TIMEOUT = 0x06, /*!< I2S timeout state */
\r
101 HAL_I2S_STATE_ERROR = 0x07 /*!< I2S error state */
\r
103 }HAL_I2S_StateTypeDef;
\r
106 * @brief I2S handle Structure definition
\r
110 SPI_TypeDef *Instance; /* I2S registers base address */
\r
112 I2S_InitTypeDef Init; /* I2S communication parameters */
\r
114 uint16_t *pTxBuffPtr; /* Pointer to I2S Tx transfer buffer */
\r
116 __IO uint16_t TxXferSize; /* I2S Tx transfer size */
\r
118 __IO uint16_t TxXferCount; /* I2S Tx transfer Counter */
\r
120 uint16_t *pRxBuffPtr; /* Pointer to I2S Rx transfer buffer */
\r
122 __IO uint16_t RxXferSize; /* I2S Rx transfer size */
\r
124 __IO uint16_t RxXferCount; /* I2S Rx transfer counter
\r
125 (This field is initialized at the
\r
126 same value as transfer size at the
\r
127 beginning of the transfer and
\r
128 decremented when a sample is received.
\r
129 NbSamplesReceived = RxBufferSize-RxBufferCount) */
\r
131 DMA_HandleTypeDef *hdmatx; /* I2S Tx DMA handle parameters */
\r
133 DMA_HandleTypeDef *hdmarx; /* I2S Rx DMA handle parameters */
\r
135 __IO HAL_LockTypeDef Lock; /* I2S locking object */
\r
137 __IO HAL_I2S_StateTypeDef State; /* I2S communication state */
\r
139 __IO uint32_t ErrorCode; /* I2S Error code */
\r
141 }I2S_HandleTypeDef;
\r
146 /* Exported constants --------------------------------------------------------*/
\r
147 /** @defgroup I2S_Exported_Constants I2S Exported Constants
\r
151 /** @defgroup I2S_Error_Defintion I2S_Error_Defintion
\r
152 *@brief I2S Error Code
\r
155 #define HAL_I2S_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
\r
156 #define HAL_I2S_ERROR_TIMEOUT ((uint32_t)0x00000001) /*!< Timeout error */
\r
157 #define HAL_I2S_ERROR_OVR ((uint32_t)0x00000002) /*!< OVR error */
\r
158 #define HAL_I2S_ERROR_UDR ((uint32_t)0x00000004) /*!< UDR error */
\r
159 #define HAL_I2S_ERROR_DMA ((uint32_t)0x00000008) /*!< DMA transfer error */
\r
160 #define HAL_I2S_ERROR_UNKNOW ((uint32_t)0x00000010) /*!< Unknow Error error */
\r
165 /** @defgroup I2S_Clock_Source I2S Clock Source
\r
168 #define I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001)
\r
169 #define I2S_CLOCK_SYSCLK ((uint32_t)0x00000002)
\r
174 /** @defgroup I2S_Mode I2S Mode
\r
177 #define I2S_MODE_SLAVE_TX ((uint32_t)0x00000000)
\r
178 #define I2S_MODE_SLAVE_RX ((uint32_t)0x00000100)
\r
179 #define I2S_MODE_MASTER_TX ((uint32_t)0x00000200)
\r
180 #define I2S_MODE_MASTER_RX ((uint32_t)0x00000300)
\r
185 /** @defgroup I2S_Standard I2S Standard
\r
188 #define I2S_STANDARD_PHILIPS ((uint32_t)0x00000000)
\r
189 #define I2S_STANDARD_MSB ((uint32_t)0x00000010)
\r
190 #define I2S_STANDARD_LSB ((uint32_t)0x00000020)
\r
191 #define I2S_STANDARD_PCM_SHORT ((uint32_t)0x00000030)
\r
192 #define I2S_STANDARD_PCM_LONG ((uint32_t)0x000000B0)
\r
197 /** @defgroup I2S_Data_Format I2S Data Format
\r
200 #define I2S_DATAFORMAT_16B ((uint32_t)0x00000000)
\r
201 #define I2S_DATAFORMAT_16B_EXTENDED ((uint32_t)0x00000001)
\r
202 #define I2S_DATAFORMAT_24B ((uint32_t)0x00000003)
\r
203 #define I2S_DATAFORMAT_32B ((uint32_t)0x00000005)
\r
208 /** @defgroup I2S_MCLK_Output I2S Mclk Output
\r
211 #define I2S_MCLKOUTPUT_ENABLE ((uint32_t)SPI_I2SPR_MCKOE)
\r
212 #define I2S_MCLKOUTPUT_DISABLE ((uint32_t)0x00000000)
\r
217 /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
\r
220 #define I2S_AUDIOFREQ_192K ((uint32_t)192000)
\r
221 #define I2S_AUDIOFREQ_96K ((uint32_t)96000)
\r
222 #define I2S_AUDIOFREQ_48K ((uint32_t)48000)
\r
223 #define I2S_AUDIOFREQ_44K ((uint32_t)44100)
\r
224 #define I2S_AUDIOFREQ_32K ((uint32_t)32000)
\r
225 #define I2S_AUDIOFREQ_22K ((uint32_t)22050)
\r
226 #define I2S_AUDIOFREQ_16K ((uint32_t)16000)
\r
227 #define I2S_AUDIOFREQ_11K ((uint32_t)11025)
\r
228 #define I2S_AUDIOFREQ_8K ((uint32_t)8000)
\r
229 #define I2S_AUDIOFREQ_DEFAULT ((uint32_t)2)
\r
235 /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
\r
238 #define I2S_CPOL_LOW ((uint32_t)0x00000000)
\r
239 #define I2S_CPOL_HIGH ((uint32_t)SPI_I2SCFGR_CKPOL)
\r
244 /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
\r
247 #define I2S_IT_TXE SPI_CR2_TXEIE
\r
248 #define I2S_IT_RXNE SPI_CR2_RXNEIE
\r
249 #define I2S_IT_ERR SPI_CR2_ERRIE
\r
254 /** @defgroup I2S_Flags_Definition I2S Flags Definition
\r
257 #define I2S_FLAG_TXE SPI_SR_TXE
\r
258 #define I2S_FLAG_RXNE SPI_SR_RXNE
\r
260 #define I2S_FLAG_UDR SPI_SR_UDR
\r
261 #define I2S_FLAG_OVR SPI_SR_OVR
\r
262 #define I2S_FLAG_FRE SPI_SR_FRE
\r
264 #define I2S_FLAG_CHSIDE SPI_SR_CHSIDE
\r
265 #define I2S_FLAG_BSY SPI_SR_BSY
\r
274 /* Exported macros -----------------------------------------------------------*/
\r
275 /** @defgroup I2S_Exported_Macros I2S Exported Macros
\r
279 /** @brief Reset I2S handle state
\r
280 * @param __HANDLE__: specifies the I2S handle.
\r
283 #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
\r
285 /** @brief Enable or disable the specified SPI peripheral (in I2S mode).
\r
286 * @param __HANDLE__: specifies the I2S Handle.
\r
289 #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
\r
290 #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
\r
292 /** @brief Enable or disable the specified I2S interrupts.
\r
293 * @param __HANDLE__: specifies the I2S Handle.
\r
294 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
\r
295 * This parameter can be one of the following values:
\r
296 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
\r
297 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
\r
298 * @arg I2S_IT_ERR: Error interrupt enable
\r
301 #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
\r
302 #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= ~(__INTERRUPT__))
\r
304 /** @brief Checks if the specified I2S interrupt source is enabled or disabled.
\r
305 * @param __HANDLE__: specifies the I2S Handle.
\r
306 * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
\r
307 * @param __INTERRUPT__: specifies the I2S interrupt source to check.
\r
308 * This parameter can be one of the following values:
\r
309 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
\r
310 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
\r
311 * @arg I2S_IT_ERR: Error interrupt enable
\r
312 * @retval The new state of __IT__ (TRUE or FALSE).
\r
314 #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
\r
316 /** @brief Checks whether the specified I2S flag is set or not.
\r
317 * @param __HANDLE__: specifies the I2S Handle.
\r
318 * @param __FLAG__: specifies the flag to check.
\r
319 * This parameter can be one of the following values:
\r
320 * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
\r
321 * @arg I2S_FLAG_TXE: Transmit buffer empty flag
\r
322 * @arg I2S_FLAG_UDR: Underrun flag
\r
323 * @arg I2S_FLAG_OVR: Overrun flag
\r
324 * @arg I2S_FLAG_FRE: Frame error flag
\r
325 * @arg I2S_FLAG_CHSIDE: Channel Side flag
\r
326 * @arg I2S_FLAG_BSY: Busy flag
\r
327 * @retval The new state of __FLAG__ (TRUE or FALSE).
\r
329 #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
\r
331 /** @brief Clears the I2S OVR pending flag.
\r
332 * @param __HANDLE__: specifies the I2S Handle.
\r
335 #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) \
\r
337 __IO uint32_t tmpreg; \
\r
338 tmpreg = (__HANDLE__)->Instance->DR; \
\r
339 tmpreg = (__HANDLE__)->Instance->SR; \
\r
343 /** @brief Clears the I2S UDR pending flag.
\r
344 * @param __HANDLE__: specifies the I2S Handle.
\r
347 #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) \
\r
349 __IO uint32_t tmpreg; \
\r
350 tmpreg = (__HANDLE__)->Instance->SR; \
\r
357 /* Exported functions --------------------------------------------------------*/
\r
358 /** @addtogroup I2S_Exported_Functions I2S Exported Functions
\r
362 /** @addtogroup I2S_Exported_Functions_Group1 Initialization and de-initialization functions
\r
366 /* Initialization and de-initialization functions *****************************/
\r
367 HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
\r
368 HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
\r
369 void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
\r
370 void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
\r
375 /** @addtogroup I2S_Exported_Functions_Group2 Input and Output operation functions
\r
378 /* I/O operation functions ***************************************************/
\r
379 /* Blocking mode: Polling */
\r
380 HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
\r
381 HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
\r
383 /* Non-Blocking mode: Interrupt */
\r
384 HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
\r
385 HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
\r
386 void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
\r
388 /* Non-Blocking mode: DMA */
\r
389 HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
\r
390 HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
\r
392 HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
\r
393 HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
\r
394 HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
\r
396 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
\r
397 void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
\r
398 void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
\r
399 void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
\r
400 void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
\r
401 void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
\r
406 /** @addtogroup I2S_Exported_Functions_Group3 Peripheral State and Errors functions
\r
409 /* Peripheral Control and State functions ************************************/
\r
410 HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
\r
411 uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
\r
421 /* Private types -------------------------------------------------------------*/
\r
422 /* Private variables ---------------------------------------------------------*/
\r
423 /* Private constants ---------------------------------------------------------*/
\r
424 /** @defgroup I2S_Private_Constants I2S Private Constants
\r
432 /* Private macros ------------------------------------------------------------*/
\r
433 /** @defgroup I2S_Private_Macros I2S Private Macros
\r
436 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) || \
\r
437 ((CLOCK) == I2S_CLOCK_SYSCLK))
\r
439 #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX) || \
\r
440 ((MODE) == I2S_MODE_SLAVE_RX) || \
\r
441 ((MODE) == I2S_MODE_MASTER_TX)|| \
\r
442 ((MODE) == I2S_MODE_MASTER_RX))
\r
444 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS) || \
\r
445 ((STANDARD) == I2S_STANDARD_MSB) || \
\r
446 ((STANDARD) == I2S_STANDARD_LSB) || \
\r
447 ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
\r
448 ((STANDARD) == I2S_STANDARD_PCM_LONG))
\r
450 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B) || \
\r
451 ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
\r
452 ((FORMAT) == I2S_DATAFORMAT_24B) || \
\r
453 ((FORMAT) == I2S_DATAFORMAT_32B))
\r
455 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
\r
456 ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
\r
458 #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
\r
459 ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
\r
460 ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
\r
462 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
\r
463 ((CPOL) == I2S_CPOL_HIGH))
\r
481 #endif /* __STM32F7xx_HAL_I2S_H */
\r
483 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
\r