Elijah Orr / mbed-renbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F303K8/stm32f3xx_hal_i2s_ex.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
109:9296ab0bfc11 
.

Who changed what in which revision?

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