mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_NUCLEO_L011K4/stm32l0xx_hal_i2s.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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