John Karatka / 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.

Fork of mbed-dev by mbed official

targets/TARGET_STM/TARGET_STM32F7/device/stm32f7xx_hal_i2s.h@168:9672193075cf, 2017-07-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Jul 06 15:42:05 2017 +0100
Revision:
168:9672193075cf
Parent:
161:2cc1468da177 
This updates the lib to the mbed lib v 146

Who changed what in which revision?

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