summaryrefslogtreecommitdiffstats
path: root/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc.h
diff options
context:
space:
mode:
Diffstat (limited to 'bsps/arm/stm32h7/include/stm32h7xx_hal_rcc.h')
-rw-r--r--bsps/arm/stm32h7/include/stm32h7xx_hal_rcc.h39
1 files changed, 39 insertions, 0 deletions
diff --git a/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc.h b/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc.h
index 08f29a0844..36e71d3bb9 100644
--- a/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc.h
+++ b/bsps/arm/stm32h7/include/stm32h7xx_hal_rcc.h
@@ -39,6 +39,7 @@
/* Exported types ------------------------------------------------------------*/
/** @defgroup RCC_Exported_Types RCC Exported Types
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -153,10 +154,12 @@ typedef struct
/* Exported constants --------------------------------------------------------*/
/** @defgroup RCC_Exported_Constants RCC Exported Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
/** @defgroup RCC_Oscillator_Type RCC Oscillator Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_OSCILLATORTYPE_NONE (0x00000000U)
@@ -172,6 +175,7 @@ typedef struct
*/
/** @defgroup RCC_HSE_Config RCC HSE Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_HSE_OFF (0x00000000U)
@@ -186,6 +190,7 @@ typedef struct
*/
/** @defgroup RCC_LSE_Config RCC LSE Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_LSE_OFF (0x00000000U)
@@ -200,6 +205,7 @@ typedef struct
*/
/** @defgroup RCC_HSI_Config RCC HSI Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_HSI_OFF (0x00000000U) /*!< HSI clock deactivation */
@@ -221,6 +227,7 @@ typedef struct
*/
/** @defgroup RCC_HSI48_Config RCC HSI48 Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_HSI48_OFF ((uint8_t)0x00)
@@ -231,6 +238,7 @@ typedef struct
*/
/** @defgroup RCC_LSI_Config RCC LSI Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_LSI_OFF (0x00000000U)
@@ -241,6 +249,7 @@ typedef struct
*/
/** @defgroup RCC_CSI_Config RCC CSI Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_CSI_OFF (0x00000000U)
@@ -256,6 +265,7 @@ typedef struct
*/
/** @defgroup RCC_PLL_Config RCC PLL Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_PLL_NONE (0x00000000U)
@@ -268,6 +278,7 @@ typedef struct
/** @defgroup RCC_PLL_Clock_Source RCC PLL Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_PLLSOURCE_HSI (0x00000000U)
@@ -279,6 +290,7 @@ typedef struct
*/
/** @defgroup RCC_PLL_Clock_Output RCC PLL Clock Output
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_PLL1_DIVP RCC_PLLCFGR_DIVP1EN
@@ -292,6 +304,7 @@ typedef struct
/** @defgroup RCC_PLL1_VCI_Range RCC PLL1 VCI Range
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_PLL1VCIRANGE_0 RCC_PLLCFGR_PLL1RGE_0 /*!< Clock range frequency between 1 and 2 MHz */
@@ -306,6 +319,7 @@ typedef struct
/** @defgroup RCC_PLL1_VCO_Range RCC PLL1 VCO Range
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_PLL1VCOWIDE (0x00000000U)
@@ -317,6 +331,7 @@ typedef struct
/** @defgroup RCC_System_Clock_Type RCC System Clock Type
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_CLOCKTYPE_SYSCLK (0x00000001U)
@@ -331,6 +346,7 @@ typedef struct
*/
/** @defgroup RCC_System_Clock_Source RCC System Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_SYSCLKSOURCE_CSI RCC_CFGR_SW_CSI
@@ -343,6 +359,7 @@ typedef struct
*/
/** @defgroup RCC_System_Clock_Source_Status System Clock Source Status
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_SYSCLKSOURCE_STATUS_CSI RCC_CFGR_SWS_CSI /*!< CSI used as system clock */
@@ -354,6 +371,7 @@ typedef struct
*/
/** @defgroup RCC_SYS_Clock_Source RCC SYS Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if defined(RCC_D1CFGR_D1CPRE_DIV1)
@@ -383,6 +401,7 @@ typedef struct
/** @defgroup RCC_HCLK_Clock_Source RCC HCLK Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if defined(RCC_D1CFGR_HPRE_DIV1)
@@ -411,6 +430,7 @@ typedef struct
*/
/** @defgroup RCC_APB3_Clock_Source RCC APB3 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if defined (RCC_D1CFGR_D1PPRE_DIV1)
@@ -431,6 +451,7 @@ typedef struct
*/
/** @defgroup RCC_APB1_Clock_Source RCC APB1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if defined (RCC_D2CFGR_D2PPRE1_DIV1)
@@ -452,6 +473,7 @@ typedef struct
*/
/** @defgroup RCC_APB2_Clock_Source RCC APB2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if defined (RCC_D2CFGR_D2PPRE2_DIV1)
@@ -472,6 +494,7 @@ typedef struct
*/
/** @defgroup RCC_APB4_Clock_Source RCC APB4 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#if defined(RCC_D3CFGR_D3PPRE_DIV1)
@@ -492,6 +515,7 @@ typedef struct
*/
/** @defgroup RCC_RTC_Clock_Source RCC RTC Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_RTCCLKSOURCE_NO_CLK (0x00000000U)
@@ -567,6 +591,7 @@ typedef struct
/** @defgroup RCC_MCO_Index RCC MCO Index
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_MCO1 (0x00000000U)
@@ -577,6 +602,7 @@ typedef struct
*/
/** @defgroup RCC_MCO1_Clock_Source RCC MCO1 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_MCO1SOURCE_HSI (0x00000000U)
@@ -590,6 +616,7 @@ typedef struct
*/
/** @defgroup RCC_MCO2_Clock_Source RCC MCO2 Clock Source
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_MCO2SOURCE_SYSCLK (0x00000000U)
@@ -604,6 +631,7 @@ typedef struct
*/
/** @defgroup RCC_MCOx_Clock_Prescaler RCC MCOx Clock Prescaler
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_MCODIV_1 RCC_CFGR_MCO1PRE_0
@@ -628,6 +656,7 @@ typedef struct
*/
/** @defgroup RCC_Interrupt RCC Interrupt
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_IT_LSIRDY (0x00000001U)
@@ -646,6 +675,7 @@ typedef struct
*/
/** @defgroup RCC_Flag RCC Flag
+ * @ingroup RTEMSBSPsARMSTM32H7
* Elements values convention: XXXYYYYYb
* - YYYYY : Flag position in the register
* - XXX : Register index
@@ -719,6 +749,7 @@ typedef struct
*/
/** @defgroup RCC_LSEDrive_Config LSE Drive Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_LSEDRIVE_LOW (0x00000000U) /*!< LSE low drive capability */
@@ -730,6 +761,7 @@ typedef struct
*/
/** @defgroup RCC_Stop_WakeUpClock RCC Stop WakeUpClock
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_STOP_WAKEUPCLOCK_HSI (0x00000000U)
@@ -740,6 +772,7 @@ typedef struct
*/
/** @defgroup RCC_Stop_KernelWakeUpClock RCC Stop KernelWakeUpClock
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
#define RCC_STOP_KERWAKEUPCLOCK_HSI (0x00000000U)
@@ -764,6 +797,7 @@ typedef struct
/* Exported macros -----------------------------------------------------------*/
/** @defgroup RCC_Exported_Macros RCC Exported Macros
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -7091,6 +7125,7 @@ typedef struct
#endif /* RCC_CR_HSEEXT */
/** @defgroup RCC_LSE_Configuration LSE Configuration
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -7404,6 +7439,7 @@ typedef struct
#define __HAL_RCC_GET_PLL_OSCSOURCE() ((uint32_t)(RCC->PLLCKSELR & RCC_PLLCKSELR_PLLSRC))
/** @defgroup RCCEx_MCOx_Clock_Config RCC Extended MCOx Clock Config
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -7496,6 +7532,7 @@ typedef struct
MODIFY_REG(RCC->CFGR, RCC_CFGR_STOPKERWUCK, (__RCC_STOPKERWUCLK__))
/** @defgroup RCC_Flags_Interrupts_Management Flags Interrupts Management
+ * @ingroup RTEMSBSPsARMSTM32H7
* @brief macros to manage the specified RCC Flags and interrupts.
* @{
*/
@@ -7721,6 +7758,7 @@ void HAL_RCC_CCSCallback(void);
/* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup RCC_Private_Constants RCC Private Constants
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/
@@ -7744,6 +7782,7 @@ void HAL_RCC_CCSCallback(void);
*/
/** @defgroup RCC_IS_RCC_Definitions RCC Private macros to check input parameters
+ * @ingroup RTEMSBSPsARMSTM32H7
* @{
*/