1 /**
2   ******************************************************************************
3   * @file    stm32l5xx_hal_i2c_ex.h
4   * @author  MCD Application Team
5   * @brief   Header file of I2C HAL Extended module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2019 STMicroelectronics.
10   * All rights reserved.
11   *
12   * This software is licensed under terms that can be found in the LICENSE file
13   * in the root directory of this software component.
14   * If no LICENSE file comes with this software, it is provided AS-IS.
15   *
16   ******************************************************************************
17   */
18 
19 /* Define to prevent recursive inclusion -------------------------------------*/
20 #ifndef STM32L5xx_HAL_I2C_EX_H
21 #define STM32L5xx_HAL_I2C_EX_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32l5xx_hal_def.h"
29 
30 /** @addtogroup STM32L5xx_HAL_Driver
31   * @{
32   */
33 
34 /** @addtogroup I2CEx
35   * @{
36   */
37 
38 /* Exported types ------------------------------------------------------------*/
39 /* Exported constants --------------------------------------------------------*/
40 /** @defgroup I2CEx_Exported_Constants I2C Extended Exported Constants
41   * @{
42   */
43 
44 /** @defgroup I2CEx_Analog_Filter I2C Extended Analog Filter
45   * @{
46   */
47 #define I2C_ANALOGFILTER_ENABLE         0x00000000U
48 #define I2C_ANALOGFILTER_DISABLE        I2C_CR1_ANFOFF
49 /**
50   * @}
51   */
52 
53 /** @defgroup I2CEx_FastModePlus I2C Extended Fast Mode Plus
54   * @{
55   */
56 #define I2C_FASTMODEPLUS_PB6            SYSCFG_CFGR1_I2C_PB6_FMP                        /*!< Enable Fast Mode Plus on PB6       */
57 #define I2C_FASTMODEPLUS_PB7            SYSCFG_CFGR1_I2C_PB7_FMP                        /*!< Enable Fast Mode Plus on PB7       */
58 #define I2C_FASTMODEPLUS_PB8            SYSCFG_CFGR1_I2C_PB8_FMP                        /*!< Enable Fast Mode Plus on PB8       */
59 #define I2C_FASTMODEPLUS_PB9            SYSCFG_CFGR1_I2C_PB9_FMP                        /*!< Enable Fast Mode Plus on PB9       */
60 #define I2C_FASTMODEPLUS_I2C1           SYSCFG_CFGR1_I2C1_FMP                           /*!< Enable Fast Mode Plus on I2C1 pins */
61 #define I2C_FASTMODEPLUS_I2C2           SYSCFG_CFGR1_I2C2_FMP                           /*!< Enable Fast Mode Plus on I2C2 pins */
62 #define I2C_FASTMODEPLUS_I2C3           SYSCFG_CFGR1_I2C3_FMP                           /*!< Enable Fast Mode Plus on I2C3 pins */
63 #define I2C_FASTMODEPLUS_I2C4           SYSCFG_CFGR1_I2C4_FMP                           /*!< Enable Fast Mode Plus on I2C4 pins */
64 /**
65   * @}
66   */
67 
68 /**
69   * @}
70   */
71 
72 /* Exported macro ------------------------------------------------------------*/
73 /** @defgroup I2CEx_Exported_Macros I2C Extended Exported Macros
74   * @{
75   */
76 
77 /**
78   * @}
79   */
80 
81 /* Exported functions --------------------------------------------------------*/
82 /** @addtogroup I2CEx_Exported_Functions I2C Extended Exported Functions
83   * @{
84   */
85 
86 /** @addtogroup I2CEx_Exported_Functions_Group1 Filter Mode Functions
87   * @{
88   */
89 /* Peripheral Control functions  ************************************************/
90 HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter);
91 HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter);
92 /**
93   * @}
94   */
95 
96 /** @addtogroup I2CEx_Exported_Functions_Group2 WakeUp Mode Functions
97   * @{
98   */
99 HAL_StatusTypeDef HAL_I2CEx_EnableWakeUp(I2C_HandleTypeDef *hi2c);
100 HAL_StatusTypeDef HAL_I2CEx_DisableWakeUp(I2C_HandleTypeDef *hi2c);
101 /**
102   * @}
103   */
104 
105 /** @addtogroup I2CEx_Exported_Functions_Group3 Fast Mode Plus Functions
106   * @{
107   */
108 void HAL_I2CEx_EnableFastModePlus(uint32_t ConfigFastModePlus);
109 void HAL_I2CEx_DisableFastModePlus(uint32_t ConfigFastModePlus);
110 /**
111   * @}
112   */
113 
114 /**
115   * @}
116   */
117 
118 /* Private constants ---------------------------------------------------------*/
119 /** @defgroup I2CEx_Private_Constants I2C Extended Private Constants
120   * @{
121   */
122 
123 /**
124   * @}
125   */
126 
127 /* Private macros ------------------------------------------------------------*/
128 /** @defgroup I2CEx_Private_Macro I2C Extended Private Macros
129   * @{
130   */
131 #define IS_I2C_ANALOG_FILTER(FILTER)    (((FILTER) == I2C_ANALOGFILTER_ENABLE) || \
132                                          ((FILTER) == I2C_ANALOGFILTER_DISABLE))
133 
134 #define IS_I2C_DIGITAL_FILTER(FILTER)   ((FILTER) <= 0x0000000FU)
135 
136 #define IS_I2C_FASTMODEPLUS(__CONFIG__) ((((__CONFIG__) & (I2C_FASTMODEPLUS_PB6))  == I2C_FASTMODEPLUS_PB6)     || \
137                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PB7))  == I2C_FASTMODEPLUS_PB7)     || \
138                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PB8))  == I2C_FASTMODEPLUS_PB8)     || \
139                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PB9))  == I2C_FASTMODEPLUS_PB9)     || \
140                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C1)) == I2C_FASTMODEPLUS_I2C1)    || \
141                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C2)) == I2C_FASTMODEPLUS_I2C2)    || \
142                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C3)) == I2C_FASTMODEPLUS_I2C3)    || \
143                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C4)) == I2C_FASTMODEPLUS_I2C4))
144 /**
145   * @}
146   */
147 
148 /* Private Functions ---------------------------------------------------------*/
149 /** @defgroup I2CEx_Private_Functions I2C Extended Private Functions
150   * @{
151   */
152 /* Private functions are defined in stm32l5xx_hal_i2c_ex.c file */
153 /**
154   * @}
155   */
156 
157 /**
158   * @}
159   */
160 
161 /**
162   * @}
163   */
164 
165 #ifdef __cplusplus
166 }
167 #endif
168 
169 #endif /* STM32L5xx_HAL_I2C_EX_H */
170