mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_DISCO_F303VC/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_i2s_ex.h@163:e59c8e839560, 2018-03-20 (annotated)

Committer:
AnnaBridge
Date:
Tue Mar 20 13:30:58 2018 +0000
Revision:
163:e59c8e839560
Child:
168:b9e159c1930a
mbed library. Release version 160

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 163:e59c8e839560 1 /**
AnnaBridge 163:e59c8e839560 2 ******************************************************************************
AnnaBridge 163:e59c8e839560 3 * @file stm32f3xx_hal_i2s_ex.h
AnnaBridge 163:e59c8e839560 4 * @author MCD Application Team
AnnaBridge 163:e59c8e839560 5 * @version V1.4.0
AnnaBridge 163:e59c8e839560 6 * @date 16-December-2016
AnnaBridge 163:e59c8e839560 7 * @brief Header file of I2S HAL Extended module.
AnnaBridge 163:e59c8e839560 8 ******************************************************************************
AnnaBridge 163:e59c8e839560 9 * @attention
AnnaBridge 163:e59c8e839560 10 *
AnnaBridge 163:e59c8e839560 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
AnnaBridge 163:e59c8e839560 12 *
AnnaBridge 163:e59c8e839560 13 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 163:e59c8e839560 14 * are permitted provided that the following conditions are met:
AnnaBridge 163:e59c8e839560 15 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 163:e59c8e839560 16 * this list of conditions and the following disclaimer.
AnnaBridge 163:e59c8e839560 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 163:e59c8e839560 18 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 163:e59c8e839560 19 * and/or other materials provided with the distribution.
AnnaBridge 163:e59c8e839560 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 163:e59c8e839560 21 * may be used to endorse or promote products derived from this software
AnnaBridge 163:e59c8e839560 22 * without specific prior written permission.
AnnaBridge 163:e59c8e839560 23 *
AnnaBridge 163:e59c8e839560 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 163:e59c8e839560 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 163:e59c8e839560 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 163:e59c8e839560 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 163:e59c8e839560 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 163:e59c8e839560 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 163:e59c8e839560 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 163:e59c8e839560 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 163:e59c8e839560 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 163:e59c8e839560 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 163:e59c8e839560 34 *
AnnaBridge 163:e59c8e839560 35 ******************************************************************************
AnnaBridge 163:e59c8e839560 36 */
AnnaBridge 163:e59c8e839560 37
AnnaBridge 163:e59c8e839560 38 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 163:e59c8e839560 39 #ifndef __STM32F3xx_HAL_I2S_EX_H
AnnaBridge 163:e59c8e839560 40 #define __STM32F3xx_HAL_I2S_EX_H
AnnaBridge 163:e59c8e839560 41
AnnaBridge 163:e59c8e839560 42 #ifdef __cplusplus
AnnaBridge 163:e59c8e839560 43 extern "C" {
AnnaBridge 163:e59c8e839560 44 #endif
AnnaBridge 163:e59c8e839560 45
AnnaBridge 163:e59c8e839560 46 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \
AnnaBridge 163:e59c8e839560 47 defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
AnnaBridge 163:e59c8e839560 48 defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) || \
AnnaBridge 163:e59c8e839560 49 defined(STM32F373xC) || defined(STM32F378xx)
AnnaBridge 163:e59c8e839560 50
AnnaBridge 163:e59c8e839560 51 /* Includes ------------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 52 #include "stm32f3xx_hal_def.h"
AnnaBridge 163:e59c8e839560 53
AnnaBridge 163:e59c8e839560 54 /** @addtogroup STM32F3xx_HAL_Driver
AnnaBridge 163:e59c8e839560 55 * @{
AnnaBridge 163:e59c8e839560 56 */
AnnaBridge 163:e59c8e839560 57
AnnaBridge 163:e59c8e839560 58 /** @addtogroup I2SEx I2SEx
AnnaBridge 163:e59c8e839560 59 * @{
AnnaBridge 163:e59c8e839560 60 */
AnnaBridge 163:e59c8e839560 61
AnnaBridge 163:e59c8e839560 62 /* Exported types ------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 63 /* Exported constants --------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 64 /* Exported macros ------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 65 /** @defgroup I2SEx_Exported_Macros I2S Extended Exported Macros
AnnaBridge 163:e59c8e839560 66 * @{
AnnaBridge 163:e59c8e839560 67 */
AnnaBridge 163:e59c8e839560 68 #if defined(SPI_I2S_FULLDUPLEX_SUPPORT)
AnnaBridge 163:e59c8e839560 69 #define I2SxEXT(__INSTANCE__) ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE))
AnnaBridge 163:e59c8e839560 70
AnnaBridge 163:e59c8e839560 71 /** @brief Enable or disable the specified I2SExt peripheral.
AnnaBridge 163:e59c8e839560 72 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 163:e59c8e839560 73 * @retval None
AnnaBridge 163:e59c8e839560 74 */
AnnaBridge 163:e59c8e839560 75 #define __HAL_I2SEXT_ENABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR |= SPI_I2SCFGR_I2SE)
AnnaBridge 163:e59c8e839560 76 #define __HAL_I2SEXT_DISABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
AnnaBridge 163:e59c8e839560 77
AnnaBridge 163:e59c8e839560 78 /** @brief Enable or disable the specified I2SExt interrupts.
AnnaBridge 163:e59c8e839560 79 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 163:e59c8e839560 80 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
AnnaBridge 163:e59c8e839560 81 * This parameter can be one of the following values:
AnnaBridge 163:e59c8e839560 82 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
AnnaBridge 163:e59c8e839560 83 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
AnnaBridge 163:e59c8e839560 84 * @arg I2S_IT_ERR: Error interrupt enable
AnnaBridge 163:e59c8e839560 85 * @retval None
AnnaBridge 163:e59c8e839560 86 */
AnnaBridge 163:e59c8e839560 87 #define __HAL_I2SEXT_ENABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 |= (__INTERRUPT__))
AnnaBridge 163:e59c8e839560 88 #define __HAL_I2SEXT_DISABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 &= ~(__INTERRUPT__))
AnnaBridge 163:e59c8e839560 89
AnnaBridge 163:e59c8e839560 90 /** @brief Checks if the specified I2SExt interrupt source is enabled or disabled.
AnnaBridge 163:e59c8e839560 91 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 163:e59c8e839560 92 * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
AnnaBridge 163:e59c8e839560 93 * @param __INTERRUPT__: specifies the I2S interrupt source to check.
AnnaBridge 163:e59c8e839560 94 * This parameter can be one of the following values:
AnnaBridge 163:e59c8e839560 95 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
AnnaBridge 163:e59c8e839560 96 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
AnnaBridge 163:e59c8e839560 97 * @arg I2S_IT_ERR: Error interrupt enable
AnnaBridge 163:e59c8e839560 98 * @retval The new state of __IT__ (TRUE or FALSE).
AnnaBridge 163:e59c8e839560 99 */
AnnaBridge 163:e59c8e839560 100 #define __HAL_I2SEXT_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((I2SxEXT((__HANDLE__)->Instance)->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
AnnaBridge 163:e59c8e839560 101
AnnaBridge 163:e59c8e839560 102 /** @brief Checks whether the specified I2SExt flag is set or not.
AnnaBridge 163:e59c8e839560 103 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 163:e59c8e839560 104 * @param __FLAG__: specifies the flag to check.
AnnaBridge 163:e59c8e839560 105 * This parameter can be one of the following values:
AnnaBridge 163:e59c8e839560 106 * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
AnnaBridge 163:e59c8e839560 107 * @arg I2S_FLAG_TXE: Transmit buffer empty flag
AnnaBridge 163:e59c8e839560 108 * @arg I2S_FLAG_UDR: Underrun flag
AnnaBridge 163:e59c8e839560 109 * @arg I2S_FLAG_OVR: Overrun flag
AnnaBridge 163:e59c8e839560 110 * @arg I2S_FLAG_FRE: Frame error flag
AnnaBridge 163:e59c8e839560 111 * @arg I2S_FLAG_CHSIDE: Channel Side flag
AnnaBridge 163:e59c8e839560 112 * @arg I2S_FLAG_BSY: Busy flag
AnnaBridge 163:e59c8e839560 113 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 163:e59c8e839560 114 */
AnnaBridge 163:e59c8e839560 115 #define __HAL_I2SEXT_GET_FLAG(__HANDLE__, __FLAG__) (((I2SxEXT((__HANDLE__)->Instance)->SR) & (__FLAG__)) == (__FLAG__))
AnnaBridge 163:e59c8e839560 116
AnnaBridge 163:e59c8e839560 117 /** @brief Clears the I2SExt OVR pending flag.
AnnaBridge 163:e59c8e839560 118 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 163:e59c8e839560 119 * @retval None
AnnaBridge 163:e59c8e839560 120 */
AnnaBridge 163:e59c8e839560 121 #define __HAL_I2SEXT_CLEAR_OVRFLAG(__HANDLE__) do{(I2SxEXT((__HANDLE__)->Instance)->DR;\
AnnaBridge 163:e59c8e839560 122 (I2SxEXT((__HANDLE__)->Instance)->SR;}while(0U)
AnnaBridge 163:e59c8e839560 123 /** @brief Clears the I2SExt UDR pending flag.
AnnaBridge 163:e59c8e839560 124 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 163:e59c8e839560 125 * @retval None
AnnaBridge 163:e59c8e839560 126 */
AnnaBridge 163:e59c8e839560 127 #define __HAL_I2SEXT_CLEAR_UDRFLAG(__HANDLE__)(I2SxEXT((__HANDLE__)->Instance)->SR)
AnnaBridge 163:e59c8e839560 128 #endif /* SPI_I2S_FULLDUPLEX_SUPPORT */
AnnaBridge 163:e59c8e839560 129 /**
AnnaBridge 163:e59c8e839560 130 * @}
AnnaBridge 163:e59c8e839560 131 */
AnnaBridge 163:e59c8e839560 132
AnnaBridge 163:e59c8e839560 133
AnnaBridge 163:e59c8e839560 134 /* Exported functions --------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 135 /* Initialization/de-initialization functions ********************************/
AnnaBridge 163:e59c8e839560 136 /** @addtogroup I2SEx_Exported_Functions I2S Extended Exported Functions
AnnaBridge 163:e59c8e839560 137 * @{
AnnaBridge 163:e59c8e839560 138 */
AnnaBridge 163:e59c8e839560 139
AnnaBridge 163:e59c8e839560 140 #if defined(SPI_I2S_FULLDUPLEX_SUPPORT)
AnnaBridge 163:e59c8e839560 141 /** @addtogroup I2SEx_Exported_Functions_Group1 I2S Extended Features Functions
AnnaBridge 163:e59c8e839560 142 * @{
AnnaBridge 163:e59c8e839560 143 */
AnnaBridge 163:e59c8e839560 144
AnnaBridge 163:e59c8e839560 145 /* Extended features functions ************************************************/
AnnaBridge 163:e59c8e839560 146 /* Blocking mode: Polling */
AnnaBridge 163:e59c8e839560 147 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size, uint32_t Timeout);
AnnaBridge 163:e59c8e839560 148 /* Non-Blocking mode: Interrupt */
AnnaBridge 163:e59c8e839560 149 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
AnnaBridge 163:e59c8e839560 150 /* Non-Blocking mode: DMA */
AnnaBridge 163:e59c8e839560 151 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
AnnaBridge 163:e59c8e839560 152 /**
AnnaBridge 163:e59c8e839560 153 * @}
AnnaBridge 163:e59c8e839560 154 */
AnnaBridge 163:e59c8e839560 155 #endif /* SPI_I2S_FULLDUPLEX_SUPPORT */
AnnaBridge 163:e59c8e839560 156
AnnaBridge 163:e59c8e839560 157 /**
AnnaBridge 163:e59c8e839560 158 * @}
AnnaBridge 163:e59c8e839560 159 */
AnnaBridge 163:e59c8e839560 160
AnnaBridge 163:e59c8e839560 161 /**
AnnaBridge 163:e59c8e839560 162 * @}
AnnaBridge 163:e59c8e839560 163 */
AnnaBridge 163:e59c8e839560 164
AnnaBridge 163:e59c8e839560 165 /** @addtogroup I2S I2S
AnnaBridge 163:e59c8e839560 166 * @{
AnnaBridge 163:e59c8e839560 167 */
AnnaBridge 163:e59c8e839560 168
AnnaBridge 163:e59c8e839560 169 /** @addtogroup I2S_Exported_Functions I2S Exported Functions
AnnaBridge 163:e59c8e839560 170 * @{
AnnaBridge 163:e59c8e839560 171 */
AnnaBridge 163:e59c8e839560 172 #if defined(SPI_I2S_FULLDUPLEX_SUPPORT)
AnnaBridge 163:e59c8e839560 173 /** @addtogroup I2S_Exported_Functions_Group2 IO operation functions
AnnaBridge 163:e59c8e839560 174 * @{
AnnaBridge 163:e59c8e839560 175 */
AnnaBridge 163:e59c8e839560 176 /* I2S IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
AnnaBridge 163:e59c8e839560 177 void HAL_I2S_FullDuplex_IRQHandler(I2S_HandleTypeDef *hi2s);
AnnaBridge 163:e59c8e839560 178 void HAL_I2S_TxRxCpltCallback(I2S_HandleTypeDef *hi2s);
AnnaBridge 163:e59c8e839560 179 /**
AnnaBridge 163:e59c8e839560 180 * @}
AnnaBridge 163:e59c8e839560 181 */
AnnaBridge 163:e59c8e839560 182 #endif /* SPI_I2S_FULLDUPLEX_SUPPORT */
AnnaBridge 163:e59c8e839560 183
AnnaBridge 163:e59c8e839560 184 /** @addtogroup I2S_Exported_Functions_Group3 Peripheral State and Errors functions
AnnaBridge 163:e59c8e839560 185 * @{
AnnaBridge 163:e59c8e839560 186 */
AnnaBridge 163:e59c8e839560 187 /* Peripheral Control and State functions ************************************/
AnnaBridge 163:e59c8e839560 188 HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
AnnaBridge 163:e59c8e839560 189 HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
AnnaBridge 163:e59c8e839560 190 HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
AnnaBridge 163:e59c8e839560 191
AnnaBridge 163:e59c8e839560 192 /**
AnnaBridge 163:e59c8e839560 193 * @}
AnnaBridge 163:e59c8e839560 194 */
AnnaBridge 163:e59c8e839560 195
AnnaBridge 163:e59c8e839560 196 /**
AnnaBridge 163:e59c8e839560 197 * @}
AnnaBridge 163:e59c8e839560 198 */
AnnaBridge 163:e59c8e839560 199
AnnaBridge 163:e59c8e839560 200 /**
AnnaBridge 163:e59c8e839560 201 * @}
AnnaBridge 163:e59c8e839560 202 */
AnnaBridge 163:e59c8e839560 203
AnnaBridge 163:e59c8e839560 204 /**
AnnaBridge 163:e59c8e839560 205 * @}
AnnaBridge 163:e59c8e839560 206 */
AnnaBridge 163:e59c8e839560 207 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
AnnaBridge 163:e59c8e839560 208 /* STM32F302xC || STM32F303xC || STM32F358xx || */
AnnaBridge 163:e59c8e839560 209 /* STM32F301x8 || STM32F302x8 || STM32F318xx || */
AnnaBridge 163:e59c8e839560 210 /* STM32F373xC || STM32F378xx */
AnnaBridge 163:e59c8e839560 211
AnnaBridge 163:e59c8e839560 212 #ifdef __cplusplus
AnnaBridge 163:e59c8e839560 213 }
AnnaBridge 163:e59c8e839560 214 #endif
AnnaBridge 163:e59c8e839560 215
AnnaBridge 163:e59c8e839560 216
AnnaBridge 163:e59c8e839560 217 #endif /* __STM32F3xx_HAL_I2S_EX_H */
AnnaBridge 163:e59c8e839560 218
AnnaBridge 163:e59c8e839560 219 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/