Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F334R8/stm32f3xx_hal_i2s_ex.h@92:4fc01daae5a5, 2014-11-27 (annotated)

Committer:
bogdanm
Date:
Thu Nov 27 13:33:22 2014 +0000
Revision:
92:4fc01daae5a5
Parent:
86:04dd9b1680ae 
Release 92 of the mbed libray



Main changes:



- nRF51822: fixed pin assignment issues

- ST targets moving to the STM32Cube driver

- LPC1439: fixed serial interrupt issue

- first Cortex-A platform supported in mbed (RZ_A1H)

Who changed what in which revision?

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