Egor Rumjantsev / mbed

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

Fork of mbed by mbed official

TARGET_NUCLEO_F334R8/stm32f3xx_hal_i2s.h@86:04dd9b1680ae, 2014-07-02 (annotated)

Committer:
bogdanm
Date:
Wed Jul 02 13:22:23 2014 +0100
Revision:
86:04dd9b1680ae
Child:
92:4fc01daae5a5
Release 86 of the mbed library



Main changes:





- bug fixes in various backends

- mbed "error" replaced by assert logic (mbed_assert)

- new ST Nucleo targets

Who changed what in which revision?

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