Jhon Plantikow / mbed

.

Dependents:   RTC

TARGET_NUCLEO_F072RB/stm32f0xx_hal_i2s.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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