[303] | 1 | /**
|
---|
| 2 | ******************************************************************************
|
---|
| 3 | * @file stm32f4xx_hal_i2c.h
|
---|
| 4 | * @author MCD Application Team
|
---|
| 5 | * @version V1.4.1
|
---|
| 6 | * @date 09-October-2015
|
---|
| 7 | * @brief Header file of I2C HAL module.
|
---|
| 8 | ******************************************************************************
|
---|
| 9 | * @attention
|
---|
| 10 | *
|
---|
| 11 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
|
---|
| 12 | *
|
---|
| 13 | * Redistribution and use in source and binary forms, with or without modification,
|
---|
| 14 | * are permitted provided that the following conditions are met:
|
---|
| 15 | * 1. Redistributions of source code must retain the above copyright notice,
|
---|
| 16 | * this list of conditions and the following disclaimer.
|
---|
| 17 | * 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
| 18 | * this list of conditions and the following disclaimer in the documentation
|
---|
| 19 | * and/or other materials provided with the distribution.
|
---|
| 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors
|
---|
| 21 | * may be used to endorse or promote products derived from this software
|
---|
| 22 | * without specific prior written permission.
|
---|
| 23 | *
|
---|
| 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
---|
| 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
---|
| 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
---|
| 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
---|
| 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
---|
| 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
---|
| 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
---|
| 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
---|
| 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
---|
| 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
---|
| 34 | *
|
---|
| 35 | ******************************************************************************
|
---|
| 36 | */
|
---|
| 37 |
|
---|
| 38 | /* Define to prevent recursive inclusion -------------------------------------*/
|
---|
| 39 | #ifndef __STM32F4xx_HAL_I2C_H
|
---|
| 40 | #define __STM32F4xx_HAL_I2C_H
|
---|
| 41 |
|
---|
| 42 | #ifdef __cplusplus
|
---|
| 43 | extern "C" {
|
---|
| 44 | #endif
|
---|
| 45 |
|
---|
| 46 | /* Includes ------------------------------------------------------------------*/
|
---|
| 47 | #include "stm32f4xx_hal_def.h"
|
---|
| 48 |
|
---|
| 49 | /** @addtogroup STM32F4xx_HAL_Driver
|
---|
| 50 | * @{
|
---|
| 51 | */
|
---|
| 52 |
|
---|
| 53 | /** @addtogroup I2C
|
---|
| 54 | * @{
|
---|
| 55 | */
|
---|
| 56 |
|
---|
| 57 | /* Exported types ------------------------------------------------------------*/
|
---|
| 58 | /** @defgroup I2C_Exported_Types I2C Exported Types
|
---|
| 59 | * @{
|
---|
| 60 | */
|
---|
| 61 |
|
---|
| 62 | /**
|
---|
| 63 | * @brief I2C Configuration Structure definition
|
---|
| 64 | */
|
---|
| 65 | typedef struct
|
---|
| 66 | {
|
---|
| 67 | uint32_t ClockSpeed; /*!< Specifies the clock frequency.
|
---|
| 68 | This parameter must be set to a value lower than 400kHz */
|
---|
| 69 |
|
---|
| 70 | uint32_t DutyCycle; /*!< Specifies the I2C fast mode duty cycle.
|
---|
| 71 | This parameter can be a value of @ref I2C_duty_cycle_in_fast_mode */
|
---|
| 72 |
|
---|
| 73 | uint32_t OwnAddress1; /*!< Specifies the first device own address.
|
---|
| 74 | This parameter can be a 7-bit or 10-bit address. */
|
---|
| 75 |
|
---|
| 76 | uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected.
|
---|
| 77 | This parameter can be a value of @ref I2C_addressing_mode */
|
---|
| 78 |
|
---|
| 79 | uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected.
|
---|
| 80 | This parameter can be a value of @ref I2C_dual_addressing_mode */
|
---|
| 81 |
|
---|
| 82 | uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected
|
---|
| 83 | This parameter can be a 7-bit address. */
|
---|
| 84 |
|
---|
| 85 | uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
|
---|
| 86 | This parameter can be a value of @ref I2C_general_call_addressing_mode */
|
---|
| 87 |
|
---|
| 88 | uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
|
---|
| 89 | This parameter can be a value of @ref I2C_nostretch_mode */
|
---|
| 90 |
|
---|
| 91 | }I2C_InitTypeDef;
|
---|
| 92 |
|
---|
| 93 | /**
|
---|
| 94 | * @brief HAL State structures definition
|
---|
| 95 | */
|
---|
| 96 | typedef enum
|
---|
| 97 | {
|
---|
| 98 | HAL_I2C_STATE_RESET = 0x00, /*!< I2C not yet initialized or disabled */
|
---|
| 99 | HAL_I2C_STATE_READY = 0x01, /*!< I2C initialized and ready for use */
|
---|
| 100 | HAL_I2C_STATE_BUSY = 0x02, /*!< I2C internal process is ongoing */
|
---|
| 101 | HAL_I2C_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
|
---|
| 102 | HAL_I2C_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
|
---|
| 103 | HAL_I2C_STATE_MEM_BUSY_TX = 0x32, /*!< Memory Data Transmission process is ongoing */
|
---|
| 104 | HAL_I2C_STATE_MEM_BUSY_RX = 0x42, /*!< Memory Data Reception process is ongoing */
|
---|
| 105 | HAL_I2C_STATE_TIMEOUT = 0x03, /*!< I2C timeout state */
|
---|
| 106 | HAL_I2C_STATE_ERROR = 0x04 /*!< I2C error state */
|
---|
| 107 |
|
---|
| 108 | }HAL_I2C_StateTypeDef;
|
---|
| 109 |
|
---|
| 110 | /**
|
---|
| 111 | * @brief I2C handle Structure definition
|
---|
| 112 | */
|
---|
| 113 | typedef struct
|
---|
| 114 | {
|
---|
| 115 | I2C_TypeDef *Instance; /*!< I2C registers base address */
|
---|
| 116 |
|
---|
| 117 | I2C_InitTypeDef Init; /*!< I2C communication parameters */
|
---|
| 118 |
|
---|
| 119 | uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
|
---|
| 120 |
|
---|
| 121 | uint16_t XferSize; /*!< I2C transfer size */
|
---|
| 122 |
|
---|
| 123 | __IO uint16_t XferCount; /*!< I2C transfer counter */
|
---|
| 124 |
|
---|
| 125 | DMA_HandleTypeDef *hdmatx; /*!< I2C Tx DMA handle parameters */
|
---|
| 126 |
|
---|
| 127 | DMA_HandleTypeDef *hdmarx; /*!< I2C Rx DMA handle parameters */
|
---|
| 128 |
|
---|
| 129 | HAL_LockTypeDef Lock; /*!< I2C locking object */
|
---|
| 130 |
|
---|
| 131 | __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */
|
---|
| 132 |
|
---|
| 133 | __IO uint32_t ErrorCode; /*!< I2C Error code */
|
---|
| 134 |
|
---|
| 135 | }I2C_HandleTypeDef;
|
---|
| 136 | /**
|
---|
| 137 | * @}
|
---|
| 138 | */
|
---|
| 139 |
|
---|
| 140 | /* Exported constants --------------------------------------------------------*/
|
---|
| 141 | /** @defgroup I2C_Exported_Constants I2C Exported Constants
|
---|
| 142 | * @{
|
---|
| 143 | */
|
---|
| 144 |
|
---|
| 145 | /** @defgroup I2C_Error_Code I2C Error Code
|
---|
| 146 | * @brief I2C Error Code
|
---|
| 147 | * @{
|
---|
| 148 | */
|
---|
| 149 | #define HAL_I2C_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
|
---|
| 150 | #define HAL_I2C_ERROR_BERR ((uint32_t)0x00000001) /*!< BERR error */
|
---|
| 151 | #define HAL_I2C_ERROR_ARLO ((uint32_t)0x00000002) /*!< ARLO error */
|
---|
| 152 | #define HAL_I2C_ERROR_AF ((uint32_t)0x00000004) /*!< AF error */
|
---|
| 153 | #define HAL_I2C_ERROR_OVR ((uint32_t)0x00000008) /*!< OVR error */
|
---|
| 154 | #define HAL_I2C_ERROR_DMA ((uint32_t)0x00000010) /*!< DMA transfer error */
|
---|
| 155 | #define HAL_I2C_ERROR_TIMEOUT ((uint32_t)0x00000020) /*!< Timeout Error */
|
---|
| 156 | /**
|
---|
| 157 | * @}
|
---|
| 158 | */
|
---|
| 159 |
|
---|
| 160 | /** @defgroup I2C_duty_cycle_in_fast_mode I2C duty cycle in fast mode
|
---|
| 161 | * @{
|
---|
| 162 | */
|
---|
| 163 | #define I2C_DUTYCYCLE_2 ((uint32_t)0x00000000)
|
---|
| 164 | #define I2C_DUTYCYCLE_16_9 I2C_CCR_DUTY
|
---|
| 165 | /**
|
---|
| 166 | * @}
|
---|
| 167 | */
|
---|
| 168 |
|
---|
| 169 | /** @defgroup I2C_addressing_mode I2C addressing mode
|
---|
| 170 | * @{
|
---|
| 171 | */
|
---|
| 172 | #define I2C_ADDRESSINGMODE_7BIT ((uint32_t)0x00004000)
|
---|
| 173 | #define I2C_ADDRESSINGMODE_10BIT (I2C_OAR1_ADDMODE | ((uint32_t)0x00004000))
|
---|
| 174 | /**
|
---|
| 175 | * @}
|
---|
| 176 | */
|
---|
| 177 |
|
---|
| 178 | /** @defgroup I2C_dual_addressing_mode I2C dual addressing mode
|
---|
| 179 | * @{
|
---|
| 180 | */
|
---|
| 181 | #define I2C_DUALADDRESS_DISABLE ((uint32_t)0x00000000)
|
---|
| 182 | #define I2C_DUALADDRESS_ENABLE I2C_OAR2_ENDUAL
|
---|
| 183 | /**
|
---|
| 184 | * @}
|
---|
| 185 | */
|
---|
| 186 |
|
---|
| 187 | /** @defgroup I2C_general_call_addressing_mode I2C general call addressing mode
|
---|
| 188 | * @{
|
---|
| 189 | */
|
---|
| 190 | #define I2C_GENERALCALL_DISABLE ((uint32_t)0x00000000)
|
---|
| 191 | #define I2C_GENERALCALL_ENABLE I2C_CR1_ENGC
|
---|
| 192 | /**
|
---|
| 193 | * @}
|
---|
| 194 | */
|
---|
| 195 |
|
---|
| 196 | /** @defgroup I2C_nostretch_mode I2C nostretch mode
|
---|
| 197 | * @{
|
---|
| 198 | */
|
---|
| 199 | #define I2C_NOSTRETCH_DISABLE ((uint32_t)0x00000000)
|
---|
| 200 | #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
|
---|
| 201 | /**
|
---|
| 202 | * @}
|
---|
| 203 | */
|
---|
| 204 |
|
---|
| 205 | /** @defgroup I2C_Memory_Address_Size I2C Memory Address Size
|
---|
| 206 | * @{
|
---|
| 207 | */
|
---|
| 208 | #define I2C_MEMADD_SIZE_8BIT ((uint32_t)0x00000001)
|
---|
| 209 | #define I2C_MEMADD_SIZE_16BIT ((uint32_t)0x00000010)
|
---|
| 210 | /**
|
---|
| 211 | * @}
|
---|
| 212 | */
|
---|
| 213 |
|
---|
| 214 | /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition
|
---|
| 215 | * @{
|
---|
| 216 | */
|
---|
| 217 | #define I2C_IT_BUF I2C_CR2_ITBUFEN
|
---|
| 218 | #define I2C_IT_EVT I2C_CR2_ITEVTEN
|
---|
| 219 | #define I2C_IT_ERR I2C_CR2_ITERREN
|
---|
| 220 | /**
|
---|
| 221 | * @}
|
---|
| 222 | */
|
---|
| 223 |
|
---|
| 224 | /** @defgroup I2C_Flag_definition I2C Flag definition
|
---|
| 225 | * @{
|
---|
| 226 | */
|
---|
| 227 | #define I2C_FLAG_SMBALERT ((uint32_t)0x00018000)
|
---|
| 228 | #define I2C_FLAG_TIMEOUT ((uint32_t)0x00014000)
|
---|
| 229 | #define I2C_FLAG_PECERR ((uint32_t)0x00011000)
|
---|
| 230 | #define I2C_FLAG_OVR ((uint32_t)0x00010800)
|
---|
| 231 | #define I2C_FLAG_AF ((uint32_t)0x00010400)
|
---|
| 232 | #define I2C_FLAG_ARLO ((uint32_t)0x00010200)
|
---|
| 233 | #define I2C_FLAG_BERR ((uint32_t)0x00010100)
|
---|
| 234 | #define I2C_FLAG_TXE ((uint32_t)0x00010080)
|
---|
| 235 | #define I2C_FLAG_RXNE ((uint32_t)0x00010040)
|
---|
| 236 | #define I2C_FLAG_STOPF ((uint32_t)0x00010010)
|
---|
| 237 | #define I2C_FLAG_ADD10 ((uint32_t)0x00010008)
|
---|
| 238 | #define I2C_FLAG_BTF ((uint32_t)0x00010004)
|
---|
| 239 | #define I2C_FLAG_ADDR ((uint32_t)0x00010002)
|
---|
| 240 | #define I2C_FLAG_SB ((uint32_t)0x00010001)
|
---|
| 241 | #define I2C_FLAG_DUALF ((uint32_t)0x00100080)
|
---|
| 242 | #define I2C_FLAG_SMBHOST ((uint32_t)0x00100040)
|
---|
| 243 | #define I2C_FLAG_SMBDEFAULT ((uint32_t)0x00100020)
|
---|
| 244 | #define I2C_FLAG_GENCALL ((uint32_t)0x00100010)
|
---|
| 245 | #define I2C_FLAG_TRA ((uint32_t)0x00100004)
|
---|
| 246 | #define I2C_FLAG_BUSY ((uint32_t)0x00100002)
|
---|
| 247 | #define I2C_FLAG_MSL ((uint32_t)0x00100001)
|
---|
| 248 | /**
|
---|
| 249 | * @}
|
---|
| 250 | */
|
---|
| 251 |
|
---|
| 252 | /**
|
---|
| 253 | * @}
|
---|
| 254 | */
|
---|
| 255 |
|
---|
| 256 | /* Exported macro ------------------------------------------------------------*/
|
---|
| 257 | /** @defgroup I2C_Exported_Macros I2C Exported Macros
|
---|
| 258 | * @{
|
---|
| 259 | */
|
---|
| 260 |
|
---|
| 261 | /** @brief Reset I2C handle state
|
---|
| 262 | * @param __HANDLE__: specifies the I2C Handle.
|
---|
| 263 | * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
|
---|
| 264 | * @retval None
|
---|
| 265 | */
|
---|
| 266 | #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
|
---|
| 267 |
|
---|
| 268 | /** @brief Enable or disable the specified I2C interrupts.
|
---|
| 269 | * @param __HANDLE__: specifies the I2C Handle.
|
---|
| 270 | * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
|
---|
| 271 | * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
|
---|
| 272 | * This parameter can be one of the following values:
|
---|
| 273 | * @arg I2C_IT_BUF: Buffer interrupt enable
|
---|
| 274 | * @arg I2C_IT_EVT: Event interrupt enable
|
---|
| 275 | * @arg I2C_IT_ERR: Error interrupt enable
|
---|
| 276 | * @retval None
|
---|
| 277 | */
|
---|
| 278 | #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
|
---|
| 279 | #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= (~(__INTERRUPT__)))
|
---|
| 280 |
|
---|
| 281 | /** @brief Checks if the specified I2C interrupt source is enabled or disabled.
|
---|
| 282 | * @param __HANDLE__: specifies the I2C Handle.
|
---|
| 283 | * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
|
---|
| 284 | * @param __INTERRUPT__: specifies the I2C interrupt source to check.
|
---|
| 285 | * This parameter can be one of the following values:
|
---|
| 286 | * @arg I2C_IT_BUF: Buffer interrupt enable
|
---|
| 287 | * @arg I2C_IT_EVT: Event interrupt enable
|
---|
| 288 | * @arg I2C_IT_ERR: Error interrupt enable
|
---|
| 289 | * @retval The new state of __INTERRUPT__ (TRUE or FALSE).
|
---|
| 290 | */
|
---|
| 291 | #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
|
---|
| 292 |
|
---|
| 293 | /** @brief Checks whether the specified I2C flag is set or not.
|
---|
| 294 | * @param __HANDLE__: specifies the I2C Handle.
|
---|
| 295 | * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
|
---|
| 296 | * @param __FLAG__: specifies the flag to check.
|
---|
| 297 | * This parameter can be one of the following values:
|
---|
| 298 | * @arg I2C_FLAG_SMBALERT: SMBus Alert flag
|
---|
| 299 | * @arg I2C_FLAG_TIMEOUT: Timeout or Tlow error flag
|
---|
| 300 | * @arg I2C_FLAG_PECERR: PEC error in reception flag
|
---|
| 301 | * @arg I2C_FLAG_OVR: Overrun/Underrun flag
|
---|
| 302 | * @arg I2C_FLAG_AF: Acknowledge failure flag
|
---|
| 303 | * @arg I2C_FLAG_ARLO: Arbitration lost flag
|
---|
| 304 | * @arg I2C_FLAG_BERR: Bus error flag
|
---|
| 305 | * @arg I2C_FLAG_TXE: Data register empty flag
|
---|
| 306 | * @arg I2C_FLAG_RXNE: Data register not empty flag
|
---|
| 307 | * @arg I2C_FLAG_STOPF: Stop detection flag
|
---|
| 308 | * @arg I2C_FLAG_ADD10: 10-bit header sent flag
|
---|
| 309 | * @arg I2C_FLAG_BTF: Byte transfer finished flag
|
---|
| 310 | * @arg I2C_FLAG_ADDR: Address sent flag
|
---|
| 311 | * Address matched flag
|
---|
| 312 | * @arg I2C_FLAG_SB: Start bit flag
|
---|
| 313 | * @arg I2C_FLAG_DUALF: Dual flag
|
---|
| 314 | * @arg I2C_FLAG_SMBHOST: SMBus host header
|
---|
| 315 | * @arg I2C_FLAG_SMBDEFAULT: SMBus default header
|
---|
| 316 | * @arg I2C_FLAG_GENCALL: General call header flag
|
---|
| 317 | * @arg I2C_FLAG_TRA: Transmitter/Receiver flag
|
---|
| 318 | * @arg I2C_FLAG_BUSY: Bus busy flag
|
---|
| 319 | * @arg I2C_FLAG_MSL: Master/Slave flag
|
---|
| 320 | * @retval The new state of __FLAG__ (TRUE or FALSE).
|
---|
| 321 | */
|
---|
| 322 | #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) ((((uint8_t)((__FLAG__) >> 16)) == 0x01)?((((__HANDLE__)->Instance->SR1) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)): \
|
---|
| 323 | ((((__HANDLE__)->Instance->SR2) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)))
|
---|
| 324 |
|
---|
| 325 | /** @brief Clears the I2C pending flags which are cleared by writing 0 in a specific bit.
|
---|
| 326 | * @param __HANDLE__: specifies the I2C Handle.
|
---|
| 327 | * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
|
---|
| 328 | * @param __FLAG__: specifies the flag to clear.
|
---|
| 329 | * This parameter can be any combination of the following values:
|
---|
| 330 | * @arg I2C_FLAG_SMBALERT: SMBus Alert flag
|
---|
| 331 | * @arg I2C_FLAG_TIMEOUT: Timeout or Tlow error flag
|
---|
| 332 | * @arg I2C_FLAG_PECERR: PEC error in reception flag
|
---|
| 333 | * @arg I2C_FLAG_OVR: Overrun/Underrun flag (Slave mode)
|
---|
| 334 | * @arg I2C_FLAG_AF: Acknowledge failure flag
|
---|
| 335 | * @arg I2C_FLAG_ARLO: Arbitration lost flag (Master mode)
|
---|
| 336 | * @arg I2C_FLAG_BERR: Bus error flag
|
---|
| 337 | * @retval None
|
---|
| 338 | */
|
---|
| 339 | #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR1 = ~((__FLAG__) & I2C_FLAG_MASK))
|
---|
| 340 |
|
---|
| 341 | /** @brief Clears the I2C ADDR pending flag.
|
---|
| 342 | * @param __HANDLE__: specifies the I2C Handle.
|
---|
| 343 | * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
|
---|
| 344 | * @retval None
|
---|
| 345 | */
|
---|
| 346 | #define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__) \
|
---|
| 347 | do{ \
|
---|
| 348 | __IO uint32_t tmpreg; \
|
---|
| 349 | tmpreg = (__HANDLE__)->Instance->SR1; \
|
---|
| 350 | tmpreg = (__HANDLE__)->Instance->SR2; \
|
---|
| 351 | UNUSED(tmpreg); \
|
---|
| 352 | } while(0)
|
---|
| 353 |
|
---|
| 354 | /** @brief Clears the I2C STOPF pending flag.
|
---|
| 355 | * @param __HANDLE__: specifies the I2C Handle.
|
---|
| 356 | * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
|
---|
| 357 | * @retval None
|
---|
| 358 | */
|
---|
| 359 | #define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__) \
|
---|
| 360 | do{ \
|
---|
| 361 | __IO uint32_t tmpreg; \
|
---|
| 362 | tmpreg = (__HANDLE__)->Instance->SR1; \
|
---|
| 363 | (__HANDLE__)->Instance->CR1 |= I2C_CR1_PE; \
|
---|
| 364 | UNUSED(tmpreg); \
|
---|
| 365 | } while(0)
|
---|
| 366 |
|
---|
| 367 | #define __HAL_I2C_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= I2C_CR1_PE)
|
---|
| 368 | #define __HAL_I2C_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~I2C_CR1_PE)
|
---|
| 369 |
|
---|
| 370 | /**
|
---|
| 371 | * @}
|
---|
| 372 | */
|
---|
| 373 |
|
---|
| 374 | /* Include I2C HAL Extension module */
|
---|
| 375 | #include "stm32f4xx_hal_i2c_ex.h"
|
---|
| 376 |
|
---|
| 377 | /* Exported functions --------------------------------------------------------*/
|
---|
| 378 | /** @addtogroup I2C_Exported_Functions
|
---|
| 379 | * @{
|
---|
| 380 | */
|
---|
| 381 |
|
---|
| 382 | /** @addtogroup I2C_Exported_Functions_Group1
|
---|
| 383 | * @{
|
---|
| 384 | */
|
---|
| 385 | /* Initialization/de-initialization functions **********************************/
|
---|
| 386 | HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
|
---|
| 387 | HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c);
|
---|
| 388 | void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
|
---|
| 389 | void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
|
---|
| 390 | /**
|
---|
| 391 | * @}
|
---|
| 392 | */
|
---|
| 393 |
|
---|
| 394 | /** @addtogroup I2C_Exported_Functions_Group2
|
---|
| 395 | * @{
|
---|
| 396 | */
|
---|
| 397 | /* I/O operation functions *****************************************************/
|
---|
| 398 | /******* Blocking mode: Polling */
|
---|
| 399 | HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
---|
| 400 | HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
---|
| 401 | HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
---|
| 402 | HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
---|
| 403 | HAL_StatusTypeDef HAL_I2C_Mem_Write(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
---|
| 404 | HAL_StatusTypeDef HAL_I2C_Mem_Read(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
|
---|
| 405 | HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
|
---|
| 406 |
|
---|
| 407 | /******* Non-Blocking mode: Interrupt */
|
---|
| 408 | HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
|
---|
| 409 | HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
|
---|
| 410 | HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
|
---|
| 411 | HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
|
---|
| 412 | HAL_StatusTypeDef HAL_I2C_Mem_Write_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
|
---|
| 413 | HAL_StatusTypeDef HAL_I2C_Mem_Read_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
|
---|
| 414 |
|
---|
| 415 | /******* Non-Blocking mode: DMA */
|
---|
| 416 | HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
|
---|
| 417 | HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
|
---|
| 418 | HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
|
---|
| 419 | HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
|
---|
| 420 | HAL_StatusTypeDef HAL_I2C_Mem_Write_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
|
---|
| 421 | HAL_StatusTypeDef HAL_I2C_Mem_Read_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
|
---|
| 422 |
|
---|
| 423 | /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
|
---|
| 424 | void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
|
---|
| 425 | void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
|
---|
| 426 | void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
|
---|
| 427 | void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
|
---|
| 428 | void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
|
---|
| 429 | void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
|
---|
| 430 | void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
|
---|
| 431 | void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
|
---|
| 432 | void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
|
---|
| 433 | /**
|
---|
| 434 | * @}
|
---|
| 435 | */
|
---|
| 436 |
|
---|
| 437 | /** @addtogroup I2C_Exported_Functions_Group3
|
---|
| 438 | * @{
|
---|
| 439 | */
|
---|
| 440 | /* Peripheral Control and State functions **************************************/
|
---|
| 441 | HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
|
---|
| 442 | uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
|
---|
| 443 |
|
---|
| 444 | /**
|
---|
| 445 | * @}
|
---|
| 446 | */
|
---|
| 447 |
|
---|
| 448 | /**
|
---|
| 449 | * @}
|
---|
| 450 | */
|
---|
| 451 | /* Private types -------------------------------------------------------------*/
|
---|
| 452 | /* Private variables ---------------------------------------------------------*/
|
---|
| 453 | /* Private constants ---------------------------------------------------------*/
|
---|
| 454 | /** @defgroup I2C_Private_Constants I2C Private Constants
|
---|
| 455 | * @{
|
---|
| 456 | */
|
---|
| 457 | #define I2C_FLAG_MASK ((uint32_t)0x0000FFFF)
|
---|
| 458 | /**
|
---|
| 459 | * @}
|
---|
| 460 | */
|
---|
| 461 |
|
---|
| 462 | /* Private macros ------------------------------------------------------------*/
|
---|
| 463 | /** @defgroup I2C_Private_Macros I2C Private Macros
|
---|
| 464 | * @{
|
---|
| 465 | */
|
---|
| 466 |
|
---|
| 467 | #define I2C_FREQRANGE(__PCLK__) ((__PCLK__)/1000000)
|
---|
| 468 | #define I2C_RISE_TIME(__FREQRANGE__, __SPEED__) (((__SPEED__) <= 100000) ? ((__FREQRANGE__) + 1) : ((((__FREQRANGE__) * 300) / 1000) + 1))
|
---|
| 469 | #define I2C_SPEED_STANDARD(__PCLK__, __SPEED__) (((((__PCLK__)/((__SPEED__) << 1)) & I2C_CCR_CCR) < 4)? 4:((__PCLK__) / ((__SPEED__) << 1)))
|
---|
| 470 | #define I2C_SPEED_FAST(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__DUTYCYCLE__) == I2C_DUTYCYCLE_2)? ((__PCLK__) / ((__SPEED__) * 3)) : (((__PCLK__) / ((__SPEED__) * 25)) | I2C_DUTYCYCLE_16_9))
|
---|
| 471 | #define I2C_SPEED(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__SPEED__) <= 100000)? (I2C_SPEED_STANDARD((__PCLK__), (__SPEED__))) : \
|
---|
| 472 | ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__)) & I2C_CCR_CCR) == 0)? 1 : \
|
---|
| 473 | ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__))) | I2C_CCR_FS))
|
---|
| 474 |
|
---|
| 475 | #define I2C_7BIT_ADD_WRITE(__ADDRESS__) ((uint8_t)((__ADDRESS__) & (~I2C_OAR1_ADD0)))
|
---|
| 476 | #define I2C_7BIT_ADD_READ(__ADDRESS__) ((uint8_t)((__ADDRESS__) | I2C_OAR1_ADD0))
|
---|
| 477 |
|
---|
| 478 | #define I2C_10BIT_ADDRESS(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FF))))
|
---|
| 479 | #define I2C_10BIT_HEADER_WRITE(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0x0300))) >> 7) | (uint16_t)(0xF0))))
|
---|
| 480 | #define I2C_10BIT_HEADER_READ(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0x0300))) >> 7) | (uint16_t)(0xF1))))
|
---|
| 481 |
|
---|
| 482 | #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0xFF00))) >> 8)))
|
---|
| 483 | #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FF))))
|
---|
| 484 |
|
---|
| 485 | /** @defgroup I2C_IS_RTC_Definitions I2C Private macros to check input parameters
|
---|
| 486 | * @{
|
---|
| 487 | */
|
---|
| 488 | #define IS_I2C_DUTY_CYCLE(CYCLE) (((CYCLE) == I2C_DUTYCYCLE_2) || \
|
---|
| 489 | ((CYCLE) == I2C_DUTYCYCLE_16_9))
|
---|
| 490 | #define IS_I2C_ADDRESSING_MODE(ADDRESS) (((ADDRESS) == I2C_ADDRESSINGMODE_7BIT) || \
|
---|
| 491 | ((ADDRESS) == I2C_ADDRESSINGMODE_10BIT))
|
---|
| 492 | #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \
|
---|
| 493 | ((ADDRESS) == I2C_DUALADDRESS_ENABLE))
|
---|
| 494 | #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \
|
---|
| 495 | ((CALL) == I2C_GENERALCALL_ENABLE))
|
---|
| 496 | #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \
|
---|
| 497 | ((STRETCH) == I2C_NOSTRETCH_ENABLE))
|
---|
| 498 | #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
|
---|
| 499 | ((SIZE) == I2C_MEMADD_SIZE_16BIT))
|
---|
| 500 | #define IS_I2C_CLOCK_SPEED(SPEED) (((SPEED) > 0) && ((SPEED) <= 400000))
|
---|
| 501 | #define IS_I2C_OWN_ADDRESS1(ADDRESS1) (((ADDRESS1) & (uint32_t)(0xFFFFFC00)) == 0)
|
---|
| 502 | #define IS_I2C_OWN_ADDRESS2(ADDRESS2) (((ADDRESS2) & (uint32_t)(0xFFFFFF01)) == 0)
|
---|
| 503 | /**
|
---|
| 504 | * @}
|
---|
| 505 | */
|
---|
| 506 |
|
---|
| 507 | /**
|
---|
| 508 | * @}
|
---|
| 509 | */
|
---|
| 510 |
|
---|
| 511 | /* Private functions ---------------------------------------------------------*/
|
---|
| 512 | /** @defgroup I2C_Private_Functions I2C Private Functions
|
---|
| 513 | * @{
|
---|
| 514 | */
|
---|
| 515 |
|
---|
| 516 | /**
|
---|
| 517 | * @}
|
---|
| 518 | */
|
---|
| 519 |
|
---|
| 520 | /**
|
---|
| 521 | * @}
|
---|
| 522 | */
|
---|
| 523 |
|
---|
| 524 | /**
|
---|
| 525 | * @}
|
---|
| 526 | */
|
---|
| 527 |
|
---|
| 528 | #ifdef __cplusplus
|
---|
| 529 | }
|
---|
| 530 | #endif
|
---|
| 531 |
|
---|
| 532 |
|
---|
| 533 | #endif /* __STM32F4xx_HAL_I2C_H */
|
---|
| 534 |
|
---|
| 535 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
---|