Stuart Northfield / mbed-src

mbed library sources

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_DISCO_F334C8/stm32f3xx_hal_i2s_ex.h@381:5460fc57b6e4, 2014-11-03 (annotated)

Committer:
mbed_official
Date:
Mon Nov 03 10:30:07 2014 +0000
Revision:
381:5460fc57b6e4
Synchronized with git revision 02478cd1f27fc7b9643486472635eb515b2bca81



Full URL: https://github.com/mbedmicro/mbed/commit/02478cd1f27fc7b9643486472635eb515b2bca81/



Target: LPC1549 - Fix serial interrupt issues (issue report #616)

Who changed what in which revision?

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