You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

stm32l1xx_hal_i2c.h 34KB

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