1 /**
2   ******************************************************************************
3   * @file    stm32wbxx_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 STM32WBxx_HAL_I2C_EX_H
21 #define STM32WBxx_HAL_I2C_EX_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32wbxx_hal_def.h"
29 
30 /** @addtogroup STM32WBxx_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_FMP_NOT_SUPPORTED           0xAAAA0000U                                     /*!< Fast Mode Plus not supported       */
57 #define I2C_FASTMODEPLUS_PB6            SYSCFG_CFGR1_I2C_PB6_FMP                        /*!< Enable Fast Mode Plus on PB6       */
58 #define I2C_FASTMODEPLUS_PB7            SYSCFG_CFGR1_I2C_PB7_FMP                        /*!< Enable Fast Mode Plus on PB7       */
59 #define I2C_FASTMODEPLUS_PB8            SYSCFG_CFGR1_I2C_PB8_FMP                        /*!< Enable Fast Mode Plus on PB8       */
60 #define I2C_FASTMODEPLUS_PB9            SYSCFG_CFGR1_I2C_PB9_FMP                        /*!< Enable Fast Mode Plus on PB9       */
61 #define I2C_FASTMODEPLUS_I2C1           SYSCFG_CFGR1_I2C1_FMP                           /*!< Enable Fast Mode Plus on I2C1 pins */
62 #if defined(SYSCFG_CFGR1_I2C3_FMP)
63 #define I2C_FASTMODEPLUS_I2C3           SYSCFG_CFGR1_I2C3_FMP                           /*!< Enable Fast Mode Plus on I2C3 pins */
64 #else
65 #define I2C_FASTMODEPLUS_I2C3           (uint32_t)(0x00000400U | I2C_FMP_NOT_SUPPORTED) /*!< Fast Mode Plus I2C3 not supported  */
66 #endif /* SYSCFG_CFGR1_I2C3_FMP */
67 /**
68   * @}
69   */
70 
71 /**
72   * @}
73   */
74 
75 /* Exported macro ------------------------------------------------------------*/
76 /** @defgroup I2CEx_Exported_Macros I2C Extended Exported Macros
77   * @{
78   */
79 
80 /**
81   * @}
82   */
83 
84 /* Exported functions --------------------------------------------------------*/
85 /** @addtogroup I2CEx_Exported_Functions I2C Extended Exported Functions
86   * @{
87   */
88 
89 /** @addtogroup I2CEx_Exported_Functions_Group1 Filter Mode Functions
90   * @{
91   */
92 /* Peripheral Control functions  ************************************************/
93 HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter);
94 HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter);
95 /**
96   * @}
97   */
98 
99 /** @addtogroup I2CEx_Exported_Functions_Group2 WakeUp Mode Functions
100   * @{
101   */
102 HAL_StatusTypeDef HAL_I2CEx_EnableWakeUp(I2C_HandleTypeDef *hi2c);
103 HAL_StatusTypeDef HAL_I2CEx_DisableWakeUp(I2C_HandleTypeDef *hi2c);
104 /**
105   * @}
106   */
107 
108 /** @addtogroup I2CEx_Exported_Functions_Group3 Fast Mode Plus Functions
109   * @{
110   */
111 void HAL_I2CEx_EnableFastModePlus(uint32_t ConfigFastModePlus);
112 void HAL_I2CEx_DisableFastModePlus(uint32_t ConfigFastModePlus);
113 /**
114   * @}
115   */
116 
117 /**
118   * @}
119   */
120 
121 /* Private constants ---------------------------------------------------------*/
122 /** @defgroup I2CEx_Private_Constants I2C Extended Private Constants
123   * @{
124   */
125 
126 /**
127   * @}
128   */
129 
130 /* Private macros ------------------------------------------------------------*/
131 /** @defgroup I2CEx_Private_Macro I2C Extended Private Macros
132   * @{
133   */
134 #define IS_I2C_ANALOG_FILTER(FILTER)    (((FILTER) == I2C_ANALOGFILTER_ENABLE) || \
135                                          ((FILTER) == I2C_ANALOGFILTER_DISABLE))
136 
137 #define IS_I2C_DIGITAL_FILTER(FILTER)   ((FILTER) <= 0x0000000FU)
138 
139 #define IS_I2C_FASTMODEPLUS(__CONFIG__) ((((__CONFIG__) & (I2C_FASTMODEPLUS_PB6))  == I2C_FASTMODEPLUS_PB6)     || \
140                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PB7))  == I2C_FASTMODEPLUS_PB7)     || \
141                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PB8))  == I2C_FASTMODEPLUS_PB8)     || \
142                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PB9))  == I2C_FASTMODEPLUS_PB9)     || \
143                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C1)) == I2C_FASTMODEPLUS_I2C1)    || \
144                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C3)) == I2C_FASTMODEPLUS_I2C3))
145 /**
146   * @}
147   */
148 
149 /* Private Functions ---------------------------------------------------------*/
150 /** @defgroup I2CEx_Private_Functions I2C Extended Private Functions
151   * @{
152   */
153 /* Private functions are defined in stm32wbxx_hal_i2c_ex.c file */
154 /**
155   * @}
156   */
157 
158 /**
159   * @}
160   */
161 
162 /**
163   * @}
164   */
165 
166 #ifdef __cplusplus
167 }
168 #endif
169 
170 #endif /* STM32WBxx_HAL_I2C_EX_H */
171