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

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

Committer:
AnnaBridge
Date:
Tue Mar 20 13:30:58 2018 +0000
Revision:
163:e59c8e839560
Child:
168:b9e159c1930a
mbed library. Release version 160

Who changed what in which revision?

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