mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Committer:
mbed_official
Date:
Wed Jul 01 09:45:11 2015 +0100
Revision:
579:53297373a894
Parent:
489:119543c9f674
Synchronized with git revision d5b4d2ab9c47edb4dc5776e7177b0c2263459081

Full URL: https://github.com/mbedmicro/mbed/commit/d5b4d2ab9c47edb4dc5776e7177b0c2263459081/

Initial version of drivers for SAMR21

Who changed what in which revision?

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