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

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.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_H
Kojto 106:ba1f97679dad 40 #define __STM32F4xx_HAL_I2S_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 I2S
Kojto 106:ba1f97679dad 54 * @{
Kojto 106:ba1f97679dad 55 */
Kojto 106:ba1f97679dad 56
Kojto 106:ba1f97679dad 57 /* Exported types ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 58 /** @defgroup I2S_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 * @brief I2S Init structure definition
Kojto 106:ba1f97679dad 64 */
Kojto 106:ba1f97679dad 65 typedef struct
Kojto 106:ba1f97679dad 66 {
Kojto 106:ba1f97679dad 67 uint32_t Mode; /*!< Specifies the I2S operating mode.
Kojto 106:ba1f97679dad 68 This parameter can be a value of @ref I2S_Mode */
Kojto 106:ba1f97679dad 69
Kojto 106:ba1f97679dad 70 uint32_t Standard; /*!< Specifies the standard used for the I2S communication.
Kojto 106:ba1f97679dad 71 This parameter can be a value of @ref I2S_Standard */
Kojto 106:ba1f97679dad 72
Kojto 106:ba1f97679dad 73 uint32_t DataFormat; /*!< Specifies the data format for the I2S communication.
Kojto 106:ba1f97679dad 74 This parameter can be a value of @ref I2S_Data_Format */
Kojto 106:ba1f97679dad 75
Kojto 106:ba1f97679dad 76 uint32_t MCLKOutput; /*!< Specifies whether the I2S MCLK output is enabled or not.
Kojto 106:ba1f97679dad 77 This parameter can be a value of @ref I2S_MCLK_Output */
Kojto 106:ba1f97679dad 78
Kojto 106:ba1f97679dad 79 uint32_t AudioFreq; /*!< Specifies the frequency selected for the I2S communication.
Kojto 106:ba1f97679dad 80 This parameter can be a value of @ref I2S_Audio_Frequency */
Kojto 106:ba1f97679dad 81
Kojto 106:ba1f97679dad 82 uint32_t CPOL; /*!< Specifies the idle state of the I2S clock.
Kojto 106:ba1f97679dad 83 This parameter can be a value of @ref I2S_Clock_Polarity */
Kojto 106:ba1f97679dad 84
Kojto 106:ba1f97679dad 85 uint32_t ClockSource; /*!< Specifies the I2S Clock Source.
Kojto 106:ba1f97679dad 86 This parameter can be a value of @ref I2S_Clock_Source */
Kojto 106:ba1f97679dad 87
Kojto 106:ba1f97679dad 88 uint32_t FullDuplexMode; /*!< Specifies the I2S FullDuplex mode.
Kojto 106:ba1f97679dad 89 This parameter can be a value of @ref I2S_FullDuplex_Mode */
Kojto 106:ba1f97679dad 90
Kojto 106:ba1f97679dad 91 }I2S_InitTypeDef;
Kojto 106:ba1f97679dad 92
Kojto 106:ba1f97679dad 93 /**
Kojto 106:ba1f97679dad 94 * @brief HAL State structures definition
Kojto 106:ba1f97679dad 95 */
Kojto 106:ba1f97679dad 96 typedef enum
Kojto 106:ba1f97679dad 97 {
Kojto 106:ba1f97679dad 98 HAL_I2S_STATE_RESET = 0x00, /*!< I2S not yet initialized or disabled */
Kojto 106:ba1f97679dad 99 HAL_I2S_STATE_READY = 0x01, /*!< I2S initialized and ready for use */
Kojto 106:ba1f97679dad 100 HAL_I2S_STATE_BUSY = 0x02, /*!< I2S internal process is ongoing */
Kojto 106:ba1f97679dad 101 HAL_I2S_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
Kojto 106:ba1f97679dad 102 HAL_I2S_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
Kojto 106:ba1f97679dad 103 HAL_I2S_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
Kojto 106:ba1f97679dad 104 HAL_I2S_STATE_TIMEOUT = 0x03, /*!< I2S timeout state */
Kojto 106:ba1f97679dad 105 HAL_I2S_STATE_ERROR = 0x04 /*!< I2S error state */
Kojto 106:ba1f97679dad 106
Kojto 106:ba1f97679dad 107 }HAL_I2S_StateTypeDef;
Kojto 106:ba1f97679dad 108
Kojto 106:ba1f97679dad 109 /**
Kojto 106:ba1f97679dad 110 * @brief I2S handle Structure definition
Kojto 106:ba1f97679dad 111 */
Kojto 106:ba1f97679dad 112 typedef struct
Kojto 106:ba1f97679dad 113 {
Kojto 106:ba1f97679dad 114 SPI_TypeDef *Instance; /* I2S registers base address */
Kojto 106:ba1f97679dad 115
Kojto 106:ba1f97679dad 116 I2S_InitTypeDef Init; /* I2S communication parameters */
Kojto 106:ba1f97679dad 117
Kojto 106:ba1f97679dad 118 uint16_t *pTxBuffPtr; /* Pointer to I2S Tx transfer buffer */
Kojto 106:ba1f97679dad 119
Kojto 106:ba1f97679dad 120 __IO uint16_t TxXferSize; /* I2S Tx transfer size */
Kojto 106:ba1f97679dad 121
Kojto 106:ba1f97679dad 122 __IO uint16_t TxXferCount; /* I2S Tx transfer Counter */
Kojto 106:ba1f97679dad 123
Kojto 106:ba1f97679dad 124 uint16_t *pRxBuffPtr; /* Pointer to I2S Rx transfer buffer */
Kojto 106:ba1f97679dad 125
Kojto 106:ba1f97679dad 126 __IO uint16_t RxXferSize; /* I2S Rx transfer size */
Kojto 106:ba1f97679dad 127
Kojto 106:ba1f97679dad 128 __IO uint16_t RxXferCount; /* I2S Rx transfer counter */
Kojto 106:ba1f97679dad 129
Kojto 106:ba1f97679dad 130 DMA_HandleTypeDef *hdmatx; /* I2S Tx DMA handle parameters */
Kojto 106:ba1f97679dad 131
Kojto 106:ba1f97679dad 132 DMA_HandleTypeDef *hdmarx; /* I2S Rx DMA handle parameters */
Kojto 106:ba1f97679dad 133
Kojto 106:ba1f97679dad 134 __IO HAL_LockTypeDef Lock; /* I2S locking object */
Kojto 106:ba1f97679dad 135
Kojto 106:ba1f97679dad 136 __IO HAL_I2S_StateTypeDef State; /* I2S communication state */
Kojto 106:ba1f97679dad 137
Kojto 106:ba1f97679dad 138 __IO uint32_t ErrorCode; /* I2S Error code */
Kojto 106:ba1f97679dad 139
Kojto 106:ba1f97679dad 140 }I2S_HandleTypeDef;
Kojto 106:ba1f97679dad 141 /**
Kojto 106:ba1f97679dad 142 * @}
Kojto 106:ba1f97679dad 143 */
Kojto 106:ba1f97679dad 144
Kojto 106:ba1f97679dad 145 /* Exported constants --------------------------------------------------------*/
Kojto 106:ba1f97679dad 146 /** @defgroup I2S_Exported_Constants I2S Exported Constants
Kojto 106:ba1f97679dad 147 * @{
Kojto 106:ba1f97679dad 148 */
Kojto 106:ba1f97679dad 149
Kojto 106:ba1f97679dad 150 /** @defgroup I2S_Error_Code I2S Error Code
Kojto 106:ba1f97679dad 151 * @brief I2S Error Code
Kojto 106:ba1f97679dad 152 * @{
Kojto 106:ba1f97679dad 153 */
Kojto 106:ba1f97679dad 154 #define HAL_I2S_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
Kojto 106:ba1f97679dad 155 #define HAL_I2S_ERROR_UDR ((uint32_t)0x00000001) /*!< I2S Underrun error */
Kojto 106:ba1f97679dad 156 #define HAL_I2S_ERROR_OVR ((uint32_t)0x00000002) /*!< I2S Overrun error */
Kojto 106:ba1f97679dad 157 #define HAL_I2SEX_ERROR_UDR ((uint32_t)0x00000004) /*!< I2S extended Underrun error */
Kojto 106:ba1f97679dad 158 #define HAL_I2SEX_ERROR_OVR ((uint32_t)0x00000008) /*!< I2S extended Overrun error */
Kojto 106:ba1f97679dad 159 #define HAL_I2S_ERROR_FRE ((uint32_t)0x00000010) /*!< I2S Frame format error */
Kojto 106:ba1f97679dad 160 #define HAL_I2S_ERROR_DMA ((uint32_t)0x00000020) /*!< DMA transfer error */
Kojto 106:ba1f97679dad 161 /**
Kojto 106:ba1f97679dad 162 * @}
Kojto 106:ba1f97679dad 163 */
Kojto 106:ba1f97679dad 164
Kojto 106:ba1f97679dad 165 /** @defgroup I2S_Mode I2S Mode
Kojto 106:ba1f97679dad 166 * @{
Kojto 106:ba1f97679dad 167 */
Kojto 106:ba1f97679dad 168 #define I2S_MODE_SLAVE_TX ((uint32_t)0x00000000)
Kojto 106:ba1f97679dad 169 #define I2S_MODE_SLAVE_RX ((uint32_t)0x00000100)
Kojto 106:ba1f97679dad 170 #define I2S_MODE_MASTER_TX ((uint32_t)0x00000200)
Kojto 106:ba1f97679dad 171 #define I2S_MODE_MASTER_RX ((uint32_t)0x00000300)
Kojto 106:ba1f97679dad 172 /**
Kojto 106:ba1f97679dad 173 * @}
Kojto 106:ba1f97679dad 174 */
Kojto 106:ba1f97679dad 175
Kojto 106:ba1f97679dad 176 /** @defgroup I2S_Standard I2S Standard
Kojto 106:ba1f97679dad 177 * @{
Kojto 106:ba1f97679dad 178 */
Kojto 106:ba1f97679dad 179 #define I2S_STANDARD_PHILIPS ((uint32_t)0x00000000)
Kojto 106:ba1f97679dad 180 #define I2S_STANDARD_MSB ((uint32_t)0x00000010)
Kojto 106:ba1f97679dad 181 #define I2S_STANDARD_LSB ((uint32_t)0x00000020)
Kojto 106:ba1f97679dad 182 #define I2S_STANDARD_PCM_SHORT ((uint32_t)0x00000030)
Kojto 106:ba1f97679dad 183 #define I2S_STANDARD_PCM_LONG ((uint32_t)0x000000B0)
Kojto 106:ba1f97679dad 184 /**
Kojto 106:ba1f97679dad 185 * @}
Kojto 106:ba1f97679dad 186 */
Kojto 106:ba1f97679dad 187
Kojto 106:ba1f97679dad 188 /** @defgroup I2S_Data_Format I2S Data Format
Kojto 106:ba1f97679dad 189 * @{
Kojto 106:ba1f97679dad 190 */
Kojto 106:ba1f97679dad 191 #define I2S_DATAFORMAT_16B ((uint32_t)0x00000000)
Kojto 106:ba1f97679dad 192 #define I2S_DATAFORMAT_16B_EXTENDED ((uint32_t)0x00000001)
Kojto 106:ba1f97679dad 193 #define I2S_DATAFORMAT_24B ((uint32_t)0x00000003)
Kojto 106:ba1f97679dad 194 #define I2S_DATAFORMAT_32B ((uint32_t)0x00000005)
Kojto 106:ba1f97679dad 195 /**
Kojto 106:ba1f97679dad 196 * @}
Kojto 106:ba1f97679dad 197 */
Kojto 106:ba1f97679dad 198
Kojto 106:ba1f97679dad 199 /** @defgroup I2S_MCLK_Output I2S Mclk Output
Kojto 106:ba1f97679dad 200 * @{
Kojto 106:ba1f97679dad 201 */
Kojto 106:ba1f97679dad 202 #define I2S_MCLKOUTPUT_ENABLE ((uint32_t)SPI_I2SPR_MCKOE)
Kojto 106:ba1f97679dad 203 #define I2S_MCLKOUTPUT_DISABLE ((uint32_t)0x00000000)
Kojto 106:ba1f97679dad 204 /**
Kojto 106:ba1f97679dad 205 * @}
Kojto 106:ba1f97679dad 206 */
Kojto 106:ba1f97679dad 207
Kojto 106:ba1f97679dad 208 /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
Kojto 106:ba1f97679dad 209 * @{
Kojto 106:ba1f97679dad 210 */
Kojto 106:ba1f97679dad 211 #define I2S_AUDIOFREQ_192K ((uint32_t)192000)
Kojto 106:ba1f97679dad 212 #define I2S_AUDIOFREQ_96K ((uint32_t)96000)
Kojto 106:ba1f97679dad 213 #define I2S_AUDIOFREQ_48K ((uint32_t)48000)
Kojto 106:ba1f97679dad 214 #define I2S_AUDIOFREQ_44K ((uint32_t)44100)
Kojto 106:ba1f97679dad 215 #define I2S_AUDIOFREQ_32K ((uint32_t)32000)
Kojto 106:ba1f97679dad 216 #define I2S_AUDIOFREQ_22K ((uint32_t)22050)
Kojto 106:ba1f97679dad 217 #define I2S_AUDIOFREQ_16K ((uint32_t)16000)
Kojto 106:ba1f97679dad 218 #define I2S_AUDIOFREQ_11K ((uint32_t)11025)
Kojto 106:ba1f97679dad 219 #define I2S_AUDIOFREQ_8K ((uint32_t)8000)
Kojto 106:ba1f97679dad 220 #define I2S_AUDIOFREQ_DEFAULT ((uint32_t)2)
Kojto 106:ba1f97679dad 221 /**
Kojto 106:ba1f97679dad 222 * @}
Kojto 106:ba1f97679dad 223 */
Kojto 106:ba1f97679dad 224
Kojto 106:ba1f97679dad 225 /** @defgroup I2S_FullDuplex_Mode I2S FullDuplex Mode
Kojto 106:ba1f97679dad 226 * @{
Kojto 106:ba1f97679dad 227 */
Kojto 106:ba1f97679dad 228 #define I2S_FULLDUPLEXMODE_DISABLE ((uint32_t)0x00000000)
Kojto 106:ba1f97679dad 229 #define I2S_FULLDUPLEXMODE_ENABLE ((uint32_t)0x00000001)
Kojto 106:ba1f97679dad 230 /**
Kojto 106:ba1f97679dad 231 * @}
Kojto 106:ba1f97679dad 232 */
Kojto 106:ba1f97679dad 233
Kojto 106:ba1f97679dad 234 /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
Kojto 106:ba1f97679dad 235 * @{
Kojto 106:ba1f97679dad 236 */
Kojto 106:ba1f97679dad 237 #define I2S_CPOL_LOW ((uint32_t)0x00000000)
Kojto 106:ba1f97679dad 238 #define I2S_CPOL_HIGH ((uint32_t)SPI_I2SCFGR_CKPOL)
Kojto 106:ba1f97679dad 239 /**
Kojto 106:ba1f97679dad 240 * @}
Kojto 106:ba1f97679dad 241 */
Kojto 106:ba1f97679dad 242
Kojto 106:ba1f97679dad 243 /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
Kojto 106:ba1f97679dad 244 * @{
Kojto 106:ba1f97679dad 245 */
Kojto 106:ba1f97679dad 246 #define I2S_IT_TXE SPI_CR2_TXEIE
Kojto 106:ba1f97679dad 247 #define I2S_IT_RXNE SPI_CR2_RXNEIE
Kojto 106:ba1f97679dad 248 #define I2S_IT_ERR SPI_CR2_ERRIE
Kojto 106:ba1f97679dad 249 /**
Kojto 106:ba1f97679dad 250 * @}
Kojto 106:ba1f97679dad 251 */
Kojto 106:ba1f97679dad 252
Kojto 106:ba1f97679dad 253 /** @defgroup I2S_Flags_Definition I2S Flags Definition
Kojto 106:ba1f97679dad 254 * @{
Kojto 106:ba1f97679dad 255 */
Kojto 106:ba1f97679dad 256 #define I2S_FLAG_TXE SPI_SR_TXE
Kojto 106:ba1f97679dad 257 #define I2S_FLAG_RXNE SPI_SR_RXNE
Kojto 106:ba1f97679dad 258
Kojto 106:ba1f97679dad 259 #define I2S_FLAG_UDR SPI_SR_UDR
Kojto 106:ba1f97679dad 260 #define I2S_FLAG_OVR SPI_SR_OVR
Kojto 106:ba1f97679dad 261 #define I2S_FLAG_FRE SPI_SR_FRE
Kojto 106:ba1f97679dad 262
Kojto 106:ba1f97679dad 263 #define I2S_FLAG_CHSIDE SPI_SR_CHSIDE
Kojto 106:ba1f97679dad 264 #define I2S_FLAG_BSY SPI_SR_BSY
Kojto 106:ba1f97679dad 265 /**
Kojto 106:ba1f97679dad 266 * @}
Kojto 106:ba1f97679dad 267 */
Kojto 106:ba1f97679dad 268
Kojto 106:ba1f97679dad 269 /**
Kojto 106:ba1f97679dad 270 * @}
Kojto 106:ba1f97679dad 271 */
Kojto 106:ba1f97679dad 272
Kojto 106:ba1f97679dad 273 /* Exported macro ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 274 /** @defgroup I2S_Exported_Macros I2S Exported Macros
Kojto 106:ba1f97679dad 275 * @{
Kojto 106:ba1f97679dad 276 */
Kojto 106:ba1f97679dad 277
Kojto 106:ba1f97679dad 278 /** @brief Reset I2S handle state
Kojto 106:ba1f97679dad 279 * @param __HANDLE__: specifies the I2S Handle.
Kojto 106:ba1f97679dad 280 * @retval None
Kojto 106:ba1f97679dad 281 */
Kojto 106:ba1f97679dad 282 #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
Kojto 106:ba1f97679dad 283
Kojto 106:ba1f97679dad 284 /** @brief Enable or disable the specified SPI peripheral (in I2S mode).
Kojto 106:ba1f97679dad 285 * @param __HANDLE__: specifies the I2S Handle.
Kojto 106:ba1f97679dad 286 * @retval None
Kojto 106:ba1f97679dad 287 */
Kojto 106:ba1f97679dad 288 #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
Kojto 106:ba1f97679dad 289 #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
Kojto 106:ba1f97679dad 290
Kojto 106:ba1f97679dad 291 /** @brief Enable or disable the specified I2S interrupts.
Kojto 106:ba1f97679dad 292 * @param __HANDLE__: specifies the I2S Handle.
Kojto 106:ba1f97679dad 293 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
Kojto 106:ba1f97679dad 294 * This parameter can be one of the following values:
Kojto 106:ba1f97679dad 295 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
Kojto 106:ba1f97679dad 296 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
Kojto 106:ba1f97679dad 297 * @arg I2S_IT_ERR: Error interrupt enable
Kojto 106:ba1f97679dad 298 * @retval None
Kojto 106:ba1f97679dad 299 */
Kojto 106:ba1f97679dad 300 #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
Kojto 106:ba1f97679dad 301 #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= ~(__INTERRUPT__))
Kojto 106:ba1f97679dad 302
Kojto 106:ba1f97679dad 303 /** @brief Checks if the specified I2S interrupt source is enabled or disabled.
Kojto 106:ba1f97679dad 304 * @param __HANDLE__: specifies the I2S Handle.
Kojto 106:ba1f97679dad 305 * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
Kojto 106:ba1f97679dad 306 * @param __INTERRUPT__: specifies the I2S interrupt source to check.
Kojto 106:ba1f97679dad 307 * This parameter can be one of the following values:
Kojto 106:ba1f97679dad 308 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
Kojto 106:ba1f97679dad 309 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
Kojto 106:ba1f97679dad 310 * @arg I2S_IT_ERR: Error interrupt enable
Kojto 106:ba1f97679dad 311 * @retval The new state of __IT__ (TRUE or FALSE).
Kojto 106:ba1f97679dad 312 */
Kojto 106:ba1f97679dad 313 #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
Kojto 106:ba1f97679dad 314
Kojto 106:ba1f97679dad 315 /** @brief Checks whether the specified I2S flag is set or not.
Kojto 106:ba1f97679dad 316 * @param __HANDLE__: specifies the I2S Handle.
Kojto 106:ba1f97679dad 317 * @param __FLAG__: specifies the flag to check.
Kojto 106:ba1f97679dad 318 * This parameter can be one of the following values:
Kojto 106:ba1f97679dad 319 * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
Kojto 106:ba1f97679dad 320 * @arg I2S_FLAG_TXE: Transmit buffer empty flag
Kojto 106:ba1f97679dad 321 * @arg I2S_FLAG_UDR: Underrun flag
Kojto 106:ba1f97679dad 322 * @arg I2S_FLAG_OVR: Overrun flag
Kojto 106:ba1f97679dad 323 * @arg I2S_FLAG_FRE: Frame error flag
Kojto 106:ba1f97679dad 324 * @arg I2S_FLAG_CHSIDE: Channel Side flag
Kojto 106:ba1f97679dad 325 * @arg I2S_FLAG_BSY: Busy flag
Kojto 106:ba1f97679dad 326 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 106:ba1f97679dad 327 */
Kojto 106:ba1f97679dad 328 #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
Kojto 106:ba1f97679dad 329
Kojto 106:ba1f97679dad 330 /** @brief Clears the I2S OVR pending flag.
Kojto 106:ba1f97679dad 331 * @param __HANDLE__: specifies the I2S Handle.
Kojto 106:ba1f97679dad 332 * @retval None
Kojto 106:ba1f97679dad 333 */
Kojto 106:ba1f97679dad 334 #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) \
Kojto 106:ba1f97679dad 335 do{ \
Kojto 106:ba1f97679dad 336 __IO uint32_t tmpreg; \
Kojto 106:ba1f97679dad 337 tmpreg = (__HANDLE__)->Instance->DR; \
Kojto 106:ba1f97679dad 338 tmpreg = (__HANDLE__)->Instance->SR; \
Kojto 106:ba1f97679dad 339 UNUSED(tmpreg); \
Kojto 106:ba1f97679dad 340 } while(0)
Kojto 106:ba1f97679dad 341
Kojto 106:ba1f97679dad 342 /** @brief Clears the I2S UDR pending flag.
Kojto 106:ba1f97679dad 343 * @param __HANDLE__: specifies the I2S Handle.
Kojto 106:ba1f97679dad 344 * @retval None
Kojto 106:ba1f97679dad 345 */
Kojto 106:ba1f97679dad 346 #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) \
Kojto 106:ba1f97679dad 347 do{ \
Kojto 106:ba1f97679dad 348 __IO uint32_t tmpreg; \
Kojto 106:ba1f97679dad 349 tmpreg = (__HANDLE__)->Instance->SR; \
Kojto 106:ba1f97679dad 350 UNUSED(tmpreg); \
Kojto 106:ba1f97679dad 351 } while(0)
Kojto 106:ba1f97679dad 352 /**
Kojto 106:ba1f97679dad 353 * @}
Kojto 106:ba1f97679dad 354 */
Kojto 106:ba1f97679dad 355
Kojto 106:ba1f97679dad 356 /* Include I2S Extension module */
Kojto 106:ba1f97679dad 357 #include "stm32f4xx_hal_i2s_ex.h"
Kojto 106:ba1f97679dad 358
Kojto 106:ba1f97679dad 359 /* Exported functions --------------------------------------------------------*/
Kojto 106:ba1f97679dad 360 /** @addtogroup I2S_Exported_Functions
Kojto 106:ba1f97679dad 361 * @{
Kojto 106:ba1f97679dad 362 */
Kojto 106:ba1f97679dad 363
Kojto 106:ba1f97679dad 364 /** @addtogroup I2S_Exported_Functions_Group1
Kojto 106:ba1f97679dad 365 * @{
Kojto 106:ba1f97679dad 366 */
Kojto 106:ba1f97679dad 367 /* Initialization/de-initialization functions **********************************/
Kojto 106:ba1f97679dad 368 HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 369 HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 370 void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 371 void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 372 /**
Kojto 106:ba1f97679dad 373 * @}
Kojto 106:ba1f97679dad 374 */
Kojto 106:ba1f97679dad 375
Kojto 106:ba1f97679dad 376 /** @addtogroup I2S_Exported_Functions_Group2
Kojto 106:ba1f97679dad 377 * @{
Kojto 106:ba1f97679dad 378 */
Kojto 106:ba1f97679dad 379 /* I/O operation functions *****************************************************/
Kojto 106:ba1f97679dad 380 /* Blocking mode: Polling */
Kojto 106:ba1f97679dad 381 HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 106:ba1f97679dad 382 HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 106:ba1f97679dad 383
Kojto 106:ba1f97679dad 384 /* Non-Blocking mode: Interrupt */
Kojto 106:ba1f97679dad 385 HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
Kojto 106:ba1f97679dad 386 HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
Kojto 106:ba1f97679dad 387 void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 388
Kojto 106:ba1f97679dad 389 /* Non-Blocking mode: DMA */
Kojto 106:ba1f97679dad 390 HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
Kojto 106:ba1f97679dad 391 HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
Kojto 106:ba1f97679dad 392
Kojto 106:ba1f97679dad 393 HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 394 HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 395 HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 396
Kojto 106:ba1f97679dad 397 /* Peripheral Control and State functions **************************************/
Kojto 106:ba1f97679dad 398 HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 399 uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 400
Kojto 106:ba1f97679dad 401 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
Kojto 106:ba1f97679dad 402 void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 403 void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 404 void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 405 void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 406 void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 407 /**
Kojto 106:ba1f97679dad 408 * @}
Kojto 106:ba1f97679dad 409 */
Kojto 106:ba1f97679dad 410
Kojto 106:ba1f97679dad 411 /**
Kojto 106:ba1f97679dad 412 * @}
Kojto 106:ba1f97679dad 413 */
Kojto 106:ba1f97679dad 414
Kojto 106:ba1f97679dad 415 /* Private types -------------------------------------------------------------*/
Kojto 106:ba1f97679dad 416 /* Private variables ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 417 /* Private constants ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 418 /** @defgroup I2S_Private_Constants I2S Private Constants
Kojto 106:ba1f97679dad 419 * @{
Kojto 106:ba1f97679dad 420 */
Kojto 106:ba1f97679dad 421
Kojto 106:ba1f97679dad 422 /**
Kojto 106:ba1f97679dad 423 * @}
Kojto 106:ba1f97679dad 424 */
Kojto 106:ba1f97679dad 425
Kojto 106:ba1f97679dad 426 /* Private macros ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 427 /** @defgroup I2S_Private_Macros I2S Private Macros
Kojto 106:ba1f97679dad 428 * @{
Kojto 106:ba1f97679dad 429 */
Kojto 106:ba1f97679dad 430 #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX) || \
Kojto 106:ba1f97679dad 431 ((MODE) == I2S_MODE_SLAVE_RX) || \
Kojto 106:ba1f97679dad 432 ((MODE) == I2S_MODE_MASTER_TX) || \
Kojto 106:ba1f97679dad 433 ((MODE) == I2S_MODE_MASTER_RX))
Kojto 106:ba1f97679dad 434
Kojto 106:ba1f97679dad 435 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS) || \
Kojto 106:ba1f97679dad 436 ((STANDARD) == I2S_STANDARD_MSB) || \
Kojto 106:ba1f97679dad 437 ((STANDARD) == I2S_STANDARD_LSB) || \
Kojto 106:ba1f97679dad 438 ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
Kojto 106:ba1f97679dad 439 ((STANDARD) == I2S_STANDARD_PCM_LONG))
Kojto 106:ba1f97679dad 440
Kojto 106:ba1f97679dad 441 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B) || \
Kojto 106:ba1f97679dad 442 ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
Kojto 106:ba1f97679dad 443 ((FORMAT) == I2S_DATAFORMAT_24B) || \
Kojto 106:ba1f97679dad 444 ((FORMAT) == I2S_DATAFORMAT_32B))
Kojto 106:ba1f97679dad 445
Kojto 106:ba1f97679dad 446 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
Kojto 106:ba1f97679dad 447 ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
Kojto 106:ba1f97679dad 448
Kojto 106:ba1f97679dad 449 #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
Kojto 106:ba1f97679dad 450 ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
Kojto 106:ba1f97679dad 451 ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
Kojto 106:ba1f97679dad 452
Kojto 106:ba1f97679dad 453 #define IS_I2S_FULLDUPLEX_MODE(MODE) (((MODE) == I2S_FULLDUPLEXMODE_DISABLE) || \
Kojto 106:ba1f97679dad 454 ((MODE) == I2S_FULLDUPLEXMODE_ENABLE))
Kojto 106:ba1f97679dad 455
Kojto 106:ba1f97679dad 456 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
Kojto 106:ba1f97679dad 457 ((CPOL) == I2S_CPOL_HIGH))
Kojto 110:165afa46840b 458
Kojto 106:ba1f97679dad 459 /**
Kojto 106:ba1f97679dad 460 * @}
Kojto 106:ba1f97679dad 461 */
Kojto 106:ba1f97679dad 462
Kojto 106:ba1f97679dad 463 /* Private functions ---------------------------------------------------------*/
Kojto 106:ba1f97679dad 464 /** @defgroup I2S_Private_Functions I2S Private Functions
Kojto 106:ba1f97679dad 465 * @{
Kojto 106:ba1f97679dad 466 */
Kojto 106:ba1f97679dad 467 void I2S_DMATxCplt(DMA_HandleTypeDef *hdma);
Kojto 106:ba1f97679dad 468 void I2S_DMATxHalfCplt(DMA_HandleTypeDef *hdma);
Kojto 106:ba1f97679dad 469 void I2S_DMARxCplt(DMA_HandleTypeDef *hdma);
Kojto 106:ba1f97679dad 470 void I2S_DMARxHalfCplt(DMA_HandleTypeDef *hdma);
Kojto 106:ba1f97679dad 471 void I2S_DMAError(DMA_HandleTypeDef *hdma);
Kojto 106:ba1f97679dad 472 HAL_StatusTypeDef I2S_WaitFlagStateUntilTimeout(I2S_HandleTypeDef *hi2s, uint32_t Flag, uint32_t Status, uint32_t Timeout);
Kojto 106:ba1f97679dad 473 HAL_StatusTypeDef I2S_Transmit_IT(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 474 HAL_StatusTypeDef I2S_Receive_IT(I2S_HandleTypeDef *hi2s);
Kojto 106:ba1f97679dad 475 /**
Kojto 106:ba1f97679dad 476 * @}
Kojto 106:ba1f97679dad 477 */
Kojto 106:ba1f97679dad 478
Kojto 106:ba1f97679dad 479 /**
Kojto 106:ba1f97679dad 480 * @}
Kojto 106:ba1f97679dad 481 */
Kojto 106:ba1f97679dad 482
Kojto 106:ba1f97679dad 483 /**
Kojto 106:ba1f97679dad 484 * @}
Kojto 106:ba1f97679dad 485 */
Kojto 106:ba1f97679dad 486
Kojto 106:ba1f97679dad 487 #ifdef __cplusplus
Kojto 106:ba1f97679dad 488 }
Kojto 106:ba1f97679dad 489 #endif
Kojto 106:ba1f97679dad 490
Kojto 106:ba1f97679dad 491
Kojto 106:ba1f97679dad 492 #endif /* __STM32F4xx_HAL_I2S_H */
Kojto 106:ba1f97679dad 493
Kojto 106:ba1f97679dad 494 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/