雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

TARGET_NUCLEO_F302R8/stm32f3xx_hal_i2s.h@98:01a414ca7d6d, 2015-04-08 (annotated)

Committer:
yusuke_kyo
Date:
Wed Apr 08 08:04:18 2015 +0000
Revision:
98:01a414ca7d6d
Parent:
90:cb3d968589d8 
remove SerialHalfDuplex.h

Who changed what in which revision?

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