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