Vladimir Vana / mbed

pro vyuku PSS v Jecne

TARGET_NUCLEO_F103RB/stm32f1xx_hal_i2s.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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