mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_i2s.h@226:b062af740e40, 2014-06-11 (annotated)

Committer:
mbed_official
Date:
Wed Jun 11 09:45:09 2014 +0100
Revision:
226:b062af740e40
Parent:
106:ced8cbb51063
Child:
369:2e96f1b71984
Synchronized with git revision 42deb9ac55f9bdf9835e9c41dc757117d344ffda



Full URL: https://github.com/mbedmicro/mbed/commit/42deb9ac55f9bdf9835e9c41dc757117d344ffda/



[NUCLEO_F401RE] Remove call to Systick + bug fixes

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