Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F070RB/stm32f0xx_hal_i2s.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
108:34e6b704fe68 
.

Who changed what in which revision?

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