1 /**
2   ******************************************************************************
3   * @file    stm32wb0x_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) 2024 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 STM32WB0x_HAL_I2C_EX_H
21 #define STM32WB0x_HAL_I2C_EX_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32wb0x_hal_def.h"
29 
30 /** @addtogroup STM32WB0x_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_PA0            SYSCFG_I2C_FMP_CTRL_I2C1_PA0_FMP                        /*!< Enable Fast Mode Plus on PA0       */
57 #define I2C_FASTMODEPLUS_PA1            SYSCFG_I2C_FMP_CTRL_I2C1_PA1_FMP                        /*!< Enable Fast Mode Plus on PA1       */
58 #if defined(SYSCFG_I2C_FMP_CTRL_I2C2_PB6_FMP)
59 #define I2C_FASTMODEPLUS_PB6            SYSCFG_I2C_FMP_CTRL_I2C2_PB6_FMP                        /*!< Enable Fast Mode Plus on PB6       */
60 #define I2C_FASTMODEPLUS_PB7            SYSCFG_I2C_FMP_CTRL_I2C2_PB7_FMP
61 #else
62 #define I2C_FASTMODEPLUS_PB6            SYSCFG_I2C_FMP_CTRL_I2C1_PB6_FMP                        /*!< Enable Fast Mode Plus on PB6       */
63 #define I2C_FASTMODEPLUS_PB7            SYSCFG_I2C_FMP_CTRL_I2C1_PB7_FMP                        /*!< Enable Fast Mode Plus on PB7       */
64 #endif /* SYSCFG_I2C_FMP_CTRL_I2C2_PB6_FMP */
65 /**
66   * @}
67   */
68 
69 /**
70   * @}
71   */
72 
73 /* Exported macro ------------------------------------------------------------*/
74 /** @defgroup I2CEx_Exported_Macros I2C Extended Exported Macros
75   * @{
76   */
77 
78 /**
79   * @}
80   */
81 
82 /* Exported functions --------------------------------------------------------*/
83 /** @addtogroup I2CEx_Exported_Functions I2C Extended Exported Functions
84   * @{
85   */
86 
87 /** @addtogroup I2CEx_Exported_Functions_Group1 Filter Mode Functions
88   * @{
89   */
90 /* Peripheral Control functions  ************************************************/
91 HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter);
92 HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter);
93 /**
94   * @}
95   */
96 
97 /** @addtogroup I2CEx_Exported_Functions_Group3 Fast Mode Plus Functions
98   * @{
99   */
100 void HAL_I2CEx_EnableFastModePlus(uint32_t ConfigFastModePlus);
101 void HAL_I2CEx_DisableFastModePlus(uint32_t ConfigFastModePlus);
102 /**
103   * @}
104   */
105 
106 /**
107   * @}
108   */
109 
110 /* Private constants ---------------------------------------------------------*/
111 /** @defgroup I2CEx_Private_Constants I2C Extended Private Constants
112   * @{
113   */
114 
115 /**
116   * @}
117   */
118 
119 /* Private macros ------------------------------------------------------------*/
120 /** @defgroup I2CEx_Private_Macro I2C Extended Private Macros
121   * @{
122   */
123 #define IS_I2C_ANALOG_FILTER(FILTER)    (((FILTER) == I2C_ANALOGFILTER_ENABLE) || \
124                                          ((FILTER) == I2C_ANALOGFILTER_DISABLE))
125 
126 #define IS_I2C_DIGITAL_FILTER(FILTER)   ((FILTER) <= 0x0000000FU)
127 
128 #define IS_I2C_FASTMODEPLUS(__CONFIG__) ((((__CONFIG__) & (I2C_FASTMODEPLUS_PB6))  == I2C_FASTMODEPLUS_PB6)     || \
129                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PB7))  == I2C_FASTMODEPLUS_PB7)     || \
130                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PA0))  == I2C_FASTMODEPLUS_PA0)     || \
131                                          (((__CONFIG__) & (I2C_FASTMODEPLUS_PA1))  == I2C_FASTMODEPLUS_PA1))
132 /**
133   * @}
134   */
135 
136 /* Private Functions ---------------------------------------------------------*/
137 /** @defgroup I2CEx_Private_Functions I2C Extended Private Functions
138   * @{
139   */
140 /* Private functions are defined in stm32wb0x_hal_i2c_ex.c file */
141 /**
142   * @}
143   */
144 
145 /**
146   * @}
147   */
148 
149 /**
150   * @}
151   */
152 
153 #ifdef __cplusplus
154 }
155 #endif
156 
157 #endif /* STM32WB0x_HAL_I2C_EX_H */
158