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