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_NUCLEO_F446RE/stm32f4xx_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:
110:165afa46840b 
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 106:ba1f97679dad 1 /**
Kojto 106:ba1f97679dad 2 ******************************************************************************
Kojto 106:ba1f97679dad 3 * @file stm32f4xx_hal_i2s_ex.h
Kojto 106:ba1f97679dad 4 * @author MCD Application Team
Kojto 110:165afa46840b 5 * @version V1.4.1
Kojto 110:165afa46840b 6 * @date 09-October-2015
Kojto 106:ba1f97679dad 7 * @brief Header file of I2S HAL module.
Kojto 106:ba1f97679dad 8 ******************************************************************************
Kojto 106:ba1f97679dad 9 * @attention
Kojto 106:ba1f97679dad 10 *
Kojto 106:ba1f97679dad 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 106:ba1f97679dad 12 *
Kojto 106:ba1f97679dad 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 106:ba1f97679dad 14 * are permitted provided that the following conditions are met:
Kojto 106:ba1f97679dad 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 106:ba1f97679dad 16 * this list of conditions and the following disclaimer.
Kojto 106:ba1f97679dad 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 106:ba1f97679dad 18 * this list of conditions and the following disclaimer in the documentation
Kojto 106:ba1f97679dad 19 * and/or other materials provided with the distribution.
Kojto 106:ba1f97679dad 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 106:ba1f97679dad 21 * may be used to endorse or promote products derived from this software
Kojto 106:ba1f97679dad 22 * without specific prior written permission.
Kojto 106:ba1f97679dad 23 *
Kojto 106:ba1f97679dad 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 106:ba1f97679dad 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 106:ba1f97679dad 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 106:ba1f97679dad 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 106:ba1f97679dad 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 106:ba1f97679dad 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 106:ba1f97679dad 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 106:ba1f97679dad 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 106:ba1f97679dad 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 106:ba1f97679dad 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 106:ba1f97679dad 34 *
Kojto 106:ba1f97679dad 35 ******************************************************************************
Kojto 106:ba1f97679dad 36 */
Kojto 106:ba1f97679dad 37
Kojto 106:ba1f97679dad 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 106:ba1f97679dad 39 #ifndef __STM32F4xx_HAL_I2S_EX_H
Kojto 106:ba1f97679dad 40 #define __STM32F4xx_HAL_I2S_EX_H
Kojto 106:ba1f97679dad 41
Kojto 106:ba1f97679dad 42 #ifdef __cplusplus
Kojto 106:ba1f97679dad 43 extern "C" {
Kojto 106:ba1f97679dad 44 #endif
Kojto 106:ba1f97679dad 45
Kojto 106:ba1f97679dad 46 /* Includes ------------------------------------------------------------------*/
Kojto 106:ba1f97679dad 47 #include "stm32f4xx_hal_def.h"
Kojto 106:ba1f97679dad 48
Kojto 106:ba1f97679dad 49 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 106:ba1f97679dad 50 * @{
Kojto 106:ba1f97679dad 51 */
Kojto 106:ba1f97679dad 52
Kojto 106:ba1f97679dad 53 /** @addtogroup I2SEx
Kojto 106:ba1f97679dad 54 * @{
Kojto 106:ba1f97679dad 55 */
Kojto 106:ba1f97679dad 56
Kojto 106:ba1f97679dad 57 /* Exported types ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 58 /** @defgroup I2SEx_Exported_Types I2S Exported Types
Kojto 106:ba1f97679dad 59 * @{
Kojto 106:ba1f97679dad 60 */
Kojto 106:ba1f97679dad 61 /**
Kojto 106:ba1f97679dad 62 * @}
Kojto 106:ba1f97679dad 63 */
Kojto 106:ba1f97679dad 64
Kojto 106:ba1f97679dad 65 /* Exported constants --------------------------------------------------------*/
Kojto 106:ba1f97679dad 66 /** @defgroup I2SEx_Exported_Constants I2S Exported Constants
Kojto 106:ba1f97679dad 67 * @{
Kojto 110:165afa46840b 68 */
Kojto 110:165afa46840b 69
Kojto 110:165afa46840b 70 /** @defgroup I2S_Clock_Source I2S Clock Source
Kojto 110:165afa46840b 71 * @{
Kojto 110:165afa46840b 72 */
Kojto 110:165afa46840b 73
Kojto 110:165afa46840b 74 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
Kojto 110:165afa46840b 75 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
Kojto 110:165afa46840b 76 defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F469xx) || \
Kojto 110:165afa46840b 77 defined(STM32F479xx)
Kojto 110:165afa46840b 78 #define I2S_CLOCK_PLL ((uint32_t)0x00000000)
Kojto 110:165afa46840b 79 #define I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001)
Kojto 110:165afa46840b 80 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
Kojto 110:165afa46840b 81 STM32F401xC || STM32F401xE || STM32F411xE || STM32F469xx || STM32F479xx */
Kojto 110:165afa46840b 82
Kojto 110:165afa46840b 83 #if defined(STM32F446xx)
Kojto 110:165afa46840b 84 #define I2S_CLOCK_PLL ((uint32_t)0x00000000)
Kojto 110:165afa46840b 85 #define I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001)
Kojto 110:165afa46840b 86 #define I2S_CLOCK_PLLR ((uint32_t)0x00000002)
Kojto 110:165afa46840b 87 #define I2S_CLOCK_PLLSRC ((uint32_t)0x00000003)
Kojto 110:165afa46840b 88 #endif /* STM32F446xx */
Kojto 110:165afa46840b 89
Kojto 110:165afa46840b 90 #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx)
Kojto 110:165afa46840b 91 #define I2S_CLOCK_PLLSRC ((uint32_t)0x00000000)
Kojto 110:165afa46840b 92 #define I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001)
Kojto 110:165afa46840b 93 #define I2S_CLOCK_PLLR ((uint32_t)0x00000002)
Kojto 110:165afa46840b 94 #endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx */
Kojto 110:165afa46840b 95 /**
Kojto 110:165afa46840b 96 * @}
Kojto 110:165afa46840b 97 */
Kojto 110:165afa46840b 98
Kojto 106:ba1f97679dad 99 /**
Kojto 106:ba1f97679dad 100 * @}
Kojto 106:ba1f97679dad 101 */
Kojto 106:ba1f97679dad 102
Kojto 106:ba1f97679dad 103 /* Exported macro ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 104 /** @defgroup I2SEx_Exported_Macros I2S Exported Macros
Kojto 106:ba1f97679dad 105 * @{
Kojto 106:ba1f97679dad 106 */
Kojto 106:ba1f97679dad 107
Kojto 106:ba1f97679dad 108 /**
Kojto 106:ba1f97679dad 109 * @}
Kojto 106:ba1f97679dad 110 */
Kojto 106:ba1f97679dad 111
Kojto 106:ba1f97679dad 112 /* Exported functions --------------------------------------------------------*/
Kojto 106:ba1f97679dad 113 /** @addtogroup I2SEx_Exported_Functions
Kojto 106:ba1f97679dad 114 * @{
Kojto 106:ba1f97679dad 115 */
Kojto 106:ba1f97679dad 116
Kojto 106:ba1f97679dad 117 /** @addtogroup I2SEx_Exported_Functions_Group1
Kojto 106:ba1f97679dad 118 * @{
Kojto 106:ba1f97679dad 119 */
Kojto 106:ba1f97679dad 120
Kojto 106:ba1f97679dad 121 /* Extended features functions **************************************************/
Kojto 106:ba1f97679dad 122 /* Blocking mode: Polling */
Kojto 106:ba1f97679dad 123 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size, uint32_t Timeout);
Kojto 106:ba1f97679dad 124 /* Non-Blocking mode: Interrupt */
Kojto 106:ba1f97679dad 125 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
Kojto 106:ba1f97679dad 126 /* Non-Blocking mode: DMA */
Kojto 106:ba1f97679dad 127 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
Kojto 106:ba1f97679dad 128 /**
Kojto 106:ba1f97679dad 129 * @}
Kojto 106:ba1f97679dad 130 */
Kojto 106:ba1f97679dad 131
Kojto 106:ba1f97679dad 132 /**
Kojto 106:ba1f97679dad 133 * @}
Kojto 106:ba1f97679dad 134 */
Kojto 106:ba1f97679dad 135 /* Private types -------------------------------------------------------------*/
Kojto 106:ba1f97679dad 136 /* Private variables ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 137 /* Private constants ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 138 /** @defgroup I2SEx_Private_Constants I2S Private Constants
Kojto 106:ba1f97679dad 139 * @{
Kojto 106:ba1f97679dad 140 */
Kojto 106:ba1f97679dad 141 /**
Kojto 106:ba1f97679dad 142 * @}
Kojto 106:ba1f97679dad 143 */
Kojto 106:ba1f97679dad 144
Kojto 106:ba1f97679dad 145 /* Private macros ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 146 /** @defgroup I2SEx_Private_Macros I2S Private Macros
Kojto 106:ba1f97679dad 147 * @{
Kojto 106:ba1f97679dad 148 */
Kojto 110:165afa46840b 149 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
Kojto 110:165afa46840b 150 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
Kojto 110:165afa46840b 151 defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F469xx) || \
Kojto 110:165afa46840b 152 defined(STM32F479xx)
Kojto 110:165afa46840b 153 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
Kojto 110:165afa46840b 154 ((CLOCK) == I2S_CLOCK_PLL))
Kojto 110:165afa46840b 155 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
Kojto 110:165afa46840b 156 STM32F401xC || STM32F401xE || STM32F411xE || STM32F469xx || STM32F479xx */
Kojto 110:165afa46840b 157
Kojto 110:165afa46840b 158 #if defined(STM32F446xx)
Kojto 110:165afa46840b 159 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
Kojto 110:165afa46840b 160 ((CLOCK) == I2S_CLOCK_PLL) ||\
Kojto 110:165afa46840b 161 ((CLOCK) == I2S_CLOCK_PLLSRC) ||\
Kojto 110:165afa46840b 162 ((CLOCK) == I2S_CLOCK_PLLR))
Kojto 110:165afa46840b 163 #endif /* STM32F446xx */
Kojto 110:165afa46840b 164
Kojto 110:165afa46840b 165 #if defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx)
Kojto 110:165afa46840b 166 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) ||\
Kojto 110:165afa46840b 167 ((CLOCK) == I2S_CLOCK_PLLSRC) ||\
Kojto 110:165afa46840b 168 ((CLOCK) == I2S_CLOCK_PLLR))
Kojto 110:165afa46840b 169 #endif /* STM32F410Tx || STM32F410Cx || STM32F410Rx */
Kojto 110:165afa46840b 170
Kojto 110:165afa46840b 171 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
Kojto 110:165afa46840b 172 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
Kojto 110:165afa46840b 173 defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F410Cx) || defined(STM32F410Rx) || \
Kojto 110:165afa46840b 174 defined(STM32F411xE) || defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Kojto 110:165afa46840b 175 #define I2SxEXT(__INSTANCE__) ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE))
Kojto 110:165afa46840b 176 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
Kojto 110:165afa46840b 177 STM32F401xC || STM32F401xE || STM32F410Cx || STM32F410Rx || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx */
Kojto 110:165afa46840b 178
Kojto 106:ba1f97679dad 179 /**
Kojto 106:ba1f97679dad 180 * @}
Kojto 106:ba1f97679dad 181 */
Kojto 106:ba1f97679dad 182
Kojto 106:ba1f97679dad 183 /* Private functions ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 184 /** @defgroup I2SEx_Private_Functions I2S Private Functions
Kojto 106:ba1f97679dad 185 * @{
Kojto 106:ba1f97679dad 186 */
Kojto 106:ba1f97679dad 187 HAL_StatusTypeDef I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 188 uint32_t I2S_GetInputClock(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 189 /**
Kojto 106:ba1f97679dad 190 * @}
Kojto 106:ba1f97679dad 191 */
Kojto 106:ba1f97679dad 192
Kojto 106:ba1f97679dad 193 /**
Kojto 106:ba1f97679dad 194 * @}
Kojto 106:ba1f97679dad 195 */
Kojto 106:ba1f97679dad 196
Kojto 106:ba1f97679dad 197 /**
Kojto 106:ba1f97679dad 198 * @}
Kojto 106:ba1f97679dad 199 */
Kojto 106:ba1f97679dad 200
Kojto 106:ba1f97679dad 201 #ifdef __cplusplus
Kojto 106:ba1f97679dad 202 }
Kojto 106:ba1f97679dad 203 #endif
Kojto 106:ba1f97679dad 204
Kojto 106:ba1f97679dad 205
Kojto 106:ba1f97679dad 206 #endif /* __STM32F4xx_HAL_I2S_EX_H */
Kojto 106:ba1f97679dad 207
Kojto 106:ba1f97679dad 208 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/