stm32f4xx_hal_i2c.h 30 KB

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