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.

Committer:
Kojto
Date:
Tue Feb 14 11:24:20 2017 +0000
Revision:
136:ef9c61f8c49f
Parent:
135:176b8275d35d
Child:
139:856d2700e60b
Release 136 of the mbed library

Ports for Upcoming Targets


Fixes and Changes

3432: Target STM USBHOST support https://github.com/ARMmbed/mbed-os/pull/3432
3181: NUCLEO_F207ZG extending PeripheralPins.c: all available alternate functions can be used now https://github.com/ARMmbed/mbed-os/pull/3181
3626: NUCLEO_F412ZG : Add USB Device +Host https://github.com/ARMmbed/mbed-os/pull/3626
3628: Fix warnings https://github.com/ARMmbed/mbed-os/pull/3628
3629: STM32: L0 LL layer https://github.com/ARMmbed/mbed-os/pull/3629
3632: IDE Export support for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3632
3642: Missing IRQ pin fix for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3642
3664: Fix ncs36510 sleep definitions https://github.com/ARMmbed/mbed-os/pull/3664
3655: [STM32F4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3655
3657: [STM32L4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3657
3658: [STM32F3] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3658
3685: STM32: I2C: reset state machine https://github.com/ARMmbed/mbed-os/pull/3685
3692: uVisor: Standardize available legacy heap and stack https://github.com/ARMmbed/mbed-os/pull/3692
3621: Fix for #2884, LPC824: export to LPCXpresso, target running with wron https://github.com/ARMmbed/mbed-os/pull/3621
3649: [STM32F7] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3649
3695: Enforce device_name is valid in targets.json https://github.com/ARMmbed/mbed-os/pull/3695
3723: NCS36510: spi_format function bug fix https://github.com/ARMmbed/mbed-os/pull/3723

Who changed what in which revision?

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