1 /**
2   ******************************************************************************
3   * @file    stm32mp1xx_hal_smbus_ex.h
4   * @author  MCD Application Team
5   * @brief   Header file of SMBUS 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_SMBUS_EX_H
21 #define STM32MP1xx_HAL_SMBUS_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 SMBUSEx
35   * @{
36   */
37 
38 /* Exported types ------------------------------------------------------------*/
39 /* Exported constants --------------------------------------------------------*/
40 /** @defgroup SMBUSEx_Exported_Constants SMBUS Extended Exported Constants
41   * @{
42   */
43 
44 /** @defgroup SMBUSEx_FastModePlus SMBUS Extended Fast Mode Plus
45   * @{
46   */
47 #define SMBUS_FASTMODEPLUS_I2C1           SYSCFG_PMCSETR_I2C1_FMP                           /*!< Enable Fast Mode Plus on I2C1 pins */
48 #define SMBUS_FASTMODEPLUS_I2C2           SYSCFG_PMCSETR_I2C2_FMP                           /*!< Enable Fast Mode Plus on I2C2 pins */
49 #define SMBUS_FASTMODEPLUS_I2C3           SYSCFG_PMCSETR_I2C3_FMP                           /*!< Enable Fast Mode Plus on I2C3 pins */
50 #define SMBUS_FASTMODEPLUS_I2C4           SYSCFG_PMCSETR_I2C4_FMP                           /*!< Enable Fast Mode Plus on I2C4 pins */
51 #define SMBUS_FASTMODEPLUS_I2C5           SYSCFG_PMCSETR_I2C5_FMP                           /*!< Enable Fast Mode Plus on I2C5 pins */
52 #define SMBUS_FASTMODEPLUS_I2C6           SYSCFG_PMCSETR_I2C6_FMP                           /*!< Enable Fast Mode Plus on I2C6 pins */
53 /**
54   * @}
55   */
56 
57 /**
58   * @}
59   */
60 
61 /* Exported macro ------------------------------------------------------------*/
62 /** @defgroup SMBUSEx_Exported_Macros SMBUS Extended Exported Macros
63   * @{
64   */
65 
66 /**
67   * @}
68   */
69 
70 /* Exported functions --------------------------------------------------------*/
71 /** @addtogroup SMBUSEx_Exported_Functions SMBUS Extended Exported Functions
72   * @{
73   */
74 
75 /** @addtogroup SMBUSEx_Exported_Functions_Group2 WakeUp Mode Functions
76   * @{
77   */
78 /* Peripheral Control functions  ************************************************/
79 HAL_StatusTypeDef HAL_SMBUSEx_EnableWakeUp(SMBUS_HandleTypeDef *hsmbus);
80 HAL_StatusTypeDef HAL_SMBUSEx_DisableWakeUp(SMBUS_HandleTypeDef *hsmbus);
81 /**
82   * @}
83   */
84 
85 /** @addtogroup SMBUSEx_Exported_Functions_Group3 Fast Mode Plus Functions
86   * @{
87   */
88 void HAL_SMBUSEx_EnableFastModePlus(uint32_t ConfigFastModePlus);
89 void HAL_SMBUSEx_DisableFastModePlus(uint32_t ConfigFastModePlus);
90 /**
91   * @}
92   */
93 
94 /**
95   * @}
96   */
97 
98 /* Private constants ---------------------------------------------------------*/
99 /** @defgroup SMBUSEx_Private_Constants SMBUS Extended Private Constants
100   * @{
101   */
102 
103 /**
104   * @}
105   */
106 
107 /* Private macros ------------------------------------------------------------*/
108 /** @defgroup SMBUSEx_Private_Macro SMBUS Extended Private Macros
109   * @{
110   */
111 #define IS_SMBUS_FASTMODEPLUS(__CONFIG__) ((((__CONFIG__) & (SMBUS_FASTMODEPLUS_I2C1)) == SMBUS_FASTMODEPLUS_I2C1)  || \
112                                            (((__CONFIG__) & (SMBUS_FASTMODEPLUS_I2C2)) == SMBUS_FASTMODEPLUS_I2C2)  || \
113                                            (((__CONFIG__) & (SMBUS_FASTMODEPLUS_I2C3)) == SMBUS_FASTMODEPLUS_I2C3)  || \
114                                            (((__CONFIG__) & (SMBUS_FASTMODEPLUS_I2C4)) == SMBUS_FASTMODEPLUS_I2C4)  || \
115                                            (((__CONFIG__) & (SMBUS_FASTMODEPLUS_I2C5)) == SMBUS_FASTMODEPLUS_I2C5)  || \
116                                            (((__CONFIG__) & (SMBUS_FASTMODEPLUS_I2C6)) == SMBUS_FASTMODEPLUS_I2C6))
117 
118 /**
119   * @}
120   */
121 
122 /* Private Functions ---------------------------------------------------------*/
123 /** @defgroup SMBUSEx_Private_Functions SMBUS Extended Private Functions
124   * @{
125   */
126 /* Private functions are defined in stm32mp1xx_hal_smbus_ex.c file */
127 /**
128   * @}
129   */
130 
131 /**
132   * @}
133   */
134 
135 /**
136   * @}
137   */
138 
139 #ifdef __cplusplus
140 }
141 #endif
142 
143 #endif /* STM32MP1xx_HAL_SMBUS_EX_H */
144