mbed official / mbed

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

Committer:
AnnaBridge
Date:
Wed Nov 08 17:18:06 2017 +0000
Revision:
156:ff21514d8981
Child:
167:84c0a372a020
Reverting back to release 154 of the mbed library

Who changed what in which revision?

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