mbed official / mbed

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

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_F302R8/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_i2s.h@128:9bcdf88f62b0, 2016-10-27 (annotated)

Committer:
<>
Date:
Thu Oct 27 16:45:56 2016 +0100
Revision:
128:9bcdf88f62b0
Parent:
TARGET_NUCLEO_F334R8/stm32f3xx_hal_i2s.h@123:b0220dba8be7
Child:
135:176b8275d35d
Release 128 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



2966: Add kw24 support https://github.com/ARMmbed/mbed-os/pull/2966

3068: MultiTech mDot - clean up PeripheralPins.c and add new pin names https://github.com/ARMmbed/mbed-os/pull/3068

3089: Kinetis HAL: Remove clock initialization code from serial and ticker  https://github.com/ARMmbed/mbed-os/pull/3089

2943: [NRF5] NVIC_SetVector functionality https://github.com/ARMmbed/mbed-os/pull/2943

2938: InterruptIn changes in NCS36510 HAL. https://github.com/ARMmbed/mbed-os/pull/2938

3108: Fix sleep function for NRF52. https://github.com/ARMmbed/mbed-os/pull/3108

3076: STM32F1: Correct timer master value reading https://github.com/ARMmbed/mbed-os/pull/3076

3085: Add LOWPOWERTIMER capability for NUCLEO_F303ZE https://github.com/ARMmbed/mbed-os/pull/3085

3046: [BEETLE] Update BLE stack on Beetle board https://github.com/ARMmbed/mbed-os/pull/3046

3122: [Silicon Labs] Update of Silicon Labs HAL https://github.com/ARMmbed/mbed-os/pull/3122

3022: OnSemi RAM usage fix https://github.com/ARMmbed/mbed-os/pull/3022

3121: STM32F3: Correct UART4 and UART5 defines when using DEVICE_SERIAL_ASYNCH https://github.com/ARMmbed/mbed-os/pull/3121

3142: Targets- NUMAKER_PFM_NUC47216 remove mbed 2 https://github.com/ARMmbed/mbed-os/pull/3142

Who changed what in which revision?

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