Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_DISCO_F334C8/stm32f3xx_hal_i2s_ex.h@100:cbbeb26dbd92, 2015-05-27 (annotated)

Committer:
Kojto
Date:
Wed May 27 08:07:35 2015 +0100
Revision:
100:cbbeb26dbd92
Release 100 of the mbed library



Changes:

 - new  target: DISCOF334C8

 - API: Ticker/Timer bugfix with constness

 - Silabs: RTC, PWM, Serial clocks bufixes

 - Renesas: i2c bugfix

 - Maxim: 326000 - pin definitions for v2, spi freq fix

Who changed what in which revision?

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