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_F411RE/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
bogdanm 86:04dd9b1680ae 1 /**
bogdanm 86:04dd9b1680ae 2 ******************************************************************************
bogdanm 86:04dd9b1680ae 3 * @file stm32f4xx_hal_i2s_ex.h
bogdanm 86:04dd9b1680ae 4 * @author MCD Application Team
Kojto 110:165afa46840b 5 * @version V1.4.1
Kojto 110:165afa46840b 6 * @date 09-October-2015
bogdanm 86:04dd9b1680ae 7 * @brief Header file of I2S HAL module.
bogdanm 86:04dd9b1680ae 8 ******************************************************************************
bogdanm 86:04dd9b1680ae 9 * @attention
bogdanm 86:04dd9b1680ae 10 *
Kojto 99:dbbf35b96557 11 * <h2><center>&copy; COPYRIGHT(c) 2015 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 __STM32F4xx_HAL_I2S_EX_H
bogdanm 86:04dd9b1680ae 40 #define __STM32F4xx_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 86:04dd9b1680ae 46 /* Includes ------------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 47 #include "stm32f4xx_hal_def.h"
bogdanm 86:04dd9b1680ae 48
bogdanm 86:04dd9b1680ae 49 /** @addtogroup STM32F4xx_HAL_Driver
bogdanm 86:04dd9b1680ae 50 * @{
bogdanm 86:04dd9b1680ae 51 */
bogdanm 86:04dd9b1680ae 52
bogdanm 86:04dd9b1680ae 53 /** @addtogroup I2SEx
bogdanm 86:04dd9b1680ae 54 * @{
bogdanm 86:04dd9b1680ae 55 */
bogdanm 86:04dd9b1680ae 56
Kojto 99:dbbf35b96557 57 /* Exported types ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 58 /** @defgroup I2SEx_Exported_Types I2S Exported Types
Kojto 99:dbbf35b96557 59 * @{
Kojto 99:dbbf35b96557 60 */
Kojto 99:dbbf35b96557 61 /**
Kojto 99:dbbf35b96557 62 * @}
Kojto 99:dbbf35b96557 63 */
Kojto 99:dbbf35b96557 64
Kojto 99:dbbf35b96557 65 /* Exported constants --------------------------------------------------------*/
Kojto 99:dbbf35b96557 66 /** @defgroup I2SEx_Exported_Constants I2S Exported Constants
Kojto 99:dbbf35b96557 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 99:dbbf35b96557 99 /**
Kojto 99:dbbf35b96557 100 * @}
Kojto 99:dbbf35b96557 101 */
Kojto 99:dbbf35b96557 102
bogdanm 86:04dd9b1680ae 103 /* Exported macro ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 104 /** @defgroup I2SEx_Exported_Macros I2S Exported Macros
Kojto 99:dbbf35b96557 105 * @{
Kojto 99:dbbf35b96557 106 */
Kojto 99:dbbf35b96557 107
Kojto 99:dbbf35b96557 108 /**
Kojto 99:dbbf35b96557 109 * @}
Kojto 99:dbbf35b96557 110 */
Kojto 99:dbbf35b96557 111
bogdanm 86:04dd9b1680ae 112 /* Exported functions --------------------------------------------------------*/
Kojto 99:dbbf35b96557 113 /** @addtogroup I2SEx_Exported_Functions
Kojto 99:dbbf35b96557 114 * @{
Kojto 99:dbbf35b96557 115 */
Kojto 99:dbbf35b96557 116
Kojto 99:dbbf35b96557 117 /** @addtogroup I2SEx_Exported_Functions_Group1
Kojto 99:dbbf35b96557 118 * @{
Kojto 99:dbbf35b96557 119 */
bogdanm 86:04dd9b1680ae 120
bogdanm 86:04dd9b1680ae 121 /* Extended features functions **************************************************/
Kojto 99:dbbf35b96557 122 /* Blocking mode: Polling */
bogdanm 86:04dd9b1680ae 123 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size, uint32_t Timeout);
Kojto 99:dbbf35b96557 124 /* Non-Blocking mode: Interrupt */
bogdanm 86:04dd9b1680ae 125 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
bogdanm 86:04dd9b1680ae 126 /* Non-Blocking mode: DMA */
bogdanm 86:04dd9b1680ae 127 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData, uint16_t Size);
Kojto 99:dbbf35b96557 128 /**
Kojto 99:dbbf35b96557 129 * @}
Kojto 99:dbbf35b96557 130 */
bogdanm 86:04dd9b1680ae 131
Kojto 99:dbbf35b96557 132 /**
Kojto 99:dbbf35b96557 133 * @}
Kojto 99:dbbf35b96557 134 */
Kojto 99:dbbf35b96557 135 /* Private types -------------------------------------------------------------*/
Kojto 99:dbbf35b96557 136 /* Private variables ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 137 /* Private constants ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 138 /** @defgroup I2SEx_Private_Constants I2S Private Constants
Kojto 99:dbbf35b96557 139 * @{
Kojto 99:dbbf35b96557 140 */
Kojto 99:dbbf35b96557 141 /**
Kojto 99:dbbf35b96557 142 * @}
Kojto 99:dbbf35b96557 143 */
Kojto 99:dbbf35b96557 144
Kojto 99:dbbf35b96557 145 /* Private macros ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 146 /** @defgroup I2SEx_Private_Macros I2S Private Macros
Kojto 99:dbbf35b96557 147 * @{
Kojto 99:dbbf35b96557 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 99:dbbf35b96557 179 /**
Kojto 99:dbbf35b96557 180 * @}
Kojto 99:dbbf35b96557 181 */
Kojto 99:dbbf35b96557 182
Kojto 99:dbbf35b96557 183 /* Private functions ---------------------------------------------------------*/
Kojto 99:dbbf35b96557 184 /** @defgroup I2SEx_Private_Functions I2S Private Functions
Kojto 99:dbbf35b96557 185 * @{
Kojto 99:dbbf35b96557 186 */
bogdanm 86:04dd9b1680ae 187 HAL_StatusTypeDef I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s);
Kojto 99:dbbf35b96557 188 uint32_t I2S_GetInputClock(I2S_HandleTypeDef *hi2s);
Kojto 99:dbbf35b96557 189 /**
Kojto 99:dbbf35b96557 190 * @}
Kojto 99:dbbf35b96557 191 */
Kojto 99:dbbf35b96557 192
bogdanm 86:04dd9b1680ae 193 /**
bogdanm 86:04dd9b1680ae 194 * @}
bogdanm 86:04dd9b1680ae 195 */
bogdanm 86:04dd9b1680ae 196
bogdanm 86:04dd9b1680ae 197 /**
bogdanm 86:04dd9b1680ae 198 * @}
bogdanm 86:04dd9b1680ae 199 */
bogdanm 86:04dd9b1680ae 200
bogdanm 86:04dd9b1680ae 201 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 202 }
bogdanm 86:04dd9b1680ae 203 #endif
bogdanm 86:04dd9b1680ae 204
bogdanm 86:04dd9b1680ae 205
bogdanm 86:04dd9b1680ae 206 #endif /* __STM32F4xx_HAL_I2S_EX_H */
bogdanm 86:04dd9b1680ae 207
bogdanm 86:04dd9b1680ae 208 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/