1 /** 2 ****************************************************************************** 3 * @file stm32mp1xx_hal_i2c.h 4 * @author MCD Application Team 5 * @brief Header file of I2C HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© Copyright (c) 2019 STMicroelectronics. 10 * All rights reserved.</center></h2> 11 * 12 * This software component is licensed by ST under BSD 3-Clause license, 13 * the "License"; You may not use this file except in compliance with the 14 * License. You may obtain a copy of the License at: 15 * opensource.org/licenses/BSD-3-Clause 16 * 17 ****************************************************************************** 18 */ 19 20 /* Define to prevent recursive inclusion -------------------------------------*/ 21 #ifndef STM32MP1xx_HAL_I2C_H 22 #define STM32MP1xx_HAL_I2C_H 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 /* Includes ------------------------------------------------------------------*/ 29 #include "stm32mp1xx_hal_def.h" 30 31 /** @addtogroup STM32MP1xx_HAL_Driver 32 * @{ 33 */ 34 35 /** @addtogroup I2C 36 * @{ 37 */ 38 39 /* Exported types ------------------------------------------------------------*/ 40 /** @defgroup I2C_Exported_Types I2C Exported Types 41 * @{ 42 */ 43 44 /** @defgroup I2C_Configuration_Structure_definition I2C Configuration Structure definition 45 * @brief I2C Configuration Structure definition 46 * @{ 47 */ 48 typedef struct 49 { 50 uint32_t Timing; /*!< Specifies the I2C_TIMINGR_register value. 51 This parameter calculated by referring to I2C initialization 52 section in Reference manual */ 53 54 uint32_t OwnAddress1; /*!< Specifies the first device own address. 55 This parameter can be a 7-bit or 10-bit address. */ 56 57 uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected. 58 This parameter can be a value of @ref I2C_ADDRESSING_MODE */ 59 60 uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected. 61 This parameter can be a value of @ref I2C_DUAL_ADDRESSING_MODE */ 62 63 uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected 64 This parameter can be a 7-bit address. */ 65 66 uint32_t OwnAddress2Masks; /*!< Specifies the acknowledge mask address second device own address if dual addressing mode is selected 67 This parameter can be a value of @ref I2C_OWN_ADDRESS2_MASKS */ 68 69 uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected. 70 This parameter can be a value of @ref I2C_GENERAL_CALL_ADDRESSING_MODE */ 71 72 uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected. 73 This parameter can be a value of @ref I2C_NOSTRETCH_MODE */ 74 75 } I2C_InitTypeDef; 76 /** 77 * @} 78 */ 79 80 /** @defgroup HAL_state_structure_definition HAL state structure definition 81 * @brief HAL State structure definition 82 * @note HAL I2C State value coding follow below described bitmap :\n 83 * b7-b6 Error information\n 84 * 00 : No Error\n 85 * 01 : Abort (Abort user request on going)\n 86 * 10 : Timeout\n 87 * 11 : Error\n 88 * b5 Peripheral initialization status\n 89 * 0 : Reset (peripheral not initialized)\n 90 * 1 : Init done (peripheral initialized and ready to use. HAL I2C Init function called)\n 91 * b4 (not used)\n 92 * x : Should be set to 0\n 93 * b3\n 94 * 0 : Ready or Busy (No Listen mode ongoing)\n 95 * 1 : Listen (peripheral in Address Listen Mode)\n 96 * b2 Intrinsic process state\n 97 * 0 : Ready\n 98 * 1 : Busy (peripheral busy with some configuration or internal operations)\n 99 * b1 Rx state\n 100 * 0 : Ready (no Rx operation ongoing)\n 101 * 1 : Busy (Rx operation ongoing)\n 102 * b0 Tx state\n 103 * 0 : Ready (no Tx operation ongoing)\n 104 * 1 : Busy (Tx operation ongoing) 105 * @{ 106 */ 107 typedef enum 108 { 109 HAL_I2C_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized */ 110 HAL_I2C_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use */ 111 HAL_I2C_STATE_BUSY = 0x24U, /*!< An internal process is ongoing */ 112 HAL_I2C_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing */ 113 HAL_I2C_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */ 114 HAL_I2C_STATE_LISTEN = 0x28U, /*!< Address Listen Mode is ongoing */ 115 HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U, /*!< Address Listen Mode and Data Transmission 116 process is ongoing */ 117 HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU, /*!< Address Listen Mode and Data Reception 118 process is ongoing */ 119 HAL_I2C_STATE_ABORT = 0x60U, /*!< Abort user request ongoing */ 120 HAL_I2C_STATE_TIMEOUT = 0xA0U, /*!< Timeout state */ 121 HAL_I2C_STATE_ERROR = 0xE0U /*!< Error */ 122 123 } HAL_I2C_StateTypeDef; 124 125 /** 126 * @} 127 */ 128 129 /** @defgroup HAL_mode_structure_definition HAL mode structure definition 130 * @brief HAL Mode structure definition 131 * @note HAL I2C Mode value coding follow below described bitmap :\n 132 * b7 (not used)\n 133 * x : Should be set to 0\n 134 * b6\n 135 * 0 : None\n 136 * 1 : Memory (HAL I2C communication is in Memory Mode)\n 137 * b5\n 138 * 0 : None\n 139 * 1 : Slave (HAL I2C communication is in Slave Mode)\n 140 * b4\n 141 * 0 : None\n 142 * 1 : Master (HAL I2C communication is in Master Mode)\n 143 * b3-b2-b1-b0 (not used)\n 144 * xxxx : Should be set to 0000 145 * @{ 146 */ 147 typedef enum 148 { 149 HAL_I2C_MODE_NONE = 0x00U, /*!< No I2C communication on going */ 150 HAL_I2C_MODE_MASTER = 0x10U, /*!< I2C communication is in Master Mode */ 151 HAL_I2C_MODE_SLAVE = 0x20U, /*!< I2C communication is in Slave Mode */ 152 HAL_I2C_MODE_MEM = 0x40U /*!< I2C communication is in Memory Mode */ 153 154 } HAL_I2C_ModeTypeDef; 155 156 /** 157 * @} 158 */ 159 160 /** @defgroup I2C_Error_Code_definition I2C Error Code definition 161 * @brief I2C Error Code definition 162 * @{ 163 */ 164 #define HAL_I2C_ERROR_NONE (0x00000000U) /*!< No error */ 165 #define HAL_I2C_ERROR_BERR (0x00000001U) /*!< BERR error */ 166 #define HAL_I2C_ERROR_ARLO (0x00000002U) /*!< ARLO error */ 167 #define HAL_I2C_ERROR_AF (0x00000004U) /*!< ACKF error */ 168 #define HAL_I2C_ERROR_OVR (0x00000008U) /*!< OVR error */ 169 #define HAL_I2C_ERROR_DMA (0x00000010U) /*!< DMA transfer error */ 170 #define HAL_I2C_ERROR_TIMEOUT (0x00000020U) /*!< Timeout error */ 171 #define HAL_I2C_ERROR_SIZE (0x00000040U) /*!< Size Management error */ 172 #define HAL_I2C_ERROR_DMA_PARAM (0x00000080U) /*!< DMA Parameter Error */ 173 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1) 174 #define HAL_I2C_ERROR_INVALID_CALLBACK (0x00000100U) /*!< Invalid Callback error */ 175 #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */ 176 #define HAL_I2C_ERROR_INVALID_PARAM (0x00000200U) /*!< Invalid Parameters error */ 177 /** 178 * @} 179 */ 180 181 /** @defgroup I2C_handle_Structure_definition I2C handle Structure definition 182 * @brief I2C handle Structure definition 183 * @{ 184 */ 185 typedef struct __I2C_HandleTypeDef 186 { 187 I2C_TypeDef *Instance; /*!< I2C registers base address */ 188 189 I2C_InitTypeDef Init; /*!< I2C communication parameters */ 190 191 uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */ 192 193 uint16_t XferSize; /*!< I2C transfer size */ 194 195 __IO uint16_t XferCount; /*!< I2C transfer counter */ 196 197 __IO uint32_t XferOptions; /*!< I2C sequantial transfer options, this parameter can 198 be a value of @ref I2C_XFEROPTIONS */ 199 200 __IO uint32_t PreviousState; /*!< I2C communication Previous state */ 201 202 HAL_StatusTypeDef(*XferISR)(struct __I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources); /*!< I2C transfer IRQ handler function pointer */ 203 204 HAL_LockTypeDef Lock; /*!< I2C locking object */ 205 206 __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */ 207 208 __IO HAL_I2C_ModeTypeDef Mode; /*!< I2C communication mode */ 209 210 __IO uint32_t ErrorCode; /*!< I2C Error code */ 211 212 __IO uint32_t AddrEventCount; /*!< I2C Address Event counter */ 213 } I2C_HandleTypeDef; 214 215 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1) 216 /** 217 * @brief HAL I2C Callback ID enumeration definition 218 */ 219 typedef enum 220 { 221 HAL_I2C_MASTER_TX_COMPLETE_CB_ID = 0x00U, /*!< I2C Master Tx Transfer completed callback ID */ 222 HAL_I2C_MASTER_RX_COMPLETE_CB_ID = 0x01U, /*!< I2C Master Rx Transfer completed callback ID */ 223 HAL_I2C_SLAVE_TX_COMPLETE_CB_ID = 0x02U, /*!< I2C Slave Tx Transfer completed callback ID */ 224 HAL_I2C_SLAVE_RX_COMPLETE_CB_ID = 0x03U, /*!< I2C Slave Rx Transfer completed callback ID */ 225 HAL_I2C_LISTEN_COMPLETE_CB_ID = 0x04U, /*!< I2C Listen Complete callback ID */ 226 HAL_I2C_MEM_TX_COMPLETE_CB_ID = 0x05U, /*!< I2C Memory Tx Transfer callback ID */ 227 HAL_I2C_MEM_RX_COMPLETE_CB_ID = 0x06U, /*!< I2C Memory Rx Transfer completed callback ID */ 228 HAL_I2C_ERROR_CB_ID = 0x07U, /*!< I2C Error callback ID */ 229 HAL_I2C_ABORT_CB_ID = 0x08U, /*!< I2C Abort callback ID */ 230 231 HAL_I2C_MSPINIT_CB_ID = 0x09U, /*!< I2C Msp Init callback ID */ 232 HAL_I2C_MSPDEINIT_CB_ID = 0x0AU /*!< I2C Msp DeInit callback ID */ 233 234 } HAL_I2C_CallbackIDTypeDef; 235 236 /** 237 * @brief HAL I2C Callback pointer definition 238 */ 239 typedef void (*pI2C_CallbackTypeDef)(I2C_HandleTypeDef *hi2c); /*!< pointer to an I2C callback function */ 240 typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode); /*!< pointer to an I2C Address Match callback function */ 241 242 #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */ 243 /** 244 * @} 245 */ 246 247 /** 248 * @} 249 */ 250 /* Exported constants --------------------------------------------------------*/ 251 252 /** @defgroup I2C_Exported_Constants I2C Exported Constants 253 * @{ 254 */ 255 256 /** @defgroup I2C_XFEROPTIONS I2C Sequential Transfer Options 257 * @{ 258 */ 259 #define I2C_FIRST_FRAME ((uint32_t)I2C_SOFTEND_MODE) 260 #define I2C_FIRST_AND_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE | I2C_SOFTEND_MODE)) 261 #define I2C_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE | I2C_SOFTEND_MODE)) 262 #define I2C_FIRST_AND_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE) 263 #define I2C_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE) 264 #define I2C_LAST_FRAME_NO_STOP ((uint32_t)I2C_SOFTEND_MODE) 265 266 /* List of XferOptions in usage of : 267 * 1- Restart condition in all use cases (direction change or not) 268 */ 269 #define I2C_OTHER_FRAME (0x000000AAU) 270 #define I2C_OTHER_AND_LAST_FRAME (0x0000AA00U) 271 /** 272 * @} 273 */ 274 275 /** @defgroup I2C_ADDRESSING_MODE I2C Addressing Mode 276 * @{ 277 */ 278 #define I2C_ADDRESSINGMODE_7BIT (0x00000001U) 279 #define I2C_ADDRESSINGMODE_10BIT (0x00000002U) 280 /** 281 * @} 282 */ 283 284 /** @defgroup I2C_DUAL_ADDRESSING_MODE I2C Dual Addressing Mode 285 * @{ 286 */ 287 #define I2C_DUALADDRESS_DISABLE (0x00000000U) 288 #define I2C_DUALADDRESS_ENABLE I2C_OAR2_OA2EN 289 /** 290 * @} 291 */ 292 293 /** @defgroup I2C_OWN_ADDRESS2_MASKS I2C Own Address2 Masks 294 * @{ 295 */ 296 #define I2C_OA2_NOMASK ((uint8_t)0x00U) 297 #define I2C_OA2_MASK01 ((uint8_t)0x01U) 298 #define I2C_OA2_MASK02 ((uint8_t)0x02U) 299 #define I2C_OA2_MASK03 ((uint8_t)0x03U) 300 #define I2C_OA2_MASK04 ((uint8_t)0x04U) 301 #define I2C_OA2_MASK05 ((uint8_t)0x05U) 302 #define I2C_OA2_MASK06 ((uint8_t)0x06U) 303 #define I2C_OA2_MASK07 ((uint8_t)0x07U) 304 /** 305 * @} 306 */ 307 308 /** @defgroup I2C_GENERAL_CALL_ADDRESSING_MODE I2C General Call Addressing Mode 309 * @{ 310 */ 311 #define I2C_GENERALCALL_DISABLE (0x00000000U) 312 #define I2C_GENERALCALL_ENABLE I2C_CR1_GCEN 313 /** 314 * @} 315 */ 316 317 /** @defgroup I2C_NOSTRETCH_MODE I2C No-Stretch Mode 318 * @{ 319 */ 320 #define I2C_NOSTRETCH_DISABLE (0x00000000U) 321 #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH 322 /** 323 * @} 324 */ 325 326 /** @defgroup I2C_MEMORY_ADDRESS_SIZE I2C Memory Address Size 327 * @{ 328 */ 329 #define I2C_MEMADD_SIZE_8BIT (0x00000001U) 330 #define I2C_MEMADD_SIZE_16BIT (0x00000002U) 331 /** 332 * @} 333 */ 334 335 /** @defgroup I2C_XFERDIRECTION I2C Transfer Direction Master Point of View 336 * @{ 337 */ 338 #define I2C_DIRECTION_TRANSMIT (0x00000000U) 339 #define I2C_DIRECTION_RECEIVE (0x00000001U) 340 /** 341 * @} 342 */ 343 344 /** @defgroup I2C_RELOAD_END_MODE I2C Reload End Mode 345 * @{ 346 */ 347 #define I2C_RELOAD_MODE I2C_CR2_RELOAD 348 #define I2C_AUTOEND_MODE I2C_CR2_AUTOEND 349 #define I2C_SOFTEND_MODE (0x00000000U) 350 /** 351 * @} 352 */ 353 354 /** @defgroup I2C_START_STOP_MODE I2C Start or Stop Mode 355 * @{ 356 */ 357 #define I2C_NO_STARTSTOP (0x00000000U) 358 #define I2C_GENERATE_STOP (uint32_t)(0x80000000U | I2C_CR2_STOP) 359 #define I2C_GENERATE_START_READ (uint32_t)(0x80000000U | I2C_CR2_START | I2C_CR2_RD_WRN) 360 #define I2C_GENERATE_START_WRITE (uint32_t)(0x80000000U | I2C_CR2_START) 361 /** 362 * @} 363 */ 364 365 /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition 366 * @brief I2C Interrupt definition 367 * Elements values convention: 0xXXXXXXXX 368 * - XXXXXXXX : Interrupt control mask 369 * @{ 370 */ 371 #define I2C_IT_ERRI I2C_CR1_ERRIE 372 #define I2C_IT_TCI I2C_CR1_TCIE 373 #define I2C_IT_STOPI I2C_CR1_STOPIE 374 #define I2C_IT_NACKI I2C_CR1_NACKIE 375 #define I2C_IT_ADDRI I2C_CR1_ADDRIE 376 #define I2C_IT_RXI I2C_CR1_RXIE 377 #define I2C_IT_TXI I2C_CR1_TXIE 378 /** 379 * @} 380 */ 381 382 /** @defgroup I2C_Flag_definition I2C Flag definition 383 * @{ 384 */ 385 #define I2C_FLAG_TXE I2C_ISR_TXE 386 #define I2C_FLAG_TXIS I2C_ISR_TXIS 387 #define I2C_FLAG_RXNE I2C_ISR_RXNE 388 #define I2C_FLAG_ADDR I2C_ISR_ADDR 389 #define I2C_FLAG_AF I2C_ISR_NACKF 390 #define I2C_FLAG_STOPF I2C_ISR_STOPF 391 #define I2C_FLAG_TC I2C_ISR_TC 392 #define I2C_FLAG_TCR I2C_ISR_TCR 393 #define I2C_FLAG_BERR I2C_ISR_BERR 394 #define I2C_FLAG_ARLO I2C_ISR_ARLO 395 #define I2C_FLAG_OVR I2C_ISR_OVR 396 #define I2C_FLAG_PECERR I2C_ISR_PECERR 397 #define I2C_FLAG_TIMEOUT I2C_ISR_TIMEOUT 398 #define I2C_FLAG_ALERT I2C_ISR_ALERT 399 #define I2C_FLAG_BUSY I2C_ISR_BUSY 400 #define I2C_FLAG_DIR I2C_ISR_DIR 401 /** 402 * @} 403 */ 404 405 /** 406 * @} 407 */ 408 409 /* Exported macros -----------------------------------------------------------*/ 410 411 /** @defgroup I2C_Exported_Macros I2C Exported Macros 412 * @{ 413 */ 414 415 /** @brief Reset I2C handle state. 416 * @param __HANDLE__ specifies the I2C Handle. 417 * @retval None 418 */ 419 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1) 420 #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) do{ \ 421 (__HANDLE__)->State = HAL_I2C_STATE_RESET; \ 422 (__HANDLE__)->MspInitCallback = NULL; \ 423 (__HANDLE__)->MspDeInitCallback = NULL; \ 424 } while(0) 425 #else 426 #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET) 427 #endif 428 429 /** @brief Enable the specified I2C interrupt. 430 * @param __HANDLE__ specifies the I2C Handle. 431 * @param __INTERRUPT__ specifies the interrupt source to enable. 432 * This parameter can be one of the following values: 433 * @arg @ref I2C_IT_ERRI Errors interrupt enable 434 * @arg @ref I2C_IT_TCI Transfer complete interrupt enable 435 * @arg @ref I2C_IT_STOPI STOP detection interrupt enable 436 * @arg @ref I2C_IT_NACKI NACK received interrupt enable 437 * @arg @ref I2C_IT_ADDRI Address match interrupt enable 438 * @arg @ref I2C_IT_RXI RX interrupt enable 439 * @arg @ref I2C_IT_TXI TX interrupt enable 440 * 441 * @retval None 442 */ 443 #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 |= (__INTERRUPT__)) 444 445 /** @brief Disable the specified I2C interrupt. 446 * @param __HANDLE__ specifies the I2C Handle. 447 * @param __INTERRUPT__ specifies the interrupt source to disable. 448 * This parameter can be one of the following values: 449 * @arg @ref I2C_IT_ERRI Errors interrupt enable 450 * @arg @ref I2C_IT_TCI Transfer complete interrupt enable 451 * @arg @ref I2C_IT_STOPI STOP detection interrupt enable 452 * @arg @ref I2C_IT_NACKI NACK received interrupt enable 453 * @arg @ref I2C_IT_ADDRI Address match interrupt enable 454 * @arg @ref I2C_IT_RXI RX interrupt enable 455 * @arg @ref I2C_IT_TXI TX interrupt enable 456 * 457 * @retval None 458 */ 459 #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__))) 460 461 /** @brief Check whether the specified I2C interrupt source is enabled or not. 462 * @param __HANDLE__ specifies the I2C Handle. 463 * @param __INTERRUPT__ specifies the I2C interrupt source to check. 464 * This parameter can be one of the following values: 465 * @arg @ref I2C_IT_ERRI Errors interrupt enable 466 * @arg @ref I2C_IT_TCI Transfer complete interrupt enable 467 * @arg @ref I2C_IT_STOPI STOP detection interrupt enable 468 * @arg @ref I2C_IT_NACKI NACK received interrupt enable 469 * @arg @ref I2C_IT_ADDRI Address match interrupt enable 470 * @arg @ref I2C_IT_RXI RX interrupt enable 471 * @arg @ref I2C_IT_TXI TX interrupt enable 472 * 473 * @retval The new state of __INTERRUPT__ (SET or RESET). 474 */ 475 #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET) 476 477 /** @brief Check whether the specified I2C flag is set or not. 478 * @param __HANDLE__ specifies the I2C Handle. 479 * @param __FLAG__ specifies the flag to check. 480 * This parameter can be one of the following values: 481 * @arg @ref I2C_FLAG_TXE Transmit data register empty 482 * @arg @ref I2C_FLAG_TXIS Transmit interrupt status 483 * @arg @ref I2C_FLAG_RXNE Receive data register not empty 484 * @arg @ref I2C_FLAG_ADDR Address matched (slave mode) 485 * @arg @ref I2C_FLAG_AF Acknowledge failure received flag 486 * @arg @ref I2C_FLAG_STOPF STOP detection flag 487 * @arg @ref I2C_FLAG_TC Transfer complete (master mode) 488 * @arg @ref I2C_FLAG_TCR Transfer complete reload 489 * @arg @ref I2C_FLAG_BERR Bus error 490 * @arg @ref I2C_FLAG_ARLO Arbitration lost 491 * @arg @ref I2C_FLAG_OVR Overrun/Underrun 492 * @arg @ref I2C_FLAG_PECERR PEC error in reception 493 * @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag 494 * @arg @ref I2C_FLAG_ALERT SMBus alert 495 * @arg @ref I2C_FLAG_BUSY Bus busy 496 * @arg @ref I2C_FLAG_DIR Transfer direction (slave mode) 497 * 498 * @retval The new state of __FLAG__ (SET or RESET). 499 */ 500 #define I2C_FLAG_MASK (0x0001FFFFU) 501 #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__)) ? SET : RESET) 502 503 /** @brief Clear the I2C pending flags which are cleared by writing 1 in a specific bit. 504 * @param __HANDLE__ specifies the I2C Handle. 505 * @param __FLAG__ specifies the flag to clear. 506 * This parameter can be any combination of the following values: 507 * @arg @ref I2C_FLAG_TXE Transmit data register empty 508 * @arg @ref I2C_FLAG_ADDR Address matched (slave mode) 509 * @arg @ref I2C_FLAG_AF Acknowledge failure received flag 510 * @arg @ref I2C_FLAG_STOPF STOP detection flag 511 * @arg @ref I2C_FLAG_BERR Bus error 512 * @arg @ref I2C_FLAG_ARLO Arbitration lost 513 * @arg @ref I2C_FLAG_OVR Overrun/Underrun 514 * @arg @ref I2C_FLAG_PECERR PEC error in reception 515 * @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag 516 * @arg @ref I2C_FLAG_ALERT SMBus alert 517 * 518 * @retval None 519 */ 520 #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__FLAG__) == I2C_FLAG_TXE) ? ((__HANDLE__)->Instance->ISR |= (__FLAG__)) \ 521 : ((__HANDLE__)->Instance->ICR = (__FLAG__))) 522 523 /** @brief Enable the specified I2C peripheral. 524 * @param __HANDLE__ specifies the I2C Handle. 525 * @retval None 526 */ 527 #define __HAL_I2C_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)) 528 529 /** @brief Disable the specified I2C peripheral. 530 * @param __HANDLE__ specifies the I2C Handle. 531 * @retval None 532 */ 533 #define __HAL_I2C_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)) 534 535 /** @brief Generate a Non-Acknowledge I2C peripheral in Slave mode. 536 * @param __HANDLE__ specifies the I2C Handle. 537 * @retval None 538 */ 539 #define __HAL_I2C_GENERATE_NACK(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR2, I2C_CR2_NACK)) 540 /** 541 * @} 542 */ 543 544 /* Include I2C HAL Extended module */ 545 546 /* Exported functions --------------------------------------------------------*/ 547 /** @addtogroup I2C_Exported_Functions 548 * @{ 549 */ 550 551 /** @addtogroup I2C_Exported_Functions_Group1 Initialization and de-initialization functions 552 * @{ 553 */ 554 /* Initialization and de-initialization functions******************************/ 555 HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c); 556 HAL_StatusTypeDef HAL_I2C_DeInit(I2C_HandleTypeDef *hi2c); 557 558 /** 559 * @} 560 */ 561 562 /** @addtogroup I2C_Exported_Functions_Group2 Input and Output operation functions 563 * @{ 564 */ 565 /* IO operation functions ****************************************************/ 566 /******* Blocking mode: Polling */ 567 HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout); 568 HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout); 569 570 /** 571 * @} 572 */ 573 574 /** 575 * @} 576 */ 577 578 /* Private constants ---------------------------------------------------------*/ 579 /** @defgroup I2C_Private_Constants I2C Private Constants 580 * @{ 581 */ 582 583 /** 584 * @} 585 */ 586 587 /* Private macros ------------------------------------------------------------*/ 588 /** @defgroup I2C_Private_Macro I2C Private Macros 589 * @{ 590 */ 591 592 #define IS_I2C_ADDRESSING_MODE(MODE) (((MODE) == I2C_ADDRESSINGMODE_7BIT) || \ 593 ((MODE) == I2C_ADDRESSINGMODE_10BIT)) 594 595 #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \ 596 ((ADDRESS) == I2C_DUALADDRESS_ENABLE)) 597 598 #define IS_I2C_OWN_ADDRESS2_MASK(MASK) (((MASK) == I2C_OA2_NOMASK) || \ 599 ((MASK) == I2C_OA2_MASK01) || \ 600 ((MASK) == I2C_OA2_MASK02) || \ 601 ((MASK) == I2C_OA2_MASK03) || \ 602 ((MASK) == I2C_OA2_MASK04) || \ 603 ((MASK) == I2C_OA2_MASK05) || \ 604 ((MASK) == I2C_OA2_MASK06) || \ 605 ((MASK) == I2C_OA2_MASK07)) 606 607 #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \ 608 ((CALL) == I2C_GENERALCALL_ENABLE)) 609 610 #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \ 611 ((STRETCH) == I2C_NOSTRETCH_ENABLE)) 612 613 #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \ 614 ((SIZE) == I2C_MEMADD_SIZE_16BIT)) 615 616 #define IS_TRANSFER_MODE(MODE) (((MODE) == I2C_RELOAD_MODE) || \ 617 ((MODE) == I2C_AUTOEND_MODE) || \ 618 ((MODE) == I2C_SOFTEND_MODE)) 619 620 #define IS_TRANSFER_REQUEST(REQUEST) (((REQUEST) == I2C_GENERATE_STOP) || \ 621 ((REQUEST) == I2C_GENERATE_START_READ) || \ 622 ((REQUEST) == I2C_GENERATE_START_WRITE) || \ 623 ((REQUEST) == I2C_NO_STARTSTOP)) 624 625 #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_FIRST_FRAME) || \ 626 ((REQUEST) == I2C_FIRST_AND_NEXT_FRAME) || \ 627 ((REQUEST) == I2C_NEXT_FRAME) || \ 628 ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \ 629 ((REQUEST) == I2C_LAST_FRAME) || \ 630 ((REQUEST) == I2C_LAST_FRAME_NO_STOP) || \ 631 IS_I2C_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST)) 632 633 #define IS_I2C_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_OTHER_FRAME) || \ 634 ((REQUEST) == I2C_OTHER_AND_LAST_FRAME)) 635 636 #define I2C_RESET_CR2(__HANDLE__) ((__HANDLE__)->Instance->CR2 &= (uint32_t)~((uint32_t)(I2C_CR2_SADD | I2C_CR2_HEAD10R | I2C_CR2_NBYTES | I2C_CR2_RELOAD | I2C_CR2_RD_WRN))) 637 638 #define I2C_GET_ADDR_MATCH(__HANDLE__) ((uint16_t)(((__HANDLE__)->Instance->ISR & I2C_ISR_ADDCODE) >> 16U)) 639 #define I2C_GET_DIR(__HANDLE__) ((uint8_t)(((__HANDLE__)->Instance->ISR & I2C_ISR_DIR) >> 16U)) 640 #define I2C_GET_STOP_MODE(__HANDLE__) ((__HANDLE__)->Instance->CR2 & I2C_CR2_AUTOEND) 641 #define I2C_GET_OWN_ADDRESS1(__HANDLE__) ((uint16_t)((__HANDLE__)->Instance->OAR1 & I2C_OAR1_OA1)) 642 #define I2C_GET_OWN_ADDRESS2(__HANDLE__) ((uint16_t)((__HANDLE__)->Instance->OAR2 & I2C_OAR2_OA2)) 643 644 #define IS_I2C_OWN_ADDRESS1(ADDRESS1) ((ADDRESS1) <= 0x000003FFU) 645 #define IS_I2C_OWN_ADDRESS2(ADDRESS2) ((ADDRESS2) <= (uint16_t)0x00FFU) 646 647 #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0xFF00U))) >> 8U))) 648 #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FFU)))) 649 650 #define I2C_GENERATE_START(__ADDMODE__,__ADDRESS__) (((__ADDMODE__) == I2C_ADDRESSINGMODE_7BIT) ? (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | (I2C_CR2_START) | (I2C_CR2_AUTOEND)) & (~I2C_CR2_RD_WRN)) : \ 651 (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | (I2C_CR2_ADD10) | (I2C_CR2_START)) & (~I2C_CR2_RD_WRN))) 652 653 #define I2C_CHECK_FLAG(__ISR__, __FLAG__) ((((__ISR__) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET) 654 #define I2C_CHECK_IT_SOURCE(__CR1__, __IT__) ((((__CR1__) & (__IT__)) == (__IT__)) ? SET : RESET) 655 /** 656 * @} 657 */ 658 659 /* Private Functions ---------------------------------------------------------*/ 660 /** @defgroup I2C_Private_Functions I2C Private Functions 661 * @{ 662 */ 663 /* Private functions are defined in stm32mp1xx_hal_i2c.c file */ 664 /** 665 * @} 666 */ 667 668 /** 669 * @} 670 */ 671 672 /** 673 * @} 674 */ 675 676 #ifdef __cplusplus 677 #if __cplusplus 678 } 679 #endif /* __cplusplus */ 680 #endif /* __cplusplus */ 681 682 #endif 683