stm32l1xx_hal_i2c.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667
  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) 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 __STM32L1xx_HAL_I2C_H
  37. #define __STM32L1xx_HAL_I2C_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /* Includes ------------------------------------------------------------------*/
  42. #include "stm32l1xx_hal_def.h"
  43. /** @addtogroup STM32L1xx_HAL_Driver
  44. * @{
  45. */
  46. /** @addtogroup I2C
  47. * @{
  48. */
  49. /* Exported types ------------------------------------------------------------*/
  50. /** @defgroup I2C_Exported_Types I2C Exported Types
  51. * @{
  52. */
  53. /** @defgroup I2C_Configuration_Structure_definition I2C Configuration Structure definition
  54. * @brief I2C Configuration Structure definition
  55. * @{
  56. */
  57. typedef struct
  58. {
  59. uint32_t ClockSpeed; /*!< Specifies the clock frequency.
  60. This parameter must be set to a value lower than 400kHz */
  61. uint32_t DutyCycle; /*!< Specifies the I2C fast mode duty cycle.
  62. This parameter can be a value of @ref I2C_duty_cycle_in_fast_mode */
  63. uint32_t OwnAddress1; /*!< Specifies the first device own address.
  64. This parameter can be a 7-bit or 10-bit address. */
  65. uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected.
  66. This parameter can be a value of @ref I2C_addressing_mode */
  67. uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected.
  68. This parameter can be a value of @ref I2C_dual_addressing_mode */
  69. uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected
  70. This parameter can be a 7-bit address. */
  71. uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
  72. This parameter can be a value of @ref I2C_general_call_addressing_mode */
  73. uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
  74. This parameter can be a value of @ref I2C_nostretch_mode */
  75. }I2C_InitTypeDef;
  76. /**
  77. * @}
  78. */
  79. /** @defgroup HAL_state_structure_definition HAL state structure definition
  80. * @brief HAL State structure definition
  81. * @note HAL I2C State value coding follow below described bitmap :
  82. * b7-b6 Error information
  83. * 00 : No Error
  84. * 01 : Abort (Abort user request on going)
  85. * 10 : Timeout
  86. * 11 : Error
  87. * b5 IP initilisation status
  88. * 0 : Reset (IP not initialized)
  89. * 1 : Init done (IP initialized and ready to use. HAL I2C Init function called)
  90. * b4 (not used)
  91. * x : Should be set to 0
  92. * b3
  93. * 0 : Ready or Busy (No Listen mode ongoing)
  94. * 1 : Listen (IP in Address Listen Mode)
  95. * b2 Intrinsic process state
  96. * 0 : Ready
  97. * 1 : Busy (IP busy with some configuration or internal operations)
  98. * b1 Rx state
  99. * 0 : Ready (no Rx operation ongoing)
  100. * 1 : Busy (Rx operation ongoing)
  101. * b0 Tx state
  102. * 0 : Ready (no Tx operation ongoing)
  103. * 1 : Busy (Tx operation ongoing)
  104. * @{
  105. */
  106. typedef enum
  107. {
  108. HAL_I2C_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized */
  109. HAL_I2C_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use */
  110. HAL_I2C_STATE_BUSY = 0x24U, /*!< An internal process is ongoing */
  111. HAL_I2C_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing */
  112. HAL_I2C_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
  113. HAL_I2C_STATE_LISTEN = 0x28U, /*!< Address Listen Mode is ongoing */
  114. HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U, /*!< Address Listen Mode and Data Transmission
  115. process is ongoing */
  116. HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU, /*!< Address Listen Mode and Data Reception
  117. process is ongoing */
  118. HAL_I2C_STATE_ABORT = 0x60U, /*!< Abort user request ongoing */
  119. HAL_I2C_STATE_TIMEOUT = 0xA0U, /*!< Timeout state */
  120. HAL_I2C_STATE_ERROR = 0xE0U /*!< Error */
  121. }HAL_I2C_StateTypeDef;
  122. /**
  123. * @}
  124. */
  125. /** @defgroup HAL_mode_structure_definition HAL mode structure definition
  126. * @brief HAL Mode structure definition
  127. * @note HAL I2C Mode value coding follow below described bitmap :
  128. * b7 (not used)
  129. * x : Should be set to 0
  130. * b6
  131. * 0 : None
  132. * 1 : Memory (HAL I2C communication is in Memory Mode)
  133. * b5
  134. * 0 : None
  135. * 1 : Slave (HAL I2C communication is in Slave Mode)
  136. * b4
  137. * 0 : None
  138. * 1 : Master (HAL I2C communication is in Master Mode)
  139. * b3-b2-b1-b0 (not used)
  140. * xxxx : Should be set to 0000
  141. * @{
  142. */
  143. typedef enum
  144. {
  145. HAL_I2C_MODE_NONE = 0x00U, /*!< No I2C communication on going */
  146. HAL_I2C_MODE_MASTER = 0x10U, /*!< I2C communication is in Master Mode */
  147. HAL_I2C_MODE_SLAVE = 0x20U, /*!< I2C communication is in Slave Mode */
  148. HAL_I2C_MODE_MEM = 0x40U /*!< I2C communication is in Memory Mode */
  149. }HAL_I2C_ModeTypeDef;
  150. /**
  151. * @}
  152. */
  153. /** @defgroup I2C_Error_Code_definition I2C Error Code definition
  154. * @brief I2C Error Code definition
  155. * @{
  156. */
  157. #define HAL_I2C_ERROR_NONE (0x00000000U) /*!< No error */
  158. #define HAL_I2C_ERROR_BERR (0x00000001U) /*!< BERR error */
  159. #define HAL_I2C_ERROR_ARLO (0x00000002U) /*!< ARLO error */
  160. #define HAL_I2C_ERROR_AF (0x00000004U) /*!< AF error */
  161. #define HAL_I2C_ERROR_OVR (0x00000008U) /*!< OVR error */
  162. #define HAL_I2C_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
  163. #define HAL_I2C_ERROR_TIMEOUT (0x00000020U) /*!< Timeout Error */
  164. /**
  165. * @}
  166. */
  167. /** @defgroup I2C_handle_Structure_definition I2C handle Structure definition
  168. * @brief I2C handle Structure definition
  169. * @{
  170. */
  171. typedef struct
  172. {
  173. I2C_TypeDef *Instance; /*!< I2C registers base address */
  174. I2C_InitTypeDef Init; /*!< I2C communication parameters */
  175. uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
  176. uint16_t XferSize; /*!< I2C transfer size */
  177. __IO uint16_t XferCount; /*!< I2C transfer counter */
  178. __IO uint32_t XferOptions; /*!< I2C transfer options */
  179. __IO uint32_t PreviousState; /*!< I2C communication Previous state and mode
  180. context for internal usage */
  181. DMA_HandleTypeDef *hdmatx; /*!< I2C Tx DMA handle parameters */
  182. DMA_HandleTypeDef *hdmarx; /*!< I2C Rx DMA handle parameters */
  183. HAL_LockTypeDef Lock; /*!< I2C locking object */
  184. __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */
  185. __IO HAL_I2C_ModeTypeDef Mode; /*!< I2C communication mode */
  186. __IO uint32_t ErrorCode; /*!< I2C Error code */
  187. __IO uint32_t Devaddress; /*!< I2C Target device address */
  188. __IO uint32_t Memaddress; /*!< I2C Target memory address */
  189. __IO uint32_t MemaddSize; /*!< I2C Target memory address size */
  190. __IO uint32_t EventCount; /*!< I2C Event counter */
  191. }I2C_HandleTypeDef;
  192. /**
  193. * @}
  194. */
  195. /**
  196. * @}
  197. */
  198. /* Exported constants --------------------------------------------------------*/
  199. /** @defgroup I2C_Exported_Constants I2C Exported Constants
  200. * @{
  201. */
  202. /** @defgroup I2C_duty_cycle_in_fast_mode I2C duty cycle in fast mode
  203. * @{
  204. */
  205. #define I2C_DUTYCYCLE_2 (0x00000000U)
  206. #define I2C_DUTYCYCLE_16_9 I2C_CCR_DUTY
  207. /**
  208. * @}
  209. */
  210. /** @defgroup I2C_addressing_mode I2C addressing mode
  211. * @{
  212. */
  213. #define I2C_ADDRESSINGMODE_7BIT (0x00004000U)
  214. #define I2C_ADDRESSINGMODE_10BIT (I2C_OAR1_ADDMODE | (0x00004000U))
  215. /**
  216. * @}
  217. */
  218. /** @defgroup I2C_dual_addressing_mode I2C dual addressing mode
  219. * @{
  220. */
  221. #define I2C_DUALADDRESS_DISABLE (0x00000000U)
  222. #define I2C_DUALADDRESS_ENABLE I2C_OAR2_ENDUAL
  223. /**
  224. * @}
  225. */
  226. /** @defgroup I2C_general_call_addressing_mode I2C general call addressing mode
  227. * @{
  228. */
  229. #define I2C_GENERALCALL_DISABLE (0x00000000U)
  230. #define I2C_GENERALCALL_ENABLE I2C_CR1_ENGC
  231. /**
  232. * @}
  233. */
  234. /** @defgroup I2C_nostretch_mode I2C nostretch mode
  235. * @{
  236. */
  237. #define I2C_NOSTRETCH_DISABLE (0x00000000U)
  238. #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
  239. /**
  240. * @}
  241. */
  242. /** @defgroup I2C_Memory_Address_Size I2C Memory Address Size
  243. * @{
  244. */
  245. #define I2C_MEMADD_SIZE_8BIT (0x00000001U)
  246. #define I2C_MEMADD_SIZE_16BIT (0x00000010U)
  247. /**
  248. * @}
  249. */
  250. /** @defgroup I2C_XferDirection_definition I2C XferDirection definition Master Point of View
  251. * @{
  252. */
  253. #define I2C_DIRECTION_RECEIVE (0x00000000U)
  254. #define I2C_DIRECTION_TRANSMIT (0x00000001U)
  255. /**
  256. * @}
  257. */
  258. /** @defgroup I2C_XferOptions_definition I2C XferOptions definition
  259. * @{
  260. */
  261. #define I2C_FIRST_FRAME (0x00000001U)
  262. #define I2C_NEXT_FRAME (0x00000002U)
  263. #define I2C_FIRST_AND_LAST_FRAME (0x00000004U)
  264. #define I2C_LAST_FRAME (0x00000008U)
  265. /**
  266. * @}
  267. */
  268. /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition
  269. * @brief I2C Interrupt definition
  270. * Elements values convention: 0xXXXXXXXX
  271. * - XXXXXXXX : Interrupt control mask
  272. * @{
  273. */
  274. #define I2C_IT_BUF I2C_CR2_ITBUFEN
  275. #define I2C_IT_EVT I2C_CR2_ITEVTEN
  276. #define I2C_IT_ERR I2C_CR2_ITERREN
  277. /**
  278. * @}
  279. */
  280. /** @defgroup I2C_Flag_definition I2C Flag definition
  281. * @{
  282. */
  283. #define I2C_FLAG_OVR ((uint32_t)(1U << 16U | I2C_SR1_OVR))
  284. #define I2C_FLAG_AF ((uint32_t)(1U << 16U | I2C_SR1_AF))
  285. #define I2C_FLAG_ARLO ((uint32_t)(1U << 16U | I2C_SR1_ARLO))
  286. #define I2C_FLAG_BERR ((uint32_t)(1U << 16U | I2C_SR1_BERR))
  287. #define I2C_FLAG_TXE ((uint32_t)(1U << 16U | I2C_SR1_TXE))
  288. #define I2C_FLAG_RXNE ((uint32_t)(1U << 16U | I2C_SR1_RXNE))
  289. #define I2C_FLAG_STOPF ((uint32_t)(1U << 16U | I2C_SR1_STOPF))
  290. #define I2C_FLAG_ADD10 ((uint32_t)(1U << 16U | I2C_SR1_ADD10))
  291. #define I2C_FLAG_BTF ((uint32_t)(1U << 16U | I2C_SR1_BTF))
  292. #define I2C_FLAG_ADDR ((uint32_t)(1U << 16U | I2C_SR1_ADDR))
  293. #define I2C_FLAG_SB ((uint32_t)(1U << 16U | I2C_SR1_SB))
  294. #define I2C_FLAG_DUALF ((uint32_t)(2U << 16U | I2C_SR2_DUALF))
  295. #define I2C_FLAG_GENCALL ((uint32_t)(2U << 16U | I2C_SR2_GENCALL))
  296. #define I2C_FLAG_TRA ((uint32_t)(2U << 16U | I2C_SR2_TRA))
  297. #define I2C_FLAG_BUSY ((uint32_t)(2U << 16U | I2C_SR2_BUSY))
  298. #define I2C_FLAG_MSL ((uint32_t)(2U << 16U | I2C_SR2_MSL))
  299. /**
  300. * @}
  301. */
  302. /**
  303. * @}
  304. */
  305. /* Exported macros -----------------------------------------------------------*/
  306. /** @defgroup I2C_Exported_Macros I2C Exported Macros
  307. * @{
  308. */
  309. /** @brief Reset I2C handle state.
  310. * @param __HANDLE__ specifies the I2C Handle.
  311. * @retval None
  312. */
  313. #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
  314. /** @brief Enable the specified I2C interrupt.
  315. * @param __HANDLE__ specifies the I2C Handle.
  316. * @param __INTERRUPT__: specifies the interrupt source to enable.
  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 None
  322. */
  323. #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__))
  324. /** @brief Disable the specified I2C interrupt.
  325. * @param __HANDLE__ specifies the I2C Handle.
  326. * @param __INTERRUPT__: specifies the interrupt source to disable.
  327. * This parameter can be one of the following values:
  328. * @arg I2C_IT_BUF: Buffer interrupt enable
  329. * @arg I2C_IT_EVT: Event interrupt enable
  330. * @arg I2C_IT_ERR: Error interrupt enable
  331. *
  332. * @retval None
  333. */
  334. #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
  335. /** @brief Check whether the specified I2C interrupt source is enabled or not.
  336. * @param __HANDLE__ specifies the I2C Handle.
  337. * @param __INTERRUPT__: specifies the I2C interrupt source to check.
  338. * This parameter can be one of the following values:
  339. * @arg I2C_IT_BUF: Buffer interrupt enable
  340. * @arg I2C_IT_EVT: Event interrupt enable
  341. * @arg I2C_IT_ERR: Error interrupt enable
  342. * @retval The new state of __INTERRUPT__ (TRUE or FALSE).
  343. */
  344. #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  345. /** @brief Check whether the specified I2C flag is set or not.
  346. * @param __HANDLE__ specifies the I2C Handle.
  347. * @param __FLAG__ specifies the flag to check.
  348. * This parameter can be one of the following values:
  349. * @arg I2C_FLAG_OVR: Overrun/Underrun flag
  350. * @arg I2C_FLAG_AF: Acknowledge failure flag
  351. * @arg I2C_FLAG_ARLO: Arbitration lost flag
  352. * @arg I2C_FLAG_BERR: Bus error flag
  353. * @arg I2C_FLAG_TXE: Data register empty flag
  354. * @arg I2C_FLAG_RXNE: Data register not empty flag
  355. * @arg I2C_FLAG_STOPF: Stop detection flag
  356. * @arg I2C_FLAG_ADD10: 10-bit header sent flag
  357. * @arg I2C_FLAG_BTF: Byte transfer finished flag
  358. * @arg I2C_FLAG_ADDR: Address sent flag
  359. * Address matched flag
  360. * @arg I2C_FLAG_SB: Start bit flag
  361. * @arg I2C_FLAG_DUALF: Dual flag
  362. * @arg I2C_FLAG_GENCALL: General call header flag
  363. * @arg I2C_FLAG_TRA: Transmitter/Receiver flag
  364. * @arg I2C_FLAG_BUSY: Bus busy flag
  365. * @arg I2C_FLAG_MSL: Master/Slave flag
  366. * @retval The new state of __FLAG__ (TRUE or FALSE).
  367. */
  368. #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) ((((uint8_t)((__FLAG__) >> 16U)) == 0x01U)?(((((__HANDLE__)->Instance->SR1) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET): \
  369. (((((__HANDLE__)->Instance->SR2) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET))
  370. /** @brief Clear the I2C pending flags which are cleared by writing 0 in a specific bit.
  371. * @param __HANDLE__ specifies the I2C Handle.
  372. * @param __FLAG__ specifies the flag to clear.
  373. * This parameter can be any combination of the following values:
  374. * @arg I2C_FLAG_OVR: Overrun/Underrun flag (Slave mode)
  375. * @arg I2C_FLAG_AF: Acknowledge failure flag
  376. * @arg I2C_FLAG_ARLO: Arbitration lost flag (Master mode)
  377. * @arg I2C_FLAG_BERR: Bus error flag
  378. * @retval None
  379. */
  380. #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR1 = ~((__FLAG__) & I2C_FLAG_MASK))
  381. /** @brief Clears the I2C ADDR pending flag.
  382. * @param __HANDLE__: specifies the I2C Handle.
  383. * @retval None
  384. */
  385. #define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__) \
  386. do{ \
  387. __IO uint32_t tmpreg = 0x00U; \
  388. tmpreg = (__HANDLE__)->Instance->SR1; \
  389. tmpreg = (__HANDLE__)->Instance->SR2; \
  390. UNUSED(tmpreg); \
  391. }while(0)
  392. /** @brief Clears the I2C STOPF pending flag.
  393. * @param __HANDLE__: specifies the I2C Handle.
  394. * @retval None
  395. */
  396. #define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__) \
  397. do{ \
  398. __IO uint32_t tmpreg = 0x00U; \
  399. tmpreg = (__HANDLE__)->Instance->SR1; \
  400. SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE); \
  401. UNUSED(tmpreg); \
  402. }while(0)
  403. /** @brief Enable the I2C peripheral.
  404. * @param __HANDLE__: specifies the I2C Handle.
  405. * This parameter can be I2Cx where x: 1 or 2 to select the I2C peripheral.
  406. * @retval None
  407. */
  408. #define __HAL_I2C_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
  409. /** @brief Disable the I2C peripheral.
  410. * @param __HANDLE__: specifies the I2C Handle.
  411. * This parameter can be I2Cx where x: 1 or 2 to select the I2C peripheral.
  412. * @retval None
  413. */
  414. #define __HAL_I2C_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
  415. /**
  416. * @}
  417. */
  418. /* Exported functions --------------------------------------------------------*/
  419. /** @addtogroup I2C_Exported_Functions
  420. * @{
  421. */
  422. /** @addtogroup I2C_Exported_Functions_Group1
  423. * @{
  424. */
  425. /* Initialization and de-initialization functions******************************/
  426. HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
  427. HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c);
  428. void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
  429. void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
  430. /**
  431. * @}
  432. */
  433. /** @addtogroup I2C_Exported_Functions_Group2
  434. * @{
  435. */
  436. /* IO operation functions ****************************************************/
  437. /******* Blocking mode: Polling */
  438. HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  439. HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  440. HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  441. HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  442. HAL_StatusTypeDef HAL_I2C_Mem_Write(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  443. HAL_StatusTypeDef HAL_I2C_Mem_Read(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  444. HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
  445. /******* Non-Blocking mode: Interrupt */
  446. HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  447. HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  448. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  449. HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  450. HAL_StatusTypeDef HAL_I2C_Mem_Write_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
  451. HAL_StatusTypeDef HAL_I2C_Mem_Read_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
  452. HAL_StatusTypeDef HAL_I2C_Master_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  453. HAL_StatusTypeDef HAL_I2C_Master_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  454. HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  455. HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
  456. HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress);
  457. HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);
  458. HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c);
  459. /******* Non-Blocking mode: DMA */
  460. HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  461. HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
  462. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  463. HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
  464. HAL_StatusTypeDef HAL_I2C_Mem_Write_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
  465. HAL_StatusTypeDef HAL_I2C_Mem_Read_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
  466. /**
  467. * @}
  468. */
  469. /** @addtogroup I2C_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks
  470. * @{
  471. */
  472. /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
  473. void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
  474. void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
  475. void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
  476. void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
  477. void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
  478. void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
  479. void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
  480. void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c);
  481. void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
  482. void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
  483. void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
  484. void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c);
  485. /**
  486. * @}
  487. */
  488. /** @addtogroup I2C_Exported_Functions_Group3
  489. * @{
  490. */
  491. /* Peripheral State, Mode and Error functions *********************************/
  492. HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
  493. HAL_I2C_ModeTypeDef HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c);
  494. uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
  495. /**
  496. * @}
  497. */
  498. /**
  499. * @}
  500. */
  501. /* Private constants ---------------------------------------------------------*/
  502. /** @defgroup I2C_Private_Constants I2C Private Constants
  503. * @{
  504. */
  505. #define I2C_FLAG_MASK (0x0000FFFFU)
  506. /**
  507. * @}
  508. */
  509. /* Private macros ------------------------------------------------------------*/
  510. /** @defgroup I2C_Private_Macro I2C Private Macros
  511. * @{
  512. */
  513. #define IS_I2C_ADDRESSING_MODE(MODE) (((MODE) == I2C_ADDRESSINGMODE_7BIT) || \
  514. ((MODE) == I2C_ADDRESSINGMODE_10BIT))
  515. #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \
  516. ((ADDRESS) == I2C_DUALADDRESS_ENABLE))
  517. #define IS_I2C_DUTY_CYCLE(CYCLE) (((CYCLE) == I2C_DUTYCYCLE_2) || \
  518. ((CYCLE) == I2C_DUTYCYCLE_16_9))
  519. #define IS_I2C_OWN_ADDRESS2(ADDRESS2) (((ADDRESS2) & (0xFFFFFF01U)) == 0U)
  520. #define IS_I2C_OWN_ADDRESS1(ADDRESS1) (((ADDRESS1) & (0xFFFFFC00U)) == 0U)
  521. #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \
  522. ((CALL) == I2C_GENERALCALL_ENABLE))
  523. #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \
  524. ((STRETCH) == I2C_NOSTRETCH_ENABLE))
  525. #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
  526. ((SIZE) == I2C_MEMADD_SIZE_16BIT))
  527. #define IS_I2C_CLOCK_SPEED(SPEED) (((SPEED) > 0U) && ((SPEED) <= 400000U))
  528. #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0xFF00U))) >> 8U)))
  529. #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FFU))))
  530. #define I2C_FREQ_RANGE(__PCLK__) ((__PCLK__)/1000000U)
  531. #define I2C_RISE_TIME(__FREQRANGE__, __SPEED__) (((__SPEED__) <= 100000U) ? ((__FREQRANGE__) + 1U) : ((((__FREQRANGE__) * 300U) / 1000U) + 1U))
  532. #define I2C_SPEED_STANDARD(__PCLK__, __SPEED__) (((((__PCLK__)/((__SPEED__) << 1U)) & I2C_CCR_CCR) < 4U)? 4U:((__PCLK__) / ((__SPEED__) << 1U)))
  533. #define I2C_SPEED_FAST(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__DUTYCYCLE__) == I2C_DUTYCYCLE_2)? ((__PCLK__) / ((__SPEED__) * 3U)) : (((__PCLK__) / ((__SPEED__) * 25U)) | I2C_DUTYCYCLE_16_9))
  534. #define I2C_SPEED(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__SPEED__) <= 100000U)? (I2C_SPEED_STANDARD((__PCLK__), (__SPEED__))) : \
  535. ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__)) & I2C_CCR_CCR) == 0U)? 1U : \
  536. ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__))) | I2C_CCR_FS))
  537. #define I2C_7BIT_ADD_WRITE(__ADDRESS__) ((uint8_t)((__ADDRESS__) & (~I2C_OAR1_ADD0)))
  538. #define I2C_7BIT_ADD_READ(__ADDRESS__) ((uint8_t)((__ADDRESS__) | I2C_OAR1_ADD0))
  539. #define I2C_10BIT_ADDRESS(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FFU))))
  540. #define I2C_10BIT_HEADER_WRITE(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0x0300U))) >> 7U) | (uint16_t)(0xF0U))))
  541. #define I2C_10BIT_HEADER_READ(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0x0300U))) >> 7U) | (uint16_t)(0xF1U))))
  542. #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_FIRST_FRAME) || \
  543. ((REQUEST) == I2C_NEXT_FRAME) || \
  544. ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \
  545. ((REQUEST) == I2C_LAST_FRAME))
  546. /**
  547. * @}
  548. */
  549. /* Private Functions ---------------------------------------------------------*/
  550. /** @defgroup I2C_Private_Functions I2C Private Functions
  551. * @{
  552. */
  553. /* Private functions are defined in stm32f0xx_hal_i2c.c file */
  554. /**
  555. * @}
  556. */
  557. /**
  558. * @}
  559. */
  560. /**
  561. * @}
  562. */
  563. #ifdef __cplusplus
  564. }
  565. #endif
  566. #endif /* __STM32L1xx_HAL_I2C_H */
  567. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/