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_NUCLEO_F303RE/TOOLCHAIN_ARM_MICRO/stm32f3xx_hal_i2s_ex.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_DISCO_F303VC/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_i2s_ex.h@168:b9e159c1930a 
mbed library. Release version 164

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