summaryrefslogtreecommitdiff
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h
diff options
context:
space:
mode:
authorKarel Gardas <karel@functional.vision>2023-07-21 14:24:09 +0200
committerKarel Gardas <karel@functional.vision>2023-07-31 15:15:10 +0200
commitba8ac65929f9e82892d44779a3c37d4cfea14ec7 (patch)
tree0606d24aa7ae7ec806837f2e67c70833ae0c58ee /bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h
parent7f3dc31336765cc46e78b7b361c548e3bbe4c51c (diff)
bsp/stm32h7: Add and use BSP Doxygen group
Inspired by: commit fe58f6ce4bf1ff5e92d64b9fee0cb46b6ac06e64 Author: Sebastian Huber <sebastian.huber@embedded-brains.de> Date: Thu Nov 26 08:13:52 2020 +0100 bsp/stm32h7: Add and use BSP Doxygen group Update #3910.
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h
index 7c853ca50f..042304f846 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_hcd.h
@@ -38,10 +38,12 @@ extern "C" {
/* Exported types ------------------------------------------------------------*/
/** @defgroup HCD_Exported_Types HCD Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup HCD_Exported_Types_Group1 HCD State Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
typedef enum
@@ -63,6 +65,7 @@ typedef USB_OTG_HCStateTypeDef HCD_HCStateTypeDef;
*/
/** @defgroup HCD_Exported_Types_Group2 HCD Handle Structure definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
@@ -101,10 +104,12 @@ typedef struct
/* Exported constants --------------------------------------------------------*/
/** @defgroup HCD_Exported_Constants HCD Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup HCD_Speed HCD Speed
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HCD_SPEED_HIGH USBH_HS_SPEED
@@ -115,6 +120,7 @@ typedef struct
*/
/** @defgroup HCD_Device_Speed HCD Device Speed
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HCD_DEVICE_SPEED_HIGH 0U
@@ -125,6 +131,7 @@ typedef struct
*/
/** @defgroup HCD_PHY_Module HCD PHY Module
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define HCD_PHY_ULPI 1U
@@ -134,6 +141,7 @@ typedef struct
*/
/** @defgroup HCD_Error_Code_definition HCD Error Code definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief HCD Error Code definition
* @{
*/
@@ -151,6 +159,7 @@ typedef struct
/* Exported macro ------------------------------------------------------------*/
/** @defgroup HCD_Exported_Macros HCD Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief macros to handle interrupts and specific clock configurations
* @{
*/
@@ -181,6 +190,7 @@ typedef struct
*/
/** @defgroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
@@ -195,6 +205,7 @@ void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
#if (USE_HAL_HCD_REGISTER_CALLBACKS == 1U)
/** @defgroup HAL_HCD_Callback_ID_enumeration_definition HAL USB OTG HCD Callback ID enumeration definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief HAL USB OTG HCD Callback ID enumeration definition
* @{
*/
@@ -215,6 +226,7 @@ typedef enum
*/
/** @defgroup HAL_HCD_Callback_pointer_definition HAL USB OTG HCD Callback pointer definition
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief HAL USB OTG HCD Callback pointer definition
* @{
*/
@@ -294,6 +306,7 @@ uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
/* Private macros ------------------------------------------------------------*/
/** @defgroup HCD_Private_Macros HCD Private Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/**