jmg
/
stm32lib
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
7 Commits
1 Branch
14 MiB
 
 
 
Tree: 1107e4bc5f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1107e4bc5f'
${ noResults }
stm32lib/STM32L4xx_HAL_Driver/Inc/stm32l4xx_hal_i2c.h

666 lines
29 KiB
Raw Blame History 

  1. /**

  2.   ******************************************************************************

  3.   * @file    stm32l4xx_hal_i2c.h

  4.   * @author  MCD Application Team

  5.   * @version V1.3.0

  6.   * @date    29-January-2016

  7.   * @brief   Header file of I2C HAL module.

  8.   ******************************************************************************

  9.   * @attention

  10.   *

  11.   * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>

  12.   *

  13.   * Redistribution and use in source and binary forms, with or without modification,

  14.   * are permitted provided that the following conditions are met:

  15.   *   1. Redistributions of source code must retain the above copyright notice,

  16.   *      this list of conditions and the following disclaimer.

  17.   *   2. Redistributions in binary form must reproduce the above copyright notice,

  18.   *      this list of conditions and the following disclaimer in the documentation

  19.   *      and/or other materials provided with the distribution.

  20.   *   3. Neither the name of STMicroelectronics nor the names of its contributors

  21.   *      may be used to endorse or promote products derived from this software

  22.   *      without specific prior written permission.

  23.   *

  24.   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

  25.   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

  26.   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

  27.   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

  28.   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

  29.   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

  30.   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

  31.   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

  32.   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

  33.   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  34.   *

  35.   ******************************************************************************

  36.   */

  37. 

  38. /* Define to prevent recursive inclusion -------------------------------------*/

  39. #ifndef __STM32L4xx_HAL_I2C_H

  40. #define __STM32L4xx_HAL_I2C_H

  41. 

  42. #ifdef __cplusplus

  43.  extern "C" {

  44. #endif

  45. 

  46. /* Includes ------------------------------------------------------------------*/

  47. #include "stm32l4xx_hal_def.h"  

  48. 

  49. /** @addtogroup STM32L4xx_HAL_Driver

  50.   * @{

  51.   */

  52. 

  53. /** @addtogroup I2C

  54.   * @{

  55.   */ 

  56. 

  57. /* Exported types ------------------------------------------------------------*/

  58. /** @defgroup I2C_Exported_Types I2C Exported Types

  59.   * @{

  60.   */

  61. 

  62. /** @defgroup I2C_Configuration_Structure_definition I2C Configuration Structure definition

  63.   * @brief  I2C Configuration Structure definition  

  64.   * @{

  65.   */

  66. typedef struct

  67. {

  68.   uint32_t Timing;              /*!< Specifies the I2C_TIMINGR_register value.

  69.                                   This parameter calculated by referring to I2C initialization 

  70.                                          section in Reference manual */

  71. 

  72.   uint32_t OwnAddress1;         /*!< Specifies the first device own address.

  73.                                   This parameter can be a 7-bit or 10-bit address. */

  74. 

  75.   uint32_t AddressingMode;      /*!< Specifies if 7-bit or 10-bit addressing mode is selected.

  76.                                   This parameter can be a value of @ref I2C_addressing_mode */

  77. 

  78.   uint32_t DualAddressMode;     /*!< Specifies if dual addressing mode is selected.

  79.                                   This parameter can be a value of @ref I2C_dual_addressing_mode */

  80. 

  81.   uint32_t OwnAddress2;         /*!< Specifies the second device own address if dual addressing mode is selected

  82.                                   This parameter can be a 7-bit address. */

  83. 

  84.   uint32_t OwnAddress2Masks;    /*!< Specifies the acknowledge mask address second device own address if dual addressing mode is selected

  85.                                   This parameter can be a value of @ref I2C_own_address2_masks */

  86. 

  87.   uint32_t GeneralCallMode;     /*!< Specifies if general call mode is selected.

  88.                                   This parameter can be a value of @ref I2C_general_call_addressing_mode */

  89. 

  90.   uint32_t NoStretchMode;       /*!< Specifies if nostretch mode is selected.

  91.                                   This parameter can be a value of @ref I2C_nostretch_mode */

  92. 

  93. }I2C_InitTypeDef;

  94. 

  95. /** 

  96.   * @}

  97.   */

  98. 

  99. /** @defgroup HAL_state_structure_definition HAL state structure definition

  100.   * @brief  HAL State structure definition

  101.   * @{

  102.   */ 

  103. 

  104. typedef enum

  105. {

  106.   HAL_I2C_STATE_RESET             = 0x00,   /*!< Peripheral is not yet Initialized         */

  107.   HAL_I2C_STATE_READY             = 0x20,   /*!< Peripheral Initialized and ready for use  */

  108.   HAL_I2C_STATE_BUSY              = 0x24,   /*!< An internal process is ongoing            */

  109.   HAL_I2C_STATE_BUSY_TX           = 0x21,   /*!< Data Transmission process is ongoing      */ 

  110.   HAL_I2C_STATE_BUSY_RX           = 0x22,   /*!< Data Reception process is ongoing         */

  111.   HAL_I2C_STATE_LISTEN            = 0x28,   /*!< Address Listen Mode is ongoing            */

  112.   HAL_I2C_STATE_BUSY_TX_LISTEN    = 0x29,   /*!< Address Listen Mode and Data Transmission

  113.                                                  process is ongoing                        */

  114.   HAL_I2C_STATE_BUSY_RX_LISTEN    = 0x2A,   /*!< Address Listen Mode and Data Reception

  115.                                                  process is ongoing                        */

  116.   HAL_I2C_STATE_TIMEOUT           = 0xA0,   /*!< Timeout state                             */

  117.   HAL_I2C_STATE_ERROR             = 0xE0    /*!< Error                                     */ 

  118. 

  119. }HAL_I2C_StateTypeDef;

  120. 

  121. /**

  122.   * @}

  123.   */

  124. 

  125. /** @defgroup HAL_mode_structure_definition HAL mode structure definition

  126.   * @brief  HAL Mode structure definition

  127.   * @{

  128.   */

  129. typedef enum

  130. {

  131.   HAL_I2C_MODE_NONE               = 0x00,   /*!< No I2C communication on going             */

  132.   HAL_I2C_MODE_MASTER             = 0x10,   /*!< I2C communication is in Master Mode       */

  133.   HAL_I2C_MODE_SLAVE              = 0x20,   /*!< I2C communication is in Slave Mode        */

  134.   HAL_I2C_MODE_MEM                = 0x40    /*!< I2C communication is in Memory Mode       */

  135. 

  136. }HAL_I2C_ModeTypeDef;

  137. 

  138. /** 

  139.   * @}

  140.   */

  141. 

  142. /** @defgroup I2C_Error_Code_definition I2C Error Code definition

  143.   * @brief  I2C Error Code definition  

  144.   * @{

  145.   */

  146. #define HAL_I2C_ERROR_NONE      ((uint32_t)0x00000000)    /*!< No error              */

  147. #define HAL_I2C_ERROR_BERR      ((uint32_t)0x00000001)    /*!< BERR error            */

  148. #define HAL_I2C_ERROR_ARLO      ((uint32_t)0x00000002)    /*!< ARLO error            */

  149. #define HAL_I2C_ERROR_AF        ((uint32_t)0x00000004)    /*!< ACKF error            */

  150. #define HAL_I2C_ERROR_OVR       ((uint32_t)0x00000008)    /*!< OVR error             */

  151. #define HAL_I2C_ERROR_DMA       ((uint32_t)0x00000010)    /*!< DMA transfer error    */

  152. #define HAL_I2C_ERROR_TIMEOUT   ((uint32_t)0x00000020)    /*!< Timeout error         */

  153. #define HAL_I2C_ERROR_SIZE      ((uint32_t)0x00000040)    /*!< Size Management error */

  154. /** 

  155.   * @}

  156.   */

  157. 

  158. /** @defgroup I2C_XferOptions_definition  I2C XferOptions definition

  159.   * @{

  160.   */

  161. #define I2C_NO_OPTION_FRAME             ((uint32_t)0xFFFF0000)

  162. #define I2C_FIRST_FRAME                 ((uint32_t)I2C_SOFTEND_MODE)

  163. #define I2C_NEXT_FRAME                  ((uint32_t)(I2C_RELOAD_MODE | I2C_SOFTEND_MODE))

  164. #define I2C_FIRST_AND_LAST_FRAME        ((uint32_t)I2C_AUTOEND_MODE)

  165. #define I2C_LAST_FRAME                  ((uint32_t)I2C_AUTOEND_MODE)

  166. /**

  167.   * @}

  168.   */

  169. 

  170. /** @defgroup I2C_handle_Structure_definition I2C handle Structure definition

  171.   * @brief  I2C handle Structure definition  

  172.   * @{

  173.   */

  174. typedef struct

  175. {

  176.   I2C_TypeDef                *Instance;        /*!< I2C registers base address       */

  177. 

  178.   I2C_InitTypeDef            Init;             /*!< I2C communication parameters     */

  179. 

  180.   uint8_t                    *pBuffPtr;        /*!< Pointer to I2C transfer buffer   */

  181. 

  182.   uint16_t                   XferSize;         /*!< I2C transfer size                */

  183. 

  184.   __IO uint16_t              XferCount;        /*!< I2C transfer counter             */

  185. 

  186.   __IO uint32_t              XferOptions;      /*!< I2C transfer options             */

  187. 

  188.   __IO uint32_t              PreviousState;    /*!< I2C communication Previous state */

  189. 

  190.   DMA_HandleTypeDef          *hdmatx;          /*!< I2C Tx DMA handle parameters     */

  191. 

  192.   DMA_HandleTypeDef          *hdmarx;          /*!< I2C Rx DMA handle parameters     */

  193. 

  194.   HAL_LockTypeDef            Lock;             /*!< I2C locking object               */

  195. 

  196.   __IO HAL_I2C_StateTypeDef  State;            /*!< I2C communication state          */

  197. 

  198.   __IO HAL_I2C_ModeTypeDef   Mode;             /*!< I2C communication mode           */

  199. 

  200.   __IO uint32_t              ErrorCode;        /*!< I2C Error code                   */

  201. 

  202.   __IO uint32_t              AddrEventCount;   /*!< I2C Address Event counter        */

  203. }I2C_HandleTypeDef;

  204. /**

  205.   * @}

  206.   */

  207. 

  208. /**

  209.   * @}

  210.   */  

  211. /* Exported constants --------------------------------------------------------*/

  212. 

  213. /** @defgroup I2C_Exported_Constants I2C Exported Constants

  214.   * @{

  215.   */

  216. 

  217. /** @defgroup I2C_addressing_mode I2C addressing mode

  218.   * @{

  219.   */

  220. #define I2C_ADDRESSINGMODE_7BIT         ((uint32_t)0x00000001)

  221. #define I2C_ADDRESSINGMODE_10BIT        ((uint32_t)0x00000002)

  222. /**

  223.   * @}

  224.   */

  225. 

  226. /** @defgroup I2C_dual_addressing_mode I2C dual addressing mode

  227.   * @{

  228.   */

  229. #define I2C_DUALADDRESS_DISABLE         ((uint32_t)0x00000000)

  230. #define I2C_DUALADDRESS_ENABLE          I2C_OAR2_OA2EN

  231. /**

  232.   * @}

  233.   */

  234. 

  235. /** @defgroup I2C_own_address2_masks I2C own address2 masks

  236.   * @{

  237.   */

  238. #define I2C_OA2_NOMASK                  ((uint8_t)0x00)

  239. #define I2C_OA2_MASK01                  ((uint8_t)0x01)

  240. #define I2C_OA2_MASK02                  ((uint8_t)0x02)

  241. #define I2C_OA2_MASK03                  ((uint8_t)0x03)

  242. #define I2C_OA2_MASK04                  ((uint8_t)0x04)

  243. #define I2C_OA2_MASK05                  ((uint8_t)0x05)

  244. #define I2C_OA2_MASK06                  ((uint8_t)0x06)

  245. #define I2C_OA2_MASK07                  ((uint8_t)0x07)

  246. /**

  247.   * @}

  248.   */

  249. 

  250. /** @defgroup I2C_general_call_addressing_mode I2C general call addressing mode

  251.   * @{

  252.   */

  253. #define I2C_GENERALCALL_DISABLE         ((uint32_t)0x00000000)

  254. #define I2C_GENERALCALL_ENABLE          I2C_CR1_GCEN

  255. /**

  256.   * @}

  257.   */

  258. 

  259. /** @defgroup I2C_nostretch_mode I2C nostretch mode

  260.   * @{

  261.   */

  262. #define I2C_NOSTRETCH_DISABLE           ((uint32_t)0x00000000)

  263. #define I2C_NOSTRETCH_ENABLE            I2C_CR1_NOSTRETCH

  264. /**

  265.   * @}

  266.   */

  267. 

  268. /** @defgroup I2C_Memory_Address_Size I2C Memory Address Size

  269.   * @{

  270.   */

  271. #define I2C_MEMADD_SIZE_8BIT            ((uint32_t)0x00000001)

  272. #define I2C_MEMADD_SIZE_16BIT           ((uint32_t)0x00000002)

  273. /**

  274.   * @}

  275.   */

  276.   

  277. /** @defgroup I2C_XferDirection_definition I2C XferDirection definition

  278.   * @{

  279.   */

  280. #define I2C_DIRECTION_TRANSMIT          ((uint32_t)0x00000000)

  281. #define I2C_DIRECTION_RECEIVE           ((uint32_t)0x00000001)

  282. /**

  283.   * @}

  284.   */

  285. 

  286. /** @defgroup I2C_ReloadEndMode_definition I2C ReloadEndMode definition

  287.   * @{

  288.   */

  289. #define  I2C_RELOAD_MODE                I2C_CR2_RELOAD

  290. #define  I2C_AUTOEND_MODE               I2C_CR2_AUTOEND

  291. #define  I2C_SOFTEND_MODE               ((uint32_t)0x00000000)

  292. /**

  293.   * @}

  294.   */

  295. 

  296. /** @defgroup I2C_StartStopMode_definition I2C StartStopMode definition

  297.   * @{

  298.   */

  299. #define  I2C_NO_STARTSTOP               ((uint32_t)0x00000000)

  300. #define  I2C_GENERATE_STOP              I2C_CR2_STOP

  301. #define  I2C_GENERATE_START_READ        (uint32_t)(I2C_CR2_START | I2C_CR2_RD_WRN)

  302. #define  I2C_GENERATE_START_WRITE       I2C_CR2_START

  303. /**

  304.   * @}

  305.   */

  306. 

  307. /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition

  308.   * @brief I2C Interrupt definition

  309.   *        Elements values convention: 0xXXXXXXXX

  310.   *           - XXXXXXXX  : Interrupt control mask

  311.   * @{

  312.   */

  313. #define I2C_IT_ERRI                     I2C_CR1_ERRIE

  314. #define I2C_IT_TCI                      I2C_CR1_TCIE

  315. #define I2C_IT_STOPI                    I2C_CR1_STOPIE

  316. #define I2C_IT_NACKI                    I2C_CR1_NACKIE

  317. #define I2C_IT_ADDRI                    I2C_CR1_ADDRIE

  318. #define I2C_IT_RXI                      I2C_CR1_RXIE

  319. #define I2C_IT_TXI                      I2C_CR1_TXIE

  320. /**

  321.   * @}

  322.   */

  323. 

  324. /** @defgroup I2C_Flag_definition I2C Flag definition

  325.   * @{

  326.   */ 

  327. #define I2C_FLAG_TXE                    I2C_ISR_TXE

  328. #define I2C_FLAG_TXIS                   I2C_ISR_TXIS

  329. #define I2C_FLAG_RXNE                   I2C_ISR_RXNE

  330. #define I2C_FLAG_ADDR                   I2C_ISR_ADDR

  331. #define I2C_FLAG_AF                     I2C_ISR_NACKF

  332. #define I2C_FLAG_STOPF                  I2C_ISR_STOPF

  333. #define I2C_FLAG_TC                     I2C_ISR_TC

  334. #define I2C_FLAG_TCR                    I2C_ISR_TCR

  335. #define I2C_FLAG_BERR                   I2C_ISR_BERR

  336. #define I2C_FLAG_ARLO                   I2C_ISR_ARLO

  337. #define I2C_FLAG_OVR                    I2C_ISR_OVR

  338. #define I2C_FLAG_PECERR                 I2C_ISR_PECERR

  339. #define I2C_FLAG_TIMEOUT                I2C_ISR_TIMEOUT

  340. #define I2C_FLAG_ALERT                  I2C_ISR_ALERT

  341. #define I2C_FLAG_BUSY                   I2C_ISR_BUSY

  342. #define I2C_FLAG_DIR                    I2C_ISR_DIR

  343. /**

  344.   * @}

  345.   */

  346. 

  347. /**

  348.   * @}

  349.   */

  350. 

  351. /* Exported macros -----------------------------------------------------------*/

  352.   

  353. /** @defgroup I2C_Exported_Macros I2C Exported Macros

  354.   * @{

  355.   */

  356. 

  357. /** @brief Reset I2C handle state.

  358.   * @param  __HANDLE__ specifies the I2C Handle.

  359.   * @retval None

  360.   */

  361. #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__)                ((__HANDLE__)->State = HAL_I2C_STATE_RESET)

  362. 

  363. /** @brief  Enable the specified I2C interrupt.

  364.   * @param  __HANDLE__ specifies the I2C Handle.

  365.   * @param  __INTERRUPT__ specifies the interrupt source to enable.

  366.   *        This parameter can be one of the following values:

  367.   *            @arg @ref I2C_IT_ERRI  Errors interrupt enable

  368.   *            @arg @ref I2C_IT_TCI   Transfer complete interrupt enable

  369.   *            @arg @ref I2C_IT_STOPI STOP detection interrupt enable

  370.   *            @arg @ref I2C_IT_NACKI NACK received interrupt enable

  371.   *            @arg @ref I2C_IT_ADDRI Address match interrupt enable

  372.   *            @arg @ref I2C_IT_RXI   RX interrupt enable

  373.   *            @arg @ref I2C_IT_TXI   TX interrupt enable

  374.   *

  375.   * @retval None

  376.   */

  377. #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__)          ((__HANDLE__)->Instance->CR1 |= (__INTERRUPT__))

  378. 

  379. /** @brief  Disable the specified I2C interrupt.

  380.   * @param  __HANDLE__ specifies the I2C Handle.

  381.   * @param  __INTERRUPT__ specifies the interrupt source to disable.

  382.   *        This parameter can be one of the following values:

  383.   *            @arg @ref I2C_IT_ERRI  Errors interrupt enable

  384.   *            @arg @ref I2C_IT_TCI   Transfer complete interrupt enable

  385.   *            @arg @ref I2C_IT_STOPI STOP detection interrupt enable

  386.   *            @arg @ref I2C_IT_NACKI NACK received interrupt enable

  387.   *            @arg @ref I2C_IT_ADDRI Address match interrupt enable

  388.   *            @arg @ref I2C_IT_RXI   RX interrupt enable

  389.   *            @arg @ref I2C_IT_TXI   TX interrupt enable

  390.   *   

  391.   * @retval None

  392.   */

  393. #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__)         ((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__)))

  394.  

  395. /** @brief  Check whether the specified I2C interrupt source is enabled or not.

  396.   * @param  __HANDLE__ specifies the I2C Handle.

  397.   * @param  __INTERRUPT__ specifies the I2C interrupt source to check.

  398.   *          This parameter can be one of the following values:

  399.   *            @arg @ref I2C_IT_ERRI  Errors interrupt enable

  400.   *            @arg @ref I2C_IT_TCI   Transfer complete interrupt enable

  401.   *            @arg @ref I2C_IT_STOPI STOP detection interrupt enable

  402.   *            @arg @ref I2C_IT_NACKI NACK received interrupt enable

  403.   *            @arg @ref I2C_IT_ADDRI Address match interrupt enable

  404.   *            @arg @ref I2C_IT_RXI   RX interrupt enable

  405.   *            @arg @ref I2C_IT_TXI   TX interrupt enable

  406.   *

  407.   * @retval The new state of __INTERRUPT__ (TRUE or FALSE).

  408.   */

  409. #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)      ((((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

  410. 

  411. /** @brief  Check whether the specified I2C flag is set or not.

  412.   * @param  __HANDLE__ specifies the I2C Handle.

  413.   * @param  __FLAG__ specifies the flag to check.

  414.   *        This parameter can be one of the following values:

  415.   *            @arg @ref I2C_FLAG_TXE     Transmit data register empty

  416.   *            @arg @ref I2C_FLAG_TXIS    Transmit interrupt status

  417.   *            @arg @ref I2C_FLAG_RXNE    Receive data register not empty

  418.   *            @arg @ref I2C_FLAG_ADDR    Address matched (slave mode)

  419.   *            @arg @ref I2C_FLAG_AF      Acknowledge failure received flag

  420.   *            @arg @ref I2C_FLAG_STOPF   STOP detection flag

  421.   *            @arg @ref I2C_FLAG_TC      Transfer complete (master mode)

  422.   *            @arg @ref I2C_FLAG_TCR     Transfer complete reload

  423.   *            @arg @ref I2C_FLAG_BERR    Bus error

  424.   *            @arg @ref I2C_FLAG_ARLO    Arbitration lost

  425.   *            @arg @ref I2C_FLAG_OVR     Overrun/Underrun

  426.   *            @arg @ref I2C_FLAG_PECERR  PEC error in reception

  427.   *            @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag

  428.   *            @arg @ref I2C_FLAG_ALERT   SMBus alert

  429.   *            @arg @ref I2C_FLAG_BUSY    Bus busy

  430.   *            @arg @ref I2C_FLAG_DIR     Transfer direction (slave mode)

  431.   *

  432.   * @retval The new state of __FLAG__ (TRUE or FALSE).

  433.   */

  434. #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__))

  435. 

  436. /** @brief  Clear the I2C pending flags which are cleared by writing 1 in a specific bit.

  437.   * @param  __HANDLE__ specifies the I2C Handle.

  438.   * @param  __FLAG__ specifies the flag to clear.

  439.   *          This parameter can be any combination of the following values:

  440.   *            @arg @ref I2C_FLAG_TXE     Transmit data register empty

  441.   *            @arg @ref I2C_FLAG_ADDR    Address matched (slave mode)

  442.   *            @arg @ref I2C_FLAG_AF      Acknowledge failure received flag

  443.   *            @arg @ref I2C_FLAG_STOPF   STOP detection flag

  444.   *            @arg @ref I2C_FLAG_BERR    Bus error

  445.   *            @arg @ref I2C_FLAG_ARLO    Arbitration lost

  446.   *            @arg @ref I2C_FLAG_OVR     Overrun/Underrun            

  447.   *            @arg @ref I2C_FLAG_PECERR  PEC error in reception

  448.   *            @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag 

  449.   *            @arg @ref I2C_FLAG_ALERT   SMBus alert

  450.   *

  451.   * @retval None

  452.   */

  453. #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__FLAG__) == I2C_FLAG_TXE) ? ((__HANDLE__)->Instance->ISR |= (__FLAG__)) \

  454.                                                                                  : ((__HANDLE__)->Instance->ICR = (__FLAG__)))

  455.  

  456. /** @brief  Enable the specified I2C peripheral.

  457.   * @param  __HANDLE__ specifies the I2C Handle.

  458.   * @retval None

  459.   */

  460. #define __HAL_I2C_ENABLE(__HANDLE__)                            (SET_BIT((__HANDLE__)->Instance->CR1,  I2C_CR1_PE))

  461. 

  462. /** @brief  Disable the specified I2C peripheral.

  463.   * @param  __HANDLE__ specifies the I2C Handle.

  464.   * @retval None

  465.   */

  466. #define __HAL_I2C_DISABLE(__HANDLE__)                           (CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE))

  467. 

  468. /**

  469.   * @}

  470.   */

  471. 

  472. /* Include I2C HAL Extended module */

  473. #include "stm32l4xx_hal_i2c_ex.h"

  474. 

  475. /* Exported functions --------------------------------------------------------*/

  476. /** @addtogroup I2C_Exported_Functions

  477.   * @{

  478.   */

  479. 

  480. /** @addtogroup I2C_Exported_Functions_Group1 Initialization and de-initialization functions

  481.   * @{

  482.   */

  483. /* Initialization and de-initialization functions******************************/

  484. HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);

  485. HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c);

  486. void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);

  487. void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);

  488. /**

  489.   * @}

  490.   */

  491. 

  492. /** @addtogroup I2C_Exported_Functions_Group2 Input and Output operation functions

  493.   * @{

  494.   */

  495. /* IO operation functions  ****************************************************/

  496.  /******* Blocking mode: Polling */

  497. HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);

  498. HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);

  499. HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);

  500. HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);

  501. 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);

  502. 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);

  503. HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);

  504. 

  505.  /******* Non-Blocking mode: Interrupt */

  506. HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);

  507. HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);

  508. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);

  509. HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);

  510. 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);

  511. 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);

  512. 

  513. HAL_StatusTypeDef HAL_I2C_Master_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);

  514. HAL_StatusTypeDef HAL_I2C_Master_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);

  515. HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);

  516. HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);

  517. HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);

  518. HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c);

  519. HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress);

  520. 

  521.  /******* Non-Blocking mode: DMA */

  522. HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);

  523. HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);

  524. HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);

  525. HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);

  526. 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);

  527. 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);

  528. /**

  529.   * @}

  530.   */

  531. 

  532. /** @addtogroup I2C_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks

  533.  * @{

  534.  */

  535. /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */

  536. void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);

  537. void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);

  538. void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);

  539. void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);

  540. void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);

  541. void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);

  542. void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);

  543. void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c);

  544. void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);

  545. void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);

  546. void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);

  547. /**

  548.   * @}

  549.   */ 

  550. 

  551. /** @addtogroup I2C_Exported_Functions_Group3 Peripheral State, Mode and Error functions

  552.   * @{

  553.   */

  554. /* Peripheral State, Mode and Error functions  *********************************/

  555. HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);

  556. HAL_I2C_ModeTypeDef  HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c);

  557. uint32_t             HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);

  558. 

  559. /**

  560.   * @}

  561.   */ 

  562. 

  563. /**

  564.   * @}

  565.   */ 

  566. 

  567. /* Private constants ---------------------------------------------------------*/

  568. /** @defgroup I2C_Private_Constants I2C Private Constants

  569.   * @{

  570.   */

  571. 

  572. /**

  573.   * @}

  574.   */ 

  575. 

  576. /* Private macros ------------------------------------------------------------*/

  577. /** @defgroup I2C_Private_Macro I2C Private Macros

  578.   * @{

  579.   */

  580. 

  581. #define IS_I2C_ADDRESSING_MODE(MODE)    (((MODE) == I2C_ADDRESSINGMODE_7BIT) || \

  582.                                          ((MODE) == I2C_ADDRESSINGMODE_10BIT))

  583. 

  584. #define IS_I2C_DUAL_ADDRESS(ADDRESS)    (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \

  585.                                          ((ADDRESS) == I2C_DUALADDRESS_ENABLE))

  586. 

  587. #define IS_I2C_OWN_ADDRESS2_MASK(MASK)  (((MASK) == I2C_OA2_NOMASK)  || \

  588.                                          ((MASK) == I2C_OA2_MASK01) || \

  589.                                          ((MASK) == I2C_OA2_MASK02) || \

  590.                                          ((MASK) == I2C_OA2_MASK03) || \

  591.                                          ((MASK) == I2C_OA2_MASK04) || \

  592.                                          ((MASK) == I2C_OA2_MASK05) || \

  593.                                          ((MASK) == I2C_OA2_MASK06) || \

  594.                                          ((MASK) == I2C_OA2_MASK07))

  595. 

  596. #define IS_I2C_GENERAL_CALL(CALL)       (((CALL) == I2C_GENERALCALL_DISABLE) || \

  597.                                          ((CALL) == I2C_GENERALCALL_ENABLE))

  598. 

  599. #define IS_I2C_NO_STRETCH(STRETCH)      (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \

  600.                                          ((STRETCH) == I2C_NOSTRETCH_ENABLE))

  601. 

  602. #define IS_I2C_MEMADD_SIZE(SIZE)        (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \

  603.                                          ((SIZE) == I2C_MEMADD_SIZE_16BIT))

  604. 

  605. #define IS_TRANSFER_MODE(MODE)          (((MODE) == I2C_RELOAD_MODE)   || \

  606.                                          ((MODE) == I2C_AUTOEND_MODE) || \

  607.                                          ((MODE) == I2C_SOFTEND_MODE))

  608. 

  609. #define IS_TRANSFER_REQUEST(REQUEST)    (((REQUEST) == I2C_GENERATE_STOP)        || \

  610.                                          ((REQUEST) == I2C_GENERATE_START_READ)  || \

  611.                                          ((REQUEST) == I2C_GENERATE_START_WRITE) || \

  612.                                          ((REQUEST) == I2C_NO_STARTSTOP))

  613. 

  614. #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST)  (((REQUEST) == I2C_FIRST_FRAME)          || \

  615.                                                    ((REQUEST) == I2C_NEXT_FRAME)           || \

  616.                                                    ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \

  617.                                                    ((REQUEST) == I2C_LAST_FRAME))

  618. 

  619. #define I2C_RESET_CR2(__HANDLE__)                 ((__HANDLE__)->Instance->CR2 &= (uint32_t)~((uint32_t)(I2C_CR2_SADD | I2C_CR2_HEAD10R | I2C_CR2_NBYTES | I2C_CR2_RELOAD | I2C_CR2_RD_WRN)))

  620. 

  621. #define I2C_GET_ADDR_MATCH(__HANDLE__)            (((__HANDLE__)->Instance->ISR & I2C_ISR_ADDCODE) >> 16)

  622. #define I2C_GET_DIR(__HANDLE__)                   (((__HANDLE__)->Instance->ISR & I2C_ISR_DIR) >> 16)

  623. #define I2C_GET_STOP_MODE(__HANDLE__)             ((__HANDLE__)->Instance->CR2 & I2C_CR2_AUTOEND)

  624. #define I2C_GET_ISR_REG(__HANDLE__)               ((__HANDLE__)->Instance->ISR)

  625. #define I2C_CHECK_FLAG(__ISR__, __FLAG__)         (((__ISR__) & (__FLAG__)) == (__FLAG__))

  626. #define I2C_GET_OWN_ADDRESS1(__HANDLE__)          ((__HANDLE__)->Instance->OAR1 & I2C_OAR1_OA1)

  627. #define I2C_GET_OWN_ADDRESS2(__HANDLE__)          ((__HANDLE__)->Instance->OAR2 & I2C_OAR2_OA2)

  628. 

  629. #define IS_I2C_OWN_ADDRESS1(ADDRESS1)             ((ADDRESS1) <= (uint32_t)0x000003FF)

  630. #define IS_I2C_OWN_ADDRESS2(ADDRESS2)             ((ADDRESS2) <= (uint16_t)0x00FF)

  631. 

  632. #define I2C_MEM_ADD_MSB(__ADDRESS__)              ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0xFF00))) >> 8)))

  633. #define I2C_MEM_ADD_LSB(__ADDRESS__)              ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FF))))

  634. 

  635. #define I2C_GENERATE_START(__ADDMODE__,__ADDRESS__) (((__ADDMODE__) == I2C_ADDRESSINGMODE_7BIT) ? (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | (I2C_CR2_START) | (I2C_CR2_AUTOEND)) & (~I2C_CR2_RD_WRN)) : \

  636.                                                           (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | (I2C_CR2_ADD10) | (I2C_CR2_START)) & (~I2C_CR2_RD_WRN)))

  637. /**

  638.   * @}

  639.   */ 

  640. 

  641. /* Private Functions ---------------------------------------------------------*/

  642. /** @defgroup I2C_Private_Functions I2C Private Functions

  643.   * @{

  644.   */

  645. /* Private functions are defined in stm32l4xx_hal_i2c.c file */

  646. /**

  647.   * @}

  648.   */ 

  649. 

  650. /**

  651.   * @}

  652.   */ 

  653. 

  654. /**

  655.   * @}

  656.   */ 

  657. 

  658. #ifdef __cplusplus

  659. }

  660. #endif

  661. 

  662. 

  663. #endif /* __STM32L4xx_HAL_I2C_H */

  664. 

  665. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/