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