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