Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F030R8/stm32f0xx_hal_i2s.h@90:cb3d968589d8, 2014-10-28 (annotated)

Committer:
Kojto
Date:
Tue Oct 28 16:40:41 2014 +0000
Revision:
90:cb3d968589d8
Child:
93:e188a91d3eaa
Release 90 of the mbed library



Changes:



- Freescale KSDK update (v1.0)

- K22 - new target addition

- KL43Z - new target addition

- Nucleo F091RC - new target addition

- Nucleo L152RE - STM32Cube driver

- Nordic - Softdevice v7.1.0

- Nvic files - BSD License

- LPC824 - various HAL fixes

- Nucleo F411RE - CMSIS - IAR files

Who changed what in which revision?

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