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_F334R8/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_i2s_ex.h@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
135:176b8275d35d 
Release 143 of the mbed library.

Who changed what in which revision?

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