stm32h7xx_hal_i2c.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675
  1. /**
  2. ******************************************************************************
  3. * @file stm32h7xx_hal_i2c.h
  4. * @author MCD Application Team
  5. * @version V1.0.0
  6. * @date 21-April-2017
  7. * @brief Header file of I2C HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2017 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. /* Define to prevent recursive inclusion -------------------------------------*/
  38. #ifndef __STM32H7xx_HAL_I2C_H
  39. #define __STM32H7xx_HAL_I2C_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. /* Includes ------------------------------------------------------------------*/
  44. #include "stm32h7xx_hal_def.h"
  45. /** @addtogroup STM32H7xx_HAL_Driver
  46. * @{
  47. */
  48. /** @addtogroup I2C
  49. * @{
  50. */
  51. /* Exported types ------------------------------------------------------------*/
  52. /** @defgroup I2C_Exported_Types I2C Exported Types
  53. * @{
  54. */
  55. /** @defgroup I2C_Configuration_Structure_definition I2C Configuration Structure definition
  56. * @brief I2C Configuration Structure definition
  57. * @{
  58. */
  59. typedef struct
  60. {
  61. uint32_t Timing; /*!< Specifies the I2C_TIMINGR_register value.
  62. This parameter calculated by referring to I2C initialization
  63. section in Reference manual */
  64. uint32_t OwnAddress1; /*!< Specifies the first device own address.
  65. This parameter can be a 7-bit or 10-bit address. */
  66. uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected.
  67. This parameter can be a value of @ref I2C_ADDRESSING_MODE */
  68. uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected.
  69. This parameter can be a value of @ref I2C_DUAL_ADDRESSING_MODE */
  70. uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected
  71. This parameter can be a 7-bit address. */
  72. uint32_t OwnAddress2Masks; /*!< Specifies the acknowledge mask address second device own address if dual addressing mode is selected
  73. This parameter can be a value of @ref I2C_OWN_ADDRESS2_MASKS */
  74. uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
  75. This parameter can be a value of @ref I2C_GENERAL_CALL_ADDRESSING_MODE */
  76. uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
  77. This parameter can be a value of @ref I2C_NOSTRETCH_MODE */
  78. }I2C_InitTypeDef;
  79. /**
  80. * @}
  81. */
  82. /** @defgroup HAL_state_structure_definition HAL state structure definition
  83. * @brief HAL State structure definition
  84. * @{
  85. */
  86. typedef enum
  87. {
  88. HAL_I2C_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized */
  89. HAL_I2C_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use */
  90. HAL_I2C_STATE_BUSY = 0x24U, /*!< An internal process is ongoing */
  91. HAL_I2C_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing */
  92. HAL_I2C_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
  93. HAL_I2C_STATE_LISTEN = 0x28U, /*!< Address Listen Mode is ongoing */
  94. HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U, /*!< Address Listen Mode and Data Transmission
  95. process is ongoing */
  96. HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU, /*!< Address Listen Mode and Data Reception
  97. process is ongoing */
  98. HAL_I2C_STATE_ABORT = 0x60U, /*!< Abort user request ongoing */
  99. HAL_I2C_STATE_TIMEOUT = 0xA0U, /*!< Timeout state */
  100. HAL_I2C_STATE_ERROR = 0xE0U /*!< Error */
  101. }HAL_I2C_StateTypeDef;
  102. /**
  103. * @}
  104. */
  105. /** @defgroup HAL_mode_structure_definition HAL mode structure definition
  106. * @brief HAL Mode structure definition
  107. * @{
  108. */
  109. typedef enum
  110. {
  111. HAL_I2C_MODE_NONE = 0x00U, /*!< No I2C communication on going */
  112. HAL_I2C_MODE_MASTER = 0x10U, /*!< I2C communication is in Master Mode */
  113. HAL_I2C_MODE_SLAVE = 0x20U, /*!< I2C communication is in Slave Mode */
  114. HAL_I2C_MODE_MEM = 0x40U /*!< I2C communication is in Memory Mode */
  115. }HAL_I2C_ModeTypeDef;
  116. /**
  117. * @}
  118. */
  119. /** @defgroup I2C_Error_Code_definition I2C Error Code definition
  120. * @brief I2C Error Code definition
  121. * @{
  122. */
  123. #define HAL_I2C_ERROR_NONE (0x00000000U) /*!< No error */
  124. #define HAL_I2C_ERROR_BERR (0x00000001U) /*!< BERR error */
  125. #define HAL_I2C_ERROR_ARLO (0x00000002U) /*!< ARLO error */
  126. #define HAL_I2C_ERROR_AF (0x00000004U) /*!< ACKF error */
  127. #define HAL_I2C_ERROR_OVR (0x00000008U) /*!< OVR error */
  128. #define HAL_I2C_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
  129. #define HAL_I2C_ERROR_TIMEOUT (0x00000020U) /*!< Timeout error */
  130. #define HAL_I2C_ERROR_SIZE (0x00000040U) /*!< Size Management error */
  131. /**
  132. * @}
  133. */
  134. /** @defgroup I2C_handle_Structure_definition I2C handle Structure definition
  135. * @brief I2C handle Structure definition
  136. * @{
  137. */
  138. typedef struct __I2C_HandleTypeDef
  139. {
  140. I2C_TypeDef *Instance; /*!< I2C registers base address */
  141. I2C_InitTypeDef Init; /*!< I2C communication parameters */
  142. uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
  143. uint16_t XferSize; /*!< I2C transfer size */
  144. __IO uint16_t XferCount; /*!< I2C transfer counter */
  145. __IO uint32_t XferOptions; /*!< I2C sequantial transfer options, this parameter can
  146. be a value of @ref I2C_XFEROPTIONS */
  147. __IO uint32_t PreviousState; /*!< I2C communication Previous state */
  148. HAL_StatusTypeDef (*XferISR)(struct __I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources); /*!< I2C transfer IRQ handler function pointer */
  149. DMA_HandleTypeDef *hdmatx; /*!< I2C Tx DMA handle parameters */
  150. DMA_HandleTypeDef *hdmarx; /*!< I2C Rx DMA handle parameters */
  151. HAL_LockTypeDef Lock; /*!< I2C locking object */
  152. __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */
  153. __IO HAL_I2C_ModeTypeDef Mode; /*!< I2C communication mode */
  154. __IO uint32_t ErrorCode; /*!< I2C Error code */
  155. __IO uint32_t AddrEventCount; /*!< I2C Address Event counter */
  156. }I2C_HandleTypeDef;
  157. /**
  158. * @}
  159. */
  160. /**
  161. * @}
  162. */
  163. /* Exported constants --------------------------------------------------------*/
  164. /** @defgroup I2C_Exported_Constants I2C Exported Constants
  165. * @{
  166. */
  167. /** @defgroup I2C_XFEROPTIONS I2C Sequential Transfer Options
  168. * @{
  169. */
  170. #define I2C_NO_OPTION_FRAME (0xFFFF0000U)
  171. #define I2C_FIRST_FRAME ((uint32_t)I2C_SOFTEND_MODE)
  172. #define I2C_FIRST_AND_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE | I2C_SOFTEND_MODE))
  173. #define I2C_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE | I2C_SOFTEND_MODE))
  174. #define I2C_FIRST_AND_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE)
  175. #define I2C_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE)
  176. /**
  177. * @}
  178. */
  179. /** @defgroup I2C_ADDRESSING_MODE I2C Addressing Mode
  180. * @{
  181. */
  182. #define I2C_ADDRESSINGMODE_7BIT (0x00000001U)
  183. #define I2C_ADDRESSINGMODE_10BIT (0x00000002U)
  184. /**
  185. * @}
  186. */
  187. /** @defgroup I2C_DUAL_ADDRESSING_MODE I2C Dual Addressing Mode
  188. * @{
  189. */
  190. #define I2C_DUALADDRESS_DISABLE (0x00000000U)
  191. #define I2C_DUALADDRESS_ENABLE I2C_OAR2_OA2EN
  192. /**
  193. * @}
  194. */
  195. /** @defgroup I2C_OWN_ADDRESS2_MASKS I2C Own Address2 Masks
  196. * @{
  197. */
  198. #define I2C_OA2_NOMASK ((uint8_t)0x00U)
  199. #define I2C_OA2_MASK01 ((uint8_t)0x01U)
  200. #define I2C_OA2_MASK02 ((uint8_t)0x02U)
  201. #define I2C_OA2_MASK03 ((uint8_t)0x03U)
  202. #define I2C_OA2_MASK04 ((uint8_t)0x04U)
  203. #define I2C_OA2_MASK05 ((uint8_t)0x05U)
  204. #define I2C_OA2_MASK06 ((uint8_t)0x06U)
  205. #define I2C_OA2_MASK07 ((uint8_t)0x07U)
  206. /**
  207. * @}
  208. */
  209. /** @defgroup I2C_GENERAL_CALL_ADDRESSING_MODE I2C General Call Addressing Mode
  210. * @{
  211. */
  212. #define I2C_GENERALCALL_DISABLE (0x00000000U)
  213. #define I2C_GENERALCALL_ENABLE I2C_CR1_GCEN
  214. /**
  215. * @}
  216. */
  217. /** @defgroup I2C_NOSTRETCH_MODE I2C No-Stretch Mode
  218. * @{
  219. */
  220. #define I2C_NOSTRETCH_DISABLE (0x00000000U)
  221. #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
  222. /**
  223. * @}
  224. */
  225. /** @defgroup I2C_MEMORY_ADDRESS_SIZE I2C Memory Address Size
  226. * @{
  227. */
  228. #define I2C_MEMADD_SIZE_8BIT (0x00000001U)
  229. #define I2C_MEMADD_SIZE_16BIT (0x00000002U)
  230. /**
  231. * @}
  232. */
  233. /** @defgroup I2C_XferDirection I2C Transfer Direction
  234. * @{
  235. */
  236. #define I2C_DIRECTION_TRANSMIT (0x00000000U)
  237. #define I2C_DIRECTION_RECEIVE (0x00000001U)
  238. /**
  239. * @}
  240. */
  241. /** @defgroup I2C_RELOAD_END_MODE I2C Reload End Mode
  242. * @{
  243. */
  244. #define I2C_RELOAD_MODE I2C_CR2_RELOAD
  245. #define I2C_AUTOEND_MODE I2C_CR2_AUTOEND
  246. #define I2C_SOFTEND_MODE (0x00000000U)
  247. /**
  248. * @}
  249. */
  250. /** @defgroup I2C_START_STOP_MODE I2C Start or Stop Mode
  251. * @{
  252. */
  253. #define I2C_NO_STARTSTOP (0x00000000U)
  254. #define I2C_GENERATE_STOP I2C_CR2_STOP
  255. #define I2C_GENERATE_START_READ (uint32_t)(I2C_CR2_START | I2C_CR2_RD_WRN)
  256. #define I2C_GENERATE_START_WRITE I2C_CR2_START
  257. /**
  258. * @}
  259. */
  260. /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition
  261. * @brief I2C Interrupt definition
  262. * Elements values convention: 0xXXXXXXXX
  263. * - XXXXXXXX : Interrupt control mask
  264. * @{
  265. */
  266. #define I2C_IT_ERRI I2C_CR1_ERRIE
  267. #define I2C_IT_TCI I2C_CR1_TCIE
  268. #define I2C_IT_STOPI I2C_CR1_STOPIE
  269. #define I2C_IT_NACKI I2C_CR1_NACKIE
  270. #define I2C_IT_ADDRI I2C_CR1_ADDRIE
  271. #define I2C_IT_RXI I2C_CR1_RXIE
  272. #define I2C_IT_TXI I2C_CR1_TXIE
  273. /**
  274. * @}
  275. */
  276. /** @defgroup I2C_Flag_definition I2C Flag definition
  277. * @{
  278. */
  279. #define I2C_FLAG_TXE I2C_ISR_TXE
  280. #define I2C_FLAG_TXIS I2C_ISR_TXIS
  281. #define I2C_FLAG_RXNE I2C_ISR_RXNE
  282. #define I2C_FLAG_ADDR I2C_ISR_ADDR
  283. #define I2C_FLAG_AF I2C_ISR_NACKF
  284. #define I2C_FLAG_STOPF I2C_ISR_STOPF
  285. #define I2C_FLAG_TC I2C_ISR_TC
  286. #define I2C_FLAG_TCR I2C_ISR_TCR
  287. #define I2C_FLAG_BERR I2C_ISR_BERR
  288. #define I2C_FLAG_ARLO I2C_ISR_ARLO
  289. #define I2C_FLAG_OVR I2C_ISR_OVR
  290. #define I2C_FLAG_PECERR I2C_ISR_PECERR
  291. #define I2C_FLAG_TIMEOUT I2C_ISR_TIMEOUT
  292. #define I2C_FLAG_ALERT I2C_ISR_ALERT
  293. #define I2C_FLAG_BUSY I2C_ISR_BUSY
  294. #define I2C_FLAG_DIR I2C_ISR_DIR
  295. /**
  296. * @}
  297. */
  298. /**
  299. * @}
  300. */
  301. /* Exported macros -----------------------------------------------------------*/
  302. /** @defgroup I2C_Exported_Macros I2C Exported Macros
  303. * @{
  304. */
  305. /** @brief Reset I2C handle state.
  306. * @param __HANDLE__ specifies the I2C Handle.
  307. * @retval None
  308. */
  309. #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
  310. /** @brief Enable the specified I2C interrupt.
  311. * @param __HANDLE__ specifies the I2C Handle.
  312. * @param __INTERRUPT__ specifies the interrupt source to enable.
  313. * This parameter can be one of the following values:
  314. * @arg @ref I2C_IT_ERRI Errors interrupt enable
  315. * @arg @ref I2C_IT_TCI Transfer complete interrupt enable
  316. * @arg @ref I2C_IT_STOPI STOP detection interrupt enable
  317. * @arg @ref I2C_IT_NACKI NACK received interrupt enable
  318. * @arg @ref I2C_IT_ADDRI Address match interrupt enable
  319. * @arg @ref I2C_IT_RXI RX interrupt enable
  320. * @arg @ref I2C_IT_TXI TX interrupt enable
  321. *
  322. * @retval None
  323. */
  324. #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 |= (__INTERRUPT__))
  325. /** @brief Disable the specified I2C interrupt.
  326. * @param __HANDLE__ specifies the I2C Handle.
  327. * @param __INTERRUPT__ specifies the interrupt source to disable.
  328. * This parameter can be one of the following values:
  329. * @arg @ref I2C_IT_ERRI Errors interrupt enable
  330. * @arg @ref I2C_IT_TCI Transfer complete interrupt enable
  331. * @arg @ref I2C_IT_STOPI STOP detection interrupt enable
  332. * @arg @ref I2C_IT_NACKI NACK received interrupt enable
  333. * @arg @ref I2C_IT_ADDRI Address match interrupt enable
  334. * @arg @ref I2C_IT_RXI RX interrupt enable
  335. * @arg @ref I2C_IT_TXI TX interrupt enable
  336. *
  337. * @retval None
  338. */
  339. #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__)))
  340. /** @brief Check whether the specified I2C interrupt source is enabled or not.
  341. * @param __HANDLE__ specifies the I2C Handle.
  342. * @param __INTERRUPT__ specifies the I2C interrupt source to check.
  343. * This parameter can be one of the following values:
  344. * @arg @ref I2C_IT_ERRI Errors interrupt enable
  345. * @arg @ref I2C_IT_TCI Transfer complete interrupt enable
  346. * @arg @ref I2C_IT_STOPI STOP detection interrupt enable
  347. * @arg @ref I2C_IT_NACKI NACK received interrupt enable
  348. * @arg @ref I2C_IT_ADDRI Address match interrupt enable
  349. * @arg @ref I2C_IT_RXI RX interrupt enable
  350. * @arg @ref I2C_IT_TXI TX interrupt enable
  351. *
  352. * @retval The new state of __INTERRUPT__ (SET or RESET).
  353. */
  354. #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  355. /** @brief Check whether the specified I2C flag is set or not.
  356. * @param __HANDLE__ specifies the I2C Handle.
  357. * @param __FLAG__ specifies the flag to check.
  358. * This parameter can be one of the following values:
  359. * @arg @ref I2C_FLAG_TXE Transmit data register empty
  360. * @arg @ref I2C_FLAG_TXIS Transmit interrupt status
  361. * @arg @ref I2C_FLAG_RXNE Receive data register not empty
  362. * @arg @ref I2C_FLAG_ADDR Address matched (slave mode)
  363. * @arg @ref I2C_FLAG_AF Acknowledge failure received flag
  364. * @arg @ref I2C_FLAG_STOPF STOP detection flag
  365. * @arg @ref I2C_FLAG_TC Transfer complete (master mode)
  366. * @arg @ref I2C_FLAG_TCR Transfer complete reload
  367. * @arg @ref I2C_FLAG_BERR Bus error
  368. * @arg @ref I2C_FLAG_ARLO Arbitration lost
  369. * @arg @ref I2C_FLAG_OVR Overrun/Underrun
  370. * @arg @ref I2C_FLAG_PECERR PEC error in reception
  371. * @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag
  372. * @arg @ref I2C_FLAG_ALERT SMBus alert
  373. * @arg @ref I2C_FLAG_BUSY Bus busy
  374. * @arg @ref I2C_FLAG_DIR Transfer direction (slave mode)
  375. *
  376. * @retval The new state of __FLAG__ (SET or RESET).
  377. */
  378. #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__)) ? SET : RESET)
  379. /** @brief Clear the I2C pending flags which are cleared by writing 1 in a specific bit.
  380. * @param __HANDLE__ specifies the I2C Handle.
  381. * @param __FLAG__ specifies the flag to clear.
  382. * This parameter can be any combination of the following values:
  383. * @arg @ref I2C_FLAG_TXE Transmit data register empty
  384. * @arg @ref I2C_FLAG_ADDR Address matched (slave mode)
  385. * @arg @ref I2C_FLAG_AF Acknowledge failure received flag
  386. * @arg @ref I2C_FLAG_STOPF STOP detection flag
  387. * @arg @ref I2C_FLAG_BERR Bus error
  388. * @arg @ref I2C_FLAG_ARLO Arbitration lost
  389. * @arg @ref I2C_FLAG_OVR Overrun/Underrun
  390. * @arg @ref I2C_FLAG_PECERR PEC error in reception
  391. * @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag
  392. * @arg @ref I2C_FLAG_ALERT SMBus alert
  393. *
  394. * @retval None
  395. */
  396. #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__FLAG__) == I2C_FLAG_TXE) ? ((__HANDLE__)->Instance->ISR |= (__FLAG__)) \
  397. : ((__HANDLE__)->Instance->ICR = (__FLAG__)))
  398. /** @brief Enable the specified I2C peripheral.
  399. * @param __HANDLE__ specifies the I2C Handle.
  400. * @retval None
  401. */
  402. #define __HAL_I2C_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE))
  403. /** @brief Disable the specified I2C peripheral.
  404. * @param __HANDLE__ specifies the I2C Handle.
  405. * @retval None
  406. */
  407. #define __HAL_I2C_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE))
  408. /** @brief Generate a Non-Acknowledge I2C peripheral in Slave mode.
  409. * @param __HANDLE__: specifies the I2C Handle.
  410. * @retval None
  411. */
  412. #define __HAL_I2C_GENERATE_NACK(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR2, I2C_CR2_NACK))
  413. /**
  414. * @}
  415. */
  416. /* Include I2C HAL Extended module */
  417. #include "stm32h7xx_hal_i2c_ex.h"
  418. /* Exported functions --------------------------------------------------------*/
  419. /** @addtogroup I2C_Exported_Functions
  420. * @{
  421. */
  422. /** @addtogroup I2C_Exported_Functions_Group1 Initialization and de-initialization functions
  423. * @{
  424. */
  425. /* Initialization and de-initialization functions******************************/
  426. HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
  427. HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c);
  428. void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
  429. void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
  430. /**
  431. * @}
  432. */
  433. /** @addtogroup I2C_Exported_Functions_Group2 Input and Output operation functions
  434. * @{
  435. */
  436. /* IO operation functions ****************************************************/
  437. /******* Blocking mode: Polling */
  438. HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  439. HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  440. HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  441. HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  442. 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);
  443. 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);
  444. HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
  445. /******* Non-Blocking mode: Interrupt */
  446. HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  447. HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  448. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  449. HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  450. 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);
  451. 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);
  452. HAL_StatusTypeDef HAL_I2C_Master_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  453. HAL_StatusTypeDef HAL_I2C_Master_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  454. HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  455. HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  456. HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);
  457. HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c);
  458. HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress);
  459. /******* Non-Blocking mode: DMA */
  460. HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  461. HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  462. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  463. HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  464. 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);
  465. 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);
  466. /**
  467. * @}
  468. */
  469. /** @addtogroup I2C_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks
  470. * @{
  471. */
  472. /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
  473. void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
  474. void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
  475. void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
  476. void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
  477. void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
  478. void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
  479. void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
  480. void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c);
  481. void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
  482. void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
  483. void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
  484. void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c);
  485. /**
  486. * @}
  487. */
  488. /** @addtogroup I2C_Exported_Functions_Group3 Peripheral State, Mode and Error functions
  489. * @{
  490. */
  491. /* Peripheral State, Mode and Error functions *********************************/
  492. HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
  493. HAL_I2C_ModeTypeDef HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c);
  494. uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
  495. /**
  496. * @}
  497. */
  498. /**
  499. * @}
  500. */
  501. /* Private constants ---------------------------------------------------------*/
  502. /** @defgroup I2C_Private_Constants I2C Private Constants
  503. * @{
  504. */
  505. /**
  506. * @}
  507. */
  508. /* Private macros ------------------------------------------------------------*/
  509. /** @defgroup I2C_Private_Macro I2C Private Macros
  510. * @{
  511. */
  512. #define IS_I2C_ADDRESSING_MODE(MODE) (((MODE) == I2C_ADDRESSINGMODE_7BIT) || \
  513. ((MODE) == I2C_ADDRESSINGMODE_10BIT))
  514. #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \
  515. ((ADDRESS) == I2C_DUALADDRESS_ENABLE))
  516. #define IS_I2C_OWN_ADDRESS2_MASK(MASK) (((MASK) == I2C_OA2_NOMASK) || \
  517. ((MASK) == I2C_OA2_MASK01) || \
  518. ((MASK) == I2C_OA2_MASK02) || \
  519. ((MASK) == I2C_OA2_MASK03) || \
  520. ((MASK) == I2C_OA2_MASK04) || \
  521. ((MASK) == I2C_OA2_MASK05) || \
  522. ((MASK) == I2C_OA2_MASK06) || \
  523. ((MASK) == I2C_OA2_MASK07))
  524. #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \
  525. ((CALL) == I2C_GENERALCALL_ENABLE))
  526. #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \
  527. ((STRETCH) == I2C_NOSTRETCH_ENABLE))
  528. #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
  529. ((SIZE) == I2C_MEMADD_SIZE_16BIT))
  530. #define IS_TRANSFER_MODE(MODE) (((MODE) == I2C_RELOAD_MODE) || \
  531. ((MODE) == I2C_AUTOEND_MODE) || \
  532. ((MODE) == I2C_SOFTEND_MODE))
  533. #define IS_TRANSFER_REQUEST(REQUEST) (((REQUEST) == I2C_GENERATE_STOP) || \
  534. ((REQUEST) == I2C_GENERATE_START_READ) || \
  535. ((REQUEST) == I2C_GENERATE_START_WRITE) || \
  536. ((REQUEST) == I2C_NO_STARTSTOP))
  537. #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_FIRST_FRAME) || \
  538. ((REQUEST) == I2C_FIRST_AND_NEXT_FRAME) || \
  539. ((REQUEST) == I2C_NEXT_FRAME) || \
  540. ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \
  541. ((REQUEST) == I2C_LAST_FRAME))
  542. #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)))
  543. #define I2C_GET_ADDR_MATCH(__HANDLE__) (((__HANDLE__)->Instance->ISR & I2C_ISR_ADDCODE) >> 16U)
  544. #define I2C_GET_DIR(__HANDLE__) (((__HANDLE__)->Instance->ISR & I2C_ISR_DIR) >> 16U)
  545. #define I2C_GET_STOP_MODE(__HANDLE__) ((__HANDLE__)->Instance->CR2 & I2C_CR2_AUTOEND)
  546. #define I2C_GET_OWN_ADDRESS1(__HANDLE__) ((__HANDLE__)->Instance->OAR1 & I2C_OAR1_OA1)
  547. #define I2C_GET_OWN_ADDRESS2(__HANDLE__) ((__HANDLE__)->Instance->OAR2 & I2C_OAR2_OA2)
  548. #define IS_I2C_OWN_ADDRESS1(ADDRESS1) ((ADDRESS1) <= 0x000003FFU)
  549. #define IS_I2C_OWN_ADDRESS2(ADDRESS2) ((ADDRESS2) <= (uint16_t)0x00FFU)
  550. #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0xFF00U))) >> 8U)))
  551. #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FFU))))
  552. #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)) : \
  553. (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | (I2C_CR2_ADD10) | (I2C_CR2_START)) & (~I2C_CR2_RD_WRN)))
  554. /**
  555. * @}
  556. */
  557. /* Private Functions ---------------------------------------------------------*/
  558. /** @defgroup I2C_Private_Functions I2C Private Functions
  559. * @{
  560. */
  561. /* Private functions are defined in stm32h7xx_hal_i2c.c file */
  562. /**
  563. * @}
  564. */
  565. /**
  566. * @}
  567. */
  568. /**
  569. * @}
  570. */
  571. #ifdef __cplusplus
  572. }
  573. #endif
  574. #endif /* __STM32H7xx_HAL_I2C_H */
  575. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/