mbed library sources

Fork of mbed-src by mbed official

Committer:
mbed_official
Date:
Thu Aug 20 10:45:13 2015 +0100
Revision:
613:bc40b8d2aec4
Parent:
532:fe11edbda85c
Synchronized with git revision 92ca8c7b60a283b6bb60eb65b183dac1599f0ade

Full URL: https://github.com/mbedmicro/mbed/commit/92ca8c7b60a283b6bb60eb65b183dac1599f0ade/

Nordic: update application start address in GCC linker script

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 87:085cde657901 1 /**
mbed_official 87:085cde657901 2 ******************************************************************************
mbed_official 87:085cde657901 3 * @file stm32f4xx_hal_i2s.h
mbed_official 87:085cde657901 4 * @author MCD Application Team
mbed_official 613:bc40b8d2aec4 5 * @version V1.3.2
mbed_official 613:bc40b8d2aec4 6 * @date 26-June-2015
mbed_official 87:085cde657901 7 * @brief Header file of I2S HAL module.
mbed_official 87:085cde657901 8 ******************************************************************************
mbed_official 87:085cde657901 9 * @attention
mbed_official 87:085cde657901 10 *
mbed_official 532:fe11edbda85c 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
mbed_official 87:085cde657901 12 *
mbed_official 87:085cde657901 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 87:085cde657901 14 * are permitted provided that the following conditions are met:
mbed_official 87:085cde657901 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 87:085cde657901 16 * this list of conditions and the following disclaimer.
mbed_official 87:085cde657901 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 87:085cde657901 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 87:085cde657901 19 * and/or other materials provided with the distribution.
mbed_official 87:085cde657901 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 87:085cde657901 21 * may be used to endorse or promote products derived from this software
mbed_official 87:085cde657901 22 * without specific prior written permission.
mbed_official 87:085cde657901 23 *
mbed_official 87:085cde657901 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 87:085cde657901 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 87:085cde657901 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 87:085cde657901 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 87:085cde657901 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 87:085cde657901 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 87:085cde657901 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 87:085cde657901 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 87:085cde657901 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 87:085cde657901 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 87:085cde657901 34 *
mbed_official 87:085cde657901 35 ******************************************************************************
mbed_official 87:085cde657901 36 */
mbed_official 87:085cde657901 37
mbed_official 87:085cde657901 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 87:085cde657901 39 #ifndef __STM32F4xx_HAL_I2S_H
mbed_official 87:085cde657901 40 #define __STM32F4xx_HAL_I2S_H
mbed_official 87:085cde657901 41
mbed_official 87:085cde657901 42 #ifdef __cplusplus
mbed_official 87:085cde657901 43 extern "C" {
mbed_official 87:085cde657901 44 #endif
mbed_official 87:085cde657901 45
mbed_official 87:085cde657901 46 /* Includes ------------------------------------------------------------------*/
mbed_official 87:085cde657901 47 #include "stm32f4xx_hal_def.h"
mbed_official 87:085cde657901 48
mbed_official 87:085cde657901 49 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 87:085cde657901 50 * @{
mbed_official 87:085cde657901 51 */
mbed_official 87:085cde657901 52
mbed_official 87:085cde657901 53 /** @addtogroup I2S
mbed_official 87:085cde657901 54 * @{
mbed_official 87:085cde657901 55 */
mbed_official 87:085cde657901 56
mbed_official 532:fe11edbda85c 57 /* Exported types ------------------------------------------------------------*/
mbed_official 532:fe11edbda85c 58 /** @defgroup I2S_Exported_Types I2S Exported Types
mbed_official 532:fe11edbda85c 59 * @{
mbed_official 532:fe11edbda85c 60 */
mbed_official 532:fe11edbda85c 61
mbed_official 87:085cde657901 62 /**
mbed_official 87:085cde657901 63 * @brief I2S Init structure definition
mbed_official 87:085cde657901 64 */
mbed_official 87:085cde657901 65 typedef struct
mbed_official 87:085cde657901 66 {
mbed_official 87:085cde657901 67 uint32_t Mode; /*!< Specifies the I2S operating mode.
mbed_official 87:085cde657901 68 This parameter can be a value of @ref I2S_Mode */
mbed_official 87:085cde657901 69
mbed_official 87:085cde657901 70 uint32_t Standard; /*!< Specifies the standard used for the I2S communication.
mbed_official 87:085cde657901 71 This parameter can be a value of @ref I2S_Standard */
mbed_official 87:085cde657901 72
mbed_official 87:085cde657901 73 uint32_t DataFormat; /*!< Specifies the data format for the I2S communication.
mbed_official 87:085cde657901 74 This parameter can be a value of @ref I2S_Data_Format */
mbed_official 87:085cde657901 75
mbed_official 87:085cde657901 76 uint32_t MCLKOutput; /*!< Specifies whether the I2S MCLK output is enabled or not.
mbed_official 87:085cde657901 77 This parameter can be a value of @ref I2S_MCLK_Output */
mbed_official 87:085cde657901 78
mbed_official 87:085cde657901 79 uint32_t AudioFreq; /*!< Specifies the frequency selected for the I2S communication.
mbed_official 87:085cde657901 80 This parameter can be a value of @ref I2S_Audio_Frequency */
mbed_official 87:085cde657901 81
mbed_official 87:085cde657901 82 uint32_t CPOL; /*!< Specifies the idle state of the I2S clock.
mbed_official 87:085cde657901 83 This parameter can be a value of @ref I2S_Clock_Polarity */
mbed_official 87:085cde657901 84
mbed_official 87:085cde657901 85 uint32_t ClockSource; /*!< Specifies the I2S Clock Source.
mbed_official 87:085cde657901 86 This parameter can be a value of @ref I2S_Clock_Source */
mbed_official 87:085cde657901 87
mbed_official 87:085cde657901 88 uint32_t FullDuplexMode; /*!< Specifies the I2S FullDuplex mode.
mbed_official 87:085cde657901 89 This parameter can be a value of @ref I2S_FullDuplex_Mode */
mbed_official 87:085cde657901 90
mbed_official 87:085cde657901 91 }I2S_InitTypeDef;
mbed_official 87:085cde657901 92
mbed_official 87:085cde657901 93 /**
mbed_official 87:085cde657901 94 * @brief HAL State structures definition
mbed_official 87:085cde657901 95 */
mbed_official 87:085cde657901 96 typedef enum
mbed_official 87:085cde657901 97 {
mbed_official 87:085cde657901 98 HAL_I2S_STATE_RESET = 0x00, /*!< I2S not yet initialized or disabled */
mbed_official 87:085cde657901 99 HAL_I2S_STATE_READY = 0x01, /*!< I2S initialized and ready for use */
mbed_official 87:085cde657901 100 HAL_I2S_STATE_BUSY = 0x02, /*!< I2S internal process is ongoing */
mbed_official 87:085cde657901 101 HAL_I2S_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
mbed_official 87:085cde657901 102 HAL_I2S_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
mbed_official 87:085cde657901 103 HAL_I2S_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
mbed_official 87:085cde657901 104 HAL_I2S_STATE_TIMEOUT = 0x03, /*!< I2S timeout state */
mbed_official 87:085cde657901 105 HAL_I2S_STATE_ERROR = 0x04 /*!< I2S error state */
mbed_official 87:085cde657901 106
mbed_official 87:085cde657901 107 }HAL_I2S_StateTypeDef;
mbed_official 87:085cde657901 108
mbed_official 87:085cde657901 109 /**
mbed_official 87:085cde657901 110 * @brief I2S handle Structure definition
mbed_official 87:085cde657901 111 */
mbed_official 87:085cde657901 112 typedef struct
mbed_official 87:085cde657901 113 {
mbed_official 87:085cde657901 114 SPI_TypeDef *Instance; /* I2S registers base address */
mbed_official 87:085cde657901 115
mbed_official 87:085cde657901 116 I2S_InitTypeDef Init; /* I2S communication parameters */
mbed_official 87:085cde657901 117
mbed_official 87:085cde657901 118 uint16_t *pTxBuffPtr; /* Pointer to I2S Tx transfer buffer */
mbed_official 87:085cde657901 119
mbed_official 87:085cde657901 120 __IO uint16_t TxXferSize; /* I2S Tx transfer size */
mbed_official 87:085cde657901 121
mbed_official 87:085cde657901 122 __IO uint16_t TxXferCount; /* I2S Tx transfer Counter */
mbed_official 87:085cde657901 123
mbed_official 87:085cde657901 124 uint16_t *pRxBuffPtr; /* Pointer to I2S Rx transfer buffer */
mbed_official 87:085cde657901 125
mbed_official 87:085cde657901 126 __IO uint16_t RxXferSize; /* I2S Rx transfer size */
mbed_official 87:085cde657901 127
mbed_official 87:085cde657901 128 __IO uint16_t RxXferCount; /* I2S Rx transfer counter */
mbed_official 87:085cde657901 129
mbed_official 87:085cde657901 130 DMA_HandleTypeDef *hdmatx; /* I2S Tx DMA handle parameters */
mbed_official 87:085cde657901 131
mbed_official 87:085cde657901 132 DMA_HandleTypeDef *hdmarx; /* I2S Rx DMA handle parameters */
mbed_official 87:085cde657901 133
mbed_official 87:085cde657901 134 __IO HAL_LockTypeDef Lock; /* I2S locking object */
mbed_official 87:085cde657901 135
mbed_official 87:085cde657901 136 __IO HAL_I2S_StateTypeDef State; /* I2S communication state */
mbed_official 87:085cde657901 137
mbed_official 532:fe11edbda85c 138 __IO uint32_t ErrorCode; /* I2S Error code */
mbed_official 532:fe11edbda85c 139
mbed_official 87:085cde657901 140 }I2S_HandleTypeDef;
mbed_official 532:fe11edbda85c 141 /**
mbed_official 532:fe11edbda85c 142 * @}
mbed_official 532:fe11edbda85c 143 */
mbed_official 87:085cde657901 144
mbed_official 87:085cde657901 145 /* Exported constants --------------------------------------------------------*/
mbed_official 532:fe11edbda85c 146 /** @defgroup I2S_Exported_Constants I2S Exported Constants
mbed_official 87:085cde657901 147 * @{
mbed_official 87:085cde657901 148 */
mbed_official 87:085cde657901 149
mbed_official 532:fe11edbda85c 150 /** @defgroup I2S_Error_Code I2S Error Code
mbed_official 532:fe11edbda85c 151 * @brief I2S Error Code
mbed_official 532:fe11edbda85c 152 * @{
mbed_official 532:fe11edbda85c 153 */
mbed_official 532:fe11edbda85c 154 #define HAL_I2S_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
mbed_official 532:fe11edbda85c 155 #define HAL_I2S_ERROR_UDR ((uint32_t)0x00000001) /*!< I2S Underrun error */
mbed_official 532:fe11edbda85c 156 #define HAL_I2S_ERROR_OVR ((uint32_t)0x00000002) /*!< I2S Overrun error */
mbed_official 532:fe11edbda85c 157 #define HAL_I2SEX_ERROR_UDR ((uint32_t)0x00000004) /*!< I2S extended Underrun error */
mbed_official 532:fe11edbda85c 158 #define HAL_I2SEX_ERROR_OVR ((uint32_t)0x00000008) /*!< I2S extended Overrun error */
mbed_official 532:fe11edbda85c 159 #define HAL_I2S_ERROR_FRE ((uint32_t)0x00000010) /*!< I2S Frame format error */
mbed_official 532:fe11edbda85c 160 #define HAL_I2S_ERROR_DMA ((uint32_t)0x00000020) /*!< DMA transfer error */
mbed_official 532:fe11edbda85c 161 /**
mbed_official 532:fe11edbda85c 162 * @}
mbed_official 532:fe11edbda85c 163 */
mbed_official 532:fe11edbda85c 164
mbed_official 532:fe11edbda85c 165 /** @defgroup I2S_Clock_Source I2S Clock Source
mbed_official 87:085cde657901 166 * @{
mbed_official 87:085cde657901 167 */
mbed_official 87:085cde657901 168 #define I2S_CLOCK_PLL ((uint32_t)0x00000000)
mbed_official 87:085cde657901 169 #define I2S_CLOCK_EXTERNAL ((uint32_t)0x00000001)
mbed_official 532:fe11edbda85c 170 #define I2S_CLOCK_PLLR ((uint32_t)0x00000002)
mbed_official 532:fe11edbda85c 171 #define I2S_CLOCK_PLLSRC ((uint32_t)0x00000003)
mbed_official 87:085cde657901 172 /**
mbed_official 87:085cde657901 173 * @}
mbed_official 87:085cde657901 174 */
mbed_official 87:085cde657901 175
mbed_official 532:fe11edbda85c 176 /** @defgroup I2S_Mode I2S Mode
mbed_official 87:085cde657901 177 * @{
mbed_official 87:085cde657901 178 */
mbed_official 87:085cde657901 179 #define I2S_MODE_SLAVE_TX ((uint32_t)0x00000000)
mbed_official 87:085cde657901 180 #define I2S_MODE_SLAVE_RX ((uint32_t)0x00000100)
mbed_official 87:085cde657901 181 #define I2S_MODE_MASTER_TX ((uint32_t)0x00000200)
mbed_official 87:085cde657901 182 #define I2S_MODE_MASTER_RX ((uint32_t)0x00000300)
mbed_official 87:085cde657901 183 /**
mbed_official 87:085cde657901 184 * @}
mbed_official 87:085cde657901 185 */
mbed_official 87:085cde657901 186
mbed_official 532:fe11edbda85c 187 /** @defgroup I2S_Standard I2S Standard
mbed_official 87:085cde657901 188 * @{
mbed_official 87:085cde657901 189 */
mbed_official 226:b062af740e40 190 #define I2S_STANDARD_PHILIPS ((uint32_t)0x00000000)
mbed_official 87:085cde657901 191 #define I2S_STANDARD_MSB ((uint32_t)0x00000010)
mbed_official 87:085cde657901 192 #define I2S_STANDARD_LSB ((uint32_t)0x00000020)
mbed_official 87:085cde657901 193 #define I2S_STANDARD_PCM_SHORT ((uint32_t)0x00000030)
mbed_official 87:085cde657901 194 #define I2S_STANDARD_PCM_LONG ((uint32_t)0x000000B0)
mbed_official 87:085cde657901 195 /**
mbed_official 87:085cde657901 196 * @}
mbed_official 87:085cde657901 197 */
mbed_official 87:085cde657901 198
mbed_official 532:fe11edbda85c 199 /** @defgroup I2S_Data_Format I2S Data Format
mbed_official 87:085cde657901 200 * @{
mbed_official 87:085cde657901 201 */
mbed_official 87:085cde657901 202 #define I2S_DATAFORMAT_16B ((uint32_t)0x00000000)
mbed_official 87:085cde657901 203 #define I2S_DATAFORMAT_16B_EXTENDED ((uint32_t)0x00000001)
mbed_official 87:085cde657901 204 #define I2S_DATAFORMAT_24B ((uint32_t)0x00000003)
mbed_official 87:085cde657901 205 #define I2S_DATAFORMAT_32B ((uint32_t)0x00000005)
mbed_official 87:085cde657901 206 /**
mbed_official 87:085cde657901 207 * @}
mbed_official 87:085cde657901 208 */
mbed_official 87:085cde657901 209
mbed_official 532:fe11edbda85c 210 /** @defgroup I2S_MCLK_Output I2S Mclk Output
mbed_official 87:085cde657901 211 * @{
mbed_official 87:085cde657901 212 */
mbed_official 87:085cde657901 213 #define I2S_MCLKOUTPUT_ENABLE ((uint32_t)SPI_I2SPR_MCKOE)
mbed_official 87:085cde657901 214 #define I2S_MCLKOUTPUT_DISABLE ((uint32_t)0x00000000)
mbed_official 87:085cde657901 215 /**
mbed_official 87:085cde657901 216 * @}
mbed_official 87:085cde657901 217 */
mbed_official 87:085cde657901 218
mbed_official 532:fe11edbda85c 219 /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
mbed_official 87:085cde657901 220 * @{
mbed_official 87:085cde657901 221 */
mbed_official 87:085cde657901 222 #define I2S_AUDIOFREQ_192K ((uint32_t)192000)
mbed_official 87:085cde657901 223 #define I2S_AUDIOFREQ_96K ((uint32_t)96000)
mbed_official 87:085cde657901 224 #define I2S_AUDIOFREQ_48K ((uint32_t)48000)
mbed_official 87:085cde657901 225 #define I2S_AUDIOFREQ_44K ((uint32_t)44100)
mbed_official 87:085cde657901 226 #define I2S_AUDIOFREQ_32K ((uint32_t)32000)
mbed_official 87:085cde657901 227 #define I2S_AUDIOFREQ_22K ((uint32_t)22050)
mbed_official 87:085cde657901 228 #define I2S_AUDIOFREQ_16K ((uint32_t)16000)
mbed_official 87:085cde657901 229 #define I2S_AUDIOFREQ_11K ((uint32_t)11025)
mbed_official 87:085cde657901 230 #define I2S_AUDIOFREQ_8K ((uint32_t)8000)
mbed_official 87:085cde657901 231 #define I2S_AUDIOFREQ_DEFAULT ((uint32_t)2)
mbed_official 87:085cde657901 232 /**
mbed_official 87:085cde657901 233 * @}
mbed_official 87:085cde657901 234 */
mbed_official 87:085cde657901 235
mbed_official 532:fe11edbda85c 236 /** @defgroup I2S_FullDuplex_Mode I2S FullDuplex Mode
mbed_official 87:085cde657901 237 * @{
mbed_official 87:085cde657901 238 */
mbed_official 87:085cde657901 239 #define I2S_FULLDUPLEXMODE_DISABLE ((uint32_t)0x00000000)
mbed_official 87:085cde657901 240 #define I2S_FULLDUPLEXMODE_ENABLE ((uint32_t)0x00000001)
mbed_official 87:085cde657901 241 /**
mbed_official 87:085cde657901 242 * @}
mbed_official 87:085cde657901 243 */
mbed_official 87:085cde657901 244
mbed_official 532:fe11edbda85c 245 /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
mbed_official 87:085cde657901 246 * @{
mbed_official 87:085cde657901 247 */
mbed_official 87:085cde657901 248 #define I2S_CPOL_LOW ((uint32_t)0x00000000)
mbed_official 87:085cde657901 249 #define I2S_CPOL_HIGH ((uint32_t)SPI_I2SCFGR_CKPOL)
mbed_official 87:085cde657901 250 /**
mbed_official 87:085cde657901 251 * @}
mbed_official 87:085cde657901 252 */
mbed_official 87:085cde657901 253
mbed_official 532:fe11edbda85c 254 /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
mbed_official 87:085cde657901 255 * @{
mbed_official 87:085cde657901 256 */
mbed_official 87:085cde657901 257 #define I2S_IT_TXE SPI_CR2_TXEIE
mbed_official 87:085cde657901 258 #define I2S_IT_RXNE SPI_CR2_RXNEIE
mbed_official 87:085cde657901 259 #define I2S_IT_ERR SPI_CR2_ERRIE
mbed_official 87:085cde657901 260 /**
mbed_official 87:085cde657901 261 * @}
mbed_official 87:085cde657901 262 */
mbed_official 87:085cde657901 263
mbed_official 532:fe11edbda85c 264 /** @defgroup I2S_Flags_Definition I2S Flags Definition
mbed_official 87:085cde657901 265 * @{
mbed_official 87:085cde657901 266 */
mbed_official 87:085cde657901 267 #define I2S_FLAG_TXE SPI_SR_TXE
mbed_official 87:085cde657901 268 #define I2S_FLAG_RXNE SPI_SR_RXNE
mbed_official 87:085cde657901 269
mbed_official 87:085cde657901 270 #define I2S_FLAG_UDR SPI_SR_UDR
mbed_official 87:085cde657901 271 #define I2S_FLAG_OVR SPI_SR_OVR
mbed_official 87:085cde657901 272 #define I2S_FLAG_FRE SPI_SR_FRE
mbed_official 87:085cde657901 273
mbed_official 87:085cde657901 274 #define I2S_FLAG_CHSIDE SPI_SR_CHSIDE
mbed_official 87:085cde657901 275 #define I2S_FLAG_BSY SPI_SR_BSY
mbed_official 87:085cde657901 276 /**
mbed_official 87:085cde657901 277 * @}
mbed_official 87:085cde657901 278 */
mbed_official 87:085cde657901 279
mbed_official 87:085cde657901 280 /**
mbed_official 87:085cde657901 281 * @}
mbed_official 87:085cde657901 282 */
mbed_official 532:fe11edbda85c 283
mbed_official 87:085cde657901 284 /* Exported macro ------------------------------------------------------------*/
mbed_official 532:fe11edbda85c 285 /** @defgroup I2S_Exported_Macros I2S Exported Macros
mbed_official 532:fe11edbda85c 286 * @{
mbed_official 532:fe11edbda85c 287 */
mbed_official 226:b062af740e40 288
mbed_official 226:b062af740e40 289 /** @brief Reset I2S handle state
mbed_official 226:b062af740e40 290 * @param __HANDLE__: specifies the I2S Handle.
mbed_official 226:b062af740e40 291 * @retval None
mbed_official 226:b062af740e40 292 */
mbed_official 226:b062af740e40 293 #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
mbed_official 226:b062af740e40 294
mbed_official 87:085cde657901 295 /** @brief Enable or disable the specified SPI peripheral (in I2S mode).
mbed_official 87:085cde657901 296 * @param __HANDLE__: specifies the I2S Handle.
mbed_official 87:085cde657901 297 * @retval None
mbed_official 87:085cde657901 298 */
mbed_official 87:085cde657901 299 #define __HAL_I2S_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR |= SPI_I2SCFGR_I2SE)
mbed_official 87:085cde657901 300 #define __HAL_I2S_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
mbed_official 87:085cde657901 301
mbed_official 87:085cde657901 302 /** @brief Enable or disable the specified I2S interrupts.
mbed_official 87:085cde657901 303 * @param __HANDLE__: specifies the I2S Handle.
mbed_official 87:085cde657901 304 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
mbed_official 87:085cde657901 305 * This parameter can be one of the following values:
mbed_official 87:085cde657901 306 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
mbed_official 87:085cde657901 307 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
mbed_official 87:085cde657901 308 * @arg I2S_IT_ERR: Error interrupt enable
mbed_official 87:085cde657901 309 * @retval None
mbed_official 87:085cde657901 310 */
mbed_official 87:085cde657901 311 #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
mbed_official 87:085cde657901 312 #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= ~(__INTERRUPT__))
mbed_official 87:085cde657901 313
mbed_official 87:085cde657901 314 /** @brief Checks if the specified I2S interrupt source is enabled or disabled.
mbed_official 87:085cde657901 315 * @param __HANDLE__: specifies the I2S Handle.
mbed_official 87:085cde657901 316 * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
mbed_official 87:085cde657901 317 * @param __INTERRUPT__: specifies the I2S interrupt source to check.
mbed_official 87:085cde657901 318 * This parameter can be one of the following values:
mbed_official 87:085cde657901 319 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
mbed_official 87:085cde657901 320 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
mbed_official 87:085cde657901 321 * @arg I2S_IT_ERR: Error interrupt enable
mbed_official 87:085cde657901 322 * @retval The new state of __IT__ (TRUE or FALSE).
mbed_official 87:085cde657901 323 */
mbed_official 87:085cde657901 324 #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
mbed_official 87:085cde657901 325
mbed_official 87:085cde657901 326 /** @brief Checks whether the specified I2S flag is set or not.
mbed_official 87:085cde657901 327 * @param __HANDLE__: specifies the I2S Handle.
mbed_official 87:085cde657901 328 * @param __FLAG__: specifies the flag to check.
mbed_official 87:085cde657901 329 * This parameter can be one of the following values:
mbed_official 87:085cde657901 330 * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
mbed_official 87:085cde657901 331 * @arg I2S_FLAG_TXE: Transmit buffer empty flag
mbed_official 87:085cde657901 332 * @arg I2S_FLAG_UDR: Underrun flag
mbed_official 87:085cde657901 333 * @arg I2S_FLAG_OVR: Overrun flag
mbed_official 87:085cde657901 334 * @arg I2S_FLAG_FRE: Frame error flag
mbed_official 87:085cde657901 335 * @arg I2S_FLAG_CHSIDE: Channel Side flag
mbed_official 87:085cde657901 336 * @arg I2S_FLAG_BSY: Busy flag
mbed_official 87:085cde657901 337 * @retval The new state of __FLAG__ (TRUE or FALSE).
mbed_official 87:085cde657901 338 */
mbed_official 87:085cde657901 339 #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
mbed_official 87:085cde657901 340
mbed_official 87:085cde657901 341 /** @brief Clears the I2S OVR pending flag.
mbed_official 87:085cde657901 342 * @param __HANDLE__: specifies the I2S Handle.
mbed_official 87:085cde657901 343 * @retval None
mbed_official 87:085cde657901 344 */
mbed_official 532:fe11edbda85c 345 #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) \
mbed_official 532:fe11edbda85c 346 do{ \
mbed_official 532:fe11edbda85c 347 __IO uint32_t tmpreg; \
mbed_official 532:fe11edbda85c 348 tmpreg = (__HANDLE__)->Instance->DR; \
mbed_official 532:fe11edbda85c 349 tmpreg = (__HANDLE__)->Instance->SR; \
mbed_official 532:fe11edbda85c 350 UNUSED(tmpreg); \
mbed_official 532:fe11edbda85c 351 } while(0)
mbed_official 532:fe11edbda85c 352
mbed_official 87:085cde657901 353 /** @brief Clears the I2S UDR pending flag.
mbed_official 87:085cde657901 354 * @param __HANDLE__: specifies the I2S Handle.
mbed_official 87:085cde657901 355 * @retval None
mbed_official 87:085cde657901 356 */
mbed_official 532:fe11edbda85c 357 #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) \
mbed_official 532:fe11edbda85c 358 do{ \
mbed_official 532:fe11edbda85c 359 __IO uint32_t tmpreg; \
mbed_official 532:fe11edbda85c 360 tmpreg = (__HANDLE__)->Instance->SR; \
mbed_official 532:fe11edbda85c 361 UNUSED(tmpreg); \
mbed_official 532:fe11edbda85c 362 } while(0)
mbed_official 532:fe11edbda85c 363 /**
mbed_official 532:fe11edbda85c 364 * @}
mbed_official 532:fe11edbda85c 365 */
mbed_official 532:fe11edbda85c 366
mbed_official 87:085cde657901 367 /* Include I2S Extension module */
mbed_official 87:085cde657901 368 #include "stm32f4xx_hal_i2s_ex.h"
mbed_official 87:085cde657901 369
mbed_official 87:085cde657901 370 /* Exported functions --------------------------------------------------------*/
mbed_official 532:fe11edbda85c 371 /** @addtogroup I2S_Exported_Functions
mbed_official 532:fe11edbda85c 372 * @{
mbed_official 532:fe11edbda85c 373 */
mbed_official 87:085cde657901 374
mbed_official 532:fe11edbda85c 375 /** @addtogroup I2S_Exported_Functions_Group1
mbed_official 532:fe11edbda85c 376 * @{
mbed_official 532:fe11edbda85c 377 */
mbed_official 87:085cde657901 378 /* Initialization/de-initialization functions **********************************/
mbed_official 87:085cde657901 379 HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 380 HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 381 void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 382 void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
mbed_official 532:fe11edbda85c 383 /**
mbed_official 532:fe11edbda85c 384 * @}
mbed_official 532:fe11edbda85c 385 */
mbed_official 87:085cde657901 386
mbed_official 532:fe11edbda85c 387 /** @addtogroup I2S_Exported_Functions_Group2
mbed_official 532:fe11edbda85c 388 * @{
mbed_official 532:fe11edbda85c 389 */
mbed_official 87:085cde657901 390 /* I/O operation functions *****************************************************/
mbed_official 532:fe11edbda85c 391 /* Blocking mode: Polling */
mbed_official 87:085cde657901 392 HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 393 HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 394
mbed_official 87:085cde657901 395 /* Non-Blocking mode: Interrupt */
mbed_official 87:085cde657901 396 HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
mbed_official 87:085cde657901 397 HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
mbed_official 87:085cde657901 398 void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 399
mbed_official 87:085cde657901 400 /* Non-Blocking mode: DMA */
mbed_official 87:085cde657901 401 HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
mbed_official 87:085cde657901 402 HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
mbed_official 87:085cde657901 403
mbed_official 87:085cde657901 404 HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 405 HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 406 HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 407
mbed_official 87:085cde657901 408 /* Peripheral Control and State functions **************************************/
mbed_official 87:085cde657901 409 HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
mbed_official 532:fe11edbda85c 410 uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
mbed_official 87:085cde657901 411
mbed_official 87:085cde657901 412 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
mbed_official 106:ced8cbb51063 413 void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
mbed_official 106:ced8cbb51063 414 void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
mbed_official 106:ced8cbb51063 415 void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
mbed_official 106:ced8cbb51063 416 void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
mbed_official 106:ced8cbb51063 417 void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
mbed_official 532:fe11edbda85c 418 /**
mbed_official 532:fe11edbda85c 419 * @}
mbed_official 532:fe11edbda85c 420 */
mbed_official 87:085cde657901 421
mbed_official 532:fe11edbda85c 422 /**
mbed_official 532:fe11edbda85c 423 * @}
mbed_official 532:fe11edbda85c 424 */
mbed_official 532:fe11edbda85c 425
mbed_official 532:fe11edbda85c 426 /* Private types -------------------------------------------------------------*/
mbed_official 532:fe11edbda85c 427 /* Private variables ---------------------------------------------------------*/
mbed_official 532:fe11edbda85c 428 /* Private constants ---------------------------------------------------------*/
mbed_official 532:fe11edbda85c 429 /** @defgroup I2S_Private_Constants I2S Private Constants
mbed_official 532:fe11edbda85c 430 * @{
mbed_official 532:fe11edbda85c 431 */
mbed_official 532:fe11edbda85c 432
mbed_official 532:fe11edbda85c 433 /**
mbed_official 532:fe11edbda85c 434 * @}
mbed_official 532:fe11edbda85c 435 */
mbed_official 532:fe11edbda85c 436
mbed_official 532:fe11edbda85c 437 /* Private macros ------------------------------------------------------------*/
mbed_official 532:fe11edbda85c 438 /** @defgroup I2S_Private_Macros I2S Private Macros
mbed_official 532:fe11edbda85c 439 * @{
mbed_official 532:fe11edbda85c 440 */
mbed_official 532:fe11edbda85c 441 #define IS_I2S_CLOCKSOURCE(CLOCK) (((CLOCK) == I2S_CLOCK_EXTERNAL) || \
mbed_official 532:fe11edbda85c 442 ((CLOCK) == I2S_CLOCK_PLLR) ||\
mbed_official 532:fe11edbda85c 443 ((CLOCK) == I2S_CLOCK_PLLSRC) ||\
mbed_official 532:fe11edbda85c 444 ((CLOCK) == I2S_CLOCK_PLL))
mbed_official 532:fe11edbda85c 445
mbed_official 532:fe11edbda85c 446 #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX) || \
mbed_official 532:fe11edbda85c 447 ((MODE) == I2S_MODE_SLAVE_RX) || \
mbed_official 532:fe11edbda85c 448 ((MODE) == I2S_MODE_MASTER_TX) || \
mbed_official 532:fe11edbda85c 449 ((MODE) == I2S_MODE_MASTER_RX))
mbed_official 532:fe11edbda85c 450
mbed_official 532:fe11edbda85c 451 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS) || \
mbed_official 532:fe11edbda85c 452 ((STANDARD) == I2S_STANDARD_MSB) || \
mbed_official 532:fe11edbda85c 453 ((STANDARD) == I2S_STANDARD_LSB) || \
mbed_official 532:fe11edbda85c 454 ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
mbed_official 532:fe11edbda85c 455 ((STANDARD) == I2S_STANDARD_PCM_LONG))
mbed_official 532:fe11edbda85c 456
mbed_official 532:fe11edbda85c 457 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B) || \
mbed_official 532:fe11edbda85c 458 ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
mbed_official 532:fe11edbda85c 459 ((FORMAT) == I2S_DATAFORMAT_24B) || \
mbed_official 532:fe11edbda85c 460 ((FORMAT) == I2S_DATAFORMAT_32B))
mbed_official 532:fe11edbda85c 461
mbed_official 532:fe11edbda85c 462 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
mbed_official 532:fe11edbda85c 463 ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
mbed_official 532:fe11edbda85c 464
mbed_official 532:fe11edbda85c 465 #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K) && \
mbed_official 532:fe11edbda85c 466 ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
mbed_official 532:fe11edbda85c 467 ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
mbed_official 532:fe11edbda85c 468
mbed_official 532:fe11edbda85c 469 #define IS_I2S_FULLDUPLEX_MODE(MODE) (((MODE) == I2S_FULLDUPLEXMODE_DISABLE) || \
mbed_official 532:fe11edbda85c 470 ((MODE) == I2S_FULLDUPLEXMODE_ENABLE))
mbed_official 532:fe11edbda85c 471
mbed_official 532:fe11edbda85c 472 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
mbed_official 532:fe11edbda85c 473 ((CPOL) == I2S_CPOL_HIGH))
mbed_official 532:fe11edbda85c 474
mbed_official 532:fe11edbda85c 475 #define I2SxEXT(__INSTANCE__) ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE))
mbed_official 532:fe11edbda85c 476 /**
mbed_official 532:fe11edbda85c 477 * @}
mbed_official 532:fe11edbda85c 478 */
mbed_official 532:fe11edbda85c 479
mbed_official 532:fe11edbda85c 480 /* Private functions ---------------------------------------------------------*/
mbed_official 532:fe11edbda85c 481 /** @defgroup I2S_Private_Functions I2S Private Functions
mbed_official 532:fe11edbda85c 482 * @{
mbed_official 532:fe11edbda85c 483 */
mbed_official 87:085cde657901 484 void I2S_DMATxCplt(DMA_HandleTypeDef *hdma);
mbed_official 87:085cde657901 485 void I2S_DMATxHalfCplt(DMA_HandleTypeDef *hdma);
mbed_official 87:085cde657901 486 void I2S_DMARxCplt(DMA_HandleTypeDef *hdma);
mbed_official 87:085cde657901 487 void I2S_DMARxHalfCplt(DMA_HandleTypeDef *hdma);
mbed_official 87:085cde657901 488 void I2S_DMAError(DMA_HandleTypeDef *hdma);
mbed_official 87:085cde657901 489 HAL_StatusTypeDef I2S_WaitFlagStateUntilTimeout(I2S_HandleTypeDef *hi2s, uint32_t Flag, uint32_t Status, uint32_t Timeout);
mbed_official 532:fe11edbda85c 490 HAL_StatusTypeDef I2S_Transmit_IT(I2S_HandleTypeDef *hi2s);
mbed_official 532:fe11edbda85c 491 HAL_StatusTypeDef I2S_Receive_IT(I2S_HandleTypeDef *hi2s);
mbed_official 532:fe11edbda85c 492 /**
mbed_official 532:fe11edbda85c 493 * @}
mbed_official 532:fe11edbda85c 494 */
mbed_official 87:085cde657901 495
mbed_official 87:085cde657901 496 /**
mbed_official 87:085cde657901 497 * @}
mbed_official 87:085cde657901 498 */
mbed_official 87:085cde657901 499
mbed_official 87:085cde657901 500 /**
mbed_official 87:085cde657901 501 * @}
mbed_official 532:fe11edbda85c 502 */
mbed_official 87:085cde657901 503
mbed_official 87:085cde657901 504 #ifdef __cplusplus
mbed_official 87:085cde657901 505 }
mbed_official 87:085cde657901 506 #endif
mbed_official 87:085cde657901 507
mbed_official 87:085cde657901 508
mbed_official 87:085cde657901 509 #endif /* __STM32F4xx_HAL_I2S_H */
mbed_official 87:085cde657901 510
mbed_official 87:085cde657901 511 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/