Flotsam / mbed-modifed

Modified version of the mbed library for use with the Nucleo boards.

Dependents:   EEPROMWrite Full-Project

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_i2s_ex.h@634:ac7d6880524d, 2015-09-28 (annotated)

Committer:
mbed_official
Date:
Mon Sep 28 20:15:09 2015 +0100
Revision:
634:ac7d6880524d
Parent:
632:7687fb9c4f91 
Synchronized with git revision 9b7d23d47153c298a6d24de9a415202705889d11



Full URL: https://github.com/mbedmicro/mbed/commit/9b7d23d47153c298a6d24de9a415202705889d11/



Revert "[NUCLEO_F303K8] add support of the STM32F303K8"

Who changed what in which revision?

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