1 /**
2   ******************************************************************************
3   * @file    stm32h5xx_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) 2022 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 STM32H5xx_HAL_SMBUS_EX_H
21 #define STM32H5xx_HAL_SMBUS_EX_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32h5xx_hal_def.h"
29 
30 /** @addtogroup STM32H5xx_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_ENABLE         0x00000000U           /*!< Enable Fast Mode Plus                        */
48 #define SMBUS_FASTMODEPLUS_DISABLE        0x00000001U           /*!< Disable Fast Mode Plus                       */
49 /**
50   * @}
51   */
52 
53 /**
54   * @}
55   */
56 
57 /* Exported macro ------------------------------------------------------------*/
58 /** @defgroup SMBUSEx_Exported_Macros SMBUS Extended Exported Macros
59   * @{
60   */
61 
62 /**
63   * @}
64   */
65 
66 /* Exported functions --------------------------------------------------------*/
67 /** @addtogroup SMBUSEx_Exported_Functions SMBUS Extended Exported Functions
68   * @{
69   */
70 
71 /** @addtogroup SMBUSEx_Exported_Functions_Group2 WakeUp Mode Functions
72   * @{
73   */
74 /* Peripheral Control functions  ************************************************/
75 HAL_StatusTypeDef HAL_SMBUSEx_EnableWakeUp(SMBUS_HandleTypeDef *hsmbus);
76 HAL_StatusTypeDef HAL_SMBUSEx_DisableWakeUp(SMBUS_HandleTypeDef *hsmbus);
77 /**
78   * @}
79   */
80 
81 /** @addtogroup SMBUSEx_Exported_Functions_Group3 Fast Mode Plus Functions
82   * @{
83   */
84 HAL_StatusTypeDef HAL_SMBUSEx_ConfigFastModePlus(SMBUS_HandleTypeDef *hsmbus, uint32_t FastModePlus);
85 /**
86   * @}
87   */
88 
89 /**
90   * @}
91   */
92 
93 /* Private constants ---------------------------------------------------------*/
94 /** @defgroup SMBUSEx_Private_Constants SMBUS Extended Private Constants
95   * @{
96   */
97 
98 /**
99   * @}
100   */
101 
102 /* Private macros ------------------------------------------------------------*/
103 /** @defgroup SMBUSEx_Private_Macro SMBUS Extended Private Macros
104   * @{
105   */
106 #define IS_SMBUS_FASTMODEPLUS(__CONFIG__) (((__CONFIG__) == (SMBUS_FASTMODEPLUS_ENABLE))   || \
107                                            ((__CONFIG__) == (SMBUS_FASTMODEPLUS_DISABLE)))
108 /**
109   * @}
110   */
111 
112 /* Private Functions ---------------------------------------------------------*/
113 /** @defgroup SMBUSEx_Private_Functions SMBUS Extended Private Functions
114   * @{
115   */
116 /* Private functions are defined in stm32h5xx_hal_smbus_ex.c file */
117 /**
118   * @}
119   */
120 
121 /**
122   * @}
123   */
124 
125 /**
126   * @}
127   */
128 
129 #ifdef __cplusplus
130 }
131 #endif
132 
133 #endif /* STM32H5xx_HAL_SMBUS_EX_H */
134