py32f0xx_hal_i2c.h 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724
  1. /**
  2. ******************************************************************************
  3. * @file py32f0xx_hal_i2c.h
  4. * @author MCU Application Team
  5. * @brief Header file of I2C HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; Copyright (c) 2023 Puya Semiconductor Co.
  10. * All rights reserved.</center></h2>
  11. *
  12. * This software component is licensed by Puya 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. * @attention
  19. *
  20. * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
  21. * All rights reserved.</center></h2>
  22. *
  23. * This software component is licensed by ST under BSD 3-Clause license,
  24. * the "License"; You may not use this file except in compliance with the
  25. * License. You may obtain a copy of the License at:
  26. * opensource.org/licenses/BSD-3-Clause
  27. *
  28. ******************************************************************************
  29. */
  30. /* Define to prevent recursive inclusion -------------------------------------*/
  31. #ifndef __PY32F0xx_HAL_I2C_H
  32. #define __PY32F0xx_HAL_I2C_H
  33. #ifdef __cplusplus
  34. extern "C" {
  35. #endif
  36. /* Includes ------------------------------------------------------------------*/
  37. #include "py32f0xx_hal_def.h"
  38. /** @addtogroup PY32F0xx_HAL_Driver
  39. * @{
  40. */
  41. /** @addtogroup I2C
  42. * @{
  43. */
  44. /* Exported types ------------------------------------------------------------*/
  45. /** @defgroup I2C_Exported_Types I2C Exported Types
  46. * @{
  47. */
  48. /** @defgroup I2C_Configuration_Structure_definition I2C Configuration Structure definition
  49. * @brief I2C Configuration Structure definition
  50. * @{
  51. */
  52. typedef struct
  53. {
  54. uint32_t ClockSpeed; /*!< Specifies the clock frequency.
  55. This parameter must be set to a value lower than 400kHz */
  56. uint32_t DutyCycle; /*!< Specifies the I2C fast mode duty cycle.
  57. This parameter can be a value of @ref I2C_duty_cycle_in_fast_mode */
  58. uint32_t OwnAddress1; /*!< Specifies the first device own address.
  59. This parameter can be a 7-bit or 10-bit address. */
  60. uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
  61. This parameter can be a value of @ref I2C_general_call_addressing_mode */
  62. uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
  63. This parameter can be a value of @ref I2C_nostretch_mode */
  64. } I2C_InitTypeDef;
  65. /**
  66. * @}
  67. */
  68. /** @defgroup HAL_state_structure_definition HAL state structure definition
  69. * @brief HAL State structure definition
  70. * @note HAL I2C State value coding follow below described bitmap :
  71. * b7-b6 Error information
  72. * 00 : No Error
  73. * 01 : Abort (Abort user request on going)
  74. * 10 : Timeout
  75. * 11 : Error
  76. * b5 Peripheral initilisation status
  77. * 0 : Reset (Peripheral not initialized)
  78. * 1 : Init done (Peripheral initialized and ready to use. HAL I2C Init function called)
  79. * b4 (not used)
  80. * x : Should be set to 0
  81. * b3
  82. * 0 : Ready or Busy (No Listen mode ongoing)
  83. * 1 : Listen (Peripheral in Address Listen Mode)
  84. * b2 Intrinsic process state
  85. * 0 : Ready
  86. * 1 : Busy (Peripheral busy with some configuration or internal operations)
  87. * b1 Rx state
  88. * 0 : Ready (no Rx operation ongoing)
  89. * 1 : Busy (Rx operation ongoing)
  90. * b0 Tx state
  91. * 0 : Ready (no Tx operation ongoing)
  92. * 1 : Busy (Tx operation ongoing)
  93. * @{
  94. */
  95. typedef enum
  96. {
  97. HAL_I2C_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized */
  98. HAL_I2C_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use */
  99. HAL_I2C_STATE_BUSY = 0x24U, /*!< An internal process is ongoing */
  100. HAL_I2C_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing */
  101. HAL_I2C_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
  102. HAL_I2C_STATE_LISTEN = 0x28U, /*!< Address Listen Mode is ongoing */
  103. HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U, /*!< Address Listen Mode and Data Transmission
  104. process is ongoing */
  105. HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU, /*!< Address Listen Mode and Data Reception
  106. process is ongoing */
  107. HAL_I2C_STATE_ABORT = 0x60U, /*!< Abort user request ongoing */
  108. HAL_I2C_STATE_TIMEOUT = 0xA0U, /*!< Timeout state */
  109. HAL_I2C_STATE_ERROR = 0xE0U /*!< Error */
  110. } HAL_I2C_StateTypeDef;
  111. /**
  112. * @}
  113. */
  114. /** @defgroup HAL_mode_structure_definition HAL mode structure definition
  115. * @brief HAL Mode structure definition
  116. * @note HAL I2C Mode value coding follow below described bitmap :\n
  117. * b7 (not used)\n
  118. * x : Should be set to 0\n
  119. * b6\n
  120. * 0 : None\n
  121. * 1 : Memory (HAL I2C communication is in Memory Mode)\n
  122. * b5\n
  123. * 0 : None\n
  124. * 1 : Slave (HAL I2C communication is in Slave Mode)\n
  125. * b4\n
  126. * 0 : None\n
  127. * 1 : Master (HAL I2C communication is in Master Mode)\n
  128. * b3-b2-b1-b0 (not used)\n
  129. * xxxx : Should be set to 0000
  130. * @{
  131. */
  132. typedef enum
  133. {
  134. HAL_I2C_MODE_NONE = 0x00U, /*!< No I2C communication on going */
  135. HAL_I2C_MODE_MASTER = 0x10U, /*!< I2C communication is in Master Mode */
  136. HAL_I2C_MODE_SLAVE = 0x20U, /*!< I2C communication is in Slave Mode */
  137. HAL_I2C_MODE_MEM = 0x40U /*!< I2C communication is in Memory Mode */
  138. } HAL_I2C_ModeTypeDef;
  139. /**
  140. * @}
  141. */
  142. /** @defgroup I2C_Error_Code_definition I2C Error Code definition
  143. * @brief I2C Error Code definition
  144. * @{
  145. */
  146. #define HAL_I2C_ERROR_NONE 0x00000000U /*!< No error */
  147. #define HAL_I2C_ERROR_BERR 0x00000001U /*!< BERR error */
  148. #define HAL_I2C_ERROR_ARLO 0x00000002U /*!< ARLO error */
  149. #define HAL_I2C_ERROR_AF 0x00000004U /*!< AF error */
  150. #define HAL_I2C_ERROR_OVR 0x00000008U /*!< OVR error */
  151. #if (defined(DMA1) || defined(DMA))
  152. #define HAL_I2C_ERROR_DMA 0x00000010U /*!< DMA transfer error */
  153. #define HAL_I2C_ERROR_DMA_PARAM 0x00000080U /*!< DMA Parameter Error */
  154. #endif /* DMA1 or DMA */
  155. #define HAL_I2C_ERROR_TIMEOUT 0x00000020U /*!< Timeout Error */
  156. #define HAL_I2C_ERROR_SIZE 0x00000040U /*!< Size Management error */
  157. #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
  158. #define HAL_I2C_ERROR_INVALID_CALLBACK 0x00000100U /*!< Invalid Callback error */
  159. #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
  160. /**
  161. * @}
  162. */
  163. /** @defgroup I2C_handle_Structure_definition I2C handle Structure definition
  164. * @brief I2C handle Structure definition
  165. * @{
  166. */
  167. typedef struct __I2C_HandleTypeDef
  168. {
  169. I2C_TypeDef *Instance; /*!< I2C registers base address */
  170. I2C_InitTypeDef Init; /*!< I2C communication parameters */
  171. uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
  172. uint16_t XferSize; /*!< I2C transfer size */
  173. __IO uint16_t XferCount; /*!< I2C transfer counter */
  174. __IO uint32_t XferOptions; /*!< I2C transfer options */
  175. __IO uint32_t PreviousState; /*!< I2C communication Previous state and mode
  176. context for internal usage */
  177. #if (defined(DMA1) || defined(DMA))
  178. DMA_HandleTypeDef *hdmatx; /*!< I2C Tx DMA handle parameters */
  179. DMA_HandleTypeDef *hdmarx; /*!< I2C Rx DMA handle parameters */
  180. #endif /* DMA1 or DMA */
  181. HAL_LockTypeDef Lock; /*!< I2C locking object */
  182. __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */
  183. __IO HAL_I2C_ModeTypeDef Mode; /*!< I2C communication mode */
  184. __IO uint32_t ErrorCode; /*!< I2C Error code */
  185. __IO uint32_t Devaddress; /*!< I2C Target device address */
  186. __IO uint32_t Memaddress; /*!< I2C Target memory address */
  187. __IO uint32_t MemaddSize; /*!< I2C Target memory address size */
  188. __IO uint32_t EventCount; /*!< I2C Event counter */
  189. #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
  190. void (* MasterTxCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Master Tx Transfer completed callback */
  191. void (* MasterRxCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Master Rx Transfer completed callback */
  192. void (* SlaveTxCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Slave Tx Transfer completed callback */
  193. void (* SlaveRxCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Slave Rx Transfer completed callback */
  194. void (* ListenCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Listen Complete callback */
  195. void (* MemTxCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Memory Tx Transfer completed callback */
  196. void (* MemRxCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Memory Rx Transfer completed callback */
  197. void (* ErrorCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Error callback */
  198. void (* AbortCpltCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Abort callback */
  199. void (* AddrCallback)(struct __I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode); /*!< I2C Slave Address Match callback */
  200. void (* MspInitCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Msp Init callback */
  201. void (* MspDeInitCallback)(struct __I2C_HandleTypeDef *hi2c); /*!< I2C Msp DeInit callback */
  202. #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
  203. } I2C_HandleTypeDef;
  204. #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
  205. /**
  206. * @brief HAL I2C Callback ID enumeration definition
  207. */
  208. typedef enum
  209. {
  210. HAL_I2C_MASTER_TX_COMPLETE_CB_ID = 0x00U, /*!< I2C Master Tx Transfer completed callback ID */
  211. HAL_I2C_MASTER_RX_COMPLETE_CB_ID = 0x01U, /*!< I2C Master Rx Transfer completed callback ID */
  212. HAL_I2C_SLAVE_TX_COMPLETE_CB_ID = 0x02U, /*!< I2C Slave Tx Transfer completed callback ID */
  213. HAL_I2C_SLAVE_RX_COMPLETE_CB_ID = 0x03U, /*!< I2C Slave Rx Transfer completed callback ID */
  214. HAL_I2C_LISTEN_COMPLETE_CB_ID = 0x04U, /*!< I2C Listen Complete callback ID */
  215. HAL_I2C_MEM_TX_COMPLETE_CB_ID = 0x05U, /*!< I2C Memory Tx Transfer callback ID */
  216. HAL_I2C_MEM_RX_COMPLETE_CB_ID = 0x06U, /*!< I2C Memory Rx Transfer completed callback ID */
  217. HAL_I2C_ERROR_CB_ID = 0x07U, /*!< I2C Error callback ID */
  218. HAL_I2C_ABORT_CB_ID = 0x08U, /*!< I2C Abort callback ID */
  219. HAL_I2C_MSPINIT_CB_ID = 0x09U, /*!< I2C Msp Init callback ID */
  220. HAL_I2C_MSPDEINIT_CB_ID = 0x0AU /*!< I2C Msp DeInit callback ID */
  221. } HAL_I2C_CallbackIDTypeDef;
  222. /**
  223. * @brief HAL I2C Callback pointer definition
  224. */
  225. typedef void (*pI2C_CallbackTypeDef)(I2C_HandleTypeDef *hi2c); /*!< pointer to an I2C callback function */
  226. typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode); /*!< pointer to an I2C Address Match callback function */
  227. #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
  228. /**
  229. * @}
  230. */
  231. /**
  232. * @}
  233. */
  234. /* Exported constants --------------------------------------------------------*/
  235. /** @defgroup I2C_Exported_Constants I2C Exported Constants
  236. * @{
  237. */
  238. /** @defgroup I2C_duty_cycle_in_fast_mode I2C duty cycle in fast mode
  239. * @{
  240. */
  241. #define I2C_DUTYCYCLE_2 0x00000000U
  242. #define I2C_DUTYCYCLE_16_9 I2C_CCR_DUTY
  243. /**
  244. * @}
  245. */
  246. /** @defgroup I2C_general_call_addressing_mode I2C general call addressing mode
  247. * @{
  248. */
  249. #define I2C_GENERALCALL_DISABLE 0x00000000U
  250. #define I2C_GENERALCALL_ENABLE I2C_CR1_ENGC
  251. /**
  252. * @}
  253. */
  254. /** @defgroup I2C_nostretch_mode I2C nostretch mode
  255. * @{
  256. */
  257. #define I2C_NOSTRETCH_DISABLE 0x00000000U
  258. #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
  259. /**
  260. * @}
  261. */
  262. /** @defgroup I2C_Memory_Address_Size I2C Memory Address Size
  263. * @{
  264. */
  265. #define I2C_MEMADD_SIZE_8BIT 0x00000001U
  266. #define I2C_MEMADD_SIZE_16BIT 0x00000010U
  267. /**
  268. * @}
  269. */
  270. /** @defgroup I2C_XferDirection_definition I2C XferDirection definition
  271. * @{
  272. */
  273. #define I2C_DIRECTION_RECEIVE 0x00000000U
  274. #define I2C_DIRECTION_TRANSMIT 0x00000001U
  275. /**
  276. * @}
  277. */
  278. /** @defgroup I2C_XferOptions_definition I2C XferOptions definition
  279. * @{
  280. */
  281. #define I2C_FIRST_FRAME 0x00000001U
  282. #define I2C_FIRST_AND_NEXT_FRAME 0x00000002U
  283. #define I2C_NEXT_FRAME 0x00000004U
  284. #define I2C_FIRST_AND_LAST_FRAME 0x00000008U
  285. #define I2C_LAST_FRAME_NO_STOP 0x00000010U
  286. #define I2C_LAST_FRAME 0x00000020U
  287. /* List of XferOptions in usage of :
  288. * 1- Restart condition in all use cases (direction change or not)
  289. */
  290. #define I2C_OTHER_FRAME (0x00AA0000U)
  291. #define I2C_OTHER_AND_LAST_FRAME (0xAA000000U)
  292. /**
  293. * @}
  294. */
  295. /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition
  296. * @brief I2C Interrupt definition
  297. * Elements values convention: 0xXXXXXXXX
  298. * - XXXXXXXX : Interrupt control mask
  299. * @{
  300. */
  301. #define I2C_IT_BUF I2C_CR2_ITBUFEN
  302. #define I2C_IT_EVT I2C_CR2_ITEVTEN
  303. #define I2C_IT_ERR I2C_CR2_ITERREN
  304. /**
  305. * @}
  306. */
  307. /** @defgroup I2C_Flag_definition I2C Flag definition
  308. * @{
  309. */
  310. #define I2C_FLAG_OVR 0x00010800U
  311. #define I2C_FLAG_AF 0x00010400U
  312. #define I2C_FLAG_ARLO 0x00010200U
  313. #define I2C_FLAG_BERR 0x00010100U
  314. #define I2C_FLAG_TXE 0x00010080U
  315. #define I2C_FLAG_RXNE 0x00010040U
  316. #define I2C_FLAG_STOPF 0x00010010U
  317. #define I2C_FLAG_ADD10 0x00010008U
  318. #define I2C_FLAG_BTF 0x00010004U
  319. #define I2C_FLAG_ADDR 0x00010002U
  320. #define I2C_FLAG_SB 0x00010001U
  321. #define I2C_FLAG_DUALF 0x00100080U
  322. #define I2C_FLAG_GENCALL 0x00100010U
  323. #define I2C_FLAG_TRA 0x00100004U
  324. #define I2C_FLAG_BUSY 0x00100002U
  325. #define I2C_FLAG_MSL 0x00100001U
  326. /**
  327. * @}
  328. */
  329. /**
  330. * @}
  331. */
  332. /* Exported macros -----------------------------------------------------------*/
  333. /** @defgroup I2C_Exported_Macros I2C Exported Macros
  334. * @{
  335. */
  336. /** @brief Reset I2C handle state.
  337. * @param __HANDLE__ specifies the I2C Handle.
  338. * @retval None
  339. */
  340. #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
  341. #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) do{ \
  342. (__HANDLE__)->State = HAL_I2C_STATE_RESET; \
  343. (__HANDLE__)->MspInitCallback = NULL; \
  344. (__HANDLE__)->MspDeInitCallback = NULL; \
  345. } while(0)
  346. #else
  347. #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
  348. #endif
  349. /** @brief Enable or disable the specified I2C interrupts.
  350. * @param __HANDLE__ specifies the I2C Handle.
  351. * @param __INTERRUPT__ specifies the interrupt source to enable or disable.
  352. * This parameter can be one of the following values:
  353. * @arg I2C_IT_BUF: Buffer interrupt enable
  354. * @arg I2C_IT_EVT: Event interrupt enable
  355. * @arg I2C_IT_ERR: Error interrupt enable
  356. * @retval None
  357. */
  358. #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__))
  359. #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
  360. /** @brief Checks if the specified I2C interrupt source is enabled or disabled.
  361. * @param __HANDLE__ specifies the I2C Handle.
  362. * @param __INTERRUPT__ specifies the I2C interrupt source to check.
  363. * This parameter can be one of the following values:
  364. * @arg I2C_IT_BUF: Buffer interrupt enable
  365. * @arg I2C_IT_EVT: Event interrupt enable
  366. * @arg I2C_IT_ERR: Error interrupt enable
  367. * @retval The new state of __INTERRUPT__ (TRUE or FALSE).
  368. */
  369. #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  370. /** @brief Checks whether the specified I2C flag is set or not.
  371. * @param __HANDLE__ specifies the I2C Handle.
  372. * @param __FLAG__ specifies the flag to check.
  373. * This parameter can be one of the following values:
  374. * @arg I2C_FLAG_OVR: Overrun/Underrun flag
  375. * @arg I2C_FLAG_AF: Acknowledge failure flag
  376. * @arg I2C_FLAG_ARLO: Arbitration lost flag
  377. * @arg I2C_FLAG_BERR: Bus error flag
  378. * @arg I2C_FLAG_TXE: Data register empty flag
  379. * @arg I2C_FLAG_RXNE: Data register not empty flag
  380. * @arg I2C_FLAG_STOPF: Stop detection flag
  381. * @arg I2C_FLAG_ADD10: 10-bit header sent flag
  382. * @arg I2C_FLAG_BTF: Byte transfer finished flag
  383. * @arg I2C_FLAG_ADDR: Address sent flag
  384. * Address matched flag
  385. * @arg I2C_FLAG_SB: Start bit flag
  386. * @arg I2C_FLAG_DUALF: Dual flag
  387. * @arg I2C_FLAG_GENCALL: General call header flag
  388. * @arg I2C_FLAG_TRA: Transmitter/Receiver flag
  389. * @arg I2C_FLAG_BUSY: Bus busy flag
  390. * @arg I2C_FLAG_MSL: Master/Slave flag
  391. * @retval The new state of __FLAG__ (TRUE or FALSE).
  392. */
  393. #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) ((((uint8_t)((__FLAG__) >> 16U)) == 0x01U) ? \
  394. (((((__HANDLE__)->Instance->SR1) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET) : \
  395. (((((__HANDLE__)->Instance->SR2) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET))
  396. /** @brief Clears the I2C pending flags which are cleared by writing 0 in a specific bit.
  397. * @param __HANDLE__ specifies the I2C Handle.
  398. * @param __FLAG__ specifies the flag to clear.
  399. * This parameter can be any combination of the following values:
  400. * @arg I2C_FLAG_OVR: Overrun/Underrun flag (Slave mode)
  401. * @arg I2C_FLAG_AF: Acknowledge failure flag
  402. * @arg I2C_FLAG_ARLO: Arbitration lost flag (Master mode)
  403. * @arg I2C_FLAG_BERR: Bus error flag
  404. * @retval None
  405. */
  406. #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR1 = ~((__FLAG__) & I2C_FLAG_MASK))
  407. /** @brief Clears the I2C ADDR pending flag.
  408. * @param __HANDLE__ specifies the I2C Handle.
  409. * @retval None
  410. */
  411. #define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__) \
  412. do{ \
  413. __IO uint32_t tmpreg = 0x00U; \
  414. tmpreg = (__HANDLE__)->Instance->SR1; \
  415. tmpreg = (__HANDLE__)->Instance->SR2; \
  416. UNUSED(tmpreg); \
  417. } while(0)
  418. /** @brief Clears the I2C STOPF pending flag.
  419. * @param __HANDLE__ specifies the I2C Handle.
  420. * @retval None
  421. */
  422. #define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__) \
  423. do{ \
  424. __IO uint32_t tmpreg = 0x00U; \
  425. tmpreg = (__HANDLE__)->Instance->SR1; \
  426. SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE); \
  427. UNUSED(tmpreg); \
  428. } while(0)
  429. /** @brief Enable the specified I2C peripheral.
  430. * @param __HANDLE__ specifies the I2C Handle.
  431. * @retval None
  432. */
  433. #define __HAL_I2C_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
  434. /** @brief Disable the specified I2C peripheral.
  435. * @param __HANDLE__ specifies the I2C Handle.
  436. * @retval None
  437. */
  438. #define __HAL_I2C_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
  439. /**
  440. * @}
  441. */
  442. /* Exported functions --------------------------------------------------------*/
  443. /** @addtogroup I2C_Exported_Functions
  444. * @{
  445. */
  446. /** @addtogroup I2C_Exported_Functions_Group1 Initialization and de-initialization functions
  447. * @{
  448. */
  449. /* Initialization and de-initialization functions******************************/
  450. HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
  451. HAL_StatusTypeDef HAL_I2C_DeInit(I2C_HandleTypeDef *hi2c);
  452. void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
  453. void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
  454. /* Callbacks Register/UnRegister functions ***********************************/
  455. #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
  456. HAL_StatusTypeDef HAL_I2C_RegisterCallback(I2C_HandleTypeDef *hi2c, HAL_I2C_CallbackIDTypeDef CallbackID, pI2C_CallbackTypeDef pCallback);
  457. HAL_StatusTypeDef HAL_I2C_UnRegisterCallback(I2C_HandleTypeDef *hi2c, HAL_I2C_CallbackIDTypeDef CallbackID);
  458. HAL_StatusTypeDef HAL_I2C_RegisterAddrCallback(I2C_HandleTypeDef *hi2c, pI2C_AddrCallbackTypeDef pCallback);
  459. HAL_StatusTypeDef HAL_I2C_UnRegisterAddrCallback(I2C_HandleTypeDef *hi2c);
  460. #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
  461. /**
  462. * @}
  463. */
  464. /** @addtogroup I2C_Exported_Functions_Group2 Input and Output operation functions
  465. * @{
  466. */
  467. /* IO operation functions ****************************************************/
  468. /******* Blocking mode: Polling */
  469. HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  470. HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  471. HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  472. HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  473. 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);
  474. 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);
  475. HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
  476. /******* Non-Blocking mode: Interrupt */
  477. HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  478. HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  479. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  480. HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  481. 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);
  482. 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);
  483. HAL_StatusTypeDef HAL_I2C_Master_Seq_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  484. HAL_StatusTypeDef HAL_I2C_Master_Seq_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  485. HAL_StatusTypeDef HAL_I2C_Slave_Seq_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  486. HAL_StatusTypeDef HAL_I2C_Slave_Seq_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  487. HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);
  488. HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c);
  489. HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress);
  490. #if (defined(DMA1) || defined(DMA))
  491. /******* Non-Blocking mode: DMA */
  492. HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  493. HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  494. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  495. HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  496. 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);
  497. 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);
  498. HAL_StatusTypeDef HAL_I2C_Master_Seq_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  499. HAL_StatusTypeDef HAL_I2C_Master_Seq_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  500. HAL_StatusTypeDef HAL_I2C_Slave_Seq_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  501. HAL_StatusTypeDef HAL_I2C_Slave_Seq_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  502. #endif /* DMA1 or DMA */
  503. /**
  504. * @}
  505. */
  506. /** @addtogroup I2C_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks
  507. * @{
  508. */
  509. /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
  510. void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
  511. void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
  512. void HAL_I2C_IRQHandler(I2C_HandleTypeDef *hi2c);
  513. void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
  514. void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
  515. void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
  516. void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
  517. void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
  518. void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c);
  519. void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
  520. void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
  521. void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
  522. void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c);
  523. /**
  524. * @}
  525. */
  526. /** @addtogroup I2C_Exported_Functions_Group3 Peripheral State, Mode and Error functions
  527. * @{
  528. */
  529. /* Peripheral State, Mode and Error functions *********************************/
  530. HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
  531. HAL_I2C_ModeTypeDef HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c);
  532. uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
  533. /**
  534. * @}
  535. */
  536. /**
  537. * @}
  538. */
  539. /* Private types -------------------------------------------------------------*/
  540. /* Private variables ---------------------------------------------------------*/
  541. /* Private constants ---------------------------------------------------------*/
  542. /** @defgroup I2C_Private_Constants I2C Private Constants
  543. * @{
  544. */
  545. #define I2C_FLAG_MASK 0x0000FFFFU
  546. #define I2C_MIN_PCLK_FREQ_STANDARD 2000000U /*!< 2 MHz */
  547. #define I2C_MIN_PCLK_FREQ_FAST 4000000U /*!< 4 MHz */
  548. /**
  549. * @}
  550. */
  551. /* Private macros ------------------------------------------------------------*/
  552. /** @defgroup I2C_Private_Macros I2C Private Macros
  553. * @{
  554. */
  555. #define I2C_MIN_PCLK_FREQ(__PCLK__, __SPEED__) (((__SPEED__) <= 100000U) ? ((__PCLK__) < I2C_MIN_PCLK_FREQ_STANDARD) : ((__PCLK__) < I2C_MIN_PCLK_FREQ_FAST))
  556. #define I2C_CCR_CALCULATION(__PCLK__, __SPEED__, __COEFF__) (((((__PCLK__) - 1U)/((__SPEED__) * (__COEFF__))) + 1U) & I2C_CCR_CCR)
  557. #define I2C_FREQRANGE(__PCLK__) ((__PCLK__)/1000000U)
  558. #define I2C_RISE_TIME(__FREQRANGE__, __SPEED__) (((__SPEED__) <= 100000U) ? ((__FREQRANGE__) + 1U) : ((((__FREQRANGE__) * 300U) / 1000U) + 1U))
  559. #define I2C_SPEED_STANDARD(__PCLK__, __SPEED__) ((I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 2U) < 4U)? 4U:I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 2U))
  560. #define I2C_SPEED_FAST(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__DUTYCYCLE__) == I2C_DUTYCYCLE_2)? I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 3U) : (I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 25U) | I2C_DUTYCYCLE_16_9))
  561. #define I2C_SPEED(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__SPEED__) <= 100000U)? (I2C_SPEED_STANDARD((__PCLK__), (__SPEED__))) : \
  562. ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__)) & I2C_CCR_CCR) == 0U)? 1U : \
  563. ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__))) | I2C_CCR_FS))
  564. #define I2C_7BIT_ADD_WRITE(__ADDRESS__) ((uint8_t)((__ADDRESS__) & (uint8_t)(~0x01)))
  565. #define I2C_7BIT_ADD_READ(__ADDRESS__) ((uint8_t)((__ADDRESS__) | 0x01))
  566. #define I2C_10BIT_ADDRESS(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)0x00FF)))
  567. #define I2C_10BIT_HEADER_WRITE(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0x0300)) >> 7) | (uint16_t)0x00F0)))
  568. #define I2C_10BIT_HEADER_READ(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0x0300)) >> 7) | (uint16_t)(0x00F1))))
  569. #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0xFF00)) >> 8)))
  570. #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)0x00FF)))
  571. /** @defgroup I2C_IS_RTC_Definitions I2C Private macros to check input parameters
  572. * @{
  573. */
  574. #define IS_I2C_DUTY_CYCLE(CYCLE) (((CYCLE) == I2C_DUTYCYCLE_2) || \
  575. ((CYCLE) == I2C_DUTYCYCLE_16_9))
  576. #define IS_I2C_ADDRESSING_MODE(ADDRESS) (((ADDRESS) == I2C_ADDRESSINGMODE_7BIT) || \
  577. ((ADDRESS) == I2C_ADDRESSINGMODE_10BIT))
  578. #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \
  579. ((ADDRESS) == I2C_DUALADDRESS_ENABLE))
  580. #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \
  581. ((CALL) == I2C_GENERALCALL_ENABLE))
  582. #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \
  583. ((STRETCH) == I2C_NOSTRETCH_ENABLE))
  584. #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
  585. ((SIZE) == I2C_MEMADD_SIZE_16BIT))
  586. #define IS_I2C_CLOCK_SPEED(SPEED) (((SPEED) > 0U) && ((SPEED) <= 400000U))
  587. #define IS_I2C_OWN_ADDRESS1(ADDRESS1) (((ADDRESS1) & 0xFFFFFC00U) == 0U)
  588. #define IS_I2C_OWN_ADDRESS2(ADDRESS2) (((ADDRESS2) & 0xFFFFFF01U) == 0U)
  589. #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_FIRST_FRAME) || \
  590. ((REQUEST) == I2C_FIRST_AND_NEXT_FRAME) || \
  591. ((REQUEST) == I2C_NEXT_FRAME) || \
  592. ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \
  593. ((REQUEST) == I2C_LAST_FRAME) || \
  594. ((REQUEST) == I2C_LAST_FRAME_NO_STOP) || \
  595. IS_I2C_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST))
  596. #define IS_I2C_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_OTHER_FRAME) || \
  597. ((REQUEST) == I2C_OTHER_AND_LAST_FRAME))
  598. #define I2C_CHECK_FLAG(__ISR__, __FLAG__) ((((__ISR__) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET)
  599. #define I2C_CHECK_IT_SOURCE(__CR1__, __IT__) ((((__CR1__) & (__IT__)) == (__IT__)) ? SET : RESET)
  600. /**
  601. * @}
  602. */
  603. /**
  604. * @}
  605. */
  606. /* Private functions ---------------------------------------------------------*/
  607. /** @defgroup I2C_Private_Functions I2C Private Functions
  608. * @{
  609. */
  610. /**
  611. * @}
  612. */
  613. /**
  614. * @}
  615. */
  616. /**
  617. * @}
  618. */
  619. #ifdef __cplusplus
  620. }
  621. #endif
  622. #endif /* __PY32F0xx_HAL_I2C_H */
  623. /************************ (C) COPYRIGHT Puya *****END OF FILE****/