mbed official / mbed-dev

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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