summaryrefslogtreecommitdiff
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h
index dcdbc8a847..ec35da9eb1 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_smbus.h
@@ -37,10 +37,12 @@ extern "C" {
/* Exported types ------------------------------------------------------------*/
/** @defgroup SMBUS_Exported_Types SMBUS Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup SMBUS_Configuration_Structure_definition SMBUS Configuration Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief SMBUS Configuration Structure definition
* @{
*/
@@ -90,6 +92,7 @@ typedef struct
*/
/** @defgroup HAL_state_definition HAL state definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief HAL State definition
* @{
*/
@@ -108,6 +111,7 @@ typedef struct
*/
/** @defgroup SMBUS_Error_Code_definition SMBUS Error Code definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief SMBUS Error Code definition
* @{
*/
@@ -129,6 +133,7 @@ typedef struct
*/
/** @defgroup SMBUS_handle_Structure_definition SMBUS handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief SMBUS handle Structure definition
* @{
*/
@@ -221,10 +226,12 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
/* Exported constants --------------------------------------------------------*/
/** @defgroup SMBUS_Exported_Constants SMBUS Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup SMBUS_Analog_Filter SMBUS Analog Filter
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SMBUS_ANALOGFILTER_ENABLE (0x00000000U)
@@ -234,6 +241,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_addressing_mode SMBUS addressing mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SMBUS_ADDRESSINGMODE_7BIT (0x00000001U)
@@ -243,6 +251,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_dual_addressing_mode SMBUS dual addressing mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -253,6 +262,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_own_address2_masks SMBUS ownaddress2 masks
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -270,6 +280,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
/** @defgroup SMBUS_general_call_addressing_mode SMBUS general call addressing mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SMBUS_GENERALCALL_DISABLE (0x00000000U)
@@ -279,6 +290,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_nostretch_mode SMBUS nostretch mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SMBUS_NOSTRETCH_DISABLE (0x00000000U)
@@ -288,6 +300,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_packet_error_check_mode SMBUS packet error check mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SMBUS_PEC_DISABLE (0x00000000U)
@@ -297,6 +310,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_peripheral_mode SMBUS peripheral mode
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define SMBUS_PERIPHERAL_MODE_SMBUS_HOST I2C_CR1_SMBHEN
@@ -307,6 +321,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_ReloadEndMode_definition SMBUS ReloadEndMode definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -319,6 +334,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_StartStopMode_definition SMBUS StartStopMode definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -331,6 +347,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_XferOptions_definition SMBUS XferOptions definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -358,6 +375,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_Interrupt_configuration_definition SMBUS Interrupt configuration definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief SMBUS Interrupt definition
* Elements values convention: 0xXXXXXXXX
* - XXXXXXXX : Interrupt control mask
@@ -381,6 +399,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
*/
/** @defgroup SMBUS_Flag_definition SMBUS Flag definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief Flag definition
* Elements values convention: 0xXXXXYYYY
* - XXXXXXXX : Flag mask
@@ -413,6 +432,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
/* Exported macros ------------------------------------------------------------*/
/** @defgroup SMBUS_Exported_Macros SMBUS Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -555,6 +575,7 @@ typedef void (*pSMBUS_AddrCallbackTypeDef)(SMBUS_HandleTypeDef *hsmbus, uint8_t
/* Private macros ------------------------------------------------------------*/
/** @defgroup SMBUS_Private_Macro SMBUS Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -764,6 +785,7 @@ uint32_t HAL_SMBUS_GetError(const SMBUS_HandleTypeDef *hsmbus);
/* Private Functions ---------------------------------------------------------*/
/** @defgroup SMBUS_Private_Functions SMBUS Private Functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/* Private functions are defined in stm32h7xx_hal_smbus.c file */