| /** |
| ****************************************************************************** |
| * @file stm32f3xx_hal_i2s_ex.h |
| * @author MCD Application Team |
| * @brief Header file of I2S HAL Extended module. |
| ****************************************************************************** |
| * @attention |
| * |
| * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> |
| * |
| * Redistribution and use in source and binary forms, with or without modification, |
| * are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright notice, |
| * this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright notice, |
| * this list of conditions and the following disclaimer in the documentation |
| * and/or other materials provided with the distribution. |
| * 3. Neither the name of STMicroelectronics nor the names of its contributors |
| * may be used to endorse or promote products derived from this software |
| * without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| * |
| ****************************************************************************** |
| */ |
| |
| /* Define to prevent recursive inclusion -------------------------------------*/ |
| #ifndef __STM32F3xx_HAL_I2S_EX_H |
| #define __STM32F3xx_HAL_I2S_EX_H |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \ |
| defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \ |
| defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) || \ |
| defined(STM32F373xC) || defined(STM32F378xx) |
| |
| /* Includes ------------------------------------------------------------------*/ |
| #include "stm32f3xx_hal_def.h" |
| |
| /** @addtogroup STM32F3xx_HAL_Driver |
| * @{ |
| */ |
| |
| /** @addtogroup I2SEx I2SEx |
| * @{ |
| */ |
| |
| /* Exported types ------------------------------------------------------------*/ |
| /* Exported constants --------------------------------------------------------*/ |
| /* Exported macros ------------------------------------------------------------*/ |
| /** @defgroup I2SEx_Exported_Macros I2S Extended Exported Macros |
| * @{ |
| */ |
| #if defined(SPI_I2S_FULLDUPLEX_SUPPORT) |
| #define I2SxEXT(__INSTANCE__) ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE)) |
| |
| /** @brief Enable or disable the specified I2SExt peripheral. |
| * @param __HANDLE__ specifies the I2S Handle. |
| * @retval None |
| */ |
| #define __HAL_I2SEXT_ENABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR |= SPI_I2SCFGR_I2SE) |
| #define __HAL_I2SEXT_DISABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR &= ~SPI_I2SCFGR_I2SE) |
| |
| /** @brief Enable or disable the specified I2SExt interrupts. |
| * @param __HANDLE__ specifies the I2S Handle. |
| * @param __INTERRUPT__ specifies the interrupt source to enable or disable. |
| * This parameter can be one of the following values: |
| * @arg I2S_IT_TXE: Tx buffer empty interrupt enable |
| * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable |
| * @arg I2S_IT_ERR: Error interrupt enable |
| * @retval None |
| */ |
| #define __HAL_I2SEXT_ENABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 |= (__INTERRUPT__)) |
| #define __HAL_I2SEXT_DISABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 &= ~(__INTERRUPT__)) |
| |
| /** @brief Checks if the specified I2SExt interrupt source is enabled or disabled. |
| * @param __HANDLE__ specifies the I2S Handle. |
| * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral. |
| * @param __INTERRUPT__ specifies the I2S interrupt source to check. |
| * This parameter can be one of the following values: |
| * @arg I2S_IT_TXE: Tx buffer empty interrupt enable |
| * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable |
| * @arg I2S_IT_ERR: Error interrupt enable |
| * @retval The new state of __IT__ (TRUE or FALSE). |
| */ |
| #define __HAL_I2SEXT_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((I2SxEXT((__HANDLE__)->Instance)->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET) |
| |
| /** @brief Checks whether the specified I2SExt flag is set or not. |
| * @param __HANDLE__ specifies the I2S Handle. |
| * @param __FLAG__ specifies the flag to check. |
| * This parameter can be one of the following values: |
| * @arg I2S_FLAG_RXNE: Receive buffer not empty flag |
| * @arg I2S_FLAG_TXE: Transmit buffer empty flag |
| * @arg I2S_FLAG_UDR: Underrun flag |
| * @arg I2S_FLAG_OVR: Overrun flag |
| * @arg I2S_FLAG_FRE: Frame error flag |
| * @arg I2S_FLAG_CHSIDE: Channel Side flag |
| * @arg I2S_FLAG_BSY: Busy flag |
| * @retval The new state of __FLAG__ (TRUE or FALSE). |
| */ |
| #define __HAL_I2SEXT_GET_FLAG(__HANDLE__, __FLAG__) (((I2SxEXT((__HANDLE__)->Instance)->SR) & (__FLAG__)) == (__FLAG__)) |
| |
| /** @brief Clears the I2SExt OVR pending flag. |
| * @param __HANDLE__ specifies the I2S Handle. |
| * @retval None |
| */ |
| #define __HAL_I2SEXT_CLEAR_OVRFLAG(__HANDLE__) do{(I2SxEXT((__HANDLE__)->Instance)->DR;\ |
| (I2SxEXT((__HANDLE__)->Instance)->SR;}while(0U) |
| /** @brief Clears the I2SExt UDR pending flag. |
| * @param __HANDLE__ specifies the I2S Handle. |
| * @retval None |
| */ |
| #define __HAL_I2SEXT_CLEAR_UDRFLAG(__HANDLE__)(I2SxEXT((__HANDLE__)->Instance)->SR) |
| #endif /* SPI_I2S_FULLDUPLEX_SUPPORT */ |
| /** |
| * @} |
| */ |
| |
| |
| /* Exported functions --------------------------------------------------------*/ |
| /* Initialization/de-initialization functions ********************************/ |
| /** @addtogroup I2SEx_Exported_Functions I2S Extended Exported Functions |
| * @{ |
| */ |
| |
| #if defined(SPI_I2S_FULLDUPLEX_SUPPORT) |
| /** @addtogroup I2SEx_Exported_Functions_Group1 I2S Extended Features Functions |
| * @{ |
| */ |
| |
| /* Extended features functions ************************************************/ |
| /* Blocking mode: Polling */ |
| HAL_StatusTypeDef HAL_I2SEx_TransmitReceive(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size, uint32_t Timeout); |
| /* Non-Blocking mode: Interrupt */ |
| HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size); |
| /* Non-Blocking mode: DMA */ |
| HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size); |
| /** |
| * @} |
| */ |
| #endif /* SPI_I2S_FULLDUPLEX_SUPPORT */ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /** @addtogroup I2S I2S |
| * @{ |
| */ |
| |
| /** @addtogroup I2S_Exported_Functions I2S Exported Functions |
| * @{ |
| */ |
| #if defined(SPI_I2S_FULLDUPLEX_SUPPORT) |
| /** @addtogroup I2S_Exported_Functions_Group2 IO operation functions |
| * @{ |
| */ |
| /* I2S IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */ |
| void HAL_I2S_FullDuplex_IRQHandler(I2S_HandleTypeDef *hi2s); |
| void HAL_I2S_TxRxCpltCallback(I2S_HandleTypeDef *hi2s); |
| /* Callback used in non blocking modes (DMA only) */ |
| void HAL_I2S_TxRxHalfCpltCallback(I2S_HandleTypeDef *hi2s); |
| /** |
| * @} |
| */ |
| #endif /* SPI_I2S_FULLDUPLEX_SUPPORT */ |
| |
| /** @addtogroup I2S_Exported_Functions_Group3 Peripheral State and Errors functions |
| * @{ |
| */ |
| /* Peripheral Control and State functions ************************************/ |
| HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s); |
| HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s); |
| HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s); |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */ |
| /* STM32F302xC || STM32F303xC || STM32F358xx || */ |
| /* STM32F301x8 || STM32F302x8 || STM32F318xx || */ |
| /* STM32F373xC || STM32F378xx */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| |
| #endif /* __STM32F3xx_HAL_I2S_EX_H */ |
| |
| /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |