tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_i2s_ex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_i2s_ex.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-2014
   7   * @brief   Header file of I2S HAL Extended module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  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.
  23   *
  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.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F3xx_HAL_I2S_EX_H
  40 #define __STM32F3xx_HAL_I2S_EX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  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)
  50
  51 /* Includes ------------------------------------------------------------------*/
  52 #include "stm32f3xx_hal_def.h"
  53
  54 /** @addtogroup STM32F3xx_HAL_Driver
  55   * @{
  56   */
  57
  58 /** @addtogroup I2SEx I2S Extended HAL module driver
  59   * @{
  60   */
  61
  62 /* Exported types ------------------------------------------------------------*/
  63 /* Exported constants --------------------------------------------------------*/
  64 /* Exported macros ------------------------------------------------------------*/
  65 /** @defgroup I2SEx_Exported_Macros I2S Extended Exported Macros
  66   * @{
  67   */
  68 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \
  69     defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx)
  70 #define I2SxEXT(__INSTANCE__) ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE))
  71
  72 /** @brief  Enable or disable the specified I2SExt peripheral.
  73   * @param  __HANDLE__: specifies the I2S Handle.
  74   * @retval None
  75   */
  76 #define __HAL_I2SEXT_ENABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR |= SPI_I2SCFGR_I2SE)
  77 #define __HAL_I2SEXT_DISABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
  78
  79 /** @brief  Enable or disable the specified I2SExt interrupts.
  80   * @param  __HANDLE__: specifies the I2S Handle.
  81   * @param  __INTERRUPT__: specifies the interrupt source to enable or disable.
  82   *        This parameter can be one of the following values:
  83   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  84   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  85   *            @arg I2S_IT_ERR: Error interrupt enable
  86   * @retval None
  87   */
  88 #define __HAL_I2SEXT_ENABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 |= (__INTERRUPT__))
  89 #define __HAL_I2SEXT_DISABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 &= ~(__INTERRUPT__))
  90
  91 /** @brief  Checks if the specified I2SExt interrupt source is enabled or disabled.
  92   * @param  __HANDLE__: specifies the I2S Handle.
  93   *         This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
  94   * @param  __INTERRUPT__: specifies the I2S interrupt source to check.
  95   *          This parameter can be one of the following values:
  96   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  97   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  98   *            @arg I2S_IT_ERR: Error interrupt enable
  99   * @retval The new state of __IT__ (TRUE or FALSE).
 100   */
 101 #define __HAL_I2SEXT_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((I2SxEXT((__HANDLE__)->Instance)->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
 102
 103 /** @brief  Checks whether the specified I2SExt flag is set or not.
 104   * @param  __HANDLE__: specifies the I2S Handle.
 105   * @param  __FLAG__: specifies the flag to check.
 106   *        This parameter can be one of the following values:
 107   *            @arg I2S_FLAG_RXNE: Receive buffer not empty flag
 108   *            @arg I2S_FLAG_TXE: Transmit buffer empty flag
 109   *            @arg I2S_FLAG_UDR: Underrun flag
 110   *            @arg I2S_FLAG_OVR: Overrun flag
 111   *            @arg I2S_FLAG_FRE: Frame error flag
 112   *            @arg I2S_FLAG_CHSIDE: Channel Side flag
 113   *            @arg I2S_FLAG_BSY: Busy flag
 114   * @retval The new state of __FLAG__ (TRUE or FALSE).
 115   */
 116 #define __HAL_I2SEXT_GET_FLAG(__HANDLE__, __FLAG__) (((I2SxEXT((__HANDLE__)->Instance)->SR) & (__FLAG__)) == (__FLAG__))
 117
 118 /** @brief Clears the I2SExt OVR pending flag.
 119   * @param  __HANDLE__: specifies the I2S Handle.
 120   * @retval None
 121   */
 122 #define __HAL_I2SEXT_CLEAR_OVRFLAG(__HANDLE__) do{(I2SxEXT((__HANDLE__)->Instance)->DR;\
 123                                                   (I2SxEXT((__HANDLE__)->Instance)->SR;}while(0)
 124 /** @brief Clears the I2SExt UDR pending flag.
 125   * @param  __HANDLE__: specifies the I2S Handle.
 126   * @retval None
 127   */
 128 #define __HAL_I2SEXT_CLEAR_UDRFLAG(__HANDLE__)(I2SxEXT((__HANDLE__)->Instance)->SR)
 129 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
 130        /* STM32F302xC || STM32F303xC || STM32F358xx */
 131  /**
 132   * @}
 133   */
 134
 135
 136 /* Exported functions --------------------------------------------------------*/
 137 /* Initialization/de-initialization functions  ********************************/
 138 /** @addtogroup I2SEx_Exported_Functions I2S Extended Exported Functions
 139   * @{
 140   */
 141
 142 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \
 143     defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx)
 144 /** @addtogroup I2SEx_Exported_Functions_Group1 Extended features functions
 145   * @{
 146   */
 147
 148 /* Extended features functions ************************************************/
 149  /* Blocking mode: Polling */
 150 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size, uint32_t Timeout);
 151 /* Non-Blocking mode: Interrupt */
 152 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
 153 /* Non-Blocking mode: DMA */
 154 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
 155 /**
 156   * @}
 157   */
 158 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
 159        /* STM32F302xC || STM32F303xC || STM32F358xx */
 160
 161 /**
 162   * @}
 163   */
 164
 165 /**
 166   * @}
 167   */
 168
 169 /** @addtogroup I2S I2S HAL module driver
 170   * @{
 171   */
 172
 173 /** @addtogroup I2S_Exported_Functions I2S Exported Functions
 174   * @{
 175   */
 176 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \
 177     defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx)
 178 /** @addtogroup  I2S_Exported_Functions_Group2 Input and Output operation functions
 179   * @{
 180   */
 181 /* I2S IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
 182 void HAL_I2S_FullDuplex_IRQHandler(I2S_HandleTypeDef *hi2s);
 183 void HAL_I2S_TxRxCpltCallback(I2S_HandleTypeDef *hi2s);
 184 /**
 185   * @}
 186   */
 187 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
 188        /* STM32F302xC || STM32F303xC || STM32F358xx */
 189
 190 /** @addtogroup I2S_Exported_Functions_Group3 Peripheral State and Errors functions
 191   * @{
 192   */
 193 /* Peripheral Control and State functions  ************************************/
 194 HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
 195 HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
 196 HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
 197
 198 /**
 199   * @}
 200   */
 201
 202 /**
 203   * @}
 204   */
 205
 206 /**
 207   * @}
 208   */
 209
 210 /**
 211   * @}
 212   */
 213 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
 214        /* STM32F302xC || STM32F303xC || STM32F358xx || */
 215        /* STM32F301x8 || STM32F302x8 || STM32F318xx || */
 216        /* STM32F373xC || STM32F378xx                   */
 217
 218 #ifdef __cplusplus
 219 }
 220 #endif
 221
 222
 223 #endif /* __STM32F3xx_HAL_I2S_EX_H */
 224
 225 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/