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_MOTE_L152RC/stm32l1xx_hal_i2s.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
112:6f327212ef96 
.

Who changed what in which revision?

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